Skip to content

docs(NODE-4724): update fle docs to use "in use encryption" terminology #3448

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

Merged
merged 5 commits into from
Oct 18, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ export class Collection<TSchema extends Document = Document> {
options = {};
}

// CSFLE passes in { w: 'majority' } to ensure the lib works in both 3.x and 4.x
// In use encryption passes in { w: 'majority' } to ensure the lib works in both 3.x and 4.x
// we support that option style here only
if (options && Reflect.get(options, 'w')) {
options.writeConcern = WriteConcern.fromOptions(Reflect.get(options, 'w'));
Expand Down
2 changes: 1 addition & 1 deletion src/deps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ export interface AutoEncryptionOptions {
*
* **NOTE**: Supplying options.schemaMap provides more security than relying on JSON Schemas obtained from the server.
* It protects against a malicious server advertising a false JSON Schema, which could trick the client into sending decrypted data that should be encrypted.
* Schemas supplied in the schemaMap only apply to configuring automatic encryption for client side encryption.
* Schemas supplied in the schemaMap only apply to configuring automatic encryption for in use encryption.
* Other validation rules in the JSON schema will not be enforced by the driver and will result in an error.
*/
schemaMap?: Document;
Expand Down
4 changes: 2 additions & 2 deletions src/error.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ export interface ErrorDescription extends Document {
* @category Error
*
* @privateRemarks
* CSFLE has a dependency on this error, it uses the constructor with a string argument
* In use encryption has a dependency on this error, it uses the constructor with a string argument
*/
export class MongoError extends Error {
/** @internal */
Expand Down Expand Up @@ -568,7 +568,7 @@ export class MongoNetworkError extends MongoError {
* @category Error
*
* @privateRemarks
* CSFLE has a dependency on this error with an instanceof check
* In use encryption has a dependency on this error with an instanceof check
*/
export class MongoNetworkTimeoutError extends MongoNetworkError {
constructor(message: string, options?: MongoNetworkErrorOptions) {
Expand Down
2 changes: 1 addition & 1 deletion src/mongo_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
/** Server API version */
serverApi?: ServerApi | ServerApiVersion;
/**
* Optionally enable client side auto encryption
* Optionally enable in use auto encryption
*
* @remarks
* Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error
Expand Down
2 changes: 1 addition & 1 deletion src/sdam/topology.ts
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
) => this.selectServer(selector, options, callback as any)
);

// Legacy CSFLE support
// Legacy in use encryption support
this.bson = Object.create(null);
this.bson.serialize = serialize;
this.bson.deserialize = deserialize;
Expand Down