feat: Add support for MongoDB $search operator

[dblythy]

Pull Request

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

Issue

Closes: #1989

Approach

Adds ability to use Mongodb atlas search

Tasks

[parse-github-assistant]

🚀 Thanks for opening this pull request!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (44eeacd) to head (4c7291b).
Report is 1 commits behind head on alpha.

Additional details and impacted files

@@            Coverage Diff            @@
##             alpha     #2526   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           64        64           
  Lines         6244      6258   +14     
  Branches      1468      1456   -12     
=========================================
+ Hits          6244      6258   +14     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[dplewis]

@dblythy I fixed the merge conflicts, can you improve code coverage?

[dplewis]

For consistency we should rename value to query and it should allow for string | string[]. This should be good enough for a simple search. We can add regex, allowAnalyzedField, and score options later or now if you prefer. For more advanced searching like compound the developer would have to use query.aggregate.

Edit: There is a empty line above that should be removed

[mtrezza]

Why has this been added as a new API? I think just allowing the $search op in the aggregation pipeline would be enough?

[dplewis]

@mtrezza I just tried it with the aggregate pipeline and it works. I think this can be closed, no need to add new api.

[mtrezza]

The issue objective was to add support for $search and $searchMeta to the aggregation pipeline. If I'm not mistaken, either the JS SDK or Parse Server are validating the aggregation pipeline stages, i.e. only the keys, not their values. If that already works, then either the key validation feature has been removed in the meantime, or the stage names are already supported. We should find out why this seems to work, to ensure that it really works.

[dplewis]

The stage check was removed parse-community/parse-server#7237

Ironically it was because somebody wanted to use $search lol

[mtrezza]

Ha! Even in PS5 already. Are we sure there there is not further validation in the JS SDK for example? The added test looks suspicious. I would rather see a test that uses Parse.Query.aggregate to go through the JS SDK. Even though $search is no supported by mongodb-runner, but we could test the error, or mock and inspect what's sent to the driver. I think this PR should be changed to add such a test if none exists yet for $search, otherwise I agree that it can be closed.

[dplewis]

You opened #1989 did you test that it wasn't supported.

[mtrezza]

That was 2 years ago, but I believe to vaguely remember that I wanted to use it and it didn't work. But maybe it was an older version of Parse Server, or maybe there has been a bug fix in the meantime, hard to tell now. I think by adding a test we can close this issue.

[dplewis]

If you want to do a test then it should be done on the server since there is access to the driver. This isn't an SDK issue.

[mtrezza]

We don't know whether it's an SDK issue, until we do an integration test, right? I think it make sense to add a test in either repo, that's unfortunately the situation we're in with the JS SDK being part of Parse Server.

[dplewis]

I know it’s not an SDK issue because I tested it on my machine, also any aggregate pipeline gets passed to the server regardless of the stages. A good test is the error thrown if MongoDB is used without atlas search

[dblythy]

Just an FYI that I use mongodb atlas search myself on my own servers:

const pipeline = [
        {
          $search: {
            index: "default",
            text: {
              path: ["name"],
              query: search,
            },
          },
        },
        { $match: { approved: true, mode: user.get("mode"), published: true } },
        { $limit: 100 },
      ];
      const response = await new Parse.Query(Business).aggregate(pipeline as any);

And it works great

[mtrezza]

Then I'm not sure why this PR was opened in the first place. The issue was that $search and $searchMeta should be supported in the aggregation pipeline. Since it's already supported, the issue should simply have been closed.

[dplewis]

Then I'm not sure why this PR was opened in the first place.

Because somebody opened a feature request for a feature that already exist and let it stay open a year and a half. Thankfully we found 2 bugs because of this PR.