@salesforce/lds-core-release 0.1.0-dev1

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2022 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2022, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/README.md

@@ -0,0 +1,3 @@
+# LDS Core Release
+
+This package defines a portable [python script](./src/release.py) along with assets to successfully update core with the latest lds-lightning-platform assets. It can be used for local development, integration testing, and the LDS weekly release. Usage is documented [here](../../docs/release/core-release-tasks.md)

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@salesforce/lds-core-release",
+    "private": false,
+    "version": "0.1.0-dev1",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "description": "LDS release System",
+    "scripts": {
+        "release:python": "python3 ./src/release.py"
+    },
+    "volta": {
+        "extends": "../../package.json"
+    },
+    "sfdc": {
+        "overrides": {
+            "artifactDirectory": "src",
+            "outputDir": "lds",
+            "artifactPaths": "**/*.{py,txt}",
+            "artifacts": {
+                "release.py": {
+                    "output": {
+                        "path": "release.py"
+                    }
+                },
+                "assets/js-meta.txt": {
+                    "output": {
+                        "path": "assets/js-meta.txt",
+                        "dir": "assets"
+                    }
+                }
+            }
+        }
+    }
+}

package/src/assets/js-meta.txt

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright 2022 salesforce.com, inc.
+  ~ All Rights Reserved
+  ~ Company Confidential
+  -->
+
+<LightningComponentBundle xmlns="xmlns=http://soap.sforce.com/2006/04/metadata">
+    <isExposed>true</isExposed>
+</LightningComponentBundle>

package/src/release.py

