feat(registry/ui): filters #607
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This middleware is used to enable strongly typed filters in the request. Additionally, the filters object is guaranteed to be valid, otherwise 400 is returned.
Also, add domainId filter parameter to /api/v1/app route.
Also, add domainId filter parameter to /api/v1/template route.
blackrabbit99
requested changes
Sep 24, 2024
| ListBulkActions, | ||
| ListActionsToolbar, | ||
| } from '../components'; | ||
| import { Datagrid, List, SimpleList, TextField, EditButton, FunctionField } from 'react-admin'; // eslint-disable-line import/no-unresolved |
There was a problem hiding this comment.
please avoid import/no-unresolved looks scary.
There was a problem hiding this comment.
Sure, done. ✅
BTW, i don't see any eslint-related checks in the repo 🤔
| @@ -23,6 +39,24 @@ const getApps = async (req: Request, res: Response): Promise<void> => { | |||
| if (filters.q) { | |||
| query.where('name', 'like', `%${filters.q}%`); | |||
| } | |||
| if (filters.domainId) { | |||
| if (filters.domainId === 'null') { | |||
| query.whereNotExists(function () { | |||
There was a problem hiding this comment.
Could you please move the code to the service because it is hard to read it.
stas-nc
reviewed
Sep 24, 2024
| @@ -23,6 +39,24 @@ const getApps = async (req: Request, res: Response): Promise<void> => { | |||
| if (filters.q) { | |||
| query.where('name', 'like', `%${filters.q}%`); | |||
| } | |||
| if (filters.domainId) { | |||
There was a problem hiding this comment.
Could you please add a test involving these queries (if it's not exits yet).
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
stas-nc
reviewed
Sep 24, 2024
| `${Tables.Templates}.*`, | ||
| ]); | ||
|
|
||
| if (req.filters?.domainId) { |
There was a problem hiding this comment.
Could you please add a test involving these queries (if it's not exits yet).
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
stas-nc
reviewed
Sep 24, 2024
| const query = db | ||
| .selectVersionedRows(Tables.SharedLibs, 'name', EntityTypes.shared_libs, [`${Tables.SharedLibs}.*`]) | ||
| .from(Tables.SharedLibs); | ||
|
|
||
| if (req.filters?.name) { |
There was a problem hiding this comment.
Could you please add a test involving these queries (if it's not exits yet).
wRLSS
reviewed
Sep 26, 2024
| try { | ||
| // create apps | ||
| for (const app of example.appsList) { | ||
| await req.post(example.url).send(app).expect(200); |
There was a problem hiding this comment.
Tbh I'm not a big fan of having manual creation explicitly in tests where its required, in this way we reduce test quality by
- testing things that are not the part of the case - creation, deletion, instead of filtering
- reducing tests speed which is a metric by itself.
I'm ok with approach for now cause there where no tests at all for this part of functionality, but I'd prefer fixtures preloading for filters instead.
| empty={<Empty />} | ||
| > | ||
| {isSmall ? ( | ||
| <SimpleList | ||
| primaryText={record => `@sharedLibrary/${record.name}`} | ||
| secondaryText={record => record.spaBundle} | ||
| primaryText={(record) => `@sharedLibrary/${record.name}`} |
There was a problem hiding this comment.
I suggest isolating this part into some function, its used multiple times
/@sharedLibrary/${record.name}
There was a problem hiding this comment.
As I am new to this project, I don't know the purpose of this prefixing, so I have no better idea than calling it getPrefixedSharedLibName(name: string): string or smth like this.
|
|
||
| useEffect(() => { | ||
| dataProvider | ||
| .getList('router_domains', { |
There was a problem hiding this comment.
(minor) introduce new method inside dataProvider in order to simplify call with these parameters? getFullList or smth
pagination: false,
sort: false,
filter: false,
| const query = db | ||
| .selectVersionedRows(Tables.SharedLibs, 'name', EntityTypes.shared_libs, [`${Tables.SharedLibs}.*`]) | ||
| .from(Tables.SharedLibs); | ||
|
|
||
| if (req.filters?.name) { | ||
| query.whereILike('name', `%${req.filters.name}%`); |
There was a problem hiding this comment.
just double-checking, does it correctly partially matches with the beginning of the string?
There was a problem hiding this comment.
From MySQL docs:
SQL pattern matching enables you to use _ to match any single character and % to match an arbitrary number of characters (including zero characters).
PostgreSQL and SQLite docs describe the same behavior.
Covered with tests too.
| if (req.filters?.id || req.filters?.name) { | ||
| const name = req.filters?.name ?? req.filters?.id; | ||
| ok(name); | ||
| const normalizedNames = Array.isArray(name) ? name : [name]; |
There was a problem hiding this comment.
(nit) slightly simpler
const normalizedNames = [].concat(name);
There was a problem hiding this comment.
In TS it becomes:
const normalizedName = ([] as string[]).concat(name)But I still prefer the more literal way over the shorter one for its readability.
wRLSS
reviewed
Sep 26, 2024
| query.whereIn('name', normalizedNames); | ||
| } | ||
|
|
||
| if (req.filters?.domainId) { |
There was a problem hiding this comment.
matching for template500 seems to happen multiple times, utilize some constant for that?
There was a problem hiding this comment.
It's a field name, just like "name" or "domainId". If we put it into constant, we will need to do the same for the rest of the fields, just like we do for tables.
blackrabbit99
previously requested changes
Sep 26, 2024
Also: - fix(registry/client): unhardcode `@sharedLibrary/` prefix
…ository Also: - refactor: convert the templatesRepository to a class - refactor: pre-initialize all my repositories in the bootstrap phase - feat: introduce normalizeArray utility function
| res.status(200).send(itemsWithId); | ||
| const getTemplates = async (req: RequestWithFilters<TemplatesGetListFilters>, res: Response): Promise<void> => { | ||
| const { data, pagination } = await templatesRepository.getList(req.filters ?? {}); | ||
| res.setHeader('Content-Range', pagination.total); //Stub for future pagination capabilities |
There was a problem hiding this comment.
I would not add that until it is required to be present
There was a problem hiding this comment.
I left it from the implementation made by previous developer. The client-side code relies on it
| }); | ||
|
|
||
| res.setHeader('Content-Range', sharedLibs.pagination.total); | ||
| res.status(200).send(preProcessResponse(itemsWithId)); | ||
| res.setHeader('Content-Range', pagination.total); |
Coverage ReportIlc/serverCommit SHA:ae871d79ec415ac4de89a9479b1d642da7bb04d1 Test coverage results 🧪File details
Ilc/clientCommit SHA:ae871d79ec415ac4de89a9479b1d642da7bb04d1 Test coverage results 🧪File details
RegistryCommit SHA:ae871d79ec415ac4de89a9479b1d642da7bb04d1 Test coverage results 🧪File details
|
wRLSS
approved these changes
Sep 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.