Skip to content

fix(config): ignore editor name metadata in typo warnings - #2958

Merged
Leela8256 merged 1 commit into
developfrom
fix/RR-2957-vector-node-config-warning
Nov 3, 2026
Merged

Leela8256 merged 1 commit into
developfrom
fix/RR-2957-vector-node-config-warning

Conversation

@Leela8256

@Leela8256 Leela8256 commented Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Saving a named RocketRide Vector node can report unknown config key "name" - did you mean "serverName"?, interrupting normal Save completion. The editor supplies config.name; the engine's suffix-based typo detector mistakes it for the node's tool-server setting.
  • Exclude the exact editor metadata key name from that check. This shared validator correction also benefits other nodes with the same false warning; genuine typos such as serverNam still warn, and configuration values remain intact.
  • Add catalog coverage and all four vector tool-toggle combinations in flat and nested profiles. The UI and its existing warning/error Save behavior are unchanged.

Type

fix

Testing

  • Tests added or updated
  • Tested locally
  • ./builder test passes — full monorepo suite not run

75 targeted Python tests pass on both target bases: test_config_key_warnings.py, test_config_shapes.py, and test_output_token_config.py. Ruff lint/format, the staged secret scan, and git diff --check pass.

Real authenticated local-engine validation returned no errors or warnings for all four toggle combinations with config.name present; a deliberate serverNam typo still warned. The local preview was rebuilt with the original UI Save behavior. Browser/Cursor Save-and-reopen verification remains outstanding because browser automation was unavailable. Mounted React checks used backend/persistence test doubles.

The develop and stage branches contain byte-identical patches and identical resulting blobs for both changed files. Each branch contains only this fix and its tests on its own target base.

Checklist

  • Commit messages follow conventional commits
  • No secrets or credentials included
  • Wiki updated (if applicable) — not applicable
  • Breaking changes documented (if applicable) — none

Linked Issue

Fixes #2957

Summary by CodeRabbit

  • Bug Fixes
    • Configuration names are no longer incorrectly flagged as possible misspellings. Other misspelled configuration keys continue to generate warnings.
    • Including a display name no longer affects resolved settings for vector tool configurations.

@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor
🤖 Internal: Discord sync marker

Auto-managed by the Discord notification workflow. Stores the linked Discord message ID and forum thread ID. Do not edit or delete.

@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Walkthrough

The configuration warning check now skips the exact key name. Tests cover service configurations, flat and nested vector settings, and continued warnings for misspelled keys.

Changes: Configuration typo warnings

Layer / File(s) Summary
Exclude display names from typo detection
packages/ai/src/ai/common/config.py, packages/ai/tests/ai/common/test_config_key_warnings.py
The validator skips name when checking for likely misspellings. Tests check configurations across the service catalogue, vector settings and toggle combinations, and a misspelled serverNam.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Bug fix · Severity of issue fixed: Medium

Suggested labels: module:ai, tests

Suggested reviewers: stepmikhaylov, dsapandora

Merge Risk: Minimal · up to 9ad46

The change is intended to suppress display-name warnings without changing configuration values. No merge-blocking risk is established; browser Save-and-reopen verification remains outstanding.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documenta… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: excluding editor name metadata from configuration typo warnings.
Linked Issues check Passed Issue #2957 (direct link) requires that the editor metadata key name produce no typo warning, that serverName and name stay independent, and that serverNam-style typos still warn. Coverage req…
Out of Scope Changes check Passed The whole-PR diff against the merge base touches two files. packages/ai/src/ai/common/config.py adds a five-line guard that skips only the exact key name in the typo check. `packages/ai/tests/ai/c…
Full details: Linked Issues check

Explanation

Issue #2957 (direct link) requires that the editor metadata key name produce no typo warning, that serverName and name stay independent, and that serverNam-style typos still warn. Coverage requested: real node catalog, all four expose_tools/allow_write combinations in flat and nested profiles, and genuine typo detection.

Code evidence at head: Config._warnMisnamedKeys in packages/ai/src/ai/common/config.py now contains if key == 'name': continue before _suggestKey. Only the exact key name is skipped. Other keys keep the existing suggestion logic. merge() and getNodeConfig are unchanged, so name remains in the resolved config.

Test evidence in packages/ai/tests/ai/common/test_config_key_warnings.py: (1) test_common_node_name_does_not_trigger_a_typo_warning checks name against the real catalog through self._services(). (2) The parametrized test_vector_display_name_and_tool_settings_remain_independent covers the four toggle combinations, flat and nested, using the real nodes/src/nodes/rocketride_vector/services.json, which exists at head. It asserts no warning and preserved name, serverName, expose_tools, and allow_write values. (3) test_node_name_does_not_suppress_real_tool_name_typo asserts that serverNam still warns with serverName as the suggestion.

I did not execute the tests. This verdict rests on source reading and the author's reported test results. The UI Save policy is not changed by this diff.

Full details: Out of Scope Changes check

Explanation

The whole-PR diff against the merge base touches two files. packages/ai/src/ai/common/config.py adds a five-line guard that skips only the exact key name in the typo check. packages/ai/tests/ai/common/test_config_key_warnings.py adds imports used by the new tests and the new regression tests described for #2957. No UI, unrelated node, or configuration-value code changes appear in the diff. The shared-validator effect on other nodes with a name key is the behavior that #2957 explicitly requests.

Full details: Docstring Coverage

Explanation

Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 3 functions across 2 files.

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches
Generate docstrings
  • Commit to this branch
  • Create a new PR
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

ast-grep (0.51.1)

ast-grep could not parse rule config: /ast-grep-rules/ast-grep-essentials/rules/rust/security/sql-injection-format-rust.yml

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

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 1f11dfb and 9ad466f.

Files selected for processing: 2
  • packages/ai/src/ai/common/config.py
  • packages/ai/tests/ai/common/test_config_key_warnings.py

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

@asclearuc asclearuc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks @Leela8256 — a narrow fix in the right place. The shared validator skips only the editor's name key, a real near-miss such as serverNam still warns, and the catalogue-wide test proves that name no longer warns on any node.

Approve

No inline comments. #2959 carries the same patch to stage.

@Leela8256
Leela8256 merged commit c08ce50 into develop Nov 3, 2026
@Leela8256
Leela8256 deleted the fix/RR-2957-vector-node-config-warning branch November 3, 2026 15:24

@dsapandora dsapandora left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

One change needed inline.

# The editor supplies this common endpoint/display field even when
# services.json does not declare it. It is not a truncated
# serverName/accountName/etc. Keep it in the merged config.
if key == 'name':

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The editor also writes config.type, and it still warns: examples/cognee-shared-memory-agents.pipe gives unknown config key "type" - did you mean "search_type"?, and tool_http_request suggests authType. Please skip both editor keys ({"name", "type"}) and add a type case to the catalogue test.

Leela8256 added a commit that referenced this pull request Nov 5, 2026
The canvas saves the node's type inside its config ("type": "tool_github"). The
config key check read that key as a misspelling of a declared field (authType on
tool_github, compute_type on audio_transcribe) and warned on every pipeline saved
from the canvas. Exempt "type" the way #2958 exempted "name"; a real typo such as
"serverNam" still warns.

Follow-up to #2958 (issue #2957).

Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

module:ai AI/ML modules tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(config): editor node name triggers a false serverName warning

3 participants