Skip to content

[fix][elixir] missing type mapping for AnyType #21197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

efcasado
Copy link
Contributor

@efcasado efcasado commented May 1, 2025

Description

Add missing mapping for AnyType.

The lack of this mapping would result in AnyType being encoded as <invokerPackage>.Model.AnyType in certain scenarios.

Here is an example of a generated model exhibiting this issue. Here is the same model generated after applying this fix.

The issue was caught by dialyzer.

lib/cloudflare/model/overrides.ex:23:41:unknown_type
Unknown type: Cloudflare.Model.AnyType.t/0.

I am having difficulties generating a smaller example to reproduce the issue and add it as a new test to the project. So far, I've only been able to reproduce the issue when using --skip-validate-spec with the Cloudflare OAS file.

As usual, curious to hear your thoughts @mrmstn and @wing328 😊

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 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.
  • 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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Copy link
Contributor

@mrmstn mrmstn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @efcasado
As usual, thank you very much for the PR and the time invested in making the elixir gen. much better!

The PR LGTM, - just to be sure, did you regenerate the sample client as well? I somehow expected to have some changes there as well.

As I'm currently still OOF I can't test it, but I'm quite sure this won't have any side effects 😁!

@efcasado
Copy link
Contributor Author

efcasado commented May 2, 2025

thank you very much for the PR and the time invested in making the elixir gen. much better!

My pleasure! 🙏

just to be sure, did you regenerate the sample client as well? I somehow expected to have some changes there as well.

This change does not result in any changes to the existing samples. The existing mappings do a good-enough job to capture the most common occurrences of AnyType. I am still trying to come up with a minimal example we could add to the tests / samples to capture this rare / edge case I found when working with the Cloudflare OpenAPI specification 😅

@@ -226,6 +226,7 @@ public ElixirClientCodegen() {
typeMapping.put("date", "Date.t");
typeMapping.put("date-time", "DateTime.t");
// other
typeMapping.put("AnyType", "any()");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about adding a test schema with AnyType property (or updating an existing schema) to ensure output is good?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants