test: add packaged import coverage#406
Conversation
Add a build-time package install harness that packs the SDK and verifies ESM, CJS, and TypeScript consumers can import every published entrypoint. This fixes a2aproject#294
🧪 Code CoverageNo coverage changes. Generated by coverage-comment.yml |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new integration test script, scripts/test-package-install.mjs, which is integrated into the test-build lifecycle. The script verifies that the package can be correctly installed and imported in ESM, CJS, and TypeScript environments by creating a tarball and setting up temporary consumer projects. Feedback suggests optimizing the npm install command for speed by disabling audits and funding notices, and improving maintainability by dynamically reading peer dependencies from package.json instead of hardcoding them.
| await mkdir(consumerDir, { recursive: true }); | ||
| await writeJson(path.join(consumerDir, 'package.json'), packageJson); | ||
| await writeFile(path.join(consumerDir, probeName), probeContents); | ||
| runNpm(['install', '--silent', ...installDeps], consumerDir); |
There was a problem hiding this comment.
To speed up the test execution, consider adding --no-audit and --no-fund to the npm install command. These checks are generally unnecessary for a throwaway consumer test environment.
runNpm(['install', '--silent', '--no-audit', '--no-fund', ...installDeps], consumerDir);| void GrpcTransportFactory; | ||
| `; | ||
|
|
||
| const peerDeps = ['express', '@grpc/grpc-js', '@bufbuild/protobuf']; |
There was a problem hiding this comment.
Hardcoding the list of peer dependencies creates a maintenance burden and a risk of drift if package.json is updated. It would be more robust to read these directly from the root package.json file.
1 participant
Summary
Verification
Closes #294