Mark shelljs as external for esbuild bundling #537
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
manodnyab
approved these changes
Jan 6, 2024
justinmk3
approved these changes
Jan 8, 2024
|
/retryBuilds |
bryceitoc9
approved these changes
Jan 8, 2024
5 tasks
rbbarad
added a commit
that referenced
this pull request
Jan 22, 2024
…g issue (#539) ### Background This is a follow-up pr to fix the issue in #522. [Mark shelljs as external for esbuild bundling](#537) attempted to address this issue, but was not a successful solution for all of our tasks, as some of our tasks need the commands present in ShellJS. ### Problem This issue emerged with the bump of `azure-pipelines-task-lib` dependency in: #473. Problem detailed in the open issue on `azure-pipelines-task-lib` repo: [Cannot use JS bundler because of shelljs dependency](microsoft/azure-pipelines-task-lib#942). Essentially, the toolkit takes a dependency on `azure-pipelines-task-lib` which takes an additional dependency on ShellJS. Our toolkit uses the esbuild JS Bundler to build the extension. This fails to bundle ShellJS because it uses dynamic require statements ([problematic ShellJS code](https://github.com/shelljs/shelljs/blob/a6d1e49f180a495d83bcf67bd85782c626aae029/shell.js#L23-L26)) instead of explicit require statements, which prevents bundlers from correctly analyzing the dependencies. - In short, require('./a') works but require('./' + 'a') doesn't. [ShellJS has no plans to accommodate these explicit requires statements](shelljs/shelljs#962 (comment)) ### Solution Before making any larger scale changes, let's get `azure-pipelines-task-lib` back to its last known healthy state (working version we used for last release). This PR addresses that. ### Future `azure-pipelines-task-lib` updates Whenever we next bump the `azure-pipelines-task-lib` major version, we'll need to keep an eye on updates to microsoft/azure-pipelines-task-lib#942 for any new fixes or workarounds. Current known workarounds involve forking the ShellJS repository, making the necessary changes to ShellJS, and overriding the ShellJS dependency in `package.json` with the forked version. - [Example of forked ShellJS with hardcoded explicit `requires` statements](Everspace/shelljs@4e2ea23) - [Example of creating a bundler plugin with a fixed ShellJS file at compile time](https://github.com/tjosepo/azure-pipelines/blob/main/packages/esbuild-plugin-azure-pipelines-task-lib-fix/src/index.js)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Marks ShellJS as external for ESBuild Bundling. This fixes the issue in #522
Description
This issue emerged with the bump of azure-pipelines-task-lib dependency in: #473.
Problem summarized in the open issue on azure-pipelines-task-lib repo: Cannot use JS bundler because of shelljs dependency.
Essentially, the toolkit takes a dependency on azure-pipelines-task-lib which takes an additional dependency on ShellJS. Our toolkit uses the esbuild JS Bundler to build the extension. This fails to bundle ShellJS because it uses dynamic require statements (problematic ShellJS code) instead of explicit require statements, which prevents bundlers from correctly analyzing the dependencies.
Related Issue(s), If Filed
Testing
Confirmed that tasks run locally (e.g.
node ./package/Tasks/AWSCLI/AWSCLI.js) and on hosted agentChecklist
npm run newChangeLicense
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.