Skip to content

Conversation

@Tecvan-fe
Copy link
Collaborator

@Tecvan-fe Tecvan-fe commented Mar 31, 2025

Summary by CodeRabbit

  • New Features

    • Introduced playback timing and state management, enhanced screen sharing with persistent video device support, and improved WebSocket speech/transcription capabilities.
    • Added asynchronous workflow execution with history tracking.
    • In the realtime API, enabled mobile support, network error handling, and a new room information customization option.
  • Bug Fixes

    • Addressed issues related to debugging (test application ID), speech functionality, file path errors, and shortcut commands.
  • Documentation

    • Updated changelogs and versioning (moved from beta to stable 1.1.1).

@coderabbitai
Copy link

coderabbitai bot commented Mar 31, 2025

Walkthrough

This pull request removes multiple JSON files that were used to track minor changes, bug fixes, and feature additions for the @coze/api and @coze/realtime-api packages. In addition, changelog entries have been updated and package versions have been bumped from beta to stable (from 1.1.0-beta.x to 1.1.1). No public APIs have been altered.

Changes

File(s) Change Summary
common/changes/@coze/api/feat-api_*.json Removed JSON files that documented minor changes such as playback timing, state management updates, README modifications, and a unit test for @coze/api.
common/changes/@coze/api/feat-network_*.json Removed JSON files recording patch changes for hardcoding test_app_id and a CR bug fix in @coze/api.
common/changes/@coze/api/feat-share_screen_*.json Removed JSON files documenting the addition of screen sharing support, video device persistence, and an accompanying unit test for @coze/api.
common/changes/@coze/api/feat-websocket-api_*.json Removed JSON files that recorded WebSocket speech/transcription clients, configuration changes, README updates, and several unit tests for @coze/api.
common/changes/@coze/api/fix-bug_*.json Removed JSON files documenting various patch changes including WebSocket bug fixes, shortcut support, file path error resolution, and the removal of the "type": "module" entry from package.json in @coze/api.
common/changes/@coze/api/fix-speech_*.json Removed JSON files that documented patch updates for fixing speech-related bugs and publishing fixes in @coze/api.
common/changes/@coze/api/fix-workflow_*.json Removed the JSON file that documented the addition of asynchronous workflow execution and history tracking in @coze/api.
common/changes/@coze/realtime-api/feat-network_*.json Removed JSON files documenting mobile support, network error handling, hardcoded test_app_id, and an associated unit test for @coze/realtime-api.
common/changes/@coze/realtime-api/feat-realtime-api_*.json Removed the JSON file that documented the addition of a getRoomInfo customization option in the RealtimeClient for @coze/realtime-api.
common/changes/@coze/realtime-api/feat-share_screen_*.json Removed JSON files documenting screen sharing support, video device persistence, the addition of test code, and a unit test for @coze/realtime-api.
common/changes/@coze/realtime-api/fix-bug_*.json Removed the JSON file that recorded the removal of the "type": "module" declaration from the package.json in @coze/realtime-api.
packages/coze-js/CHANGELOG.{json,md}, packages/coze-js/package.json Updated changelog entries and bumped the package version from 1.1.0-beta.7 to 1.1.1 for @coze/api.
packages/realtime-api/CHANGELOG.{json,md}, packages/realtime-api/package.json Updated changelog entries and bumped the package version from 1.1.0-beta.2 to 1.1.1 for @coze/realtime-api.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant WS as Workflow Service
    participant HT as History Tracker

    U->>WS: Trigger asynchronous workflow
    WS->>HT: Log workflow start
    WS-->>WS: Process tasks asynchronously
    WS->>HT: Record workflow completion
    WS-->>U: Return workflow result
Loading

Possibly related PRs

Suggested reviewers

  • jackshen310

Poem

I'm a rabbit in code, hopping with delight,
Removing old logs that no longer feel right.
JSON files vanish, leaving our repo so neat,
New features and fixes keeping our pace upbeat.
Version 1.1.1 shines as I skip through the night!
🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link

@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: 0

🧹 Nitpick comments (5)
packages/realtime-api/package.json (1)

24-24: Verify "type" Field Consistency

The changelog indicates that the "type": "module" declaration should be removed from package.json files. However, it remains here. Please verify if its retention is intentional or if it should be removed for consistency.

packages/realtime-api/CHANGELOG.md (1)

3-18: Changelog Entry for Version 1.1.1 Validated

The new changelog section clearly documents both new features (e.g., mobile support, network error handling, screen sharing support) and bug fixes (including the removal of "type": "module" from package.json files). Please consider reviewing the repeated unit test mentions to ensure clarity.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~15-~15: This word is normally spelled with a hyphen.
Context: ... code - add unit test ### Bug Fixes - Hard code test_app_id for Debug - add unit test -...

