Implemented Save lwc's resource file to Salesforce

lushang · lushang · commit b0eae4ccf619 · 2020-03-29T13:47:37.000+08:00
diff --git a/main.py b/main.py
@@ -2294,7 +2294,11 @@ def create_component(self):
                                                 self.markup_or_body, 
                                                 file_name)
 
+
 class SaveToServer(sublime_plugin.TextCommand):
+    """
+    Save Metadata to Server using Tooling API or Metadata API
+    """
     def run(self, edit, is_check_only=False):
         # Check whether need confirm
         settings = context.get_settings()
@@ -2311,9 +2315,10 @@ def run(self, edit, is_check_only=False):
         processor.handle_save_to_server(self.view.file_name(), is_check_only)
 
     def is_enabled(self):
-        if not self.view or not self.view.file_name(): return False
+        if not self.view or not self.view.file_name():
+            return False
         attributes = util.get_file_attributes(self.view.file_name())
-        if attributes["metadata_folder"] not in ["classes", "components", "pages", "triggers", "aura"]:
+        if attributes["metadata_folder"] not in ["classes", "components", "pages", "triggers", "aura", "lwc"]:
             return False
             
         return util.check_enabled(self.view.file_name())
diff --git a/processor.py b/processor.py
@@ -1582,9 +1582,9 @@ def handle_thread(thread, timeout):
 
 
 def handle_retrieve_package(types, extract_to, source_org=None, ignore_package_xml=False, timeout=120):
-    def handle_thread(thread, timeout):
-        if thread.is_alive():
-            sublime.set_timeout(lambda: handle_thread(thread, timeout), timeout)
+    def handle_thread(_thread, timeout):
+        if _thread.is_alive():
+            sublime.set_timeout(lambda: handle_thread(_thread, timeout), timeout)
             return
 
         # If source_org is not None, we need to switch project back
@@ -1593,11 +1593,11 @@ def handle_thread(thread, timeout):
 
         # Extract the zipFile to extract_to
         if api.result and api.result["success"]:
-            thread = threading.Thread(target=util.extract_encoded_zipfile,
-                                      args=(api.result["zipFile"], extract_to, ignore_package_xml,))
-            thread.start()
+            _thread = threading.Thread(target=util.extract_encoded_zipfile,
+                                       args=(api.result["zipFile"], extract_to, ignore_package_xml,))
+            _thread.start()
 
