chore: temp reverts - Githubissues

saikumarrs commented 4 days ago

PR Description

Please include a summary of the change along with the relevant motivation and context.

Linear task (optional)

Linear task link

Cross Browser Tests

Please confirm you have tested for the following browsers:

[ ] Chrome
[ ] Firefox
[ ] IE11

Sanity Suite

[ ] All sanity suite test cases pass locally

Security

[ ] The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

New Features
- Introduced stringifyData and getSanitizedValue functions for improved JSON serialization and sanitization.
- Enhanced error handling with the addition of dispatchErrorEvent function.
- Updated logging mechanism to consolidate warnings into a single BAD_DATA_WARNING.
Bug Fixes
- Streamlined test cases for various utilities by removing unnecessary checks related to BigInt handling.
Chores
- Updated imports and internal logic across multiple files to replace stringifyWithoutCircular with stringifyData, improving code clarity and maintainability.

coderabbitai[bot] commented 4 days ago

📝 Walkthrough

## Walkthrough This pull request introduces significant updates to JSON utility functions and their associated test suites across the codebase. Key changes include the replacement of the `stringifyWithoutCircular` function with `stringifyData`, which simplifies JSON serialization. New functions `getSanitizedValue` and `dispatchErrorEvent` are added to improve error handling and data sanitization. Additionally, various logging constants are consolidated, and multiple test cases related to handling non-stringifiable values are removed to streamline testing. Overall, the changes enhance clarity and maintainability while ensuring robust error management. ## Changes | File Path | Change Summary | |----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | `packages/analytics-js-common/__tests__/utilities/json.test.ts` | Updated tests to replace `stringifyWithoutCircular` with `stringifyData` and added tests for new functions. | | `packages/analytics-js-common/src/constants/integrations/integration_cname.js` | Added a trailing comma in the `commonNames` object. | | `packages/analytics-js-common/src/constants/logMessages.ts` | Removed `CIRCULAR_REFERENCE_WARNING` and `JSON_STRINGIFY_WARNING`, added `BAD_DATA_WARNING`. | | `packages/analytics-js-common/src/utilities/errors.ts` | Replaced `stringifyWithoutCircular` with `stringifyData`, added `dispatchErrorEvent` and `MANUAL_ERROR_IDENTIFIER`.| | `packages/analytics-js-common/src/utilities/json.ts` | Removed `getCircularReplacer` and `stringifyWithoutCircular`, added `stringifyData`, `getSanitizedValue`. | | `packages/analytics-js-cookies/__tests__/cookieUtilities.test.ts` | Removed tests for handling non-stringifiable inputs in `getEncryptedValueBrowser` and `getEncryptedValue`. | | `packages/analytics-js-cookies/src/cookiesUtilities.ts` | Replaced `stringifyWithoutCircular` with `stringifyData` in `getEncryptedValueInternal`. | | `packages/analytics-js-plugins/__tests__/bugsnag/utils.test.ts` | Removed test case checking BigInt handling in `getAppStateForMetadata`. | | `packages/analytics-js-plugins/__tests__/errorReporting/utils.test.ts` | Removed test case for BigInt in `getAppStateForMetadata`. | | `packages/analytics-js-plugins/__tests__/utilities/queue.test.ts` | Removed tests for circular dependencies and BigInt in `getDeliveryPayload` and `validateEventPayloadSize`. | | `packages/analytics-js-plugins/__tests__/xhrQueue/utilities.test.ts` | Removed tests for circular dependencies and BigInt in `getBatchDeliveryPayload`. | | `packages/analytics-js-plugins/src/beaconQueue/utilities.ts` | Replaced `json.stringifyWithoutCircular` with `json.stringifyData` in `getBatchDeliveryPayload`. | | `packages/analytics-js-plugins/src/bugsnag/constants.ts` | Updated `APP_STATE_EXCLUDE_KEYS` to include `'authToken'`. | | `packages/analytics-js-plugins/src/bugsnag/utils.ts` | Replaced `stringifyWithoutCircular` with `stringifyData` in `getAppStateForMetadata`. | | `packages/analytics-js-plugins/src/errorReporting/constants.ts` | Updated `APP_STATE_EXCLUDE_KEYS` to include `'authToken'`. | | `packages/analytics-js-plugins/src/errorReporting/event/event.ts` | Replaced `stringifyWithoutCircular` with `stringifyData` in error handling. | | `packages/analytics-js-plugins/src/errorReporting/utils.ts` | Replaced `stringifyWithoutCircular` with `stringifyData` in `getAppStateForMetadata` and `getErrorDeliveryPayload`.| | `packages/analytics-js-plugins/src/utilities/eventsDelivery.ts` | Removed optional `logger` parameter from `getDeliveryPayload` and `getDMTDeliveryPayload`. | | `packages/analytics-js-plugins/src/xhrQueue/index.ts` | Removed `logger` parameter from `getRequestInfo` and `getBatchDeliveryPayload`. | | `packages/analytics-js-plugins/src/xhrQueue/utilities.ts` | Removed `logger` parameter from `getBatchDeliveryPayload` and `getRequestInfo`. | | `packages/analytics-js/__tests__/components/userSessionManager/UserSessionManager.test.ts` | Updated tests to replace `stringifyWithoutCircular` with `stringifyData`. | | `packages/analytics-js/__tests__/services/HttpClient/HttpClient.test.ts` | Removed test case for non-stringifiable values in `getAsyncData`. | | `packages/analytics-js/src/components/userSessionManager/UserSessionManager.ts` | Replaced `stringifyWithoutCircular` with `stringifyData`, refined anonymous ID handling. | | `packages/analytics-js/src/services/ErrorHandler/processError.ts` | Replaced `stringifyWithoutCircular` with `stringifyData` in `processError`. | | `packages/analytics-js/src/services/HttpClient/HttpClient.ts` | Removed `this.logger` parameter from `xhrRequest` function call in `getAsyncData`. | | `packages/analytics-js/src/services/HttpClient/xhr/xhrRequestHandler.ts` | Replaced `stringifyWithoutCircular` with `stringifyData` in `xhrRequest`, removed `logger` parameter. | | `packages/analytics-js/src/services/StoreManager/Store.ts` | Replaced `stringifyWithoutCircular` with `stringifyData` in `set` method. | ## Possibly related PRs - **#1865**: This PR focuses on filtering non-error types in error handling, which relates to the main PR's emphasis on robust error management in JSON serialization and sanitization. - **#1907**: This PR enhances error handling across public APIs, aligning with the main PR's updates to error management and logging in JSON utilities.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 4 days ago

