Add API version negotiation to detect frontend/server mismatch#108
Draft
yzx9 wants to merge 1 commit into
Draft
Conversation
yzx9
changed the title
The publicly-deployed copilotj.chat frontend can point at user self-hosted
servers. Add a MAJOR.MINOR protocol version so the frontend can detect an
incompatible (typically too-old) server instead of silently breaking.
Backend:
- copilotj/server/protocol.py: API_VERSION_MAJOR/MINOR integers combined
into API_VERSION = "1.0" (bump MAJOR on breaking protocol changes, MINOR
on backward-compatible additions).
- server.py: add GET /api/version -> {"api_version": ...}; /api/ping is
unchanged.
Frontend:
- web/src/apis/version.ts: API_VERSION constant, getServerVersion(), and
isApiVersionCompatible() (compatible when MAJOR matches).
- store/state.ts: apiVersionStatus (compatible/incompatible/unknown) and a
checkApiVersion() action.
- SettingsConnection.vue (wizard Step 1): inline version status after a
successful connect; non-blocking.
- ChatboxHello.vue: dismissible version banner for returning users.
- Chat.vue: run checkApiVersion() on load and after the wizard completes.
The backend protocol.py and frontend version.ts constants must be kept in
sync by hand (called out in both docstrings).
yzx9
force-pushed
the
issue-68-api-version
branch
from
5c010fa to
82873d3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The publicly-deployed copilotj.chat frontend can point at user self-hosted servers. Add a MAJOR.MINOR protocol version so the frontend can detect an incompatible (typically too-old) server instead of silently breaking.
Backend:
Frontend:
The backend protocol.py and frontend version.ts constants must be kept in sync by hand (called out in both docstrings).
close: #68