Enabled diff with server for aura and lwc components

Author: lushang

README.md

@@ -101,3 +101,9 @@ well welcome to any contribution, open an issue for discussion before draft you
   * Press ``alt`` + Click ``left mouse button``: Retrieve debug log detail by id
   * Press ``alt`` + DblClick ``left mouse button``: View code coverage by name
   * Press ``alt`` + Triple Click ``left mouse button``: Cancel deployment by Id
+
+# Development Reference
+
+- [Sublime Test Documentation](https://www.sublimetext.com/docs/index.html)
+- [API Reference](https://www.sublimetext.com/docs/api_reference.html)
+- [Sublime Text Community Documentation](https://docs.sublimetext.io/guide/extensibility/plugins/)

config/snippets/Apex/Class Header - class header.sublime-snippet

@@ -5,9 +5,9 @@
  * Object: $2
  * Purpose: $3
  * Author: $4 ($5)
- * Create Date: 2020-${6:03-27}
+ * Create Date: 2022-${6:03-30}
  * Modify History:
- * 2021-${6:01-13}    $4    ${7:Create this class}
+ * 2022-${6:03-30}    $4    ${7:Create this class}
  **************************************************************************************************/
 ]]></content>
     <tabTrigger>ch</tabTrigger>

events.py

@@ -43,9 +43,10 @@ def on_hover(self, view, pt, hover_zone):
 
     def on_new(self, view):
         """
-        1. Eveytime when you open a new view, default syntax is Apex
+        1. Everytime when you open a new view, default syntax is Apex
         2. Set Status with current default project
         """
+
         view.set_syntax_file("Packages/Java/Java.tmLanguage")
         util.display_active_project(view)
 

main.py

@@ -306,7 +306,8 @@ def is_enabled(self):
 
         self.settings = context.get_settings()
         self.attributes = util.get_file_attributes(self.file_name)
-        if self.attributes["metadata_folder"] not in ["classes", "triggers", "pages", "components"]:
+        diffable_attrbs = ["classes", "triggers", "pages", "components", "aura", "lwc"]
+        if self.attributes["metadata_folder"] not in diffable_attrbs:
             return False
 
         return True

processor.py

@@ -1737,7 +1737,7 @@ def handle_thread(thread, timeout):
             handle_set_component_attribute(component_attribute)
 
         # If not succeed, just go to the error line
-        # Because error line in page is always at the line 1, so just work in class or trigger
+        # Only works in class or trigger since error line in page is always at the line 1
         elif "success" in result and not result["success"]:
             print('error result', result)
             # Maybe network issue
@@ -1759,8 +1759,8 @@ def handle_thread(thread, timeout):
 
             # Check current view the saving code file
             if not view or not view.file_name(): return
-            if not file_base_name in view.file_name(): return
-            if not extension in [".trigger", ".cls", ".page", ".cmp", '.js', '.css']: return
+            if file_base_name not in view.file_name(): return
+            if extension not in [".trigger", ".cls", ".page", ".cmp", '.js', '.css']: return
 
             if "line" in result:
                 line = result["line"]
@@ -1941,6 +1941,7 @@ def handle_thread(thread, timeout):
             return
 
         result = api.result
+
         if result["success"] and result["records"]:
             lastModifiedDate = result["records"][0]["LastModifiedDate"]
             util.set_component_attribute(attributes, lastModifiedDate)
@@ -1952,8 +1953,13 @@ def handle_thread(thread, timeout):
 
     settings = context.get_settings()
     api = ToolingApi(settings)
+    cmp_type = attributes["type"]
+    if cmp_type == "AuraDefinitionBundle":
+        cmp_type = 'AuraDefinition'
+    elif cmp_type == 'LightningComponentBundle':
+        cmp_type = "LightningComponentResource"
     soql = "SELECT LastModifiedDate FROM %s WHERE Id = '%s'" % (
-        attributes["type"], attributes["id"]
+        cmp_type, attributes["id"]
     )
     thread = threading.Thread(target=api.query, args=(soql, True,))
     thread.start()
@@ -2007,7 +2013,8 @@ def handle_thread(thread, timeout):
         result = api.result
 
         # If error, just skip, error is processed in ThreadProgress
-        if not result["success"]: return
+        if not result["success"]:
+            return
 
         # Diff Change Compare
         diff.diff_changes(file_name, result)

salesforce/api/tooling.py

@@ -1161,14 +1161,15 @@ def save_to_server(self, component_attribute, body, is_check_only, check_save_co
         # Result used in thread invoke
         self.result = return_result
 
-    def save_lightning_to_server(self, component_attribute, body, check_save_conflict=True):
+    def save_lightning_to_server(self, component_attribute, body, is_check_only, check_save_conflict=True):
         """
         Save Lightning AuraDefinition or LightningComponentResource such as component makeup, controller and helper or
         Lightning Web component resource to Salesforce
 
         Arguments:
         @param component_attribute: attribute of component, e.g., component id, url
         @param body: Code content
+        @param is_check_only: is check only
         @param check_save_conflict: indicate whether to check saving conflict
         @return: saving result
         """
@@ -1219,12 +1220,16 @@ def handle_error_message(result):
 
         # Component Attribute
         bundle_type = component_attribute["type"]
-        component_type = 'AuraDefinition' if bundle_type == "AuraDefinitionBundle" else 'LightningComponentResource'
+        component_type = 'AuraDefinition' \
+            if bundle_type == "AuraDefinitionBundle" \
+            else 'LightningComponentResource'
         component_id = component_attribute["id"]
-        component_url = self.base_url + '/tooling/sobjects/' + component_type + '/' + component_id
+        component_url = self.base_url + \
+            '/tooling/sobjects/%s/%s' % (component_type, component_id)
 
         # 2. Check conflict
-        if self.settings["check_save_conflict"] and check_save_conflict:
+        if self.settings["check_save_conflict"] and not is_check_only \
+                and check_save_conflict and "url" in component_attribute:
             Printer.get('log').write("Start to check saving conflict")
             query = "SELECT Id, LastModifiedById, LastModifiedBy.Id, " + \
                     "LastModifiedBy.Name, LastModifiedDate, SystemModstamp " + \
@@ -1274,7 +1279,7 @@ def handle_error_message(result):
         data = {
             "Source": body
         }
-        result = self.patch(component_url, data)
+        result = self.patch(component_url, data)  # {"str": "", "success": true}
         return_result = {
             "success": False,
             "problem": '',

salesforce/lib/diff.py

@@ -5,31 +5,36 @@
 import codecs
 import os
 
+
 def diff_changes(file_name, result):
     try:
         if "Body" in result:
             server = result["Body"].splitlines()
         elif "Markup" in result:
             server = result["Markup"].splitlines()
+        elif "Source" in result:
+            server = result["Source"].splitlines()
+        else:
+            show_diff_panel("No server text found to diff")
+            return
 
         local = codecs.open(file_name, "r", "utf-8").read().splitlines()
-    except UnicodeDecodeError:
-        show_diff_panel("Diff only works with UTF-8 files")
-        return
 
-    time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(time.time()))
-    bdate_literal = result["LastModifiedDate"].split(".")[0]
-    server_date = datetime.datetime.strptime(bdate_literal, "%Y-%m-%dT%H:%M:%S")
-    local_date = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(time.time()))
+        time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(time.time()))
+        bdate_literal = result["LastModifiedDate"].split(".")[0]
+        server_date = datetime.datetime.strptime(bdate_literal, "%Y-%m-%dT%H:%M:%S")
+        local_date = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(time.time()))
 
-    diff = difflib.unified_diff(server, local, "Server", "Local ", server_date, local_date, lineterm='')
-    difftxt = u"\n".join(line for line in diff)
+        diff = difflib.unified_diff(server, local, "Server", "Local ", server_date, local_date, lineterm='')
+        difftxt = u"\n".join(line for line in diff)
 
-    if difftxt == "":
-        show_diff_panel("There is no difference between %s and server" % os.path.basename(file_name))
-        return
+        if difftxt == "":
+            show_diff_panel("There is no difference between %s and server" % os.path.basename(file_name))
+        else:
+            show_diff_panel(difftxt)
+    except UnicodeDecodeError:
+        show_diff_panel("Diff only works with UTF-8 files")
 
-    show_diff_panel(difftxt)
 
 def diff_files(file_name, other_file_name):
     try:
@@ -51,10 +56,11 @@ def diff_files(file_name, other_file_name):
 
     show_diff_panel(difftxt)
 
-def show_diff_panel(difftxt):
+
+def show_diff_panel(diff_txt):
     win = sublime.active_window()
     v = win.create_output_panel('diff_with_server')
     v.assign_syntax('Packages/Diff/Diff.tmLanguage')
 
-    v.run_command('append', {'characters': difftxt})
+    v.run_command('append', {'characters': diff_txt})
     win.run_command("show_panel", {"panel": "output.diff_with_server"})

