AFFiNE icon indicating copy to clipboard operation
AFFiNE copied to clipboard
verified publisher icon toeverything

chore: switch to oxnode

Open Brooooooklyn opened this issue 1 year ago • 4 comments

Summary by CodeRabbit

  • Refactor
    • Simplified TypeScript execution setup in the CLI, now using a single module for registration.
    • Removed custom loader and hooks files for TypeScript/ESM integration in the CLI.
    • Updated CLI logic to always use @oxc-node/core/register for module loading.
    • Replaced custom path utilities with native Node.js modules and improved environment path handling in CLI runs.
  • Chores
    • Reduced parallelism in server test runs for improved resource management.
    • Added @oxc-node/core as a dependency in the CLI package.
    • Improved test isolation in backend cache tests by scoping dependencies to individual test contexts.

Brooooooklyn avatar Apr 02 '25 09:04 Brooooooklyn

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

Brooooooklyn avatar Apr 02 '25 09:04 Brooooooklyn

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 53.73%. Comparing base (61af6fd) to head (2bfc7e3).

Additional details and impacted files 
@@            Coverage Diff             @@
##           canary   #11412      +/-   ##
==========================================
- Coverage   53.77%   53.73%   -0.04%     
==========================================
  Files        2665     2665              
  Lines      118478   118478              
  Branches    19160    18637     -523     
==========================================
- Hits        63717    63670      -47     
- Misses      53223    53317      +94     
+ Partials     1538     1491      -47
Flag Coverage Δ
server-test 77.79% <ø> (+<0.01%) :arrow_up:
unittest 30.83% <ø> (-0.01%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Apr 02 '25 10:04 codecov[bot]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security		 Vulnerability Quality Maintenance License

View full report

socket-security[bot] avatar Apr 10 '25 02:04 socket-security[bot]

Walkthrough

This set of changes refactors and simplifies the TypeScript execution setup in the CLI toolchain. It removes custom loader and hook scripts (register.js and hooks.js) in favor of using the @oxc-node/core/register module for Node.js ESM and TypeScript support. The runner and command execution logic are updated accordingly, with related dependencies added to package.json. The GitHub Actions workflow for server tests reduces parallelism from eight to four nodes. Additionally, a test suite is refactored to use AVA's typed test context for better isolation.

Changes

File(s) Change Summary
.github/workflows/build-test.yml Reduced server-test matrix parallelism from 8 to 4 nodes by adjusting node_index and total_nodes.
packages/backend/server/src/tests/cache.spec.ts Refactored to use AVA's typed test context for scoping test dependencies.
tools/cli/bin/runner.js Removed custom loader logic and always uses @oxc-node/core/register for Node.js options; simplified argument handling.
tools/cli/src/run.ts Replaced custom path utility with Node.js path, updated loader logic, extended ignore list, and improved PATH handling.
tools/cli/package.json Added @oxc-node/core as a dependency.
tools/cli/register.js, tools/cli/hooks.js Deleted files; removed custom ESM/TypeScript loader and hooks setup.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Node
    participant oxcNodeCore

    User->>CLI: Run TypeScript/ESM script
    CLI->>Node: Start process with --import=@oxc-node/core/register
    Node->>oxcNodeCore: Register ESM/TypeScript hooks
    oxcNodeCore-->>Node: Hooks ready
    Node->>CLI: Execute script with ESM/TS support

Poem

In the warren, scripts once hopped with care,
Through custom hooks and loaders rare.
Now with oxc-node’s magic wand,
The path is clear, the code is fond.
Four test shards race—no longer eight—
The CLI’s lighter, isn’t that great?
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c7701b5d65070b75a883ef8e09387ff808e1b6dc and 2bfc7e33f1d2899eff8b3c39a6a18bcd12d3f0e9.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (7)
  • .github/workflows/build-test.yml (1 hunks)
  • packages/backend/server/src/__tests__/cache.spec.ts (5 hunks)
  • tools/cli/bin/runner.js (2 hunks)
  • tools/cli/hooks.js (0 hunks)
  • tools/cli/package.json (1 hunks)
  • tools/cli/register.js (0 hunks)
  • tools/cli/src/run.ts (3 hunks)
💤 Files with no reviewable changes (2)
  • tools/cli/hooks.js
  • tools/cli/register.js
🚧 Files skipped from review as they are similar to previous changes (5)
  • tools/cli/package.json
  • packages/backend/server/src/tests/cache.spec.ts
  • .github/workflows/build-test.yml
  • tools/cli/bin/runner.js
  • tools/cli/src/run.ts
⏰ Context from checks skipped due to timeout of 90000ms (408)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E BlockSuite Test (5)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: E2E Mobile Test (1)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E BlockSuite Test (5)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E BlockSuite Test (5)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E BlockSuite Test (5)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E BlockSuite Test (5)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E BlockSuite Test (5)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E BlockSuite Test (5)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
  • GitHub Check: test-build-mobile-app / ios
  • GitHub Check: test-build-mobile-app / android
  • GitHub Check: Desktop Test (windows-latest, windows, x64, x86_64-pc-windows-msvc, true)
  • GitHub Check: Desktop bundle check (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (ubuntu-latest, linux, x64, x86_64-unknown-linux-gnu, true)
  • GitHub Check: Desktop Test (macos-latest, macos, arm64, aarch64-apple-darwin, true)
  • GitHub Check: Cloud Desktop E2E Test
  • GitHub Check: Cloud E2E Test 6/6
  • GitHub Check: Cloud E2E Test 5/6
  • GitHub Check: Cloud E2E Test 4/6
  • GitHub Check: Server Test (3, 4)
  • GitHub Check: Cloud E2E Test 3/6
  • GitHub Check: Server Test (2, 4)
  • GitHub Check: Cloud E2E Test 2/6
  • GitHub Check: Server Test (1, 4)
  • GitHub Check: Cloud E2E Test 1/6
  • GitHub Check: Server Test (0, 4)
  • GitHub Check: Unit Test (5)
  • GitHub Check: Unit Test (4)
  • GitHub Check: Unit Test (3)
  • GitHub Check: Unit Test (2)
  • GitHub Check: Unit Test (1)
  • GitHub Check: fuzzing
  • GitHub Check: E2E Test (10)
  • GitHub Check: E2E Test (9)
  • GitHub Check: E2E Test (8)
  • GitHub Check: E2E Test (7)
  • GitHub Check: E2E Test (6)
  • GitHub Check: E2E Test (5)
  • GitHub Check: E2E Test (4)
  • GitHub Check: E2E BlockSuite Test (6)
  • GitHub Check: E2E Test (3)
  • GitHub Check: E2E Test (2)
  • GitHub Check: E2E BlockSuite Test (4)
  • GitHub Check: E2E Test (1)
  • GitHub Check: E2E Mobile Test (2)
  • GitHub Check: Analyze (typescript, blocksuite)
  • GitHub Check: Analyze (typescript, affine)
  • GitHub Check: Analyze (javascript, blocksuite)
  • GitHub Check: Analyze (javascript, affine)
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings
🪧 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

coderabbitai[bot] avatar Apr 28 '25 13:04 coderabbitai[bot]