Codecov Report

Attention: Patch coverage is 98.58156% with 2 lines in your changes missing coverage. Please review.

Project coverage is 58.22%. Comparing base (9d33769) to head (0183632).

Files with missing lines	Patch %	Lines
...ckages/analytics-js-common/src/utilities/errors.ts	50.00%	1 Missing :warning:
.../analytics-js-plugins/src/beaconQueue/utilities.ts	0.00%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #1924 +/- ## ========================================== - Coverage 58.27% 58.22% -0.05% ========================================== Files 485 485 Lines 16602 16593 -9 Branches 3335 3324 -11 ========================================== - Hits 9674 9661 -13 - Misses 5713 5734 +21 + Partials 1215 1198 -17 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

github-actions[bot] commented 4 days ago

size-limit report 📦

Name	Size (Base)	Size (Current)	Size Limit	Status
Plugins Module Federation Mapping - Legacy - CDN	332 B	332 B (0%)	512 B	✅
Plugins - Legacy - CDN	15.65 KB	15.54 KB (-0.75% ▼)	16 KB	✅
Plugins Module Federation Mapping - Modern - CDN	331 B	331 B (0%)	512 B	✅
Plugins - Modern - CDN	7.2 KB	7.2 KB (0%)	7.5 KB	✅
Common - No bundling	16.27 KB	16.27 KB (0%)	16.5 KB	✅
Cookies Utils - Legacy - NPM (ESM)	1.54 KB	1.45 KB (-5.9% ▼)	2 KB	✅
Cookies Utils - Legacy - NPM (CJS)	1.75 KB	1.65 KB (-5.26% ▼)	2 KB	✅
Cookies Utils - Legacy - NPM (UMD)	1.53 KB	1.43 KB (-6.44% ▼)	2 KB	✅
Cookies Utils - Modern - NPM (ESM)	1.17 KB	1.11 KB (-5.26% ▼)	1.5 KB	✅
Cookies Utils - Modern - NPM (CJS)	1.4 KB	1.34 KB (-4.61% ▼)	1.5 KB	✅
Cookies Utils - Modern - NPM (UMD)	1.16 KB	1.08 KB (-6.17% ▼)	1.5 KB	✅
Load Snippet	758 B	758 B (0%)	1 KB	✅
Core (v1.1) - NPM (ESM)	30.37 KB	30.37 KB (0%)	32 KB	✅
Core (v1.1) - NPM (CJS)	30.6 KB	30.6 KB (0%)	32 KB	✅
Core (v1.1) - NPM (UMD)	30.39 KB	30.39 KB (0%)	32 KB	✅
Core (Content Script - v1.1) - NPM (ESM)	29.87 KB	29.87 KB (0%)	30.5 KB	✅
Core (Content Script - v1.1) - NPM (CJS)	30.04 KB	30.04 KB (0%)	30.5 KB	✅
Core (Content Script - v1.1) - NPM (UMD)	29.9 KB	29.9 KB (0%)	30 KB	✅
Core - Legacy - CDN	48.78 KB	48.59 KB (-0.39% ▼)	49 KB	✅
Core - Modern - CDN	25.02 KB	24.82 KB (-0.79% ▼)	25.5 KB	✅
Core - Legacy - NPM (ESM)	48.67 KB	48.45 KB (-0.47% ▼)	49 KB	✅
Core - Legacy - NPM (CJS)	48.91 KB	48.64 KB (-0.55% ▼)	49 KB	✅
Core - Legacy - NPM (UMD)	48.65 KB	48.45 KB (-0.43% ▼)	49 KB	✅
Core - Modern - NPM (ESM)	24.72 KB	24.57 KB (-0.59% ▼)	25 KB	✅
Core - Modern - NPM (CJS)	24.95 KB	24.8 KB (-0.6% ▼)	25.5 KB	✅
Core - Modern - NPM (UMD)	24.76 KB	24.61 KB (-0.64% ▼)	25 KB	✅
Core (Bundled) - Legacy - NPM (ESM)	48.67 KB	48.45 KB (-0.47% ▼)	49 KB	✅
Core (Bundled) - Legacy - NPM (CJS)	48.9 KB	48.7 KB (-0.41% ▼)	49 KB	✅
Core (Bundled) - Legacy - NPM (UMD)	48.65 KB	48.45 KB (-0.43% ▼)	49 KB	✅
Core (Bundled) - Modern - NPM (ESM)	39.69 KB	39.52 KB (-0.42% ▼)	40 KB	✅
Core (Bundled) - Modern - NPM (CJS)	39.97 KB	39.74 KB (-0.57% ▼)	40.5 KB	✅
Core (Bundled) - Modern - NPM (UMD)	39.68 KB	39.53 KB (-0.39% ▼)	40 KB	✅
Core (Content Script) - Legacy - NPM (ESM)	48.14 KB	47.87 KB (-0.55% ▼)	48.5 KB	✅
Core (Content Script) - Legacy - NPM (CJS)	48.38 KB	48.16 KB (-0.45% ▼)	48.5 KB	✅
Core (Content Script) - Legacy - NPM (UMD)	48.12 KB	47.89 KB (-0.47% ▼)	48.5 KB	✅
Core (Content Script) - Modern - NPM (ESM)	39.19 KB	38.97 KB (-0.57% ▼)	39.5 KB	✅
Core (Content Script) - Modern - NPM (CJS)	39.49 KB	39.25 KB (-0.61% ▼)	40 KB	✅
Core (Content Script) - Modern - NPM (UMD)	39.21 KB	38.93 KB (-0.71% ▼)	39.5 KB	✅
Service Worker - Legacy - NPM (ESM)	30.63 KB	30.63 KB (0%)	31 KB	✅
Service Worker - Legacy - NPM (CJS)	30.87 KB	30.87 KB (0%)	31 KB	✅
Service Worker - Legacy - NPM (UMD)	30.6 KB	30.6 KB (0%)	31 KB	✅
Service Worker - Modern - NPM (ESM)	25.75 KB	25.75 KB (0%)	26 KB	✅
Service Worker - Modern - NPM (CJS)	25.99 KB	25.99 KB (0%)	26.5 KB	✅
Service Worker - Modern - NPM (UMD)	25.77 KB	25.77 KB (0%)	26 KB	✅
All Integrations - Legacy - CDN	95.06 KB	95.06 KB (0%)	95.3 KB	✅
All Integrations - Modern - CDN	90.32 KB	90.32 KB (0%)	91 KB	✅