[typescript-fetch] Improve code generation for `oneOf` cases without discriminator

[odiak]

Problem

Previously, generated code from the oneOf schema without a discriminator might cause runtime errors.

schema:

openapi: 3.0.0
info:
  version: 1.0.0
  title: Test
  description: Test
paths:
  /foo:
    get:
      responses:
        200:
          description: foo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Foo'
components:
  schemas:
    Foo:
      oneOf:
        - $ref: '#/components/schemas/Bar'
        - $ref: '#/components/schemas/Buzz'
    Bar:
      type: object
      required:
        - abc
      properties:
        abc:
          type: array
          items:
            type: object
            properties:
              xyz:
                type: number
    Buzz:
      type: object
      required:
        - def
      properties:
        def:
          type: number

generated model code (partial):

// models/Foo.ts
// ...
export function FooFromJSON(json: any): Foo {
    return FooFromJSONTyped(json, false);
}

export function FooFromJSONTyped(json: any, ignoreDiscriminator: boolean): Foo {
    if (json == null) {
        return json;
    }
    return BarFromJSONTyped(json, true) || BuzzFromJSONTyped(json, true);
}
// ...

// on models/Bar.ts
// ...
export function BarFromJSONTyped(json: any, ignoreDiscriminator: boolean): Bar {
    if (json == null) {
        return json;
    }
    return {
        'abc': ((json['abc'] as Array<any>).map(BarAbcInnerFromJSON)),  // ← this causes error
    };
}
// ...

In BarFromJSONTyped, if the given json doesn't have the abc property, (json['abc'] as Array<any>).map(...) will fail. The same problem also occurs if abc is a string with a date-time format.

Solution

I modified the template to generate FooFromJSONTyped like the following:

// models/Foo.ts
// ...
export function FooFromJSONTyped(json: any, ignoreDiscriminator: boolean): Foo {
    if (json == null) {
        return json;
    }
    if (instanceOfBar(json)) {
        return BarFromJSONTyped(json, true);
    }
    if (instanceOfBuzz(json)) {
        return BuzzFromJSONTyped(json, true);
    }
}
// ...

Because instanceOfXXXX functions check for the existence of required keys, it makes the generated code safer.

How to check

1. Check out this branch.
2. Build the generator.
3. Generate an API client using the schema above.
4. Check generated model files.

PR checklist

• [x] Read the contribution guidelines.
• [x] 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.
• [x] Run the following to build the project and update samples:

  ./mvnw clean package 
  ./bin/generate-samples.sh ./bin/configs/*.yaml
  ./bin/utils/export_docs_generators.sh
  

  (For Windows users, please run the script in Git BASH) 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.
• [x] File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
• [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

[odiak]

Dear technical committee members of TypeScript, please check this pull request if you have time. :bow: @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka

[sir4ur0n]

@odiak I just updated our openapi-generator to 7.7.0 which comes with this PR, and now Typescript fails typechecking:

Function lacks ending return statement and return type does not include 'undefined'

And indeed, if the input JSON is not an instance of any of the variants, this function returns undefined but it's not in the signature.

Don't you have this exact same problem? I feel like I am missing something :thinking:

[macjohnny]

@sir4ur0n thanks for reporting that. do you want to try to fix this?

[sir4ur0n]

I don't really know how to fix that:

• should the return type of the function be changed to | undefined?
• throw an error in the default case?
• other?

I think this PR was right to use instanceOf functions, I am not challenging that. I just don't know how the function xxxFromJSONTyped is supposed to behave when the input JSON is incorrect.

I also don't feel very confident in attempting to fix because I am not great at Typescript :sweat_smile:

[odiak]

@sir4ur0n I also realized same problem last month. I have workaround for it but I forgot to submit pull request. Sorry!

My solution is just adding return json to the end of the function. I think it's not perfect though.

[sir4ur0n]

@odiak no worries :+1:

Would you mind opening a PR with your workaround please? :pray:

[odiak]

@sir4ur0n Sure!

[sir4ur0n]

@odiak did you get a chance to work on that? :pray:

[odiak]

I'll do it tonight! (Currently 9pm on my timezone)