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

fix: remove MutationObserver and make polyfill checks consistent #1688

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

saikumarrs
Copy link
Member

@saikumarrs saikumarrs commented Apr 10, 2024

PR Description

  • Removed MutationObserver polyfill as it's unused.
  • Made all the polyfill detection checks consistent.

Linear task (optional)

https://linear.app/rudderstack/issue/SDK-1589/remove-mutationobserver-polyfill-js-sdk

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 Apr 10, 2024
Copy link
Contributor

coderabbitai bot commented Apr 10, 2024

Walkthrough

The recent updates focus on refining polyfill configurations and improving issue templates for bug reports and feature requests. Additionally, adjustments in the detection capabilities for the analytics SDK enhance compatibility with modern web technologies. These changes streamline developer interactions and ensure the SDK remains robust across diverse environments.

Changes

File Path Change Summary
.eslintrc.json Updated polyfills, adding several new items while removing Promise and Element.prototype.dataset.
.github/ISSUE_TEMPLATE/... Modified assignees and restructured templates for bug reports and feature requests.
packages/analytics-js/src/.../dom.ts Revised detection checks, removing some and adding others like URLSearchParams and TextEncoder. Consistency improved with isFunction usage.

🐇✨
Oh hark! A change does come,
In code and doc, it's spun.
From .eslintrc to templates grand,
A rabbit hops through tech's vast land.
With every commit and push, we see,
CodeRabbit bounds with glee! 🌟📜


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 56e34be and e2db1ef.
Files selected for processing (4)
  • .eslintrc.json (2 hunks)
  • .github/ISSUE_TEMPLATE/bug_report.md (2 hunks)
  • .github/ISSUE_TEMPLATE/feature_request.md (1 hunks)
  • packages/analytics-js/src/components/capabilitiesManager/detection/dom.ts (1 hunks)
Additional comments not posted (8)
.github/ISSUE_TEMPLATE/feature_request.md (1)

6-6: Change in default assignee to rudderlabs/js-sdk is appropriate for streamlining issue management.

.github/ISSUE_TEMPLATE/bug_report.md (2)

6-6: Change in default assignee to rudderlabs/js-sdk is appropriate for streamlining issue management.


28-38: Reorganization of additional information sections improves clarity and detail in bug reporting.

packages/analytics-js/src/components/capabilitiesManager/detection/dom.ts (3)

24-26: Removal of unused polyfill checks (Object.entries, Object.values, Object.assign) aligns with optimization objectives.


12-30: Addition of new polyfill checks enhances compatibility and functionality across different environments.


12-36: Standardizing the method to use isFunction for all polyfill checks improves consistency and maintainability.

.eslintrc.json (2)

19-30: Additions to the polyfills array ensure that linting covers new features used in the code.


10-10: Removal of Promise from the polyfills array is consistent with the changes in the codebase.


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 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.92%. Comparing base (56e34be) to head (e2db1ef).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1688      +/-   ##
===========================================
- Coverage    53.93%   53.92%   -0.01%     
===========================================
  Files          461      461              
  Lines        15616    15615       -1     
  Branches      3109     3100       -9     
===========================================
- Hits          8422     8421       -1     
- Misses        5840     5869      +29     
+ Partials      1354     1325      -29     

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

Copy link

Copy link

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Common Code - No bundling 15.81 KB 15.81 KB (0%) 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%) 8 KB
Core CJS - NPM 22.45 KB 22.45 KB (+0.03% ▲) 23 KB
Core - NPM 22.55 KB 22.54 KB (-0.05% ▼) 23 KB
Core Legacy - CDN 42.99 KB 42.97 KB (-0.05% ▼) 44 KB
Core - CDN 22.71 KB 22.71 KB (-0.01% ▼) 23 KB
Core (legacy build) - CDN - v1.1 31.55 KB 31.55 KB (0%) 32 KB
Core - NPM - v1.1 31.53 KB 31.53 KB (0%) 32 KB
Service Worker Module 22.64 KB 22.64 KB (0%) 24 KB
All Integrations (legacy build) - CDN 98.6 KB 98.6 KB (0%) 105 KB

@saikumarrs saikumarrs marked this pull request as ready for review April 10, 2024 15:45
@saikumarrs saikumarrs requested a review from a team as a code owner April 10, 2024 15:45
@saikumarrs saikumarrs merged commit 51b42fe into develop Apr 12, 2024
13 checks passed
@saikumarrs saikumarrs deleted the feat.make-polyfill-checks-consistent-sdk-1589 branch April 12, 2024 05:22
@saikumarrs saikumarrs linked an issue Apr 12, 2024 that may be closed by this pull request
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.

bug: MutationObserver is not defined
2 participants