Repository navigation
refactor(stack-encrypt,eql-bindings)!: remove the plan chain, the builder and the old traits #1666
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
coderdan
wants to merge
4
commits into
feat/stack-encrypt-json-targets-owned-traits
from
refactor/stack-encrypt-remove-chain-and-old-traits
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5721065
refactor(stack-encrypt,eql-bindings)!: remove the plan chain, the bui…
coderdan 769102d
fix(stack-encrypt,eql-bindings): address the review of the removal
coderdan ca46547
docs(stack-encrypt): drop two more mentions of the plan builder and t…
coderdan 24def60
docs(stack-encrypt): refresh the API plan's tracking lines
coderdan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| '@cipherstash/eql': minor | ||
| --- | ||
|
|
||
| `eql-bindings`, the Rust crate released with this package: the EQL v4 types no longer implement Stack Encrypt's older traits `EncryptFrom` and `DecryptInto`. Stack Encrypt removed them, with `encrypt_as`, `decrypt_as`, the plan builder and the query chain. | ||
|
|
||
| - Every type keeps `EncryptTarget` and `DecryptSource`. Write with `value.encrypt_into_with_context(&keyset, column)` and read with `P::decrypt_from_with_context(stored, &keyset, column)`. | ||
| - A typed query is a field marker of a derived record, such as `EncryptedMember::EMAIL.eq("bob").encrypt(&keyset)`. | ||
| - A JSON document is a `JsonPlaintext`, not a `serde_json::Value`. A typed JSON query has no replacement yet: derive the operand through a data plan that names `JsonSearch`. | ||
| - `JsonTree` no longer implements `stack_encrypt::target::Layout`. `encryption()`, `index()` and `specs()` are its own methods. | ||
|
|
||
| The stored format, the SQL bundle, and the TypeScript types do not change. | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
F7 (minor): six pending changesets still advertise the API this one removes, and they ship in the same release.
packages/eql/packages/eql/CHANGELOG.mdtops out at 3.0.6 and mentions none of them, so all of these are unreleased. They will appear in the same@cipherstash/eqlCHANGELOG section as this entry:.changeset/eql-v4-owned-targets.md:9-10: "The same derives still implement the olderEncryptFromandDecryptInto. Soencrypt_as, plans ... work as before" and "To build a plan for a type, usePlan::value::<P>().encrypt_into::<T>().".changeset/eql-v4-bindings.md:5: "A Rust caller queries those types through Stack Encrypt's typed query chain:cipher.query(op::Eq, v).on(&plan)", and "throughencrypt_as"..changeset/eql-json-tree-walk-and-projection.md:15: "stack-encryptgainstarget::LayoutandPlan::value().encrypt_with_layout(layout)"..changeset/eql-plan-field-targets.md:5,.changeset/eql-json-tree-domain.md:5,.changeset/eql-bindings-optional-storage-only.md:5: each namesEncryptFrom/DecryptIntoas what the types implement.A reader of the release notes is told to use
Plan::valueandcipher.queryin the same section that says they are gone.Verified with
git grepover.changeset/and the EQL CHANGELOG.Fix: since these are unreleased, edit them to name the owned API, or drop the sentences about the removed API.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in ebf5a61. The six pending changesets name the owned API now:
eql-v4-owned-targets,eql-v4-bindings,eql-json-tree-walk-and-projection,eql-plan-field-targets,eql-json-tree-domainandeql-bindings-optional-storage-only. The unreleased entries ofeql-bindings/CHANGELOG.mdhad the same problem and are corrected too. Two of its sentences saidOpeCllwandOreBlock256implement an encryption trait; neither does any more, so I deleted them.