fix(typescript-angular): handle Set in query parameter serialization

Merged
LE
6mo ago
+171-88

Fixes #23434

When a query parameter is defined with type: array and uniqueItems: true, the typescript-angular generator produces a Set<T> type. However, addToHttpParams only checks Array.isArray(value) to detect collections. Since Array.isArray(new Set()) returns false, the Set falls through to the object-handling branch and query parameters are silently lost.

This adds a value instanceof Set check alongside Array.isArray(value) in the addToHttpParams method of api.base.service.mustache. When a Set is detected, it is converted to an Array before serialization.

cc @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha @dennisameling

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Fixes lost query params when uniqueItems: true arrays generate Set<T> in the typescript-angular client by treating Set like arrays in addToHttpParams across form/space/pipe styles. Fixes #23434.

  • Bug Fixes
    • In api.base.service.mustache, detect Set alongside arrays and serialize via Array.from(...) for form, space-delimited, and pipe-delimited styles.
    • Extended query-param-form.yaml with a tags query param (array, uniqueItems: true) on explode and non-explode routes.
    • Regenerated typescript-angular samples and updated services to accept tags: Set<string>; added tests for Set-only and combined cases for explode and non-explode.