Skip to content

[DRIVERS-2338] Rename csfle to "crypt_shared" #1236

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.

Sign up for GitHub

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

Jump to bottom
Merged
vector-of-bool merged 4 commits into from
May 31, 2022
Merged

[DRIVERS-2338] Rename csfle to "crypt_shared" #1236

vector-of-bool merged 4 commits into from
May 31, 2022

Conversation

@vector-of-bool
Copy link
Contributor

@vector-of-bool vector-of-bool commented May 31, 2022

Refer: DRIVERS-2338

Please complete the following before merging:

  • Bump spec version and last modified date.
  • Update changelog.
  • Make sure there are generated JSON files from the YAML test files.
  • Test changes in at least one language driver.
  • Test these changes against all server versions and topologies (including standalone, replica set, sharded clusters, and serverless).

@vector-of-bool vector-of-bool requested review from a team as code owners May 31, 2022 17:46
@vector-of-bool vector-of-bool requested review from jmikola and kevinAlbs and removed request for a team May 31, 2022 17:46
kevinAlbs
kevinAlbs approved these changes May 31, 2022
View reviewed changes
Copy link
Contributor

@kevinAlbs kevinAlbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with two small notes.

source/client-side-encryption/client-side-encryption.rst Outdated
:Minimum Server Version: 4.2
:Last Modified: 2022-05-27
:Last Modified: 2022-05-31
:Version: 1.7.2
Copy link
Contributor

@kevinAlbs kevinAlbs May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest bumping version to 1.7.3.

source/client-side-encryption/tests/README.rst Outdated
.. code-block:: shell
$ python3 mongodl.py --component=csfle --version=6.0.0-rc4 --out=./csfle/
$ python3 mongodl.py --component=crypt_shared --version=6.0.0-rc4 --out=./crypt_shared/
Copy link
Contributor

@kevinAlbs kevinAlbs May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ python3 mongodl.py --component=crypt_shared --version=6.0.0-rc4 --out=./crypt_shared/
$ python3 mongodl.py --component=crypt_shared --version=<VERSION> --out=./crypt_shared/

6.0.0-rc4 will not include crypt_shared. I suggest using a placeholder.

Copy link
Member

@jmikola jmikola May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a ticket to remind us to come back and revise this placeholder?

jmikola
jmikola reviewed May 31, 2022
View reviewed changes
source/client-side-encryption/client-side-encryption.rst Outdated
:align: left
Date, Description
22-05-31, Rename ``csfle`` to crypt_shared_
Copy link
Member

@jmikola jmikola May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think changelogs would do well to avoid document references and stand on their own. Suggested placement:

Suggested change
22-05-31, Rename ``csfle`` to crypt_shared_
22-05-31, Rename ``csfle`` to ``crypt_shared``

Feel free to reject this and the subsequent suggestion if you disagree.

source/client-side-encryption/client-side-encryption.rst Outdated
22-05-03, "Add queryType, contentionFactor, and ""Indexed"" and ""Unindexed"" to algorithm."
22-04-29, Add bypassQueryAnalysis option
22-04-11, Document the usage of the new csfle_ library
22-04-11, Document the usage of the new `csfle <crypt_shared_>`_ library (Note: Later renamed to crypt_shared_)
Copy link
Member

@jmikola jmikola May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per above.

Suggested change
22-04-11, Document the usage of the new `csfle <crypt_shared_>`_ library (Note: Later renamed to crypt_shared_)
22-04-11, Document the usage of the new ``csfle`` library (Note: Later renamed to ``crypt_shared``)

source/client-side-encryption/tests/README.rst Outdated
.. code-block:: shell
$ python3 mongodl.py --component=csfle --version=6.0.0-rc4 --out=./csfle/
$ python3 mongodl.py --component=crypt_shared --version=6.0.0-rc4 --out=./crypt_shared/
Copy link
Member

@jmikola jmikola May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a ticket to remind us to come back and revise this placeholder?

jmikola
jmikola approved these changes May 31, 2022
View reviewed changes
Copy link
Member

@jmikola jmikola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with suggested patch version bump and optional changelog revisions.

@vector-of-bool vector-of-bool mentioned this pull request May 31, 2022
Merged
@vector-of-bool vector-of-bool merged commit ecc9757 into mongodb:master May 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jmikola jmikola jmikola approved these changes

@addaleax addaleax addaleax approved these changes

@kevinAlbs kevinAlbs kevinAlbs approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vector-of-bool @jmikola @addaleax @kevinAlbs