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

Use module import style for Protobuf #853

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Use module import style for Protobuf #853

merged 1 commit into from
Jun 25, 2024

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Jun 25, 2024

What this PR does / why we need it?

Use module import style for Protobuf

This commit switches Protobuf build to use js_import_style=module.
This change is possible due to migration from benchmark.js to vitest.

Any background context you want to provide?

What are the relevant tickets?

Related to

Checklist

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Updated the import/export style in several modules to use ES Modules instead of CommonJS, enhancing compatibility with modern JavaScript environments.
  • Improvements

    • Switched from require to import statements across the codebase for better readability and maintainability.
    • Modified various export declarations to use explicit export statements, improving module interoperability.

This commit switchs Protobuf build to use js_import_style=module. This
change is possible due to migration from Webpack to Vite.
Copy link

coderabbitai bot commented Jun 25, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The recent changes shift the JavaScript import style from legacy_commonjs to module for several components in the Yorkie system. This transition involves updating import and export statements across multiple files to align with ES module syntax, enhancing modern JavaScript compatibility and consistency in module management.

Changes

File/Group Change Summary
buf.gen.yaml Updated js_import_style option from legacy_commonjs to module for es and connect-es plugins.
src/api/yorkie/v1/resources_pb.d.ts Changed generation parameter for protoc-gen-es from legacy_commonjs to module.
src/api/yorkie/v1/resources_pb.js Switched from require to import statements, and transitioned from implicit to explicit exports.
src/api/yorkie/v1/yorkie_connect.d.ts Modified generation parameters for protoc-gen-connect-es from legacy_commonjs to module.
src/api/yorkie/v1/yorkie_connect.js Converted from legacy_commonjs to module import style and exported YorkieService directly.
src/api/yorkie/v1/yorkie_pb.d.ts Updated generator parameter to use module instead of legacy_commonjs.
src/api/yorkie/v1/yorkie_pb.js Changed export declarations from const to export const and modified import statements to ES module syntax.

No sequence diagrams will be provided due to the nature of the changes, which are primarily syntactical without altering control flow or adding new features.

Poem

In code’s embrace, a shift unfolds,
From old CommonJS to modules bold.
Imports and exports, clear and bright,
Yorkie adapts, in modern light.
export const and import pure,
JS evolves, refined and sure.


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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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 Jun 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.61%. Comparing base (d346fb3) to head (14e7d23).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #853      +/-   ##
==========================================
- Coverage   80.68%   80.61%   -0.07%     
==========================================
  Files          59       60       +1     
  Lines        4586     4565      -21     
  Branches      932      932              
==========================================
- Hits         3700     3680      -20     
+ Misses        617      616       -1     
  Partials      269      269              

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

@hackerwins hackerwins marked this pull request as ready for review June 25, 2024 10:50
@hackerwins hackerwins merged commit e268160 into main Jun 25, 2024
2 checks passed
@hackerwins hackerwins deleted the module branch June 25, 2024 10:52
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.

1 participant