Skip to content

feat!(NODE-3094): improve dots-and-dollars in keys experience #2863

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

Merged
merged 1 commit into from
Jun 28, 2021
Merged

feat!(NODE-3094): improve dots-and-dollars in keys experience #2863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/bulk/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -977,7 +977,7 @@ export abstract class BulkOperationBase {
// Fundamental error
err: undefined,
// check keys
checkKeys: typeof options.checkKeys === 'boolean' ? options.checkKeys : true
checkKeys: typeof options.checkKeys === 'boolean' ? options.checkKeys : false
};

// bypass Validation
Expand Down
4 changes: 2 additions & 2 deletions src/cmap/commands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ export class Query {
this.ignoreUndefined =
typeof options.ignoreUndefined === 'boolean' ? options.ignoreUndefined : false;
this.maxBsonSize = options.maxBsonSize || 1024 * 1024 * 16;
this.checkKeys = typeof options.checkKeys === 'boolean' ? options.checkKeys : true;
this.checkKeys = typeof options.checkKeys === 'boolean' ? options.checkKeys : false;
this.batchSize = this.numberToReturn;

// Flags
Expand Down Expand Up @@ -677,7 +677,7 @@ export class Msg {
typeof options.serializeFunctions === 'boolean' ? options.serializeFunctions : false;
this.ignoreUndefined =
typeof options.ignoreUndefined === 'boolean' ? options.ignoreUndefined : false;
this.checkKeys = typeof options.checkKeys === 'boolean' ? options.checkKeys : true;
this.checkKeys = typeof options.checkKeys === 'boolean' ? options.checkKeys : false;
this.maxBsonSize = options.maxBsonSize || 1024 * 1024 * 16;

// flags
Expand Down
2 changes: 1 addition & 1 deletion src/operations/insert.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export class InsertOperation extends CommandOperation<Document> {

constructor(ns: MongoDBNamespace, documents: Document[], options: BulkWriteOptions) {
super(undefined, options);
this.options = { ...options, checkKeys: options.checkKeys ?? true };
this.options = { ...options, checkKeys: options.checkKeys ?? false };
this.ns = ns;
this.documents = documents;
}
Expand Down
86 changes: 0 additions & 86 deletions test/functional/collection.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,92 +163,6 @@ describe('Collection', function () {
});
});

it('should fail to insert due to illegal keys', function (done) {
db.createCollection('test_invalid_key_names', (err, collection) => {
// Legal inserts
collection.insertMany(
[{ hello: 'world' }, { hello: { hello: 'world' } }],
configuration.writeConcernMax(),
err => {
expect(err).to.not.exist;

// Illegal insert for key
collection.insertOne({ $hello: 'world' }, configuration.writeConcernMax(), err => {
expect(err).to.be.an.instanceof(Error);
expect(err.message).to.equal("key $hello must not start with '$'");

collection.insertOne(
{ hello: { $hello: 'world' } },
configuration.writeConcernMax(),
err => {
expect(err).to.be.an.instanceof(Error);
expect(err.message).to.equal("key $hello must not start with '$'");

collection.insertOne(
{ he$llo: 'world' },
configuration.writeConcernMax(),
err => {
expect(err).to.not.exist;

collection.insertOne(
{ hello: { hell$o: 'world' } },
configuration.writeConcernMax(),
err => {
expect(err).to.not.exist;

collection.insertOne(
{ '.hello': 'world' },
configuration.writeConcernMax(),
err => {
expect(err).to.be.an.instanceof(Error);
expect(err.message).to.equal("key .hello must not contain '.'");

collection.insertOne(
{ hello: { '.hello': 'world' } },
configuration.writeConcernMax(),
err => {
expect(err).to.be.an.instanceof(Error);
expect(err.message).to.equal("key .hello must not contain '.'");

collection.insertOne(
{ 'hello.': 'world' },
configuration.writeConcernMax(),
err => {
expect(err).to.be.an.instanceof(Error);
expect(err.message).to.equal(
"key hello. must not contain '.'"
);

collection.insertOne(
{ hello: { 'hello.': 'world' } },
configuration.writeConcernMax(),
err => {
expect(err).to.be.an.instanceof(Error);
expect(err.message).to.equal(
"key hello. must not contain '.'"
);
// Let's close the db
done();
}
);
}
);
}
);
}
);
}
);
}
);
}
);
});
}
);
});
});

it('should permit insert of dot and dollar keys if requested', function () {
const collection = db.collection('test_invalid_key_names');
return Promise.all([
Expand Down
28 changes: 0 additions & 28 deletions test/functional/insert.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -900,34 +900,6 @@ describe('Insert', function () {
}
});

it('Should fail on insert due to key starting with $', {
// Add a tag that our runner can trigger on
// in this case we are setting that node needs to be higher than 0.10.X to run
metadata: {
requires: { topology: ['single', 'replicaset', 'sharded', 'ssl', 'heap', 'wiredtiger'] }
},

test: function (done) {
var configuration = this.configuration;
var doc = {
_id: new ObjectId('4e886e687ff7ef5e00000162'),
$key: 'foreign'
};

var client = configuration.newClient(configuration.writeConcernMax(), { maxPoolSize: 1 });
client.connect(function (err, client) {
var db = client.db(configuration.db);
var collection = db.collection('Should_fail_on_insert_due_to_key_starting_with');
collection.insert(doc, configuration.writeConcernMax(), function (err, result) {
test.ok(err != null);
expect(result).to.not.exist;

client.close(done);
});
});
}
});

it('Should Correctly allow for control of serialization of functions on command level', {
// Add a tag that our runner can trigger on
// in this case we are setting that node needs to be higher than 0.10.X to run
Expand Down
2 changes: 1 addition & 1 deletion test/functional/unified-spec-runner/operations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ operations.set('find', async ({ entities, operation }) => {
operations.set('findOneAndReplace', async ({ entities, operation }) => {
const collection = entities.getEntity('collection', operation.object);
const { filter, replacement, ...opts } = operation.arguments;
return collection.findOneAndReplace(filter, replacement, translateOptions(opts));
return (await collection.findOneAndReplace(filter, replacement, translateOptions(opts))).value;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This matches what findOneAndUpdate does below

});

operations.set('findOneAndUpdate', async ({ entities, operation }) => {
Expand Down
2 changes: 1 addition & 1 deletion test/functional/unified-spec-runner/runner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ export async function runUnifiedTest(

expect(documents).to.have.lengthOf(collectionData.documents.length);
for (const [expected, actual] of zip(collectionData.documents, documents)) {
expect(actual).to.include(expected, 'Test outcome did not match expected');
expect(actual).to.deep.include(expected);
}
}
}
Expand Down
Loading