fix: Parse.Query.distinct fails due to invalid aggregate stage 'hint'

[Chilldev]

Pull Request

• Report security issues confidentially.
• Any contribution is under this license.
• Link this pull request to an issue.

Issue

Closes: #8804

Approach

When directAccess is set to true and a distinct query is made within an eachBatch query an Error: Invalid aggregate stage 'hint'. is thrown.

Tasks

• Add tests

[parse-github-assistant]

Thanks for opening this pull request!

[mtrezza]

So this test looks good, we just need to the fix for it.

[mtrezza]

Interesting, could you explain the last commit?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.48%. Comparing base (dfd5a8e) to head (e654b92).
Report is 4 commits behind head on alpha.

Additional details and impacted files

@@           Coverage Diff           @@
##            alpha    #9295   +/-   ##
=======================================
  Coverage   93.48%   93.48%           
=======================================
  Files         186      186           
  Lines       14811    14812    +1     
=======================================
+ Hits        13846    13847    +1     
  Misses        965      965           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Chilldev]

Interesting, could you explain the last commit?

What happens is the Parse JS SDK sends the data directly to the AggregateRouter without it being sent over http (which removes undefined properties from the request). It has code where it sets hint with value undefined to query body by default.

So when that check is made it doesn't pass as hint is undefined and the property is never deleted from the object.

When it goes to the aggregatePipeline it finds it on the body and throws an error.

What I did was checking if the object has that property to make sure it gets deleted wether it has value or not and assign that property to the options object only if it's truthy.

https://github.com/parse-community/Parse-SDK-JS/blob/alpha/src%2FParseQuery.ts#L820-L827

[mtrezza]

Does that mean that we missed something in d0d30c4? I mean is this PR treating merely the symptom, or is it the actual root cause that gets fixed?

[Chilldev]

Does that mean that we missed something in d0d30c4? I mean is this PR treating merely the symptom, or is it the actual root cause that gets fixed?

Nothing is missing getPipeline handles it.
And hint is expected to be provided that way for the query options.

parse-server/src/Adapters/Storage/Mongo/MongoCollection.js

Lines 16 to 47 in dfd5a8e

	find(
	query,
	{
	skip,
	limit,
	sort,
	keys,
	maxTimeMS,
	readPreference,
	hint,
	caseInsensitive,
	explain,
	comment,
	} = {}
	) {
	// Support for Full Text Search - $text
	if (keys && keys.$score) {
	delete keys.$score;
	keys.score = { $meta: 'textScore' };
	}
	return this._rawFind(query, {
	skip,
	limit,
	sort,
	keys,
	maxTimeMS,
	readPreference,
	hint,
	caseInsensitive,
	explain,
	comment,
	}).catch(error => {

parse-server/src/Adapters/Storage/Mongo/MongoCollection.js

Lines 89 to 111 in dfd5a8e

	_rawFind(
	query,
	{
	skip,
	limit,
	sort,
	keys,
	maxTimeMS,
	readPreference,
	hint,
	caseInsensitive,
	explain,
	comment,
	} = {}
	) {
	let findOperation = this._mongoCollection.find(query, {
	skip,
	limit,
	sort,
	readPreference,
	hint,
	comment,
	});

[parseplatformorg]

🎉 This change has been released in version 7.4.0-alpha.4