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(): support block pages by license blacklist #4591

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

weareoutman
Copy link
Member

@weareoutman weareoutman commented Jan 9, 2025

依赖检查

组件之间的依赖声明,是微服务组件架构下的重要信息,请确保其正确性。

请勾选以下两组选项其中之一:

  • 本次 MR 没有使用上游组件(例如框架、后台组件等)的较新版本提供的特性。

或者:

  • 本次 MR 使用了上游组件(例如框架、后台组件等)的较新版本提供的特性。
  • 在对应的文件中更新了该上游组件的依赖版本(或确认了当前声明的依赖版本已包含本次 MR 使用的新特性)。

提交信息检查

Git 提交信息将决定包的版本发布及自动生成的 CHANGELOG,请检查工作内容与提交信息是否相符,并在以下每组选项中都依次确认。

破坏性变更是针对于下游使用者而言,可以通过本次改动对下游使用者的影响来识别变更类型:

  • 下游使用者不做任何改动,仍可以正常工作时,那么它属于普通变更。
  • 反之,下游使用者不做改动就无法正常工作时,那么它属于破坏性变更。

例如,构件修改了一个属性名,小产品 Storyboard 中需要使用新属性名才能工作,那么它就是破坏性变更。
又例如,构件还没有任何下游使用者,那么它的任何变更都是普通变更。

破坏性变更:

  • ⚠️ 本次 MR 包含破坏性变更的提交,请继续确认以下所有选项:
  • 没有更好的兼容方案,必须做破坏性变更。
  • 使用了 feat 作为提交类型。
  • 标注了 BREAKING CHANGE: 你的变更说明
  • 同时更新了本仓库中所有下游使用者的调用。
  • 同时更新了本仓库中所有下游使用者对该子包的依赖为即将发布的 major 版本。
  • 同时为其它仓库的 Migrating 做好了准备,例如文档或批量改动的方法。
  • 手动验证过破坏性变更在 Migrate 后可以正常工作。
  • 破坏性变更所在的提交没有意外携带其它子包的改动。

新特性:

  • 本次 MR 包含新特性的提交,且该提交不带有破坏性变更,并使用了 feat 作为提交类型。
  • 给新特性添加了单元测试。
  • 手动验证过新特性可以正常工作。

问题修复:

  • 本次 MR 包含问题修复的提交,且该提交不带有新特性或破坏性变更,并使用了 fix 作为提交类型。
  • 给问题修复添加了单元测试。
  • 手动验证过问题修复得到解决。

杂项工作:

即所有对下游使用者无任何影响、且没有必要显示在 CHANGELOG 中的改动,例如修改注释、测试用例、开发文档等:

  • 本次 MR 包含杂项工作的提交,且该提交不带有问题修复、新特性或破坏性变更,并使用了 chore, docs, test 等作为提交类型。

Summary by CodeRabbit

发布说明

  • 新功能

    • 新增路径和页面阻止功能
    • 扩展了菜单项和认证钩子的阻止检查能力
  • Bug 修复

    • 优化了错误处理和路径阻止逻辑
  • 国际化

    • 新增许可证阻止相关的本地化错误消息
  • 依赖更新

    • 更新了多个包中的 @next-api-sdk/api-gateway-sdk 依赖版本到 1.2.2
  • 测试

    • 增加了对路径阻止场景的测试覆盖率

Copy link

coderabbitai bot commented Jan 9, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

bricks/e2e/src/list-by-use-brick/index.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "@next-core/eslint-config-next" to extend from. Please check that the name of the config is correct.

The config "@next-core/eslint-config-next" was referenced from the config file in "/.eslintrc".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

总览

这个拉取请求包含了多个仓库和模块的更改,主要涉及路径和页面阻止(blocked)功能的增强。更改范围广泛,包括运行时、认证、菜单处理、错误节点和国际化等多个方面,旨在提供更细粒度的路径访问控制和状态管理。

变更

