Use shell for execFileSync during extension packaging #552
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
justinmk3
approved these changes
May 6, 2024
justinmk3
pushed a commit
to aws/aws-toolkit-vscode
that referenced
this pull request
May 7, 2024
Problem: Node v20.12.2 has introduced an issue with spawnSync (execFileSync) on Windows: nodejs/node#52554 ``` > ts-node ./scripts/build/handlePackageJson <ref *1> Error: spawnSync vsce ENOENT at Object.spawnSync (node:internal/child_process:1124:20) at spawnSync (node:child_process:876:24) at Object.execFileSync (node:child_process:919:15) at main (C:\Users\rbbarad\Desktop\vscode-toolkit\aws-toolkit-vscode-staging\scripts\package.ts:156:23) at Object.<anonymous> (C:\Users\rbbarad\Desktop\vscode-toolkit\aws-toolkit-vscode-staging\scripts\package.ts:181:1) at Module._compile (node:internal/modules/cjs/loader:1369:14) at Module.m._compile (C:\Users\rbbarad\Desktop\vscode-toolkit\aws-toolkit-vscode-staging\node_modules\ts-node\src\index.ts:1618:23) at Module._extensions..js (node:internal/modules/cjs/loader:1427:10) at Object.require.extensions.<computed> [as .ts] (C:\Users\rbbarad\Desktop\vscode-toolkit\aws-toolkit-vscode-staging\node_modules\ts-node\src\index.ts:1621:12) at Module.load (node:internal/modules/cjs/loader:1206:32) { errno: -4058, code: 'ENOENT', syscall: 'spawnSync vsce', path: 'vsce', spawnargs: [ 'package', '--ignoreFile', '../.vscodeignore.packages' ], error: [Circular *1], status: null, signal: null, output: null, pid: 0, stdout: null, stderr: null } ``` Solution: Set the "shell" flag when on Windows OS. This is because `vsce` is a `.cmd` file which needs a shell to run. Testing: - Ran `npm install`, `npm run compile`, `npm run package` locally. confirmed packaging was successful Related: - aws/aws-toolkit-azure-devops#552 - nodejs/node#52554
ROunofF
pushed a commit
to ROunofF/aws-toolkit-azure-devops
that referenced
this pull request
May 10, 2024
A recent node update has introduced an issue with spawnSync (execFileSync) on Windows. This fixes the issue by using a shell to run child_process execFileSync. This is because tfx is a .cmd file, which actually needs a shell. This is one of the rare cases where shell: true is necessary.
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.
Use shell for execFileSync during extension packaging
Problem
A recent node update (~3 weeks ago) has introduced an issue with spawnSync (execFileSync) on Windows. An issue has been filed for this here nodejs/node#52554.
This is affecting our packageExtension step (locally, Windows, Node v20.12.2), giving the following error:
Solution
This PR fixes the issue by using a shell to run child_process execFileSync. This solution approach was suggested here: nodejs/node#52554 (comment)
Related Issue(s), If Filed
Testing
License
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.