Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(release): pull main into develop post release v3.3.0 #1668

Merged
merged 16 commits into from
Mar 22, 2024
Merged

Conversation

MoumitaM
Copy link
Contributor

@MoumitaM MoumitaM commented Mar 22, 2024

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
    • Added support for date types in analytics API.
  • Bug Fixes
    • Optimized local storage transactions.
    • Resolved type issues.
    • Added backward compatibility for storage API.
    • Replaced polyfillio with fastly for improved performance.
  • Chores
    • Updated dependencies across various analytics packages.

Copy link
Contributor

coderabbitai bot commented Mar 22, 2024

Walkthrough

The recent updates across various packages primarily focus on enhancing the analytics-js ecosystem. Key improvements include the addition of date types, optimization of local storage transactions, and resolution of type issues. Dependency updates have been made across several packages to ensure compatibility and performance. Notably, the replacement of polyfillio with fastly addresses bug fixes and efficiency in loading scripts.

Changes

File(s) Change Summary
.../analytics-js-common/CHANGELOG.md Added date type, optimized local storage, resolved type issues.
.../analytics-js-integrations/CHANGELOG.md
.../analytics-js-plugins/CHANGELOG.md
.../analytics-js/CHANGELOG.md
.../analytics-js-loading-scripts/CHANGELOG.md
.../sanity-suite/CHANGELOG.md
Updated dependencies, fixed local storage optimization, replaced polyfillio with fastly, addressed type issues.
sonar-project.properties Updated sonar.projectVersion from 3.1.0 to 3.3.0.

🐰✨

In the land of code where the bits do hop,
A rabbit worked hard in the digital crop.
With a click and a clack, it fixed and it tuned,
From the dawn of the day to the glow of the moon.

"Hooray!" it exclaimed, "for the changes we've made,
Our code now runs swift, no longer delayed!"

🌟🐾
--- CodeRabbit 🐾🌟

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

codecov bot commented Mar 22, 2024

Codecov Report

Attention: Patch coverage is 78.43137% with 11 lines in your changes are missing coverage. Please review.

Project coverage is 53.90%. Comparing base (60f2027) to head (395f9b9).
Report is 6 commits behind head on develop.

Files Patch % Lines
...-js-plugins/src/utilities/retryQueue/RetryQueue.ts 63.33% 11 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1668      +/-   ##
===========================================
+ Coverage    53.89%   53.90%   +0.01%     
===========================================
  Files          461      461              
  Lines        15588    15611      +23     
  Branches      3095     3102       +7     
