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

feat: add a patch for storejs to expose length of the store #1694

Conversation

MoumitaM
Copy link
Contributor

@MoumitaM MoumitaM commented Apr 17, 2024

PR Description

Added a patch for storejs to expose the length of the store

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-1550/failed-to-save-the-value-for-ack-to-storage-null-is-not-an-object

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

  • Bug Fixes
    • Improved the efficiency of setting and removing items in local storage by optimizing how storage size is calculated.

@MoumitaM MoumitaM requested a review from a team as a code owner April 17, 2024 07:48
Copy link
Contributor

coderabbitai bot commented Apr 17, 2024

Walkthrough

The recent update involves enhancing the efficiency of the LocalStorage class in handling storage length calculations. This was achieved by introducing a new len() method in the StoreJS library, which directly provides the storage length, replacing the previous approach of using store.keys().length.

Changes

File Path Change Summary
.../LocalStorage.ts Updated setItem and removeItem to use store.len() for length calculations.
patches/storejs+2.0.7.patch Added len() method to StoreJS for direct length retrieval.

🐰🌟
In the realm of bytes and keys,
A clever rabbit made a tweak.
No more counting, one by one,
len() is here, the job is done!
Hop, hop, hooray, for efficiency's peak! 🎉
🐰🌟


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f3a59a1 and 031dbc5.
Files selected for processing (2)
  • packages/analytics-js/src/services/StoreManager/storages/LocalStorage.ts (2 hunks)
  • patches/storejs+2.0.7.patch (1 hunks)
Additional comments not posted (6)
patches/storejs+2.0.7.patch (4)

10-11: Ensure storage is defined and accessible in the scope where len() is used.


24-25: Ensure storage is defined and accessible in the scope where len() is used.


38-39: Ensure storage is defined and accessible in the scope where len() is used.


52-52: Type definition for len() correctly specifies the return type as number.

packages/analytics-js/src/services/StoreManager/storages/LocalStorage.ts (2)

41-41: Update to use store.len() correctly implements the intended functionality.


52-52: Update to use store.len() correctly implements the intended functionality.


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 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 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 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.

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.
  • Please see the configuration documentation 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Apr 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.92%. Comparing base (711180c) to head (031dbc5).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1694   +/-   ##
========================================
  Coverage    53.92%   53.92%           
========================================
  Files          461      461           
  Lines        15615    15615           
  Branches      3098     3101    +3     
========================================
  Hits          8421     8421           
+ Misses        5899     5890    -9     
- Partials      1295     1304    +9     

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

Copy link

sonarcloud bot commented Apr 17, 2024

Copy link

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Common Code - No bundling 15.81 KB 15.78 KB (-0.22% ▼) 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.66 KB (+0.23% ▲) 8 KB
Core CJS - NPM 22.45 KB 22.47 KB (+0.07% ▲) 23 KB
Core - NPM 22.54 KB 22.56 KB (+0.07% ▲) 23 KB
Core Legacy - CDN 42.92 KB 43 KB (+0.2% ▲) 44 KB
Core - CDN 22.71 KB 22.71 KB (+0.02% ▲) 23 KB
Core (legacy build) - CDN - v1.1 31.55 KB 31.57 KB (+0.06% ▲) 32 KB
Core - NPM - v1.1 31.53 KB 31.56 KB (+0.08% ▲) 32 KB
Service Worker Module 22.64 KB 22.64 KB (0%) 24 KB
All Integrations (legacy build) - CDN 98.6 KB 98.4 KB (-0.2% ▼) 105 KB

@MoumitaM MoumitaM merged commit 36a13b0 into develop Apr 17, 2024
10 checks passed
@MoumitaM MoumitaM deleted the feature/sdk-1550-failed-to-save-the-value-for-ack-to-storage-null-is-not-an branch April 17, 2024 10:21
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.

None yet

2 participants