Skip to content

Conversation

blckmn
Copy link
Member

@blckmn blckmn commented Jul 31, 2025

  • this is to help identify last use of a build key for storage analysis

Summary by CodeRabbit

  • Refactor
    • Improved tracking event details by including an additional property.
    • Adjusted the sequence of certain background operations for better processing flow.

- this is to help identify last use of a build key for storage analysis
@blckmn blckmn self-assigned this Jul 31, 2025
Copy link
Contributor

coderabbitai bot commented Jul 31, 2025

Walkthrough

The sendConfigTracking function in src/js/serial_backend.js was updated to include the buildKey property from FC.CONFIG in its tracking payload. Additionally, in the processUid function, the sequence of awaiting sendConfigTracking() and processBuildConfiguration() was reversed, so that processBuildConfiguration() is now awaited before sendConfigTracking().

Changes

Cohort / File(s) Change Summary
Tracking Payload and Async Flow
src/js/serial_backend.js
Added buildKey to the tracking event payload in sendConfigTracking. Swapped the await order of sendConfigTracking() and processBuildConfiguration() in processUid.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant serial_backend.js

    Caller->>serial_backend.js: processUid()
    serial_backend.js->>serial_backend.js: processBuildConfiguration() (await)
    serial_backend.js->>serial_backend.js: sendConfigTracking() (await, includes buildKey)
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Suggested reviewers

  • haslinghuis
  • nerdCopter

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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 generate unit tests to generate unit tests for 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.

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

Copy link
Contributor

Preview URL: https://41c46135.betaflight-configurator.pages.dev

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

🧹 Nitpick comments (1)
src/js/serial_backend.js (1)

95-95: Fix trailing comma formatting issue.

The addition of buildKey to the tracking payload aligns perfectly with the PR objectives to assist in storage analysis. However, there's a missing trailing comma that should be addressed for consistency.

-        buildKey: FC.CONFIG.buildKey
+        buildKey: FC.CONFIG.buildKey,
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ec6f58 and 41c4613.

📒 Files selected for processing (1)
  • src/js/serial_backend.js (2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: DavidAnson
PR: betaflight/betaflight-configurator#4450
File: src/js/tabs/setup.js:0-0
Timestamp: 2025-05-01T05:41:03.282Z
Learning: In the Betaflight Configurator, FC.CONFIG.buildKey is defaulted to an empty string when not present, making the length check (FC.CONFIG.buildKey.length === 32) safe without additional type checking.
Learnt from: mituritsyn
PR: betaflight/betaflight-configurator#4526
File: src/js/gui.js:43-43
Timestamp: 2025-06-20T12:35:49.283Z
Learning: In the Betaflight Configurator codebase, tabs in `defaultCloudBuildTabOptions` are conditionally displayed based on firmware build options. The logic in `serial_backend.js` checks `FC.CONFIG.buildOptions` and only adds tabs to `GUI.allowedTabs` if the firmware was built with support for that feature.
📚 Learning: in the betaflight configurator codebase, tabs in `defaultcloudbuildtaboptions` are conditionally dis...
Learnt from: mituritsyn
PR: betaflight/betaflight-configurator#4526
File: src/js/gui.js:43-43
Timestamp: 2025-06-20T12:35:49.283Z
Learning: In the Betaflight Configurator codebase, tabs in `defaultCloudBuildTabOptions` are conditionally displayed based on firmware build options. The logic in `serial_backend.js` checks `FC.CONFIG.buildOptions` and only adds tabs to `GUI.allowedTabs` if the firmware was built with support for that feature.

Applied to files:

  • src/js/serial_backend.js
📚 Learning: in the betaflight configurator, fc.config.buildkey is defaulted to an empty string when not present,...
Learnt from: DavidAnson
PR: betaflight/betaflight-configurator#4450
File: src/js/tabs/setup.js:0-0
Timestamp: 2025-05-01T05:41:03.282Z
Learning: In the Betaflight Configurator, FC.CONFIG.buildKey is defaulted to an empty string when not present, making the length check (FC.CONFIG.buildKey.length === 32) safe without additional type checking.

Applied to files:

  • src/js/serial_backend.js
🧬 Code Graph Analysis (1)
src/js/serial_backend.js (1)
src/js/fc.js (1)
  • FC (130-993)
🪛 ESLint
src/js/serial_backend.js

[error] 95-96: Missing trailing comma.

(comma-dangle)

🔇 Additional comments (1)
src/js/serial_backend.js (1)

533-533: Sequencing Confirmed: buildKey Populated Before Tracking

processBuildConfiguration() issues an MSP2_GET_TEXT BUILD_KEY request (in serial_backend.js) and sets FC.CONFIG.buildKey in MSPHelper.js (line 920). Placing await sendConfigTracking() immediately afterward guarantees the tracking payload carries the correct buildKey. LGTM.

@haslinghuis haslinghuis moved this to App in 2025.12.0 Jul 31, 2025
@haslinghuis haslinghuis added this to the 11.0 milestone Jul 31, 2025
@VitroidFPV VitroidFPV merged commit 640ba32 into betaflight:master Jul 31, 2025
7 checks passed
@github-project-automation github-project-automation bot moved this from App to Done in 2025.12.0 Jul 31, 2025
@blckmn blckmn deleted the buildkey branch July 31, 2025 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants