1797620 - Create modular framework for adding use case specific search endpoints to the BMO API

Status: RESOLVED FIXED

(bugzilla.mozilla.org :: API, enhancement)

Description

[David Lawrence [:dkl]]

We get requests from time to time to update Search internally in BMO to support specific search use cases for retrieving data from the DB. BMO search is coded (broken) in a way that makes it non-trivial to update to support the types of searches that users expect.

Something we discussed doing is create a drop in modular framework that uses direct SQL to get data for users and their specific data needs. Each module will create a specific API endpoint that takes parameters that can be plugged into the SQL as needed. When a new module is dropped in, it will automatically become available. We do something similar for bug field changes in the MozChangeField extension already.

extensions/MozSearchAPI
extensions/MozSearchAPI/Config.pm
extensions/MozSearchAPI/Extension.pm
extensions/MozSearchAPI/lib
extensions/MozSearchAPI/lib/SomeSpecificSearch.pm

This will map to /rest/moz_search/some_specific_search?param1=foo&param2=bar.

The matching bugs will be filtered before returning based on current user permissions and fields will match the normal bug search API and can also be filtered.

Comment 1

[:glob ✱]

Lets drop the Moz prefix from all of these please; it's redundant.

Comment 2

[:glob ✱]

My thinking around params was we'd require named placeholders in the SQL that would map directly to params.

Sadly DBD::mysql doesn't actually support named placeholders, but it should be easy to implement (eg. replace :name with ? and control the order of unnamed placeholder values).

Comment 3

[BMO Github Automation]

Attachment: [mozilla-bteam/bmo] Bug 1797620 - Create modular framework for adding use case specific search endpoints to the BMO API (#2082)

Comment 4

[David Lawrence [:dkl]]

Merged
https://github.com/mozilla-bteam/bmo/commit/617b0ebb46c3cefa3d3844f3e6dd7414f4dd7632