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

refactor: remove random querystrings from extension build artifacts #5404

Merged
merged 6 commits into from
Sep 30, 2024

Conversation

goosewobbler
Copy link
Contributor

@goosewobbler goosewobbler commented Aug 2, 2024

Amending the querystrings used in the extension build so that the the build artifacts have consistent hashes. This should enable the extension to be accepted by the Mozilla addons store.

#3351

Summary by CodeRabbit

  • 新功能

    • 在返回的对象中新增 currentVersion 属性,以提供当前版本信息。
    • 更新 HTML 模板中的脚本源 URL,采用版本控制方式加载脚本,而非动态时间戳。
  • 改进

    • 根据环境变量 NODE_ENV 条件设置 hash 属性,优化插件配置。

Copy link

codesandbox bot commented Aug 2, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

what-the-diff bot commented Aug 2, 2024

PR Summary

  • New Feature to Track Version
    New 'currentVersion' property added to give us the ability to keep an eye on and manage application versions.
  • Environment Specific Functionality
    The 'hash' property has been updated to vary its value depending on the environment. This will give us more flexibility when operating in different environments.
  • Dynamic Script Sourcing in Index
    The source path of the script tag has been updated. With this change, it now uses the 'currentVersion' variable. This allows the right version of the script to be loaded dynamically.

@originalix originalix enabled auto-merge (squash) September 30, 2024 01:51
Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

Walkthrough

此次更改包括在 createEjsParams 函数返回的对象中添加了一个新属性 currentVersion,该属性从环境变量 process.env.VERSION 获取当前版本信息。createHtmlPlugin 函数中的 hash 属性根据环境变量 NODE_ENV 进行条件设置,只有在开发环境中才为 true。此外,HTML 模板中的脚本源 URL 从动态时间戳更新为使用 currentVersion 变量。

Changes

文件 更改摘要
development/indexHtmlParameter.js 添加 currentVersion 属性到 createEjsParams 函数返回对象,值为 process.env.VERSION
development/webpack/ext/pluginsHtml.js 修改 createHtmlPlugin 函数中的 hash 属性,根据 NODE_ENV 设置为 true(仅在开发环境中)。
packages/shared/src/web/index.html.ejs 修改脚本源 URL,从动态时间戳更新为使用 currentVersion 变量。

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant HTMLTemplate

    Client->>Server: 请求页面
    Server->>Server: 调用 createEjsParams()
    Server->>Server: 获取 process.env.VERSION
    Server->>HTMLTemplate: 返回包含 currentVersion 的参数
    HTMLTemplate->>Client: 返回页面
Loading

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 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 or 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
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: 1

🧹 Outside diff range comments (1)
packages/shared/src/web/index.html.ejs (1)

Line range hint 1-124: 建议:整理代码提高可读性

文件结构不错,但可以更好:

  1. 把平台相关代码分组
  2. 用注释解释复杂的条件语句
  3. 考虑把大块CSS移到单独文件

这些改动会让代码更易读、维护。

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 8534f47 and 67c248d.

📒 Files selected for processing (3)
  • development/indexHtmlParameter.js (1 hunks)
  • development/webpack/ext/pluginsHtml.js (1 hunks)
  • packages/shared/src/web/index.html.ejs (1 hunks)
🔇 Additional comments (2)
development/webpack/ext/pluginsHtml.js (1)

34-34: 好改动!提高了生产构建的一致性。

这个改动很棒。只在开发环境中设置 hash: true 确保了生产构建的一致性。这有助于解决 Mozilla 插件商店的接受问题。简单有效!

packages/shared/src/web/index.html.ejs (1)

39-39: 好改动!版本号替代时间戳。

currentVersion替换Date.now()很棒。这样做能让构建结果更稳定,有利于Mozilla商店接受扩展。

development/indexHtmlParameter.js Show resolved Hide resolved
@loatheb loatheb disabled auto-merge September 30, 2024 02:02
@loatheb loatheb merged commit fd3e576 into OneKeyHQ:x Sep 30, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants