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

Inject element polyfills where used using Babel #20689

Merged
merged 1 commit into from
May 29, 2024

Conversation

steverep
Copy link
Member

@steverep steverep commented May 1, 2024

Proposed change

Takes the 3 Element polyfills we have in the compatibility module and lets Babel inject them using the custom plugin. Note the modern build changes here because we serve it to browsers old enough that some don't support toggleAttribute.

Since these injections are for prototype methods, it's a bit shy of optimal because it doesn't look at the object type. In other words, if Babel finds a non-Element object with an undefined append(), it'll still inject the polyfill. For HA, we get several injections for using append on URLSearchParams and FormData instances. It's not harmful, just unnecessary. Hoping to discuss and possibly improve via babel/babel-polyfills#193.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue or discussion:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • New Features

    • Added polyfill support for append(), getAttributeNames(), and toggleAttribute() methods to enhance browser compatibility for DOM elements.
  • Enhancements

    • Improved compatibility for older browsers by dynamically generating polyfill entries for the aforementioned methods.

@github-actions github-actions bot added the Build Related to building the code label May 1, 2024
@steverep steverep marked this pull request as ready for review May 1, 2024 18:58
@steverep steverep marked this pull request as draft May 2, 2024 20:24
@steverep
Copy link
Member Author

steverep commented May 3, 2024

Needs #20718 first

@steverep steverep marked this pull request as ready for review May 4, 2024 02:22
@steverep
Copy link
Member Author

steverep commented May 4, 2024

Good to go now. PR for injecting ResizeObserver will follow.

Copy link
Contributor

coderabbitai bot commented May 24, 2024

Walkthrough

Walkthrough

This update enhances browser compatibility by adding polyfills for the append, getAttributeNames, and toggleAttribute methods to the Element, Document, and DocumentFragment prototypes. These changes ensure that these methods are available and functional across various browsers, regardless of native support. The update includes modifications to build scripts for dynamic polyfill generation and the addition of polyfill implementations in the source resources.

Changes

File Path Change Summary
build-scripts/babel-plugins/custom-polyfill-plugin.js Added support for element-append, element-getattributenames, and element-toggleattribute with version mappings for various browsers.
src/resources/compatibility.ts Added polyfills for append(), getAttributeNames(), and toggleAttribute() methods for Element, Document, and DocumentFragment prototypes.
src/resources/polyfills/element-append.ts Introduced a polyfill for the append() method for Element, Document, and DocumentFragment prototypes.
src/resources/polyfills/element-getattributenames.ts Introduced a polyfill for the getAttributeNames method for the Element prototype.
src/resources/polyfills/element-toggleattribute.ts Introduced a polyfill for the toggleAttribute method for the Element prototype.

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits Files that changed from the base of the PR and between 661b14d and ea69a9a.
Files selected for processing (5)
  • build-scripts/babel-plugins/custom-polyfill-plugin.js (3 hunks)
  • src/resources/compatibility.ts (1 hunks)
  • src/resources/polyfills/element-append.ts (1 hunks)
  • src/resources/polyfills/element-getattributenames.ts (1 hunks)
  • src/resources/polyfills/element-toggleattribute.ts (1 hunks)
Additional Context Used
Biome (4)
src/resources/polyfills/element-append.ts (3)

3-24: Prefer for...of instead of forEach.


14-19: Prefer for...of instead of forEach.


2-25: This function expression can be turned into an arrow function.

src/resources/polyfills/element-toggleattribute.ts (1)

5-5: Reassigning a function parameter is confusing.

Additional comments not posted (3)
src/resources/compatibility.ts (1)

1-2: No changes detected in this file. Ensure that the import of polyfills is correctly handled during the build process.

src/resources/polyfills/element-getattributenames.ts (1)

1-12: The polyfill for Element.prototype.getAttributeNames is correctly implemented and checks for existing definitions before applying the polyfill. Good use of standard JavaScript practices.

build-scripts/babel-plugins/custom-polyfill-plugin.js (1)

Line range hint 21-110: The configuration for polyfill support in the Babel plugin is well-implemented. The dynamic generation of polyfill entries for append, getAttributeNames, and toggleAttribute using modern JavaScript features enhances maintainability and scalability.


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

Actionable comments posted: 2

@bramkragten bramkragten merged commit 97206ee into dev May 29, 2024
13 checks passed
@bramkragten bramkragten deleted the inject-element-polyfills branch May 29, 2024 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build Related to building the code cla-signed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants