Repository navigation
add the appwrite plugin - #135
Conversation
Watches appwrite/specs (the newest minor's server operations at the newest commit) for operation deprecations, quoting x-appwrite.deprecated. SDK method renames flagged deprecated are not read as deprecations, and removals are never events. Adds two diff options, QuoteDeprecated and FlagNotDeprecation; their zero values keep every other plugin's output unchanged. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: brandonphelps1212 <[email protected]>
Keeps both sides of the shared files: the neon, convex and planetscale rows and registrations, then appwrite's. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: brandonphelps1212 <[email protected]>
Version is the specs commit's date, for the client's date-versioned gate: a server version can't be placed against an SDK pin. Operations are named by the path a caller sends (/v1/...) through ServerBasePath, with pointers into the spec as published. A deprecated flag on an operation that still has a live SDK method isn't read as a deprecation, and a single document with no server operation fails the fetch. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: brandonphelps1212 <[email protected]>
|
Claude finished @brandonphelps1212's task in 2m 4s —— View job ✅ Ready to merge. The plugin follows every repo rule, all local checks pass, and I found no path that emits an event for something that isn't a real deprecation. Rules
BugsNone found. What I checked:
Verified
I didn't run Non-blocking
Nice work: the history replay and the tests on what the filter keeps and drops make this easy to trust. |
| ## Known gaps | ||
|
|
||
| - **Removals aren't events.** The spec doesn't mark them first, so real ones are missed. The SDK changelogs say them ("* Breaking: removed `X`"); a `changelog` plugin per SDK could read them. | ||
| - **Deprecations from before the plugin's first run aren't events,** nor ones that came with a new minor's directory already flagged. The Databases to TablesDB deprecations of 1.8.0 can be replayed (`1.7.x@<sha>` to `<sha>`), and a run never sees them. |
There was a problem hiding this comment.
Non-blocking, wording only: I don't think "nor ones that came with a new minor's directory already flagged" matches the code. When a new specs/<X.Y>.x appears, Fetch switches to it and the plugin diffs it against the last spec it saw from the previous minor. So an operation that was unflagged in 2.7.x and is flagged in a new 2.8.x is an event. The 1.7.x → 1.8.x replay shows this: 50 events. What's actually missed is an operation that is new in the new minor and already flagged, because it has no unflagged version to compare against. Could you reword this, e.g. "nor operations that first appear already flagged (for example in a new minor's directory)"?
Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: brandonphelps1212 <[email protected]>
What this changes
Adds
appwrite, anopenapiplugin for Appwrite's server API. Part of #76 (I11.8 · Watch Appwrite), under #14.Source: https://github.com/appwrite/specs (BSD-3-Clause). It reads the newest
specs/<X.Y>.xdirectory (compared by number), pinned to a commit SHA.x-appwrite.platformsincludeserver.open-api3-<X.Y>.x-server.json.versionis the pinned commit's date (UTC), likeneon,convexandplanetscale. Appwrite's server version (info.version, e.g.1.9.5) isn't what a repo pins: the SDKs are numbered on their own (node-appwrite32.x). The client getsappwritein its date-versioned list in a separate PR.Operation names include
/v1, via the sharedadapter.ServerBasePath. Quotes point into the spec as published.Rule: deprecations only, never removals. Of the removals in the history, only one was marked deprecated first, and it was a path move still served through an alias. A deprecation is the
deprecatedflag, quoted asx-appwrite.deprecated({since, replaceWith}), because the descriptions don't say why.New shared
diff.Options, with zero values leaving every other golden unchanged:QuoteDeprecated: what a flag deprecation cites, relative to the operation.FlagNotDeprecation(op): a flag that isn't a route deprecation.For Appwrite, that's an SDK method rename (
replaceWithnames another method of the same operation, e.g.Mfa→MFA), or an operation where any SDK method is still live.Fails loudly: if filtering to
serverleaves no operations (say, if the layout changes),Fetcherrors instead of emitting nothing.History: replaying all 177 commits, side branches and every directory switch included, gives exactly 14 events. They're the deprecations of 2026-06-24: the six
/v1/databases/transactionsoperations and the text/varchar attribute operations, each replaced bytablesDB.*.Needs a client change
appwritemust be added to the patch-it client's list of date-versioned APIs. It's included in the client PR that addsneon,convexandplanetscale.Checklist
docs/plugins.md: new row, statuslive.docs/plugins.jsonregenerated, README badge 28. I compared the row's words with the plugin.8c00ba35→7d74bf9f, 14 deprecation events.98cc1a25→06e6fafa, 0 events. With the filter off it gives 13 removals: operations taken offserverfor a day, which came back in 2.5.x.testdata/README.mdrows: URL at the commit, date, license (BSD-3-Clause), quote. The fixtures are re-serialized; on a full file that reproduces the original byte for byte, as documented.providers/appwrite.mdfrom the template, with Why this source and Known gaps (unmarked removals, whose real ones are in the SDK changelogs; specs commits that don't line up with releases).make checkpasses.Notes for the reviewer
An independent review replayed the specs repo through the branch's own adapter.
Its findings are fixed in the last commit: date versions so the client doesn't drop the events,
/v1paths, the live-method rule, and the zero-operations error.🤖 Generated with Claude Code