rudderlabs / rudder-sdk-js

JavaScript SDK for RudderStack - the Customer Data Platform for Developers.
https://www.rudderstack.com
Other
144 stars 83 forks source link

feat: add date datatype #1906

Closed MoumitaM closed 2 weeks ago

MoumitaM commented 3 weeks ago

PR Description

Allow date data type in apiObject interface.

Linear task (optional)

Linear task link

Cross Browser Tests

Please confirm you have tested for the following browsers:

Sanity Suite

Security

Summary by CodeRabbit

These changes improve the flexibility and capability of data handling within the application.

coderabbitai[bot] commented 3 weeks ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes involve an update to the `ApiObject` interface in the `types.ts` file within the analytics-js-service-worker package. The index signature of `ApiObject` has been modified to include `Date` and `null` as allowable types, both as standalone types and within arrays. This modification enhances the interface's capability to represent more complex data structures by allowing date values and null entries. ## Changes | File Path | Change Summary | |---------------------------------------------------|----------------------------------------------------------------------------------------------------| | packages/analytics-js-service-worker/src/types.ts | Updated the `ApiObject` interface to include `Date` and `null` as allowable types in the index signature. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Client participant ApiObject Client->>ApiObject: Create new ApiObject ApiObject->>ApiObject: Add properties (including Date and null) Client->>ApiObject: Retrieve ApiObject ApiObject-->>Client: Return ApiObject with Date and null properties ```

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between b1312e7bd33f46c0be110c342afd6656bc2acfc6 and 413356bc47c1a3c90029e0596888ff469d182171.
📒 Files selected for processing (1) * `packages/analytics-js-service-worker/src/types.ts` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * packages/analytics-js-service-worker/src/types.ts

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://coderabbit.ai/docs) 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 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 57.47%. Comparing base (b71c44a) to head (413356b). Report is 1 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #1906 +/- ## ======================================== Coverage 57.47% 57.47% ======================================== Files 485 485 Lines 16495 16495 Branches 3304 3313 +9 ======================================== Hits 9481 9481 + Misses 5745 5734 -11 - Partials 1269 1280 +11 ```

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

github-actions[bot] commented 3 weeks 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.48 KB 15.48 KB (0%) 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.21 KB 16.27 KB (+0.36% ▲) 16.5 KB
Cookies Utils - Legacy - NPM (ESM) 1.45 KB 1.45 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.65 KB 1.65 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.43 KB 1.43 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.11 KB 1.11 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.34 KB 1.34 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.08 KB 1.08 KB (0%) 1.5 KB
Load Snippet 758 B 758 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.36 KB 30.36 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.55 KB 30.55 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.37 KB 30.37 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.89 KB 29.89 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 30.09 KB 30.09 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.92 KB 29.92 KB (0%) 30 KB
Core - Legacy - CDN 48.33 KB 48.33 KB (0%) 48.5 KB
Core - Modern - CDN 24.75 KB 24.75 KB (0%) 25 KB
Core - Legacy - NPM (ESM) 48.24 KB 48.24 KB (0%) 48.5 KB
Core - Legacy - NPM (CJS) 48.46 KB 48.46 KB (0%) 49 KB
Core - Legacy - NPM (UMD) 48.19 KB 48.19 KB (0%) 48.5 KB
Core - Modern - NPM (ESM) 24.48 KB 24.48 KB (0%) 25 KB
Core - Modern - NPM (CJS) 24.72 KB 24.72 KB (0%) 25 KB
Core - Modern - NPM (UMD) 24.53 KB 24.53 KB (0%) 25 KB
Core (Bundled) - Legacy - NPM (ESM) 48.24 KB 48.24 KB (0%) 48.5 KB
Core (Bundled) - Legacy - NPM (CJS) 48.44 KB 48.44 KB (0%) 49 KB
Core (Bundled) - Legacy - NPM (UMD) 48.19 KB 48.19 KB (0%) 48.5 KB
Core (Bundled) - Modern - NPM (ESM) 39.34 KB 39.34 KB (0%) 39.5 KB
Core (Bundled) - Modern - NPM (CJS) 39.6 KB 39.6 KB (0%) 40 KB
Core (Bundled) - Modern - NPM (UMD) 39.29 KB 39.29 KB (0%) 39.5 KB
Core (Content Script) - Legacy - NPM (ESM) 47.61 KB 47.61 KB (0%) 48 KB
Core (Content Script) - Legacy - NPM (CJS) 47.89 KB 47.89 KB (0%) 48 KB
Core (Content Script) - Legacy - NPM (UMD) 47.62 KB 47.62 KB (0%) 48 KB
Core (Content Script) - Modern - NPM (ESM) 38.84 KB 38.84 KB (0%) 39 KB
Core (Content Script) - Modern - NPM (CJS) 39.05 KB 39.05 KB (0%) 40 KB
Core (Content Script) - Modern - NPM (UMD) 38.76 KB 38.76 KB (0%) 39 KB
Service Worker - Legacy - NPM (ESM) 30.6 KB 30.6 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.88 KB 30.88 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.68 KB 30.68 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.74 KB 25.74 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26.02 KB 26.02 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.79 KB 25.79 KB (0%) 26 KB
All Integrations - Legacy - CDN 94.68 KB 94.68 KB (0%) 95.3 KB
All Integrations - Modern - CDN 89.82 KB 89.82 KB (0%) 91 KB
sonarcloud[bot] commented 2 weeks ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud