Skip to content

fix(bundler): reject non-mapping 'integration' in a bundle manifest#3629

Merged
mnriem merged 1 commit into
github:mainfrom
jawwad-ali:fix/manifest-integration-mapping-guard
Jul 22, 2026
Merged

fix(bundler): reject non-mapping 'integration' in a bundle manifest#3629
mnriem merged 1 commit into
github:mainfrom
jawwad-ali:fix/manifest-integration-mapping-guard

Conversation

@jawwad-ali

Copy link
Copy Markdown
Contributor

What

BundleManifest.from_dict rejects a present-but-non-mapping requires and provides:

if not isinstance(requires_raw, dict):
    raise BundlerError("'requires' must be a mapping when present.")
...
if not isinstance(provides, dict):
    raise BundlerError("'provides' must be a mapping when present.")

…but integration is the odd one out — a non-mapping value is silently dropped:

integration = None
integration_raw = data.get("integration")
if isinstance(integration_raw, dict) and integration_raw.get("id"):   # bare string "copilot" fails silently
    integration = IntegrationRef(id=...)

So a manifest with integration: copilot (a common mistake — the schema wants integration: {id: copilot}) parses as a bundle that is wrongly integration-agnostic (is_agnostic() True), instead of surfacing the error.

Fix

Add the same guard as its sibling mapping fields — scoped strictly to the non-mapping-present case, leaving the existing dict-with-id behavior unchanged.

Test

test_string_integration_rejected_not_silently_dropped: integration="copilot" now raises BundlerError("'integration' must be a mapping when present") — fails before (silently dropped, no raise).


🤖 Written with the assistance of Claude Code (AI). Bug self-found; fix/tests verified locally (fail-before / pass-after), ruff clean.

BundleManifest.from_dict guarded 'requires' and 'provides' with
"must be a mapping when present", but a present-but-non-mapping 'integration'
(e.g. a bare string "copilot") silently failed the isinstance(dict) check and
was dropped — leaving the bundle wrongly integration-agnostic (is_agnostic()
True) instead of surfacing the authoring mistake. Add the same guard so
'integration' is consistent with its sibling mapping fields.

Test: integration='copilot' now raises BundlerError (fails before: silently
dropped, no raise).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Rejects malformed non-mapping integration values instead of silently treating bundles as integration-agnostic.

Changes:

  • Adds explicit integration mapping validation.
  • Adds a regression test for bare string values.
Show a summary per file
File Description
src/specify_cli/bundler/models/manifest.py Validates the optional integration field.
tests/contract/test_manifest_schema.py Covers malformed string integration input.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 0
  • Review effort level: Medium

@mnriem
mnriem merged commit cbfb9f0 into github:main Jul 22, 2026
12 checks passed
@mnriem

mnriem commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Thank you!

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.

3 participants