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

ZO minor fixes #2628

Merged
merged 1 commit into from
Jan 26, 2025
Merged

ZO minor fixes #2628

merged 1 commit into from
Jan 26, 2025

Conversation

frzyc
Copy link
Owner

@frzyc frzyc commented Jan 26, 2025

Describe your changes

  • Showing the build progress earlier in build process (instead of waiting for first childWorker update)
  • Show the # of builds in dropdown

Issue or discord link

Testing/validation

Checklist before requesting a review (leave this PR as draft if any part of this list is not done.)

  • I have commented my code in hard-to understand areas.
  • I have made corresponding changes to README or wiki.
  • For front-end changes, I have updated the corresponding English translations.
  • I have run yarn run mini-ci locally to validate format and lint.
  • If I have added a new library or app, I have updated the deployment scripts to ignore changes as needed

Summary by CodeRabbit

  • New Features

    • Enhanced progress tracking for worker optimization tasks
    • Added real-time updates during build computation process
  • User Interface

    • Modified worker selection dropdown to display worker count directly
    • Removed localized text for worker count
  • Performance

    • Improved feedback mechanism for background worker processes

Copy link
Contributor

coderabbitai bot commented Jan 26, 2025

Walkthrough

The pull request introduces enhancements to progress tracking and reporting in worker-related components across multiple files. The changes focus on adding more detailed progress updates during optimization processes, specifically in parentWorker.ts files. The modifications enable real-time progress reporting to the main thread by posting initial and incremental updates about the number of builds computed and kept, without fundamentally altering the existing worker management logic.

Changes

File Change Summary
libs/sr/solver/src/parentWorker.ts Added initial progress update posting with numBuildsKept and numBuildsComputed set to 0
libs/zzz/page-optimize/src/WorkerSelector.tsx Removed localized worker count translation, replaced with static "X Workers" text
libs/zzz/solver/src/parentWorker.ts Enhanced progress reporting mechanism with more granular updates during worker optimization

Sequence Diagram

sequenceDiagram
    participant MainThread
    participant ParentWorker
    participant Workers

    MainThread->>ParentWorker: Start optimization
    ParentWorker->>ParentWorker: Post initial progress (0/0)
    ParentWorker->>Workers: Spawn workers
    Workers-->>ParentWorker: Compute builds
    ParentWorker->>MainThread: Update progress incrementally
    Workers-->>ParentWorker: Complete optimization
    ParentWorker->>MainThread: Final progress report
Loading

Possibly related PRs

Suggested labels

ZO

Suggested reviewers

  • nguyentvan7

Poem

🐰 Optimization's dance begins anew,
Progress tracked with updates true,
Workers spinning, data in flight,
Reporting metrics, shining bright!
A rabbit's code, precise and neat 🚀

✨ 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.

@frzyc frzyc added ZO Zenless Optimizer SRO For Star Rail Optimizer labels Jan 26, 2025
Copy link
Contributor

github-actions bot commented Jan 26, 2025

[zzz-frontend] [Sun Jan 26 17:40:45 UTC 2025] - Deployed 4004a2b to https://genshin-optimizer-prs.github.io/pr/2628/zzz-frontend (Takes 3-5 minutes after this completes to be available)

[sr-frontend] [Sun Jan 26 17:41:02 UTC 2025] - Deployed 4004a2b to https://genshin-optimizer-prs.github.io/pr/2628/sr-frontend (Takes 3-5 minutes after this completes to be available)

[Sun Jan 26 17:52:56 UTC 2025] - Deleted deployment

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

🧹 Nitpick comments (3)
libs/zzz/solver/src/parentWorker.ts (1)

125-136: LGTM! Consider adding error handling for postMessage.

The addition of initial progress updates aligns well with the PR objective to show progress earlier in the build process. The placement is correct, occurring right after worker initialization.

Consider wrapping postMessage calls in a try-catch block to handle potential messaging errors:

+  function safePostMessage(message: ParentMessage) {
+    try {
+      postMessage(message)
+    } catch (error) {
+      console.error('Failed to post message:', error)
+    }
+  }
+
   // post initial progress
-  postMessage({
+  safePostMessage({
     resultType: 'progress',
     progress: {
       numBuildsKept: 0,
       numBuildsComputed: 0,
     },
   })
libs/sr/solver/src/parentWorker.ts (2)

137-149: LGTM! Consider extracting common worker logic.

The addition of initial progress updates is consistent with the changes in zzz/solver and aligns with the PR objectives.

Consider creating a shared worker utility module to reduce code duplication between sr/solver and zzz/solver. This could include:

  • Progress tracking logic
  • Message posting utilities
  • Common worker management code

Example structure:

// libs/common/worker/progress.ts
export interface ProgressResult {
  numBuildsKept: number
  numBuildsComputed: number
}

export function initializeProgress(): void {
  postMessage({
    resultType: 'progress',
    progress: {
      numBuildsKept: 0,
      numBuildsComputed: 0,
    },
  })
}

// Additional shared worker utilities...

149-149: Implement build filtering optimization.

Both sr/solver and zzz/solver have TODO comments about sending the lowest build value to child workers for early filtering. This optimization could significantly improve performance by allowing workers to skip builds that won't make the cut.

Would you like me to help implement this optimization? The solution would involve:

  1. Tracking the lowest kept build value
  2. Implementing a new message type for updating the threshold
  3. Adding filtering logic in child workers
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 72d89fb and 4ea985a.

📒 Files selected for processing (3)
  • libs/sr/solver/src/parentWorker.ts (1 hunks)
  • libs/zzz/page-optimize/src/WorkerSelector.tsx (1 hunks)
  • libs/zzz/solver/src/parentWorker.ts (1 hunks)

libs/zzz/page-optimize/src/WorkerSelector.tsx Show resolved Hide resolved
@frzyc frzyc merged commit 0c53322 into master Jan 26, 2025
12 checks passed
@frzyc frzyc deleted the zo_fixes branch January 26, 2025 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SRO For Star Rail Optimizer ZO Zenless Optimizer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant