feat(marketplace): add optional sorting, filtering, pagination to marketplace api

[its-mitesh-kumar]

Hey, I just made a Pull Request!

✔️ Checklist

• A changeset describing the change and affected packages. (more info)
• Added or Updated documentation
• Tests for new functionality and regression tests for bug fixes
• Screenshots attached (for UI changes)

[rhdh-gh-app]

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@red-hat-developer-hub/backstage-plugin-marketplace-backend	workspaces/marketplace/plugins/marketplace-backend	patch	v0.0.7
@red-hat-developer-hub/backstage-plugin-marketplace-common	workspaces/marketplace/plugins/marketplace-common	patch	v0.0.7
@red-hat-developer-hub/backstage-plugin-marketplace	workspaces/marketplace/plugins/marketplace	patch	v0.0.7

[its-mitesh-kumar]

Resolves : https://issues.redhat.com/browse/RHIDP-5329
@christoph-jerolimov Can you have a look into this PR , I can update unit test once you confirm the functionality changes seems good to you .

[christoph-jerolimov]

Thanks! As discussed some improvement ideas :)

[its-mitesh-kumar]

@karthikjeeyar @christoph-jerolimov I have implemented like
We can encode complex query parameter like fullTextFilter , filter and orderFields in frontend and decode it in the backend. Encoding in frontend can be like this . Let me know with this approach we may have any problem .

let search = {
  term: "Backstage",
  fields: ["metadata.description"], // mutiple fields we can add 
}
let orderFields = {
  field: "metadata.name",
  order: "asc",
} // can be array of object also in case of multiple fields
let filter = {
  "spec.type": "backend-plugin",
  "metadata.name": "search",
}
filter= encodeURIComponent(JSON.stringify(filter))
search=encodeURIComponent(JSON.stringify(search))
orderFields=encodeURIComponent(JSON.stringify(orderFields))
const endpoint=`${baseUrl}?fullTextFilter=${search}&filter=${filter}&orderFields=${orderFields}&limit=10&offset=10`

[karthikjeeyar]

You could reuse decodeFilterParams from /utils/decodeQueryParams.ts here.

[karthikjeeyar]

I think it will be good to extend the generic encodeQueryParams function to handle more fields, Instead of having it's own version for GetPluginsRequest. This way we can reuse the function for other API like PluginLists, Packages etc.

[christoph-jerolimov]

Small type questions for now. We should also align that with the other utils. But its a good start so far. Please add unit tests for all utils.

[christoph-jerolimov]

Don't know if this is needed. But please start consts with lower case characters.

[its-mitesh-kumar]

Have changed into lower case . Since we want to get plugins by default we need to pass { kind: 'plugin' } , in queryEntities . I wanted to get only 20 results by default .

[christoph-jerolimov]

Without a default limit it will return all entities? Let us not have a limit for now since the UI doesn't support pagination at the moment.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.7% Duplication on New Code

See analysis details on SonarQube Cloud