[BUG][typescript-angular] 7.12.0 refactoring changes behaviour of http params

[gratzl-dev]

Description

JS Objects used to be flattened into individual parameters. Now they just get JSON.stringified.

Example:
Page Object:

{
   page: 1,
   items: 10
}

7.11.0

/api/request?page=1&items=10

7.12.0

/api/request?page={page:1,items:10}

There is no config to set the behaviour to how it was previously.

openapi-generator version

7.11.0

    private addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
        if (value == null) {
            return httpParams;
        }

        if (typeof value === "object") {
            if (Array.isArray(value)) {
                (value as any[]).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));
            } else if (value instanceof Date) {
                if (key != null) {
                    httpParams = httpParams.append(key, (value as Date).toISOString().substring(0, 10));
                } else {
                   throw Error("key may not be null if value is Date");
                }
            } else {
                Object.keys(value).forEach( k => httpParams = this.addToHttpParamsRecursive(
                    httpParams, value[k], key != null ? `${key}.${k}` : k));
            }
        } else if (key != null) {
            httpParams = httpParams.append(key, value);
        } else {
            throw Error("key may not be null if value is not object or array");
        }
        return httpParams;
    }

7.12.0

   protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string): HttpParams {
        if (value === null || value === undefined) {
            return httpParams;
        }
        if (typeof value === 'object') {
            // If JSON format is preferred, key must be provided.
            if (key != null) {
                return httpParams.append(key, JSON.stringify(value));
            }
            // Otherwise, if it's an array, add each element.
            if (Array.isArray(value)) {
                value.forEach(elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));
            } else if (value instanceof Date) {
                if (key != null) {
                    httpParams = httpParams.append(key, value.toISOString());
                } else {
                    throw Error("key may not be null if value is Date");
                }
            } else {
                Object.keys(value).forEach(k => {
                    const paramKey = key ? `${key}.${k}` : k;
                    httpParams = this.addToHttpParamsRecursive(httpParams, value[k], paramKey);
                });
            }
            return httpParams;
        } else if (key != null) {
            return httpParams.append(key, value);
        }
        throw Error("key may not be null if value is not object or array");
    }

Steps to reproduce

Run openapi-generator with the latest version

Related issues/PRs

This merge causes the issue:
#20681

Suggest a fix

I would suggest to either add a config to enable/disable json http params, or revert the addToHttpParamsRecursive method to how it was previously

[bhahn57570]

Issue already open #20980 please close both if the problem is fixed.

[gratzl-dev]

After looking at related issues (#20799, #20850)

I can see that a fix has been implemented, but for my case, serializing the object when a key is provided does not solve the issue.

In the case of having a spring boot appliciation with spring docs generated api spec, using the @pageable annotation for automatic query params resolution cases the query param to get the key "pageable" and in turn telling it to be parsed into json.

Therefore a config would be nice to tell the generator to not JSON.stringify

[bhahn57570]

I am exactly in the same case so yes could be great to have the option to switch between the 2 implementations

[kzander91]

Similarly with an object like this:

{
  myArrayParam: ['val1', 'val2'],
  anotherParam: 'value'
}

7.11.0: /api/request?myArrayParam=val1&myArrayParam=val2&anotherParam=value
7.13.0: /api/request?myArrayParam=["val1","val2"]&anotherParam=value

I had to downgrade back to 7.11.0 for now.

[kzander91]

Issue is still present in the new 7.14.0 release, I will have to keep staying at 7.11.0.

[bhahn57570]

Hello, I checked yesterday yes
This class
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/typescript-angular/api.base.service.mustache
is still the same. No new properties was added to allow the old behavior I don't know if they plan to correct it the next release.
Only the array problem

7.11.0: /api/request?myArrayParam=val1&myArrayParam=val2&anotherParam=value
7.13.0: /api/request?myArrayParam=["val1","val2"]&anotherParam=value

is remaining

[abos]

I am having the same problem. I would fix it - but i am afraid to break something else. I haven't seen any tests that cover the BaseService.

[bhahn57570]

I am having the same problem. I would fix it - but i am afraid to break something else. I haven't seen any tests that cover the BaseService.

Currently if we have a property that use the code has it was before I think nothing will break.

[kzander91]

Issue is still present in the new 7.15.0 release, I will have to keep staying at 7.11.0.

[bhahn57570]

This problem is not planned to be corrected, it has to be pushed to correction so it's still the same