-            # Apex Code Cache
+            # Code Cache
             if isinstance(api.result.get("fileProperties", None), list):
                 util.reload_file_attributes(
                     api.result["fileProperties"],
@@ -1610,11 +1610,19 @@ def handle_thread(thread, timeout):
     thread = threading.Thread(target=api.retrieve, args=({"types": types},))
     thread.start()
     handle_thread(thread, timeout)
-    ThreadProgress(api, thread, "Retrieve File From Server",
+    ThreadProgress(api, thread,
+                   "Retrieve File From Server",
                    "Retrieve File From Server Succeed")
 
 
 def handle_save_to_server(file_name, is_check_only=False, timeout=120):
+    """
+    Handle Save metadata to Salesforce
+    @param file_name: file name with path format
+    @param is_check_only: only check the file from Salesforce, do not really save
+    @param timeout: timeout in seconds
+    @return: None
+    """
     def handle_thread(thread, timeout):
         if thread.is_alive():
             sublime.set_timeout(lambda: handle_thread(thread, timeout), timeout)
@@ -1679,15 +1687,18 @@ def handle_thread(thread, timeout):
         # Because error line in page is always at the line 1, so just work in class or trigger
         elif "success" in result and not result["success"]:
             # Maybe network issue
-            if "problem" not in result: return
+            _message = "Unknown Problem!"
+            if "problem" in result:
+                _message = "Compile Error for %s: %s at line %s column %s" % (
+                    file_base_name,
+                    result["problem"],
+                    result["lineNumber"],
+                    result["columnNumber"]
+                )
+            elif "message" in result:
+                _message = result["message"]
 
-            message = "Compile Error for %s: %s at line %s column %s" % (
-                file_base_name,
-                result["problem"],
-                result["lineNumber"],
-                result["columnNumber"]
-            )
-            Printer.get('log').write(message)
+            Printer.get('log').write(_message)
 
             # Get the active view
             view = util.get_view_by_file_name(file_name)
@@ -1753,8 +1764,10 @@ def handle_thread(thread, timeout):
     Printer.get('log').write_start().write("Start to %s %s" % (compile_or_save, file_base_name))
 
     api = ToolingApi(settings)
-    if component_attribute["type"] in ["AuraDefinitionBundle", "AuraDefinition"]:
-        target = api.save_aura_to_server
+    lngt_meta_type = ["AuraDefinitionBundle", "AuraDefinition",
+                      "LightningComponentBundle", "LightningComponentResource"]
+    if component_attribute["type"] in lngt_meta_type:
+        target = api.save_lightning_to_server
     else:
         target = api.save_to_server
     thread = threading.Thread(target=target,
diff --git a/salesforce/api/metadata.py b/salesforce/api/metadata.py
@@ -179,7 +179,7 @@ def retrieve(self, options, timeout=120):
 
         Arguments:
 
-        * options -- {"types" : types, "package_names": package_names}
+        * options -- {"types" : types_dict, "package_names": package_names}
         """
         result = self.login()
         if not result or not result["success"]: 
@@ -223,8 +223,8 @@ def retrieve(self, options, timeout=120):
 
         # Post retrieve request
         try:
-            response = requests.post(self.metadata_url, soap_body, verify=False, 
-                headers=self.headers, timeout=120)
+            response = requests.post(self.metadata_url, soap_body, verify=False,
+                                     headers=self.headers, timeout=120)
         except requests.exceptions.RequestException as e:
             self.result = {
                 "Error Message":  "Network connection timeout when issuing retrieve request",
@@ -322,11 +322,13 @@ def retrieve(self, options, timeout=120):
         # Total time
         total_seconds = (datetime.datetime.now() - start_time).seconds
         Printer.get('log').write("Total time: %s seconds" % total_seconds, False)
+        # print('meta retrive result', result)
 
         self.result = result
 
     def prepare_members(self, _types, list_package_for_all=False):
-        if not self.login(): return
+        if not self.login():
+            return
 
         if list_package_for_all:
             Printer.get("log").write_start()
@@ -335,7 +337,8 @@ def prepare_members(self, _types, list_package_for_all=False):
         # EmailFolder, DocumentFolder, DashboardFolder and ReportFolder
         records = []
         for _type in _types:
-            if "*" not in _types[_type]: continue
+            if "*" not in _types[_type]:
+                continue
             if _type in self.settings["metadata_objects_in_folder"]:
                 # List package for ``suffix.capitalize() + 'Folder'``
                 metadata_object = _type + "Folder" if _type != "EmailTemplate" else "EmailFolder"
@@ -377,19 +380,20 @@ def prepare_members(self, _types, list_package_for_all=False):
 
         # In order to speed up retrieve request, we will not list package for them
         # just when we want to get full copy or build package.xml, we will list_package for all
-        #       Note: CustomObject must be retrieved by ``list_package`` request
+        # Note: CustomObject must be retrieved by ``list_package`` request
         # list package for metadata object which supports wildcard retrieve
         _types_list = []
+        # print("retrieve types: ", _types)
         if not list_package_for_all:
             if "CustomObject" in _types and "*" in _types["CustomObject"]:
                 _types_list.append("CustomObject")
 
-            print(_types)
             if "InstalledPackage" in _types and "*" in _types["InstalledPackage"]:
                 _types_list.append("InstalledPackage")
         else:
             for _type in _types:
-                if "*" not in _types[_type]: continue
+                if "*" not in _types[_type]:
+                    continue
                 if _type not in self.settings["metadata_objects_in_folder"]:
                     _types_list.append(_type)
 
diff --git a/salesforce/api/tooling.py b/salesforce/api/tooling.py
@@ -958,7 +958,7 @@ def save_to_server(self, component_attribute, body, is_check_only, check_save_co
         # Component Attribute
         component_type = component_attribute["type"]
         component_id = component_attribute["id"]
-        component_body = component_attribute["body"]
+        # component_body = component_attribute["body"]
 
         if self.settings["check_save_conflict"] and not is_check_only and check_save_conflict:
             Printer.get('log').write("Start to check saving conflict")
@@ -1159,45 +1159,54 @@ 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_aura_to_server(self, component_attribute, body, check_save_conflict=True):
-        """ Save AuraDefinition such as Lightning component makeup, controller and helper
+    def save_lightning_to_server(self, component_attribute, body, check_save_conflict=True):
+        """
+        Save Lightning AuraDefinition or LightningComponentResource such as component makeup, controller and helper or
+        Lightning Web component teampl to Salesforce
 
         Arguments:
-
-        * component_attribute - attribute of component, e.g., component id, url
-        * body -- Code content
-        * check_save_conflict -- indicate whether to check saving conflict
+        @param component_attribute: attribute of component, e.g., component id, url
+        @param body: Code content
+        @param check_save_conflict: indicate whether to check saving conflict
+        @return: saving result
         """
 
         def handle_error_message(result):
+            if self.settings["debug_mode"]:
+                print('Error: ', result)
             _result = dict()
             _result["success"] = False
             _result["errorCode"] = result["errorCode"]
-            if "\n" in result["message"]:
-                error_messages = result["message"].split('\n')
-                if "CSS Parser" in error_messages[0] :
-                    error_msg = error_messages[2]
-                    _result["problem"] = error_msg
-                    error_line_info = error_msg[error_msg.find("(")+1: error_msg.find(")")]
-                    _result["lineNumber"] = error_line_info.split(",")[0][5:]
-                    _result["columnNumber"] = error_line_info.split(",")[1][5:]
+            try:
+                if "\n" in result["message"]:
+                    error_messages = result["message"].split('\n')
+                    if "CSS Parser" in error_messages[0] :
+                        error_msg = error_messages[2]
+                        _result["problem"] = error_msg
+                        error_line_info = error_msg[error_msg.find("(")+1: error_msg.find(")")]
+                        _result["lineNumber"] = error_line_info.split(",")[0][5:]
+                        _result["columnNumber"] = error_line_info.split(",")[1][5:]
+                    else:
+                        error_base_info = error_messages[0].split(': ')
+                        error_line_info = error_base_info[1].split(':')[1]
+                        error_line_info = error_line_info[1 : len(error_line_info) - 1]
+                        _result['id'] = error_base_info[0]
+                        _result["lineNumber"] = error_line_info.split(',')[0]
+                        _result["columnNumber"] = error_line_info.split(',')[1]
+                        _result["problem"] = error_messages[1]
                 else:
-                    error_base_info = error_messages[0].split(': ')
-                    error_line_info = error_base_info[1].split(':')[1]
-                    error_line_info = error_line_info[1 : len(error_line_info) - 1]
-                    _result['id'] = error_base_info[0]
-                    _result["lineNumber"] = error_line_info.split(',')[0]
-                    _result["columnNumber"] = error_line_info.split(',')[1]
-                    _result["problem"] = error_messages[1]
-            else:
-                _result["problem"] = result["message"]
-                _result['id'] = result["message"].split(':')[0]
-                m = re.search(r'\[\d+,\s*\d+\]', result["message"])
-                if m:
-                    col_row = m.group(0)
-                    col_row = col_row[1:len(col_row)-1]
-                    _result["lineNumber"] = col_row.split(',')[0]
-                    _result["columnNumber"] = col_row.split(',')[1]
+                    _result["problem"] = result["message"]
+                    _result['id'] = result["message"].split(':')[0]
+                    m = re.search(r'\[\d+,\s*\d+\]', result["message"])
+                    if m:
+                        col_row = m.group(0)
+                        col_row = col_row[1:len(col_row)-1]
+                        _result["lineNumber"] = col_row.split(',')[0]
+                        _result["columnNumber"] = col_row.split(',')[1]
+            except Exception as _ex:
+                if self.settings["debug_mode"]:
+                    print('Error parsing error result: ', _ex)
+                _result["message"] = result["message"]
             return _result
 
         # 1. Firstly Login
@@ -1207,10 +1216,10 @@ def handle_error_message(result):
             return self.result
 
         # Component Attribute
-        # component_type = component_attribute["type"]
-        component_type = 'AuraDefinition'
+        bundle_type = component_attribute["type"]
+        component_type = 'AuraDefinition' if bundle_type == "AuraDefinitionBundle" else 'LightningComponentResource'
         component_id = component_attribute["id"]
-        component_url = self.base_url + '/tooling/sobjects/AuraDefinition/' + component_id
+        component_url = self.base_url + '/tooling/sobjects/' + component_type + '/' + component_id
 
         # 2. Check conflict
         if self.settings["check_save_conflict"] and check_save_conflict:
diff --git a/util.py b/util.py
@@ -1687,13 +1687,21 @@ def extract_zipfile(zipfile_path, extract_to):
 
     zfile.close()
 
+
 def extract_file(zipfile_path, extract_to, ignore_package_xml=False):
-    zfile = zipfile.ZipFile(zipfile_path, 'r')
-    for filename in zfile.namelist():
+    """
+    extract packaged Zip file from metadata API
+    @param zipfile_path:
+    @param extract_to:
+    @param ignore_package_xml:
+    @return:
+    """
+    zip_file = zipfile.ZipFile(zipfile_path, 'r')
+    for filename in zip_file.namelist():
         if filename.endswith('/'): 
             continue
 
-        if ignore_package_xml and filename == "unpackaged/package.xml": 
+        if ignore_package_xml and filename == "unpackaged/package.xml":
             continue
 
         if filename.startswith("unpackaged"):
@@ -1705,9 +1713,9 @@ def extract_file(zipfile_path, extract_to, ignore_package_xml=False):
             os.makedirs(os.path.dirname(f))
 
         with open(f, "wb") as fp:
-            fp.write(zfile.read(filename))
+            fp.write(zip_file.read(filename))
 
-    zfile.close()
+    zip_file.close()
 
 def extract_zip(base64String, extract_to):
     """
@@ -1802,6 +1810,8 @@ def reload_file_attributes(file_properties, settings=None, append=False):
         "ApexComponent": "Markup"
     }
 
+    # print(file_properties)
+
     # If the package only contains `package.xml`
     if isinstance(file_properties, dict): 
         file_properties = [file_properties]
@@ -2194,8 +2204,9 @@ def parse_sync_test_coverage(result):
             allrows.append("\n".join(success_row))
 
     allrows.append("~" * 80)
-    allrows.append("Follow the instruction as below, you can quickly view code coverage,")
-    allrows.append("    * Put focus on code name, hold down 'alt' and Dblclick the 'Left Mouse'")
+    allrows.append("Apex Class Or Trigger Code Coverage Statistics:")
+    # allrows.append("Follow the instruction as below, you can quickly view code coverage,")
+    # allrows.append("    * Put focus on code name, hold down 'alt' and Dblclick the 'Left Mouse'")
 
     header_width = {
         "Type": 15, "Name": 50, "Percent": 10, "Lines": 10
@@ -3148,7 +3159,8 @@ def check_enabled(file_name, check_cache=True):
 
     * Bool -- check whether current file is apex code file and has local cache
     """
-    if not file_name: return False
+    if not file_name:
+        return False
 
     # Get toolingapi settings
     settings = context.get_settings()
@@ -3593,7 +3605,7 @@ def export_profile_settings():
                 if sobject in profile_settings[profile]["objectPermissions"]:
                     object_permission = profile_settings[profile]["objectPermissions"][sobject]
                     for crud in cruds:
-                        rows.append("√" if object_permission[crud] == "true" else "")
+                        rows.append("True" if object_permission[crud] == "true" else "")
                 else:
                     for crud in cruds:
                         rows.append("")