===========================================
+ Hits          8401     8415      +14     
- Misses        5871     5890      +19     
+ Partials      1316     1306      -10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a1771e8 and d0e0bae.
Files ignored due to path filters (15)
  • package-lock.json is excluded by: !**/*.json
  • package.json is excluded by: !**/*.json
  • packages/analytics-js-common/package.json is excluded by: !**/*.json
  • packages/analytics-js-common/project.json is excluded by: !**/*.json
  • packages/analytics-js-integrations/package.json is excluded by: !**/*.json
  • packages/analytics-js-integrations/project.json is excluded by: !**/*.json
  • packages/analytics-js-plugins/package.json is excluded by: !**/*.json
  • packages/analytics-js-plugins/project.json is excluded by: !**/*.json
  • packages/analytics-js/package.json is excluded by: !**/*.json
  • packages/analytics-js/project.json is excluded by: !**/*.json
  • packages/analytics-v1.1/package.json is excluded by: !**/*.json
  • packages/analytics-v1.1/project.json is excluded by: !**/*.json
  • packages/loading-scripts/package.json is excluded by: !**/*.json
  • packages/loading-scripts/project.json is excluded by: !**/*.json
  • packages/sanity-suite/package.json is excluded by: !**/*.json
Files selected for processing (14)
  • packages/analytics-js-common/CHANGELOG.md (1 hunks)
  • packages/analytics-js-common/CHANGELOG_LATEST.md (1 hunks)
  • packages/analytics-js-integrations/CHANGELOG.md (1 hunks)
  • packages/analytics-js-integrations/CHANGELOG_LATEST.md (1 hunks)
  • packages/analytics-js-plugins/CHANGELOG.md (1 hunks)
  • packages/analytics-js-plugins/CHANGELOG_LATEST.md (1 hunks)
  • packages/analytics-js/CHANGELOG.md (1 hunks)
  • packages/analytics-js/CHANGELOG_LATEST.md (1 hunks)
  • packages/analytics-v1.1/CHANGELOG.md (1 hunks)
  • packages/analytics-v1.1/CHANGELOG_LATEST.md (1 hunks)
  • packages/loading-scripts/CHANGELOG.md (1 hunks)
  • packages/loading-scripts/CHANGELOG_LATEST.md (1 hunks)
  • packages/sanity-suite/CHANGELOG.md (1 hunks)
  • sonar-project.properties (1 hunks)
Files skipped from review due to trivial changes (5)
  • packages/analytics-js-integrations/CHANGELOG_LATEST.md
  • packages/analytics-js-plugins/CHANGELOG.md
  • packages/analytics-v1.1/CHANGELOG.md
  • packages/sanity-suite/CHANGELOG.md
  • sonar-project.properties
Additional comments: 10
packages/analytics-v1.1/CHANGELOG_LATEST.md (1)
  • 1-10: LGTM! The changelog is clear and follows the conventional format, providing transparency and traceability for the changes.
packages/analytics-js-plugins/CHANGELOG_LATEST.md (1)
  • 1-10: LGTM! The changelog is well-structured, providing clear information on dependency updates and bug fixes.
packages/loading-scripts/CHANGELOG_LATEST.md (1)
  • 1-11: LGTM! The changelog provides a clear and structured overview of the updates, including dependency updates and bug fixes.
packages/analytics-js-common/CHANGELOG_LATEST.md (1)
  • 1-12: LGTM! The changelog is comprehensive, detailing new features and bug fixes in a clear and structured manner.
packages/analytics-js/CHANGELOG_LATEST.md (1)
  • 1-13: LGTM! The changelog provides a clear and structured overview of the updates, including dependency updates and bug fixes.
packages/loading-scripts/CHANGELOG.md (1)
  • 5-15: LGTM! The comprehensive changelog provides a clear historical view of the changes across versions, maintaining consistency and traceability.
packages/analytics-js-common/CHANGELOG.md (1)
  • 10-10: Consider revising "apiobject" and "apioptions" to ensure they are correctly spelled or formatted according to your project's naming conventions. If these are specific technical terms within your project, consider using backticks (apiobject and apioptions) for clarity.
packages/analytics-js-integrations/CHANGELOG.md (1)
  • 5-9: The documentation of the dependency update for @rudderstack/analytics-js-common to version 3.0.1 in version 3.0.2 is clear and accurate.
packages/analytics-js/CHANGELOG.md (2)
  • 5-10: The version update and dependency updates are correctly documented.
  • 12-16: The bug fixes section is well-documented, providing clear traceability to the issues and commits.


### Bug Fixes

* optimize localstorage transactions ([#1651](https://github.com/rudderlabs/rudder-sdk-js/issues/1651)) ([1289217](https://github.com/rudderlabs/rudder-sdk-js/commit/12892176578dd3628fded2311ea2548e3ff5802c))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The term "localstorage" might be more accurately written as "localStorage" to reflect the correct API name in web development. Consider updating this for clarity and consistency with web standards.

- * optimize localstorage transactions ([#1651](https://github.com/rudderlabs/rudder-sdk-js/issues/1651)) ([1289217](https://github.com/rudderlabs/rudder-sdk-js/commit/12892176578dd3628fded2311ea2548e3ff5802c))
+ * optimize localStorage transactions ([#1651](https://github.com/rudderlabs/rudder-sdk-js/issues/1651)) ([1289217](https://github.com/rudderlabs/rudder-sdk-js/commit/12892176578dd3628fded2311ea2548e3ff5802c))

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
* optimize localstorage transactions ([#1651](https://github.com/rudderlabs/rudder-sdk-js/issues/1651)) ([1289217](https://github.com/rudderlabs/rudder-sdk-js/commit/12892176578dd3628fded2311ea2548e3ff5802c))
* optimize localStorage transactions ([#1651](https://github.com/rudderlabs/rudder-sdk-js/issues/1651)) ([1289217](https://github.com/rudderlabs/rudder-sdk-js/commit/12892176578dd3628fded2311ea2548e3ff5802c))

Copy link

github-actions bot commented Mar 22, 2024

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Common Code - No bundling 15.82 KB 15.81 KB (-0.04% ▼) 16.5 KB
Remote Module Federation Mapping - CDN 330 B 330 B (0%) 512 B
Remote Module Federated Plugins - CDN 5.71 KB 5.71 KB (0%) 6 KB
Core ESM - NPM 7.64 KB 7.64 KB (-0.02% ▼) 8 KB
Core CJS - NPM 22.44 KB 22.45 KB (+0.02% ▲) 23 KB
Core - NPM 22.56 KB 22.55 KB (-0.04% ▼) 23 KB
Core Legacy - CDN 42.98 KB 42.99 KB (+0.03% ▲) 44 KB
Core - CDN 22.71 KB 22.71 KB (0%) 23 KB
Core (legacy build) - CDN - v1.1 31.54 KB 31.52 KB (-0.09% ▼) 32 KB
Core - NPM - v1.1 31.55 KB 31.54 KB (-0.05% ▼) 32 KB
Service Worker Module 22.64 KB 22.64 KB (0%) 24 KB
All Integrations (legacy build) - CDN 98.57 KB 98.57 KB (0%) 105 KB

saikumarrs
saikumarrs previously approved these changes Mar 22, 2024
@saikumarrs saikumarrs changed the title chore(release): pull main into develop post release v3.2.0 chore(release): pull main into develop post release v3.3.0 Mar 22, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between d0e0bae and 395f9b9.
Files ignored due to path filters (9)
  • package-lock.json is excluded by: !**/*.json
  • package.json is excluded by: !**/*.json
  • packages/analytics-js-plugins/package.json is excluded by: !**/*.json
  • packages/analytics-js-plugins/project.json is excluded by: !**/*.json
  • packages/analytics-js/package.json is excluded by: !**/*.json
  • packages/analytics-js/project.json is excluded by: !**/*.json
  • packages/loading-scripts/package.json is excluded by: !**/*.json
  • packages/loading-scripts/project.json is excluded by: !**/*.json
  • packages/sanity-suite/package.json is excluded by: !**/*.json
