Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !13874

[Elixir] Fixes issue with maps/dictionary not present in payload

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/mrmstn/elixir/deserialize-nullable-maps into master Nov 01, 2022
  • Overview 2
  • Commits 2
  • Pipelines 0
  • Changes 2

Created by: mrmstn

Currently, there is an issue with the deserializations of maps, which are null.

As an example, the given payload is the following

{
  "ID": "2b892741-1853-3ddd-382f-fc12e93b5174",
  "CreateTime": 1666707394061348343,
  "ModifyTime": 1666707394064897549
}

the schema definitions looks something like this

components:
  schemas:
    Evaluation:
      properties:
        CreateTime:
          format: int64
          type: integer
        FailedTGAllocs:
          additionalProperties:
            $ref: '#/components/schemas/AllocationMetric'
          type: object
        ID:
          type: string
        ModifyTime:
          format: int64
          type: integer
      type: object
    AllocationMetric:
      properties:
        AllocationTime:
          format: int64
          type: integer
      type: object

As you can see, FailedTGAllocs is a simple dictionary with the value type of AllocationMetric. The generator will produce something like this (which is correct):

defimpl Poison.Decoder, for: Example.Model.Evaluation do
  import Example.Deserializer

  def decode(value, options) do
    value
    |> deserialize(:FailedTGAllocs, :map, Example.Model.AllocationMetric, options)
  end
end

The main issue is now, since payload doesn't have the field FailedTGAllocs, the Map.new(...) call will receive nil as the first parameter, which results in a pattern match error. To prevent this, I've added the maybe_transform_map function, which simply returns nil for nil, and the decoded/transformed model for everything else.

Since I'm the only one in the technical committee, @wing328, could you take a look?

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/mrmstn/elixir/deserialize-nullable-maps