Add new Queries decorator to include all query parameters in one sing… #1309

daniseijo · 2022-09-12T13:17:01Z

This PR adds a new @Queries decorator that accepts an object and wraps all the query parameters into it. This is something very useful for example if the request has a lot of filter parameters that we want to handle. It has been requested several times for example in this issue.

I have tried to keep this new decorator behavior as similar as the Body and the BodyProps decorators were implemented.

Use example:

export interface QueryParams {
  numberParam: number;
  stringParam: string;
  booleanParam: boolean;
  optionalStringParam?: string;
}


@Get('AllQueriesInOneObject')
public async getAllQueriesInOneObject(@Queries() queryParams: QueryParams) {
  const model = new ModelService().getModel();
  model.optionalString = queryParams.optionalStringParam;
  model.numberValue = queryParams.numberParam;
  model.boolValue = queryParams.booleanParam;
  model.stringValue = queryParams.stringParam;

  return model;
}

All Submissions:

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Have you written unit tests?
Have you written unit tests that cover the negative cases (i.e.: if bad data is submitted, does the library respond properly)?
This PR is associated with an existing issue? (Dynamic Query/Header Param #353)

If this is a new feature submission:

Has the issue had a maintainer respond to the issue and clarify that the feature is something that aligns with the goals and philosophy of the project?

Potential Problems With The Approach

I have not tested yet if it would be a problem to have both the Queries and the Query decorator in one single function. It would be nice to add some test cases testing this.

Test plan

For what I wanted, the code is working as expected. I have tried to keep this new decorator as similar as you have implemented the Body and the BodyProps decorators. I still want to add more tests to check the doc generation but wanted to check if this approach was the correct one before continuing.

github-actions

Hello there daniseijo 👋

Thank you and congrats 🎉 for opening your first PR on this project.✨

We will review the following PR soon! 👀

WoH · 2022-09-12T15:58:04Z

Looks great!
I'll write down some questions which I am asking myself, maybe some you already considered.

Validation: Seems to make sense, I'll have to check what happens if we combine with @Query() under different excess prop handling scenarios

Spec: No immediate questions, we can add that as another query parameter I presume.
Maybe need to check if it aligns with how express etc. would parse it.

In general I think the easiest way to deal with the combination of several Query and Queries mixes is to not allow it. Otherwise this may blow up in complexity.

There's an issue similar to this which proposed @Query('*') or something similar, but I like the explicit @Queries better.

daniseijo · 2022-09-13T13:16:41Z

Hi! Thanks for the quick response, I would love a bit of help with the swagger part. I have created a method to spread the properties of the Queries object to show its internal query parameters on the swagger document. However, I'm not sure if this is the best approach.

Could you check it out and also help me with the next steps to get this up and ready?

PD.: I will try to add more negative test cases to check all the variations but I think I will not have time to advance until next week.

rwmblabs · 2022-10-04T14:53:35Z

Do we have any updates here? I really like this solution 😂

daniseijo · 2022-10-04T15:17:02Z

Do we have any updates here? I really like this solution 😂

Hi, I implemented a solution for the swagger part but I am not sure if there is a cleaner way. If it is ok, maybe @WoH could help me with the next steps and have it merge.

WoH · 2022-10-05T14:56:57Z

Thanks for the ping, I'll try to find time over the weekend to leave suggestions if needed

WoH · 2022-10-07T08:07:50Z

Can you rebase this PR? CI on master should work again

WoH · 2022-10-09T18:24:52Z

packages/cli/src/swagger/specGenerator3.ts

@@ -458,6 +467,15 @@ export class SpecGenerator3 extends SpecGenerator {
    return mediaType;
  }

+  private buildQueriesParameter(source: Tsoa.Parameter): Swagger.Parameter3[] {
+    if (source.type.dataType === 'refAlias' && source.type.type.dataType === 'nestedObjectLiteral') {


'refObject' should probably work here.
We should not only check 1 level deep on the alias, I've written similar code which checks deeep for isVoidType I think

If we can't handle, I'd rather throw than return an array I think?

Thinking about this, I think is better to fail if there is a nested object, to be coherent with the @Query decorator failing if we pass it a refObject. @WoH What do you think?

packages/cli/src/swagger/specGenerator3.ts

WoH · 2022-10-09T18:27:14Z

packages/cli/src/swagger/specGenerator2.ts

@@ -173,12 +173,22 @@ export class SpecGenerator2 extends SpecGenerator {
      pathMethod.security = method.security;
    }

+    const queriesParams: Tsoa.Parameter[] = method.parameters.filter(p => p.in === 'queries');


WoH · 2022-10-09T18:30:48Z

I think I've mentioned this, but we really don´t want both @Query and @Queries at the same time.
It'll be impossible to manage all that complexity when it comes to what belongs where for now.
For test cases: Please make sure { [name: string]: unknown/any } (basically Records) can be used to wildcard anything.
Maybe { [name: string]: number } and handle that which will be fun.

github-actions · 2022-11-09T00:08:52Z

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

matthewyu-ptr · 2022-11-09T07:32:09Z

This is a good feature, please don't close this PR

aakash-at · 2022-11-16T03:36:05Z

Any update on this PR?

WoH · 2022-11-16T17:15:59Z

Just to be clear, this was not a no from my side. Just throw an Error of both Decorators are parsed in the same method

daniseijo · 2022-11-16T17:37:55Z

Sorry, my intention is to fix the changes but I left my work where I worked with tsoa. Since then I have had no time to continue with this. I will try to take some time to read and solve the issues on the PR as soon as possible. Sorry again for the delay.

…le object

daniseijo · 2022-11-24T01:45:36Z

Hi, I already made the changes to the code and added some more tests. @WoH, I wrote a response to one of your comments. Check it out and, if you think that behavior does not make sense, tell me and I will change it.

In any case, I think the failing tests in some environments are not my fault anymore and they are more of a problem with a timeout. Whenever you can, check the PR again and let me know if I am missing something.

u12206050 · 2022-11-25T10:58:19Z

Awesome! Can't wait for this to be published!

u12206050 · 2022-11-25T11:02:24Z

@WoH Any chance you could push a new release with this then we can test it? :) Thanks for the work @daniseijo

filipRisteski · 2022-12-02T19:51:22Z

I wanted to write something like this, but since it's here it would be very much appreciate if we can speed this up :) Thanks for the hard work @daniseijo

WoH · 2022-12-02T20:28:04Z

it's available! yarn add tsoa@next

bsberry · 2022-12-21T19:46:59Z

@daniseijo Thank you so much for implementing this. The lack of this almost stopped our adoption of tsoa cold.

grug · 2022-12-23T15:12:24Z

Is there any idea of when 5.0.0 will come out of RC and released?

github-actions bot reviewed Sep 12, 2022

View reviewed changes

WoH reviewed Oct 9, 2022

View reviewed changes

github-actions bot added the Stale label Nov 9, 2022

github-actions bot removed the Stale label Nov 10, 2022

Daniel Seijo and others added 6 commits November 17, 2022 17:21

Add new Queries decorator to include all query parameters in one sing…

7e95abb

…le object

Spread Queries properties to create Query swagger parameters

4c17f39

Limit using Query and Queries decorators at the same time

c6eca69

Only allow one level of object when using Queries

8948ba5

Add more cases to test Queries decorator whit wildcards

f970f51

Fix invalid tests

649d6ca

WoH approved these changes Nov 24, 2022

View reviewed changes

WoH merged commit db08b5f into lukeautry:master Nov 25, 2022

WoH mentioned this pull request Dec 14, 2022

Possible to get all query parameters in one object? #1355

Closed

SO-Eng mentioned this pull request Mar 30, 2023

Queries with same parameters throw an error #1410

Closed

4 tasks

dderevjanik mentioned this pull request Jun 4, 2023

feat: add queries param tsoa-community/docs#71

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new Queries decorator to include all query parameters in one sing… #1309

Add new Queries decorator to include all query parameters in one sing… #1309

daniseijo commented Sep 12, 2022 •

edited

github-actions bot left a comment

WoH commented Sep 12, 2022

daniseijo commented Sep 13, 2022

rwmblabs commented Oct 4, 2022

daniseijo commented Oct 4, 2022

WoH commented Oct 5, 2022

WoH commented Oct 7, 2022

WoH Oct 9, 2022

daniseijo Nov 17, 2022

WoH Oct 9, 2022

WoH commented Oct 9, 2022

github-actions bot commented Nov 9, 2022

matthewyu-ptr commented Nov 9, 2022

aakash-at commented Nov 16, 2022

WoH commented Nov 16, 2022

daniseijo commented Nov 16, 2022

daniseijo commented Nov 24, 2022 •

edited

u12206050 commented Nov 25, 2022

u12206050 commented Nov 25, 2022

filipRisteski commented Dec 2, 2022

WoH commented Dec 2, 2022

bsberry commented Dec 21, 2022

grug commented Dec 23, 2022

Add new Queries decorator to include all query parameters in one sing… #1309

Add new Queries decorator to include all query parameters in one sing… #1309

Conversation

daniseijo commented Sep 12, 2022 • edited

All Submissions:

If this is a new feature submission:

github-actions bot left a comment

Choose a reason for hiding this comment

WoH commented Sep 12, 2022

daniseijo commented Sep 13, 2022

rwmblabs commented Oct 4, 2022

daniseijo commented Oct 4, 2022

WoH commented Oct 5, 2022

WoH commented Oct 7, 2022

WoH Oct 9, 2022

Choose a reason for hiding this comment

daniseijo Nov 17, 2022

Choose a reason for hiding this comment

WoH Oct 9, 2022

Choose a reason for hiding this comment

WoH commented Oct 9, 2022

github-actions bot commented Nov 9, 2022

matthewyu-ptr commented Nov 9, 2022

aakash-at commented Nov 16, 2022

WoH commented Nov 16, 2022

daniseijo commented Nov 16, 2022

daniseijo commented Nov 24, 2022 • edited

u12206050 commented Nov 25, 2022

u12206050 commented Nov 25, 2022

filipRisteski commented Dec 2, 2022

WoH commented Dec 2, 2022

bsberry commented Dec 21, 2022

grug commented Dec 23, 2022

daniseijo commented Sep 12, 2022 •

edited

daniseijo commented Nov 24, 2022 •

edited