Files selected for processing (9)
  • packages/analytics-js-plugins/CHANGELOG.md (1 hunks)
  • packages/analytics-js-plugins/CHANGELOG_LATEST.md (1 hunks)
  • packages/analytics-js-plugins/src/utilities/retryQueue/RetryQueue.ts (2 hunks)
  • packages/analytics-js/CHANGELOG.md (1 hunks)
  • packages/analytics-js/CHANGELOG_LATEST.md (1 hunks)
  • packages/loading-scripts/CHANGELOG.md (1 hunks)
  • packages/loading-scripts/CHANGELOG_LATEST.md (1 hunks)
  • packages/sanity-suite/CHANGELOG.md (1 hunks)
  • sonar-project.properties (1 hunks)
Files skipped from review as they are similar to previous changes (5)
  • packages/analytics-js/CHANGELOG_LATEST.md
  • packages/loading-scripts/CHANGELOG.md
  • packages/loading-scripts/CHANGELOG_LATEST.md
  • packages/sanity-suite/CHANGELOG.md
  • sonar-project.properties
Additional comments: 7
packages/analytics-js-plugins/CHANGELOG_LATEST.md (1)
  • 1-7: The change log update for version 3.0.3 of analytics-js-plugins is clear and adheres to standard practices, detailing the bug fixes for backward compatibility with the storage API effectively.
packages/analytics-js-plugins/CHANGELOG.md (1)
  • 5-11: The changelog entry for version 3.0.3 of @rudderstack/analytics-js-plugins clearly documents the addition of backward compatibility for the storage API. This is a crucial update for users relying on previous storage API versions. It's important to ensure that all relevant details about such changes are captured in the changelog to aid developers in understanding the impact of the update on their implementations.
packages/analytics-js-plugins/src/utilities/retryQueue/RetryQueue.ts (2)
  • 8-8: The import statement correctly includes isDefined, isFunction, and isNullOrUndefined from @rudderstack/analytics-js-common/utilities/checks. This aligns with the summary stating that isDefined and isNullOrUndefined functions are replaced with isDefined, isFunction, and isNullOrUndefined.
  • 708-721: The addition of a check for the existence of the keys function in the storage engine (lines 708-721) is a good practice for ensuring backward compatibility. This change allows the RetryQueue class to work with different versions of the storage engine that may or may not support the keys method. However, it's important to ensure that the storageEngine object always has a length property and a key method when the keys method is not available. This assumption should be verified if not already known to be true.
packages/analytics-js/CHANGELOG.md (3)
  • 5-5: The markdown link for version 3.0.3 seems to be formatted correctly, but static analysis hinted at possible unpaired symbols. This appears to be a false positive, as the markdown syntax for links is correct throughout the document. No action is required here.
  • 5-5: Ensure the correctness of GitHub comparison links for each version. While the format looks correct, it's important to manually verify that these links lead to the intended comparisons between versions.
  • 7-7: The descriptions for features and bug fixes are clear and concise, providing valuable context for users. Including links to relevant GitHub issues and commits is a good practice for transparency.

packages/analytics-js/CHANGELOG.md Show resolved Hide resolved
packages/analytics-js/CHANGELOG.md Show resolved Hide resolved
Copy link

sonarcloud bot commented Mar 22, 2024

@saikumarrs saikumarrs merged commit d31252e into develop Mar 22, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants