Skip to content

[codex] add app-server protocol compatibility check - #29509

Closed
willwang-openai wants to merge 1 commit into
mainfrom
codex/app-server-protocol-compatibility
Closed

willwang-openai wants to merge 1 commit into
mainfrom
codex/app-server-protocol-compatibility

Conversation

@willwang-openai

Copy link
Copy Markdown
Contributor

Summary

Add a pull-request check that rejects backwards-incompatible changes to the stable app-server protocol.

  • compare freshly generated head schemas against the PR base revision
  • apply directional compatibility rules to client inputs and server outputs
  • detect removed methods, fields, enum variants, union variants, constraints, and generated TypeScript exports
  • exclude experimental protocol surface
  • provide a local just check-app-server-protocol-compatibility command
  • intentionally omit an in-code waiver; repository-owner required-check bypass remains the emergency path

Why

The existing schema fixture test verifies generated schemas against checked-in fixtures, but it does not compare the protocol exposed by a PR with its base revision. A breaking schema change can therefore land if the fixtures are regenerated in the same PR.

This workflow generates the candidate schema from source and compares it directly with the PR base, so updating fixtures cannot bypass the compatibility check.

Validation

  • python3 -m unittest discover -s scripts -p 'test_check_app_server_protocol_compatibility.py' — 11 tests passed
  • just write-app-server-schema --schema-root /tmp/codex-app-server-compat-head
  • current generated schema compared with HEAD — compatible
  • historical comparison across the needsAuth removal — break detected
  • just test -p codex-app-server-protocol — 241 tests passed
  • git diff --check

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Closing this pull request because it has had no updates for more than 14 days. If you plan to continue working on it, feel free to reopen or open a new PR.

@github-actions github-actions Bot closed this Jul 7, 2026
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