@@ -0,0 +1,198 @@
+#!/usr/bin/env python3
+import subprocess;
+import errno;
+from string import Template
+from pathlib import Path
+from typing import List
+from functools import lru_cache
+import asyncio
+import argparse
+
+# resolve static files used by the script
+script_path = Path(__file__).resolve()
+script_directory = script_path.parent
+assets_path = script_directory / 'assets'
+
+async def usingPerforce(coreDir):
+    isPerforceDir = True
+    try:
+        # Run the 'p4 where ...' command using subprocess
+        result = subprocess.run(['p4 where ...'], cwd=coreDir, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True, check=True)
+        # Check if the error message indicates the directory is not under client's root
+        if "is not under client's root" in result.stderr:
+            print('Client root error!')
+            isPerforceDir = False
+
+    except subprocess.CalledProcessError as e:
+        print('Got an error trying to verify p4 workspace. Assuming Git.')
+        print(e) 
+        # Handle any errors, but we assume that if 'p4 where' fails, it's not a Perforce directory
+        isPerforceDir = False
+
+    return isPerforceDir
+
+async def checkoutFileP4(corePath: Path, coreDir: Path):
+    # Check if the file exists
+    if not corePath.exists():
+        # If it doesn't exist, add it to Perforce
+        print('New file in perforce. Attempting add.')
+        p4_command = [f'p4 add {corePath}']
+
+        try:
+            subprocess.run(p4_command, cwd=coreDir, check=True, shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+        except subprocess.CalledProcessError as e:
+            print(f"Error adding file to Perforce: {e}")
+            return
+
+        # Create the directory structure if it doesn't exist
+        corePath.parent.mkdir(parents=True, exist_ok=True)
+
+        # Create an empty file
+        try:
+            corePath.touch()
+        except OSError as e:
+            if e.errno == errno.EACCES:
+                print(f"File is not writable. Make sure to run 'p4 edit {corePath}'.")
+            else:
+                print(f"Error creating file: {e}")
+    else:
+        # If the file exists, edit it in Perforce
+        p4_command = [f'p4 edit {corePath}']
+
+        try:
+            subprocess.run(p4_command, cwd=coreDir, check=True, shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+        except subprocess.CalledProcessError as e:
+            print(f"Error editing file in Perforce: {e}")
+
+        # Check if the file is writable
+        try:
+            corePath.touch(mode=0o666, exist_ok=True)
+        except OSError as e:
+            if e.errno == errno.EACCES:
+                print(f"File is not writable. Make sure to run 'p4 edit {corePath}'.")
+            else:
+                print(f"Error checking file access: {e}")
+
+# Python 3 script that does the LDS release.
+async def copy_release(source_dir: Path, destination_dir: Path, useP4: bool):
+    try:
+        new_modules = []
+
+        # Copy files from the source directory to the destination directory
+        for file in Path(source_dir).rglob("*.js"):
+            print(f"File detected: {file}")
+
+            relative_path = file.relative_to(source_dir)
+            destination_file = destination_dir / relative_path
+
+            if(useP4):
+                await checkoutFileP4(destination_file, destination_dir)
+            
+            destination_file.parent.mkdir(parents=True, exist_ok=True)
+            destination_file.touch(mode= 0o666 ,exist_ok=True)
+
+            # Copy the file
+            destination_file.write_bytes(file.read_bytes())
+            # Get the directory name (module name)
+            module_name = destination_file.parent.name
+            metajs_xml_filename_template = Template("$module.js-meta.xml")
+            metajs_xml_filename = metajs_xml_filename_template.substitute(module=module_name)
+
+            # # Check if a meta xml file exists in the module.
+            meta_xml_file = destination_file.parent / metajs_xml_filename
+            if not meta_xml_file.exists() and requires_js_meta(meta_xml_file):
+                new_modules.append(module_name)
+                # Create the meta xml file if missing
+                meta_xml_template_bytes = read_js_meta_template()
+                if(useP4):
+                    await checkoutFileP4(meta_xml_file, destination_dir)
+                meta_xml_file.touch(mode= 0o666 ,exist_ok=True)
+                meta_xml_file.write_bytes(meta_xml_template_bytes)
+
+        print("Release copied successfully!")
+        return new_modules
+    except Exception as e:
+        raise SystemExit(f"An error occurred while copying the release: {e}")
+    
+@lru_cache(1)
+def read_js_meta_template():
+    js_meta_path = assets_path / 'js-meta.txt'
+    return js_meta_path.read_bytes()
+
+@lru_cache(1)
+def read_miniftests_template():
+    miniftests_path = assets_path / 'miniftests.lst'
+    return miniftests_path.read_bytes()
+    
+def requires_js_meta(file: Path):
+    if  "Adapters" in file.name:
+        return True
+    else:
+        return False
+
+def replace_string_in_file(file_path: Path, old_string: str, new_string: str, success_string: str ="String replaced successfully!"):
+    try:
+        # Read the contents of the file
+        with open(file_path, 'r') as file:
+            file_contents = file.read()
+
+        # Replace the old string with the new string
+        modified_contents = file_contents.replace(old_string, new_string)
+
+        # Write the modified contents back to the file
+        with open(file_path, 'w') as file:
+            file.write(modified_contents)
+
+        print(success_string)
+    
+    except Exception as e:
+        print("An error occurred while replacing the string:", e)
+
+async def update_ownership_yml(destination_filepath: Path, new_modules: List[str], useP4: bool):   
+    ownershipYamlPath = destination_filepath / 'ui-force-components' / 'java' / 'resources' / 'ownership.yaml'
+    newEntriesString = "\n".join([f"  - modules/force/{module}/**" for module in new_modules]) + "\n  - modules/force/ldsBindings/**"
+    if useP4:
+        await checkoutFileP4(ownershipYamlPath, destination_filepath)
+    ownershipYamlPath.chmod(0o666)
+    replace_string_in_file(ownershipYamlPath, '  - modules/force/ldsBindings/**', newEntriesString, "Updated ownership.yml")
+    return
+
+async def update_lwc_workflow_test(destination_filepath: Path, new_modules: List[str], useP4: bool):    
+    lwcWorkflowTestPath = destination_filepath / 'aura-impl-sfdc' / 'test' / 'func' / 'java' / 'src' / 'aura' / 'impl' / 'sfdc' / 'modules' / 'LWCWorkflowTest.java'
+    newEntriesString = "\n".join([f'            "force/{module}",' for module in new_modules]) + '\n            "force/ldsBindings",'
+    if useP4:
+        await checkoutFileP4(lwcWorkflowTestPath, destination_filepath)
+
+    lwcWorkflowTestPath.chmod(0o666)
+    replace_string_in_file(lwcWorkflowTestPath, '            "force/ldsBindings",', newEntriesString, "Updated LWCWorkflowTest")
+    return
+
+async def main():
+    parser = argparse.ArgumentParser(description="The release script for LDS")
+    parser.add_argument("-o", "--outputDir", help="Path to the output directory generated by yarn build:core-artifacts")
+    parser.add_argument("-c", "--coreDir", help="Path to the target core directory")
+    args, unknown = parser.parse_known_args()
+    
+    source_filepath = Path(args.outputDir or input("Enter the location of the LDS release artifact. Default: ./output: ") or './output').expanduser()
+    print("LDS Release artifact path:", source_filepath)
+    if not (source_filepath / 'sfdc').exists():
+        raise SystemExit(f"LDS release artifact directory({source_filepath}) does not seem to exist. Did you provide the correct path? Did you run yarn build:core-artifacts?")
+    destination_filepath = Path(args.coreDir or input("Enter the core filepath. Default: /opt/workspace/core-public/core: ") or '/opt/workspace/core-public/core').expanduser()
+    print("Destination filepath:", destination_filepath)
+    if not (destination_filepath / 'ui-force-components').exists():
+        raise SystemExit(f"Destination core directory does not seem to contain ui-force-components. Did you provide the correct path to your core directory?")
+    # Print the entered filepaths
+
+    
+    useP4 = await usingPerforce(destination_filepath)
+    new_modules = await copy_release(source_filepath / 'sfdc', destination_filepath, useP4)
+
+    if(len(new_modules) == 0):
+        print(f"No new modules detected")
+        return
+    else:
+        print(f"New modules added: {new_modules}")
+        await update_ownership_yml(destination_filepath, new_modules, useP4)
+        await update_lwc_workflow_test(destination_filepath, new_modules, useP4)
+
+asyncio.run(main())