Skip to content

Prep for cds10#465

Open
eric-pSAP wants to merge 1 commit into
mainfrom
cds10
Open

Prep for cds10#465
eric-pSAP wants to merge 1 commit into
mainfrom
cds10

Conversation

@eric-pSAP

@eric-pSAP eric-pSAP commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Prepare for CDS 10 Compatibility

Chore

🔧 Updates the @cap-js/attachments package configuration to be compatible with the upcoming CDS 10 release by bumping the minimum peer dependency version and updating an API configuration key.

Changes

  • package.json:
    • Updated peerDependencies minimum version for @sap/cds from >=8 to >=9.
    • Renamed the outbox configuration key to queue under the attachments service configuration, reflecting a CDS API change.
  • 🔄 Regenerate and Update Summary
PR Bot Information

Version: 1.22.9

  • Output Template: Default Template
  • Summary Prompt: Default Prompt
  • Correlation ID: f46a17c8-b3b9-46d1-bb2a-96ece60109b1
  • LLM: anthropic--claude-4.6-sonnet
  • Event Trigger: pull_request.opened
  • File Content Strategy: Full file content

@eric-pSAP eric-pSAP requested a review from a team as a code owner June 15, 2026 08:27

@hyperspace-insights hyperspace-insights Bot 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.

The PR makes two configuration changes to prepare for CDS 9/10: bumping the peer dependency floor from >=8 to >=9, and renaming the outbox queue setting to queue. Both changes are functionally straightforward, but the outboxqueue rename is a silent breaking change for existing consumers with no changelog entry or migration path, and the CDS 8 compatibility dead code should be cleaned up alongside the peer dep bump.

PR Bot Information

Version: 1.22.9

  • Event Trigger: pull_request.opened
  • File Content Strategy: Full file content
  • Correlation ID: f46a17c8-b3b9-46d1-bb2a-96ece60109b1
  • LLM: anthropic--claude-4.6-sonnet

Comment thread package.json
},
"peerDependencies": {
"@sap/cds": ">=8"
"@sap/cds": ">=9"

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.

Best Practices: CDS 8 fallback code is now dead code after dropping >=8 peer dependency

The peer dependency floor was raised to >=9, but lib/plugin.js still contains a CDS 8 fallback branch (cds.version >= "8.6.0" ? "compile.to.edmx" : "loaded" on line 18) and lib/generic-handlers.js still has a // CAP 8 fallback comment block around the inferTargetCAP8 helper. With @sap/cds >=9 enforced, these branches are unreachable and should be removed to avoid confusion and maintenance burden.

Consider cleaning up the CDS 8 compatibility shims now that support is officially dropped.


Please provide feedback on the review comment by checking the appropriate box:

  • 🌟 Awesome comment, a human might have missed that.
  • ✅ Helpful comment
  • 🤷 Neutral
  • ❌ This comment is not helpful

Comment thread package.json
},
"attachments": {
"outbox": true,
"queue": true,

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.

Best Practices: Breaking configuration rename is not documented in CHANGELOG.md

Renaming outbox: true to queue: true in the default cds.requires.attachments config is a breaking change for any consumer who has explicitly set attachments.outbox: true in their own project's cds configuration — their value will now be silently ignored.

No entry for this rename appears in CHANGELOG.md. Consider:

  1. Adding a changelog entry under a new version that calls this out as a breaking change.
  2. Adding a migration hint or deprecation warning in the runtime when the old outbox key is detected, e.g.:
if (cds.env.requires.attachments?.outbox !== undefined) {
  LOG.warn('`cds.requires.attachments.outbox` is deprecated; use `queue` instead.')
}

Please provide feedback on the review comment by checking the appropriate box:

  • 🌟 Awesome comment, a human might have missed that.
  • ✅ Helpful comment
  • 🤷 Neutral
  • ❌ This comment is not helpful

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.

1 participant