Make TypeScript test reporter optional #37182
Open
+14
−3
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.
Summary
Fixes #37181
Makes the Develocity mocha reporter optional in the TypeScript SDK test configuration, allowing
npm testto run out-of-the-box afternpm installwithout requiring the@gradle-tech/develocity-agentpackage.Problem
The TypeScript SDK test configuration (
sdks/typescript/reporterConfig.js) hard-requires@gradle-tech/develocity-agent/mocha-reporterviarequire.resolve(), but this package is not listed inpackage.jsondevDependencies. This causesnpm testto fail for new contributors on a fresh clone with: Error: Cannot find module '@gradle-tech/develocity-agent/mocha-reporter'Solution
require.resolve()in a try-catch block to gracefully handle when the module is not availablespecreporter when the Develocity reporter cannot be resolvedChanges
sdks/typescript/reporterConfig.jsto make the Develocity reporter optionalTesting
npm testpasses locally without the Develocity reporter installedspecreporterThank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.