salesforce/soap.py

@@ -46,7 +46,7 @@ def format_request_envelope(self, request_body):
             formatted_body = formatter.format_string(request_body)
         except Exception as ex:
             if self.settings["debug_mode"]: 
-                print ("[Format Request Body] " + str(ex))
+                print("[Format Request Body] " + str(ex))
             formatted_body = request_body
 
         return formatted_body
@@ -55,7 +55,7 @@ def format_request_envelope(self, request_body):
     def create_request(self, request_type, options={}):
         soap_body = getattr(self, "create_%s_request" % request_type)(options)
         if self.settings["debug_mode"]:
-            print ("[Debug for {request_type}]: \n{seprate}\n{content}\n{seprate}".format(
+            print("[Debug for {request_type}]: \n{seprate}\n{content}\n{seprate}".format(
                 seprate="~" * 100,
                 request_type=request_type,
                 content=soap_body.decode("UTF-8")

util.py

@@ -1821,7 +1821,12 @@ def reload_file_attributes(file_properties, settings=None, append=False):
         "ApexComponent": "Markup"
     }
 
-    # print(file_properties)
+    lightning_body = {
+        "AuraDefinitionBundle": "AuraDefinition",
+        "LightningComponentBundle": "LightningComponentResource"
+    }
+
+    # print(json.dumps(file_properties))
 
     # If the package only contains `package.xml`
     if isinstance(file_properties, dict):
@@ -1863,6 +1868,13 @@ def reload_file_attributes(file_properties, settings=None, append=False):
             attrs["url"] = "/services/data/v%s.0/sobjects/%s/%s" % (
                 settings["api_version"], metdata_object, filep["id"]
             )
+        elif metdata_object in lightning_body:
+            attrs["body"] = 'Source'
+            attrs["url"] = "/services/data/v%s.0/tooling/sobjects/%s/%s" % (
+                settings["api_version"],
+                lightning_body.get(metdata_object),
+                filep["id"]
+            )
 
         # Check whether component is Test Class or not
         if metdata_object == "ApexClass":
@@ -3199,13 +3211,23 @@ def get_component_attribute(file_name, switch=True, reload_cache=False):
     xml_name = settings[metadata_folder]["xmlName"]
     username = settings["username"]
     components = load_metadata_cache(reload_cache=reload_cache, username=username)
+    lightning_cmps = {
+        "AuraDefinitionBundle": "AuraDefinition",
+        "LightningComponentBundle": "LightningComponentResource"
+    }
     try:
-        component_attribute = components[xml_name][fullName.lower()]
+        cmp_attr = components[xml_name][fullName.lower()]
+        if 'url' not in cmp_attr and cmp_attr['type'] in lightning_cmps:
+            cmp_attr['url'] = "/services/data/v%s.0/tooling/sobjects/%s/%s" % (
+                settings["api_version"],
+                lightning_cmps.get(cmp_attr['type']),
+                cmp_attr["id"]
+            )
     except:
-        component_attribute, name = None, None
+        cmp_attr, name = None, None
 
     # Return tuple
-    return (component_attribute, name)
+    return cmp_attr, name
 
 
 def delete_component_attribute(dirs_or_files, switch=True):