Skip to content

Conversation

@junaiddshaukat
Copy link

Summary

Fixes #37181

Makes the Develocity mocha reporter optional in the TypeScript SDK test configuration, allowing npm test to run out-of-the-box after npm install without requiring the @gradle-tech/develocity-agent package.

Problem

The TypeScript SDK test configuration (sdks/typescript/reporterConfig.js) hard-requires @gradle-tech/develocity-agent/mocha-reporter via require.resolve(), but this package is not listed in package.json devDependencies. This causes npm test to fail for new contributors on a fresh clone with: Error: Cannot find module '@gradle-tech/develocity-agent/mocha-reporter'

Solution

  • Wrap require.resolve() in a try-catch block to gracefully handle when the module is not available
  • Fall back to the default spec reporter when the Develocity reporter cannot be resolved
  • The reporter is still used in CI environments where it's installed (for build scans), but local development no longer requires it

Changes

  • Modified sdks/typescript/reporterConfig.js to make the Develocity reporter optional

Testing

  • npm test passes locally without the Develocity reporter installed
  • ✅ Tests run successfully with the fallback spec reporter
  • ✅ No breaking changes (backward compatible - CI environments with the reporter installed will continue to use it)

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: 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, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @junaiddshaukat, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where new contributors to the TypeScript SDK faced npm test failures due to a hard dependency on the @gradle-tech/develocity-agent package, which is not a listed devDependency. By making the Develocity Mocha reporter optional and implementing a fallback to the standard spec reporter, this change significantly improves the out-of-the-box developer experience. It ensures local tests run smoothly without requiring additional setup, while preserving the Develocity reporter's functionality in CI environments.

Highlights

  • Optional Develocity Reporter: The Develocity Mocha test reporter is now optional, preventing npm test failures for new contributors who do not have the @gradle-tech/develocity-agent package installed.
  • Fallback Reporter: When the Develocity reporter is not available, the test configuration gracefully falls back to using the default spec reporter.
  • CI Compatibility: The Develocity reporter will continue to be used in CI environments where it is installed, ensuring build scans are still generated without breaking local development.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Contributor

Assigning reviewers:

R: @damccorm added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: TypeScript SDK: npm test fails due to missing Develocity mocha reporter dependency

1 participant