fix: Defining agent api methods for ts types #613
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
patrickhousley
added
bug
metal-messiah
approved these changes
Jul 12, 2023
Asset Size ReportMerging this pull request will result in the following CDN asset size changes:
Merging this pull request will result in the following NPM package consumer size changes:
Other Standard CDN AssetsReleased Assets
Built Assets
Other Polyfill CDN AssetsReleased Assets
Built Assets
|
Codecov Report
@@ Coverage Diff @@
## main #613 +/- ##
==========================================
- Coverage 67.00% 66.73% -0.27%
==========================================
Files 129 130 +1
Lines 5979 6003 +24
Branches 1137 1137
==========================================
Hits 4006 4006
- Misses 1608 1632 +24
Partials 365 365
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
This is a very elegant use of the abstract base class pattern. Well done 👏 |
Comment on lines
+65
to
+66
| * @param {string} key Used as the attribute name on the BrowserInteraction event. | ||
| * @param {any} key Used as the attribute value on the BrowserInteraction event. This can be a string, number, boolean, or object. If it is an object, New Relic serializes it to a JSON string. |
| * @property {createTracer} createTracer | ||
| * @property {end} end | ||
| * @property {getContext} getContext | ||
| * @property {ignore} ignore |
|
@patrickhousley I had some TS issues after updating... |
|
Thanks @villelahdenvuo I guess I was half asleep when I wrote that 😥 I will get a fix put in |
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.
Updating the type interface of the Agent and MicroAgent classes to properly expose the agent API methods in the generated typescript types.
Overview
Added a new base agent class that contains stubbed methods for all the agent API methods with proper documentation. The Agent and MicroAgent classes now extend this base class. While this does add code to the bundle and a new inheritance, I could find no other way to expose the API methods on the classes in the generated typescript types and retain the code in javascript.
Related Issue(s)
https://issues.newrelic.com/browse/NR-139951
Closes #608
Testing
Run
npm run build:alland start the test servernpm run test-server. Once the server is up, access http://bam-test-1.nr-local.net:3333/tests/assets/test-builds/vite-react-wrapper/index.html and verify the interaction name has been updated.To test other API methods, update
tools/test-builds/vite-react-wrapper/src/newrelic.tsand re-run the build.