feat(packages/scripts): add a build script for darwin targets

[wuhuizuo]

It can not run standalone, it is used in CD workflow to replace multi tasks:

• acquire Darwin resource.
• prepare ssh credentials.
• prepare for remote builder files.
• run remote build and get the built artifacts.
• release the Darwin resource.

After this, the above tasks can run in a single Deno image.

Usage:

deno run --allow-all <url-of>/build-in-darwin-boskos.ts \
    --sshInfoDir <ssh-info-dir> \
    --sourcePath <code-source-dir> \
    --envFile <remote-env-file> \
    --scriptFile <path-of-generated-build-script> \
    --component <component-name> \
    --boskos.serverUrl <boskos-api-base-url> \
    --boskos.type mac-machine-[arm64|amd64] \
    --boskos.owner <hostname-or-task-name> \
    --releaseDir <release-dir>

Signed-off-by: wuhuizuo [email protected]

[ti-chi-bot]

I have already done a preliminary review for you, and I hope to help you do a better job.

Key changes:

1. build-in-darwin-boskos.ts: This is a new script file added to handle building for darwin targets. The script seems to be designed to work in a Continuous Delivery (CD) workflow, where it handles tasks such as acquiring a darwin resource, preparing SSH credentials, setting up for remote builder files, running remote build to get the built artifacts, and releasing the darwin resource.

2. The build script uses several Deno modules and standard JavaScript modules for handling tasks such as SSH connections (node-ssh), path manipulations (path), argument parsing (parse-args), and YAML parsing (yaml).

3. The script defines several interfaces and classes to model the build process and resources, including CliArgs, BoskosOptions, buildOptions, BoskosResource, boskosAcquireParams, and BoskosClient.

4. The BoskosClient class is used to communicate with a Boskos server to acquire and release resources. It also provides a lockAndDo method to ensure that resource operations are performed in a safe manner.

5. The script uses the NodeSSH module to establish SSH connections and perform operations on the remote host, such as creating directories, copying files, and executing commands.

6. The script provides a main function to tie all the operations together. It uses the BoskosClient to acquire a resource, sets up an SSH connection to the remote host, and triggers the build process.

Potential problems:

1. Error Handling: The script doesn't have robust error handling. For example, if the SSH connection fails or the remote host is unavailable, the script may crash.

2. Security: The script requires the --allow-all flag when running with Deno, which could potentially expose security vulnerabilities if the script is run in an untrusted environment.

3. Hardcoded values: There are hardcoded values like timeouts and intervals in the script. It would be better to make these configurable via command line arguments or environment variables.

4. The script doesn't seem to have any logging mechanism. It would be better to log important events and errors for easier debugging and auditing.

Fixing suggestions:

1. Add robust error handling and recovery mechanisms. For example, you can use try-catch blocks to handle potential errors during SSH connections and file operations.

2. Review the script's permissions and limit its access to the necessary resources only. For example, you can use the --allow-net, --allow-read, and --allow-write flags instead of --allow-all.

3. Replace the hardcoded values with configurable options.

4. Use a logging library or the built-in console methods to log important events and errors. You could also consider adding a verbosity level option to control the amount of logging.

[wuhuizuo]

/approve

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wuhuizuo

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [wuhuizuo]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment