Repository navigation
refactor(guest,auth): name each key vendor backend in one place - #1561
Draft
freshtonic wants to merge 1 commit into
Draft
freshtonic wants to merge 1 commit into
freshtonic wants to merge 1 commit into
Conversation
The five-way vendor switch was written again in each place that used it: the guest's GuestVendor Debug, VendorSettings::vendor, a dispatch macro with one arm per vendor and method, and run_vendor in the auth binding. A new vendor meant an edit to each one. In the guest, one macro call lists the vendor clients once. The macro makes the GuestVendor enum and forwards every KeyVendorBackend method to the configured client. Debug reads the name from vendor(), and VendorSettings::vendor is gone. The config keys and the constructor of each vendor stay where they are, because they are different data for each vendor, not the same switch. The dispatch did not forward same_key, so the guest used the default text compare for Google Cloud KMS and Azure, which ignore the key version. The guest does not rewrap a record, so no call path changes, but the macro now forwards it and a test shows it. In the auth binding, each row of BACKENDS now also holds how to build the vendor client from the environment. run_vendor reads the row, so the table is the one list of backends in the module.
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true |
🦋 Changeset detectedLatest commit: ea7f160 The changes in this PR will be included in the next version bump. This PR includes changesets to release 19 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This branch has not been deployed
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
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.
Summary
The same five-way vendor switch was written in four places: three in the Go guest and one in the
@cipherstash/authbinding. A new vendor meant an edit to each. This PR lists the vendors once on each side.Changes
guest_vendors!macro call lists the vendor clients once. It generates theGuestVendorenum and forwards everyKeyVendorBackendmethod.VendorSettings::vendor()is gone.@cipherstash/auth: eachBACKENDSrow also holds the function that builds the client from the environment, sorun_vendorhas no switch.@cipherstash/authpatch.native.d.tsrebuilt, no change.Behaviour change
same_key, so the guest used a plain text compare for Google Cloud KMS and Azure key names. Those should ignore the key version. It is forwarded now, and a new test covers it. The guest never rewraps a record, so no reachable path changes.Verification
Run on the top branch of this stack (
james/kms-vendor-dispatch), on macOS:cargo fmt --all --checkandcargo clippy --workspace --all-features --all-targets -- -D warnings: pass.mise x --env test -- cargo nextest run --workspace --all-features: 1401 of 1402 pass. The one failure isstack-encrypt::ui derive_diagnostics(trybuild). It fails on every snapshot because of a local rustc wrapper that changes the paths in the compiler output. This stack does not touchstack-encrypt. CI is the check for it.mise run wasm:guest:test: 80 of 80 pass.go vet ./...andgo test -count=1 ./...inlanguages/golang: pass.pnpm --filter @cipherstash/auth test: 92 pass.pnpm --filter stash test: 1667 pass.cargo checkof the workspace and the guest (native andwasm32-wasip1) on each branch of the stack: pass.Related
Refs #1541. Code-smell follow-up to the key vendor backend stack.