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: lock plugins and integrations version by default #1956

Merged

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Dec 3, 2024

PR Description

I've deprecated the lockIntegrationsVersion and lockPluginsVersion load API options as the SDK will load the integrations and plugins from the versioned directories by default now.

Even in the case of when user provides the paths for these components, the major version (/v3) will be replaced with the exact version of the core SDK.

Additionally, the core SDK script tag will be identified using the dataset attribute first before using the fallback option.

The deployment workflow has been updated with the following changes:

  • No longer publish integrations and plugin artefacts to the default production path (/v3). They are published only to the versioned directories.
  • Copy SDK dependencies ahead of the core artefacts.
  • The HTML files to list the integrations and plugins are regenerated for the versioned directories.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-2708/namespace-the-dynamically-loaded-sdk-artifacts-with-a-release-tag

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.

@saikumarrs saikumarrs self-assigned this Dec 3, 2024
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (2)
  • main
  • develop

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 Dec 3, 2024

Codecov Report

Attention: Patch coverage is 98.43750% with 1 line in your changes missing coverage. Please review.

Project coverage is 61.38%. Comparing base (826439e) to head (fd6f9f1).
Report is 1 commits behind head on hotfix/lock-components.

Files with missing lines Patch % Lines
...alytics-js/src/components/utilities/loadOptions.ts 96.87% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@                    Coverage Diff                     @@
##           hotfix/lock-components    #1956      +/-   ##
==========================================================
+ Coverage                   61.30%   61.38%   +0.08%     
==========================================================
  Files                         484      484              
  Lines                       16626    16622       -4     
  Branches                     3356     3323      -33     
==========================================================
+ Hits                        10192    10204      +12     
- Misses                       5167     5209      +42     
+ Partials                     1267     1209      -58     

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

Copy link

github-actions bot commented Dec 3, 2024

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Cookies Utils - Legacy - NPM (ESM) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.75 KB 1.75 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.17 KB 1.17 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.4 KB 1.4 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.16 KB 1.16 KB (0%) 1.5 KB
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins - Legacy - CDN 15.75 KB 15.75 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 17.8 KB 17.8 KB (0%) 18.4 KB
Load Snippet 762 B 762 B (0%) 1 KB
Core (v1.1) - NPM (ESM) 30.25 KB 30.25 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 30.47 KB 30.47 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 30.29 KB 30.29 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.81 KB 29.81 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (CJS) 29.97 KB 29.97 KB (0%) 30.5 KB
Core (Content Script - v1.1) - NPM (UMD) 29.81 KB 29.81 KB (0%) 30 KB
Core - Legacy - CDN 49.1 KB 49.1 KB (0%) 49.1 KB
Core - Modern - CDN 25.09 KB 25.09 KB (0%) 25.5 KB
Service Worker - Legacy - NPM (ESM) 30.62 KB 30.62 KB (0%) 31 KB
Service Worker - Legacy - NPM (CJS) 30.85 KB 30.85 KB (0%) 31 KB
Service Worker - Legacy - NPM (UMD) 30.58 KB 30.58 KB (0%) 31 KB
Service Worker - Modern - NPM (ESM) 25.71 KB 25.71 KB (0%) 26 KB
Service Worker - Modern - NPM (CJS) 26 KB 26 KB (0%) 26.5 KB
Service Worker - Modern - NPM (UMD) 25.75 KB 25.75 KB (0%) 26 KB
Core - Legacy - NPM (ESM) 48.9 KB 48.9 KB (0%) 49 KB
Core - Legacy - NPM (CJS) 49.21 KB 49.21 KB (0%) 49.3 KB
Core - Legacy - NPM (UMD) 48.95 KB 48.95 KB (0%) 49 KB
Core - Modern - NPM (ESM) 24.87 KB 24.87 KB (0%) 25 KB
Core - Modern - NPM (CJS) 25.06 KB 25.06 KB (0%) 25.5 KB
Core - Modern - NPM (UMD) 24.87 KB 24.87 KB (0%) 25 KB
Core (Bundled) - Legacy - NPM (ESM) 48.9 KB 48.9 KB (0%) 49 KB
Core (Bundled) - Legacy - NPM (CJS) 49.12 KB 49.12 KB (0%) 49.5 KB
Core (Bundled) - Legacy - NPM (UMD) 48.95 KB 48.95 KB (0%) 49 KB
Core (Bundled) - Modern - NPM (ESM) 39.87 KB 39.87 KB (0%) 40 KB
Core (Bundled) - Modern - NPM (CJS) 40.06 KB 40.06 KB (0%) 40.5 KB
Core (Bundled) - Modern - NPM (UMD) 39.88 KB 39.88 KB (0%) 40 KB
Core (Content Script) - Legacy - NPM (ESM) 48.36 KB 48.36 KB (0%) 48.5 KB
Core (Content Script) - Legacy - NPM (CJS) 48.63 KB 48.63 KB (0%) 48.8 KB
Core (Content Script) - Legacy - NPM (UMD) 48.36 KB 48.36 KB (0%) 48.5 KB
Core (Content Script) - Modern - NPM (ESM) 39.33 KB 39.33 KB (0%) 39.5 KB
Core (Content Script) - Modern - NPM (CJS) 39.62 KB 39.62 KB (0%) 40 KB
Core (Content Script) - Modern - NPM (UMD) 39.41 KB 39.41 KB (0%) 39.5 KB
All Integrations - Legacy - CDN 94.93 KB 94.93 KB (0%) 95.3 KB
All Integrations - Modern - CDN 90.38 KB 90.38 KB (0%) 91 KB

@github-actions github-actions bot added the Stale label Jan 7, 2025
@saikumarrs saikumarrs removed the Stale label Jan 7, 2025
@rudderlabs rudderlabs deleted a comment from sonarqubecloud bot Jan 22, 2025
@saikumarrs saikumarrs marked this pull request as ready for review January 22, 2025 15:06
@saikumarrs saikumarrs requested a review from a team as a code owner January 22, 2025 15:06
@saikumarrs saikumarrs requested a review from arpl January 22, 2025 15:06
@rudderlabs rudderlabs deleted a comment from github-actions bot Jan 23, 2025
.github/workflows/deploy.yml Outdated Show resolved Hide resolved
@saikumarrs saikumarrs merged commit 45e716e into hotfix/lock-components Jan 24, 2025
7 checks passed
@saikumarrs saikumarrs deleted the feat.lock-components-version-sdk-2708 branch January 24, 2025 06:08
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