(HARD_CODE_COMPOUND)

packages/coze-js/CHANGELOG.md (1)

16-27: Review Bug Fixes Section for Redundancies

In the Bug Fixes section, multiple entries mention "add unit test." It might help clarity to consolidate these entries or clarify their differences so that the changelog remains concise.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~18-~18: This word is normally spelled with a hyphen.
Context: ... and history tracking ### Bug Fixes - Hard code test_app_id for Debug - CR bug - add un...

(HARD_CODE_COMPOUND)


[grammar] ~24-~24: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...- Remove type: module from package.json files - file path error - fix speech bug - Publish f...

(REPEATED_VERBS)

packages/realtime-api/CHANGELOG.json (1)

4-37: Structured JSON Changelog Entry

The new JSON entry for version "1.1.1" accurately categorizes changes under "minor" and "patch". Note that "add unit test" appears in both sections; please verify if this redundancy is intentional.

packages/coze-js/CHANGELOG.json (1)

4-67: New Changelog Entry for Version "1.1.1":
The new entry is well-structured with separate arrays for "minor" and "patch" comments. Verify that the "date" and "tag" fields align with your release process.

Consistency & Clarity Improvements:

  • In the "minor" section, the entries "update README.md" (line 14) and "Update readme" (line 29) use inconsistent casing. It’s recommended to standardize these (e.g., always use "Update README.md").
  • Some comment texts (e.g., "CR bug" on line 40 and "ws-tools rslib config" on line 26) are terse. Consider expanding these to provide clearer context for future readers of the changelog.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9ba4bc9 and 1fd0e60.

📒 Files selected for processing (43)
  • common/changes/@coze/api/feat-api_2025-02-27-11-10.json (0 hunks)
  • common/changes/@coze/api/feat-api_2025-02-27-12-38.json (0 hunks)
  • common/changes/@coze/api/feat-api_2025-02-28-03-27.json (0 hunks)
  • common/changes/@coze/api/feat-network_2025-03-05-07-11.json (0 hunks)
  • common/changes/@coze/api/feat-network_2025-03-05-11-19.json (0 hunks)
  • common/changes/@coze/api/feat-share_screen_2025-02-21-09-29.json (0 hunks)
  • common/changes/@coze/api/feat-share_screen_2025-02-24-06-38.json (0 hunks)
  • common/changes/@coze/api/feat-share_screen_2025-02-27-13-12.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-07-31.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-08-59.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-09-05.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-02-54.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-03-16.json (0 hunks)
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-05-13.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-07-10-41.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-09-03-21.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-10-05-12.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-10-06-06.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-11-06-32.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-11-06-43.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-28-07-06.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-28-07-07.json (0 hunks)
  • common/changes/@coze/api/fix-bug_2025-03-30-09-25.json (0 hunks)
  • common/changes/@coze/api/fix-speech_2025-03-12-13-51.json (0 hunks)
  • common/changes/@coze/api/fix-speech_2025-03-14-03-48.json (0 hunks)
  • common/changes/@coze/api/fix-speech_2025-03-14-04-06.json (0 hunks)
  • common/changes/@coze/api/fix-speech_2025-03-14-04-11.json (0 hunks)
  • common/changes/@coze/api/fix-workflow_2025-02-24-12-00.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-network_2025-03-04-05-18.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-network_2025-03-05-07-10.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-network_2025-03-05-12-16.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-02-14-10-11.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-21-09-29.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-24-06-38.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-27-12-50.json (0 hunks)
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-27-13-27.json (0 hunks)
  • common/changes/@coze/realtime-api/fix-bug_2025-03-28-07-06.json (0 hunks)
  • packages/coze-js/CHANGELOG.json (1 hunks)
  • packages/coze-js/CHANGELOG.md (1 hunks)
  • packages/coze-js/package.json (1 hunks)
  • packages/realtime-api/CHANGELOG.json (1 hunks)
  • packages/realtime-api/CHANGELOG.md (1 hunks)
  • packages/realtime-api/package.json (1 hunks)
💤 Files with no reviewable changes (37)
  • common/changes/@coze/api/fix-speech_2025-03-12-13-51.json
  • common/changes/@coze/api/feat-network_2025-03-05-11-19.json
  • common/changes/@coze/api/fix-bug_2025-03-10-06-06.json
  • common/changes/@coze/api/fix-bug_2025-03-10-05-12.json
  • common/changes/@coze/api/feat-share_screen_2025-02-21-09-29.json
  • common/changes/@coze/api/fix-bug_2025-03-11-06-32.json
  • common/changes/@coze/api/fix-speech_2025-03-14-04-11.json
  • common/changes/@coze/api/fix-workflow_2025-02-24-12-00.json
  • common/changes/@coze/realtime-api/feat-network_2025-03-04-05-18.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-02-54.json
  • common/changes/@coze/api/feat-network_2025-03-05-07-11.json
  • common/changes/@coze/api/fix-bug_2025-03-07-10-41.json
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-24-06-38.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-09-05.json
  • common/changes/@coze/realtime-api/fix-bug_2025-03-28-07-06.json
  • common/changes/@coze/api/feat-share_screen_2025-02-24-06-38.json
  • common/changes/@coze/api/fix-bug_2025-03-28-07-06.json
  • common/changes/@coze/api/fix-speech_2025-03-14-04-06.json
  • common/changes/@coze/api/feat-api_2025-02-28-03-27.json
  • common/changes/@coze/api/fix-speech_2025-03-14-03-48.json
  • common/changes/@coze/api/feat-api_2025-02-27-12-38.json
  • common/changes/@coze/api/fix-bug_2025-03-09-03-21.json
  • common/changes/@coze/api/feat-share_screen_2025-02-27-13-12.json
  • common/changes/@coze/api/feat-api_2025-02-27-11-10.json
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-27-12-50.json
  • common/changes/@coze/realtime-api/feat-network_2025-03-05-07-10.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-03-16.json
  • common/changes/@coze/api/fix-bug_2025-03-30-09-25.json
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-21-09-29.json
  • common/changes/@coze/realtime-api/feat-share_screen_2025-02-27-13-27.json
  • common/changes/@coze/api/fix-bug_2025-03-11-06-43.json
  • common/changes/@coze/api/fix-bug_2025-03-28-07-07.json
  • common/changes/@coze/realtime-api/feat-network_2025-03-05-12-16.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-20-05-13.json
  • common/changes/@coze/realtime-api/feat-realtime-api_2025-02-14-10-11.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-07-31.json
  • common/changes/@coze/api/feat-websocket-api_2025-02-17-08-59.json
🧰 Additional context used
🪛 LanguageTool
packages/realtime-api/CHANGELOG.md

[uncategorized] ~15-~15: This word is normally spelled with a hyphen.
Context: ... code - add unit test ### Bug Fixes - Hard code test_app_id for Debug - add unit test -...

(HARD_CODE_COMPOUND)

packages/coze-js/CHANGELOG.md

[uncategorized] ~18-~18: This word is normally spelled with a hyphen.
Context: ... and history tracking ### Bug Fixes - Hard code test_app_id for Debug - CR bug - add un...

(HARD_CODE_COMPOUND)


[grammar] ~24-~24: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...- Remove type: module from package.json files - file path error - fix speech bug - Publish f...

(REPEATED_VERBS)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Node.js v20 (ubuntu-latest)
🔇 Additional comments (3)
packages/coze-js/package.json (1)

3-3: Version Bump Confirmation

The version update from "1.1.0-beta.7" to "1.1.1" correctly reflects the transition from beta to stable. Ensure that any downstream dependencies or documentation referring to the version are updated accordingly.

packages/realtime-api/package.json (1)

3-3: Version Update Confirmed

The version bump from "1.1.0-beta.2" to "1.1.1" aligns with the stable release strategy.

packages/coze-js/CHANGELOG.md (1)

3-14: Comprehensive New Features Documentation

The entry for version 1.1.1 is detailed and well-structured with the listing of new features such as playback timing, screen sharing, and async workflow execution.

@Tecvan-fe Tecvan-fe merged commit 7d8cc47 into main Mar 31, 2025
5 of 6 checks passed
@Tecvan-fe Tecvan-fe deleted the release/20250331-72e07e branch March 31, 2025 02:43
@codecov
Copy link

codecov bot commented Mar 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

❌ Your project status has failed because the head coverage (0.00%) is below the target coverage (90.00%). You can increase the head coverage or adjust the target coverage.

@@            Coverage Diff            @@
##             main   #169       +/-   ##
=========================================
- Coverage   91.82%      0   -91.83%     
=========================================
  Files         117      0      -117     
  Lines        5469      0     -5469     
  Branches     1106      0     -1106     
=========================================
- Hits         5022      0     -5022     
+ Misses        447      0      -447     
Components Coverage Δ
coze-js ∅ <ø> (∅)
realtime-api ∅ <ø> (∅)
chat-sdk ∅ <ø> (∅)

see 117 files with indirect coverage changes

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

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.

2 participants