文件路径 变更摘要
bricks/e2e/src/list-by-use-brick/index.tsx UseSingleBrickConf 类型过渡到 UseBrickConf,支持多个构件配置
etc/runtime.api.md PageViewInfo 接口中添加 "blocked" 状态,并在 RuntimeHooks 中新增 isBlockedPath 方法
packages/brick-container/package.json
packages/easyops-runtime/package.json
packages/runtime/package.json
更新 @next-api-sdk/api-gateway-sdk 依赖版本到 ^1.2.2
packages/easyops-runtime/src/auth-v2.ts
packages/easyops-runtime/src/auth.ts
新增 isBlockedPathisBlockedUrlisBlockedHref 方法,用于检查路径和 URL 是否被阻止
packages/runtime/src/internal/Router.ts
packages/runtime/src/internal/Runtime.ts
重命名 PageNotFoundErrorPageError,添加路径阻止状态处理
packages/runtime/src/internal/i18n.ts 添加 LICENSE_BLOCKED 本地化键,支持中英文错误消息
packages/babel-preset-next/index.js 更新 Node.js 目标版本和依赖版本

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 7 out of 18 changed files in this pull request and generated no comments.

Files not reviewed (11)
  • packages/brick-container/package.json: Language not supported
  • packages/easyops-runtime/package.json: Language not supported
  • packages/runtime/package.json: Language not supported
  • bricks/e2e/src/list-by-use-brick/index.tsx: Evaluated as low risk
  • packages/easyops-runtime/src/auth-v2.ts: Evaluated as low risk
  • packages/runtime/src/internal/i18n.ts: Evaluated as low risk
  • packages/easyops-runtime/src/menu/interfaces.ts: Evaluated as low risk
  • packages/runtime/src/internal/Router.ts: Evaluated as low risk
  • etc/runtime.api.md: Evaluated as low risk
  • packages/easyops-runtime/src/auth.spec.ts: Evaluated as low risk
  • packages/runtime/src/internal/ErrorNode.ts: Evaluated as low risk
@weareoutman weareoutman force-pushed the steve/v3-license-blacklist branch from b48d71a to 683a0eb Compare January 9, 2025 10:28
Copy link

cypress bot commented Jan 9, 2025

next-core    Run #10869

Run Properties:  status check passed Passed #10869  •  git commit 72626d2b96 ℹ️: Merge 60fd41482725e8d6088f80010b38c6e5213f5aa1 into 8e258c1ba4a02a2fb0a374f36c8f...
Project next-core
Branch Review steve/v3-license-blacklist
Run status status check passed Passed #10869
Run duration 00m 22s
Commit git commit 72626d2b96 ℹ️: Merge 60fd41482725e8d6088f80010b38c6e5213f5aa1 into 8e258c1ba4a02a2fb0a374f36c8f...
Committer Shenwei Wang
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 16
View all changes introduced in this branch ↗︎

coderabbitai[bot]

This comment was marked as outdated.

Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.25%. Comparing base (8e258c1) to head (60fd414).
Report is 3 commits behind head on v3.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##               v3    #4591      +/-   ##
==========================================
+ Coverage   95.21%   95.25%   +0.04%     
==========================================
  Files         208      208              
  Lines        8958     8976      +18     
  Branches     1711     1717       +6     
==========================================
+ Hits         8529     8550      +21     
+ Misses        321      319       -2     
+ Partials      108      107       -1     
Files with missing lines Coverage Δ
packages/easyops-runtime/src/auth.ts 100.00% <100.00%> (ø)
packages/easyops-runtime/src/menu/fetchMenuById.ts 96.96% <100.00%> (+0.30%) ⬆️
packages/runtime/src/internal/ErrorNode.ts 100.00% <100.00%> (ø)
packages/runtime/src/internal/Router.ts 95.13% <100.00%> (+0.02%) ⬆️
packages/runtime/src/internal/Runtime.ts 94.56% <ø> (ø)
packages/runtime/src/internal/i18n.ts 100.00% <ø> (ø)

... and 2 files with indirect coverage changes

@weareoutman weareoutman force-pushed the steve/v3-license-blacklist branch from 683a0eb to 0f84de8 Compare January 9, 2025 10:35
coderabbitai[bot]

This comment was marked as outdated.

@qiaofengxi qiaofengxi merged commit d76bd55 into v3 Jan 10, 2025
7 checks passed
@qiaofengxi qiaofengxi deleted the steve/v3-license-blacklist branch January 10, 2025 02:49
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.

2 participants