From 0fd310124e460af44db9767f423ed100ec41f1e4 Mon Sep 17 00:00:00 2001 From: Meglali20 <56823121+Meglali20@users.noreply.github.com> Date: Mon, 19 Feb 2024 11:22:07 +0100 Subject: [PATCH 1/5] Initial commit to add comment to a query --- spec/ParseQuery.Comment.spec.js | 40 +++++++++++++++++++ src/Adapters/Storage/Mongo/MongoCollection.js | 36 ++++++++++++++--- .../Storage/Mongo/MongoStorageAdapter.js | 21 ++++++++-- src/Adapters/Storage/StorageAdapter.js | 7 +++- src/Controllers/DatabaseController.js | 8 +++- src/RestQuery.js | 1 + src/Routers/AggregateRouter.js | 4 ++ src/Routers/ClassesRouter.js | 4 ++ src/triggers.js | 4 ++ 9 files changed, 113 insertions(+), 12 deletions(-) create mode 100644 spec/ParseQuery.Comment.spec.js diff --git a/spec/ParseQuery.Comment.spec.js b/spec/ParseQuery.Comment.spec.js new file mode 100644 index 0000000000..1cbdab10f4 --- /dev/null +++ b/spec/ParseQuery.Comment.spec.js @@ -0,0 +1,40 @@ +'use strict'; + +const Config = require('../lib/Config'); +const TestUtils = require('../lib/TestUtils'); +const { MongoClient } = require('mongodb'); +const databaseURI = 'mongodb://localhost:27017/'; + +let config, client, database; + +describe_only_db('mongo')('Parse.Query testing', () => { + beforeEach(async () => { + config = Config.get('test'); + client = await MongoClient.connect(databaseURI, { + useNewUrlParser: true, + useUnifiedTopology: true, + }); + database = client.db('parseServerMongoAdapterTestDatabase'); + const level = 2; + const profiling = await database.command({ profile: level }); + console.log(`profiling ${JSON.stringify(profiling)}`); + }); + + afterEach(async () => { + await client.close(); + await TestUtils.destroyAllDataPermanently(false); + }); + it('send comment with query', async () => { + const object = new TestObject(); + object.set('name', 'object'); + const comment = 'comment'; + await object.save(); + + const collection = await config.database.adapter._adaptiveCollection('TestObject'); + + await collection._rawFind({ name: 'object' }, { comment: comment }); + + const result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); + expect(result.command.comment).toBe(comment); + }); +}); diff --git a/src/Adapters/Storage/Mongo/MongoCollection.js b/src/Adapters/Storage/Mongo/MongoCollection.js index 48de677c2e..4f02c5c8fa 100644 --- a/src/Adapters/Storage/Mongo/MongoCollection.js +++ b/src/Adapters/Storage/Mongo/MongoCollection.js @@ -15,7 +15,18 @@ export default class MongoCollection { // idea. Or even if this behavior is a good idea. find( query, - { skip, limit, sort, keys, maxTimeMS, readPreference, hint, caseInsensitive, explain } = {} + { + skip, + limit, + sort, + keys, + maxTimeMS, + readPreference, + hint, + caseInsensitive, + explain, + comment, + } = {} ) { // Support for Full Text Search - $text if (keys && keys.$score) { @@ -32,6 +43,7 @@ export default class MongoCollection { hint, caseInsensitive, explain, + comment, }).catch(error => { // Check for "no geoindex" error if (error.code != 17007 && !error.message.match(/unable to find index for .geoNear/)) { @@ -60,6 +72,7 @@ export default class MongoCollection { hint, caseInsensitive, explain, + comment, }) ) ); @@ -75,7 +88,18 @@ export default class MongoCollection { _rawFind( query, - { skip, limit, sort, keys, maxTimeMS, readPreference, hint, caseInsensitive, explain } = {} + { + skip, + limit, + sort, + keys, + maxTimeMS, + readPreference, + hint, + caseInsensitive, + explain, + comment, + } = {} ) { let findOperation = this._mongoCollection.find(query, { skip, @@ -83,6 +107,7 @@ export default class MongoCollection { sort, readPreference, hint, + comment, }); if (keys) { @@ -100,7 +125,7 @@ export default class MongoCollection { return explain ? findOperation.explain(explain) : findOperation.toArray(); } - count(query, { skip, limit, sort, maxTimeMS, readPreference, hint } = {}) { + count(query, { skip, limit, sort, maxTimeMS, readPreference, hint, comment } = {}) { // If query is empty, then use estimatedDocumentCount instead. // This is due to countDocuments performing a scan, // which greatly increases execution time when being run on large collections. @@ -118,6 +143,7 @@ export default class MongoCollection { maxTimeMS, readPreference, hint, + comment, }); return countOperation; @@ -127,9 +153,9 @@ export default class MongoCollection { return this._mongoCollection.distinct(field, query); } - aggregate(pipeline, { maxTimeMS, readPreference, hint, explain } = {}) { + aggregate(pipeline, { maxTimeMS, readPreference, hint, explain, comment } = {}) { return this._mongoCollection - .aggregate(pipeline, { maxTimeMS, readPreference, hint, explain }) + .aggregate(pipeline, { maxTimeMS, readPreference, hint, explain, comment }) .toArray(); } diff --git a/src/Adapters/Storage/Mongo/MongoStorageAdapter.js b/src/Adapters/Storage/Mongo/MongoStorageAdapter.js index 53d1bc4959..03065af8ff 100644 --- a/src/Adapters/Storage/Mongo/MongoStorageAdapter.js +++ b/src/Adapters/Storage/Mongo/MongoStorageAdapter.js @@ -603,7 +603,17 @@ export class MongoStorageAdapter implements StorageAdapter { className: string, schema: SchemaType, query: QueryType, - { skip, limit, sort, keys, readPreference, hint, caseInsensitive, explain }: QueryOptions + { + skip, + limit, + sort, + keys, + readPreference, + hint, + caseInsensitive, + explain, + comment, + }: QueryOptions ): Promise { validateExplainValue(explain); schema = convertParseSchemaToMongoSchema(schema); @@ -646,6 +656,7 @@ export class MongoStorageAdapter implements StorageAdapter { hint, caseInsensitive, explain, + comment, }) ) .then(objects => { @@ -735,7 +746,8 @@ export class MongoStorageAdapter implements StorageAdapter { schema: SchemaType, query: QueryType, readPreference: ?string, - hint: ?mixed + hint: ?mixed, + comment: ?string ) { schema = convertParseSchemaToMongoSchema(schema); readPreference = this._parseReadPreference(readPreference); @@ -745,6 +757,7 @@ export class MongoStorageAdapter implements StorageAdapter { maxTimeMS: this._maxTimeMS, readPreference, hint, + comment, }) ) .catch(err => this.handleError(err)); @@ -777,7 +790,8 @@ export class MongoStorageAdapter implements StorageAdapter { pipeline: any, readPreference: ?string, hint: ?mixed, - explain?: boolean + explain?: boolean, + comment: ?string ) { validateExplainValue(explain); let isPointerField = false; @@ -811,6 +825,7 @@ export class MongoStorageAdapter implements StorageAdapter { maxTimeMS: this._maxTimeMS, hint, explain, + comment, }) ) .then(results => { diff --git a/src/Adapters/Storage/StorageAdapter.js b/src/Adapters/Storage/StorageAdapter.js index 7605784a43..d25c9753c0 100644 --- a/src/Adapters/Storage/StorageAdapter.js +++ b/src/Adapters/Storage/StorageAdapter.js @@ -19,6 +19,7 @@ export type QueryOptions = { caseInsensitive?: boolean, action?: string, addsField?: boolean, + comment?: string, }; export type UpdateQueryOptions = { @@ -97,7 +98,8 @@ export interface StorageAdapter { query: QueryType, readPreference?: string, estimate?: boolean, - hint?: mixed + hint?: mixed, + comment?: string ): Promise; distinct( className: string, @@ -111,7 +113,8 @@ export interface StorageAdapter { pipeline: any, readPreference: ?string, hint: ?mixed, - explain?: boolean + explain?: boolean, + comment?: string ): Promise; performInitialization(options: ?any): Promise; watch(callback: () => void): void; diff --git a/src/Controllers/DatabaseController.js b/src/Controllers/DatabaseController.js index 5975e94053..c5c3d1ab05 100644 --- a/src/Controllers/DatabaseController.js +++ b/src/Controllers/DatabaseController.js @@ -1188,6 +1188,7 @@ class DatabaseController { hint, caseInsensitive = false, explain, + comment, }: any = {}, auth: any = {}, validSchemaController: SchemaController.SchemaController @@ -1237,6 +1238,7 @@ class DatabaseController { hint, caseInsensitive: this.options.enableCollationCaseComparison ? false : caseInsensitive, explain, + comment, }; Object.keys(sort).forEach(fieldName => { if (fieldName.match(/^authData\.([a-zA-Z0-9_]+)\.id$/)) { @@ -1306,7 +1308,8 @@ class DatabaseController { query, readPreference, undefined, - hint + hint, + comment ); } } else if (distinct) { @@ -1325,7 +1328,8 @@ class DatabaseController { pipeline, readPreference, hint, - explain + explain, + comment ); } } else if (explain) { diff --git a/src/RestQuery.js b/src/RestQuery.js index 5af678bb96..57fc435526 100644 --- a/src/RestQuery.js +++ b/src/RestQuery.js @@ -212,6 +212,7 @@ function _UnsafeRestQuery( case 'skip': case 'limit': case 'readPreference': + case 'comment': this.findOptions[option] = restOptions[option]; break; case 'order': diff --git a/src/Routers/AggregateRouter.js b/src/Routers/AggregateRouter.js index c69c9c40ca..f8bca7fd65 100644 --- a/src/Routers/AggregateRouter.js +++ b/src/Routers/AggregateRouter.js @@ -19,6 +19,10 @@ export class AggregateRouter extends ClassesRouter { options.explain = body.explain; delete body.explain; } + if (body.comment) { + options.comment = body.comment; + delete body.comment; + } if (body.readPreference) { options.readPreference = body.readPreference; delete body.readPreference; diff --git a/src/Routers/ClassesRouter.js b/src/Routers/ClassesRouter.js index 5dfba97ee0..0a68e25254 100644 --- a/src/Routers/ClassesRouter.js +++ b/src/Routers/ClassesRouter.js @@ -166,6 +166,7 @@ export class ClassesRouter extends PromiseRouter { 'subqueryReadPreference', 'hint', 'explain', + 'comment', ]; for (const key of Object.keys(body)) { @@ -215,6 +216,9 @@ export class ClassesRouter extends PromiseRouter { if (body.explain) { options.explain = body.explain; } + if (body.comment && typeof body.comment === 'string') { + options.comment = body.comment; + } return options; } diff --git a/src/triggers.js b/src/triggers.js index 5c4755af54..bfebde2e83 100644 --- a/src/triggers.js +++ b/src/triggers.js @@ -576,6 +576,10 @@ export function maybeRunQueryTrigger( restOptions = restOptions || {}; restOptions.hint = jsonQuery.hint; } + if (jsonQuery.comment) { + restOptions = restOptions || {}; + restOptions.comment = jsonQuery.comment; + } if (requestObject.readPreference) { restOptions = restOptions || {}; restOptions.readPreference = requestObject.readPreference; From b7d3e559b41ad62aeba1c840ceeb1d0a35a9e3fd Mon Sep 17 00:00:00 2001 From: Meglali20 <56823121+Meglali20@users.noreply.github.com> Date: Tue, 20 Feb 2024 12:17:58 +0100 Subject: [PATCH 2/5] added more tests --- spec/ParseQuery.Comment.spec.js | 67 +++++++++++++++++++++++++++++++-- 1 file changed, 63 insertions(+), 4 deletions(-) diff --git a/spec/ParseQuery.Comment.spec.js b/spec/ParseQuery.Comment.spec.js index 1cbdab10f4..01f241b1b6 100644 --- a/spec/ParseQuery.Comment.spec.js +++ b/spec/ParseQuery.Comment.spec.js @@ -4,10 +4,23 @@ const Config = require('../lib/Config'); const TestUtils = require('../lib/TestUtils'); const { MongoClient } = require('mongodb'); const databaseURI = 'mongodb://localhost:27017/'; +const request = require('../lib/request'); let config, client, database; -describe_only_db('mongo')('Parse.Query testing', () => { +const masterKeyHeaders = { + 'X-Parse-Application-Id': 'test', + 'X-Parse-Rest-API-Key': 'rest', + 'X-Parse-Master-Key': 'test', + 'Content-Type': 'application/json', +}; + +const masterKeyOptions = { + headers: masterKeyHeaders, + json: true, +}; + +describe_only_db('mongo')('Parse.Query with comment testing', () => { beforeEach(async () => { config = Config.get('test'); client = await MongoClient.connect(databaseURI, { @@ -24,17 +37,63 @@ describe_only_db('mongo')('Parse.Query testing', () => { await client.close(); await TestUtils.destroyAllDataPermanently(false); }); + + it('send comment with query through REST', async () => { + const comment = 'Hello Parse'; + const options = Object.assign({}, masterKeyOptions, { + url: Parse.serverURL + '/classes/TestObject', + qs: { + explain: true, + comment: comment, + }, + }); + const response = await request(options); + let result = response.data.results; + expect(result.command.comment).toBe(comment); + result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); + expect(result.command.comment).toBe(comment); + }); + it('send comment with query', async () => { + const comment = 'Hello Parse'; const object = new TestObject(); object.set('name', 'object'); - const comment = 'comment'; await object.save(); - const collection = await config.database.adapter._adaptiveCollection('TestObject'); - await collection._rawFind({ name: 'object' }, { comment: comment }); + const result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); + expect(result.command.comment).toBe(comment); + }); + it('send a comment with a count query', async () => { + const comment = 'Hello Parse'; + const object = new TestObject(); + object.set('name', 'object'); + await object.save(); + + const object2 = new TestObject(); + object2.set('name', 'object'); + await object2.save(); + + const collection = await config.database.adapter._adaptiveCollection('TestObject'); + const countResult = await collection.count({ name: 'object' }, { comment: comment }); + expect(countResult).toEqual(2); const result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); expect(result.command.comment).toBe(comment); }); + + it('attach a comment to an aggregation', async () => { + const comment = 'Hello Parse'; + const object = new TestObject(); + object.set('name', 'object'); + await object.save(); + const collection = await config.database.adapter._adaptiveCollection('TestObject'); + let result = await collection.aggregate([{ $group: { _id: '$name' } }], { + explain: true, + comment: comment, + }); + expect(result[0].command.comment).toBe(comment); + result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); + expect(result.command.comment).toBe(comment); + }); }); From d95e64ee60ca2519c4b7e7d7156e0202189952a4 Mon Sep 17 00:00:00 2001 From: Meglali20 <56823121+Meglali20@users.noreply.github.com> Date: Wed, 21 Feb 2024 12:34:17 +0100 Subject: [PATCH 3/5] fixed test for different mongoDb versions --- spec/ParseQuery.Comment.spec.js | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/spec/ParseQuery.Comment.spec.js b/spec/ParseQuery.Comment.spec.js index 01f241b1b6..c61c8c09c4 100644 --- a/spec/ParseQuery.Comment.spec.js +++ b/spec/ParseQuery.Comment.spec.js @@ -40,6 +40,9 @@ describe_only_db('mongo')('Parse.Query with comment testing', () => { it('send comment with query through REST', async () => { const comment = 'Hello Parse'; + const object = new TestObject(); + object.set('name', 'object'); + await object.save(); const options = Object.assign({}, masterKeyOptions, { url: Parse.serverURL + '/classes/TestObject', qs: { @@ -47,11 +50,9 @@ describe_only_db('mongo')('Parse.Query with comment testing', () => { comment: comment, }, }); - const response = await request(options); - let result = response.data.results; - expect(result.command.comment).toBe(comment); - result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); - expect(result.command.comment).toBe(comment); + await request(options); + const result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); + expect(result.command.explain.comment).toBe(comment); }); it('send comment with query', async () => { @@ -88,12 +89,11 @@ describe_only_db('mongo')('Parse.Query with comment testing', () => { object.set('name', 'object'); await object.save(); const collection = await config.database.adapter._adaptiveCollection('TestObject'); - let result = await collection.aggregate([{ $group: { _id: '$name' } }], { + await collection.aggregate([{ $group: { _id: '$name' } }], { explain: true, comment: comment, }); - expect(result[0].command.comment).toBe(comment); - result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); - expect(result.command.comment).toBe(comment); + const result = await database.collection('system.profile').findOne({}, { sort: { ts: -1 } }); + expect(result.command.explain.comment).toBe(comment); }); }); From ffcd8d041019052a8f9f4805fd22ca90640b691d Mon Sep 17 00:00:00 2001 From: Meglali20 <56823121+Meglali20@users.noreply.github.com> Date: Sat, 24 Feb 2024 12:25:04 +0100 Subject: [PATCH 4/5] Fix failing lint check --- src/Adapters/Storage/Mongo/MongoStorageAdapter.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Adapters/Storage/Mongo/MongoStorageAdapter.js b/src/Adapters/Storage/Mongo/MongoStorageAdapter.js index 03065af8ff..e9d49b2ecf 100644 --- a/src/Adapters/Storage/Mongo/MongoStorageAdapter.js +++ b/src/Adapters/Storage/Mongo/MongoStorageAdapter.js @@ -746,6 +746,7 @@ export class MongoStorageAdapter implements StorageAdapter { schema: SchemaType, query: QueryType, readPreference: ?string, + _estimate: ?boolean, hint: ?mixed, comment: ?string ) { From a962a486754daed3401412f4e01a5784911e13b4 Mon Sep 17 00:00:00 2001 From: Meglali20 <56823121+Meglali20@users.noreply.github.com> Date: Thu, 14 Mar 2024 16:42:24 +0100 Subject: [PATCH 5/5] Updated tests to work only if profiler is enabled --- spec/ParseQuery.Comment.spec.js | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/spec/ParseQuery.Comment.spec.js b/spec/ParseQuery.Comment.spec.js index c61c8c09c4..12713387a0 100644 --- a/spec/ParseQuery.Comment.spec.js +++ b/spec/ParseQuery.Comment.spec.js @@ -1,7 +1,6 @@ 'use strict'; const Config = require('../lib/Config'); -const TestUtils = require('../lib/TestUtils'); const { MongoClient } = require('mongodb'); const databaseURI = 'mongodb://localhost:27017/'; const request = require('../lib/request'); @@ -20,22 +19,33 @@ const masterKeyOptions = { json: true, }; +const profileLevel = 2; describe_only_db('mongo')('Parse.Query with comment testing', () => { - beforeEach(async () => { + beforeAll(async () => { config = Config.get('test'); client = await MongoClient.connect(databaseURI, { useNewUrlParser: true, useUnifiedTopology: true, }); database = client.db('parseServerMongoAdapterTestDatabase'); - const level = 2; - const profiling = await database.command({ profile: level }); - console.log(`profiling ${JSON.stringify(profiling)}`); + let profiler = await database.command({ profile: 0 }); + expect(profiler.was).toEqual(0); + console.log(`Disabling profiler : ${profiler.was}`); + profiler = await database.command({ profile: profileLevel }); + profiler = await database.command({ profile: -1 }); + console.log(`Enabling profiler : ${profiler.was}`); + profiler = await database.command({ profile: -1 }); + expect(profiler.was).toEqual(profileLevel); + }); + + beforeEach(async () => { + const profiler = await database.command({ profile: -1 }); + expect(profiler.was).toEqual(profileLevel); }); - afterEach(async () => { + afterAll(async () => { + await database.command({ profile: 0 }); await client.close(); - await TestUtils.destroyAllDataPermanently(false); }); it('send comment with query through REST', async () => {