feat: Add OTP 28+ compatibility with version-aware regex pattern handling #670
+97
−89
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ling - Implement OTP version detection in schema macro - Add runtime schema compilation for OTP 28+ when regex patterns are present - Maintain module attribute optimization for non-regex schemas on all OTP versions - Add deprecation warning for regex patterns on OTP 28+ with migration guidance - Fix cast_parameters.ex to avoid regex in module attributes - Update string test to check pattern source instead of regex struct equality This ensures backward compatibility while providing a clear migration path for OTP 28+ users to move from regex patterns to string patterns.
mbuhot
approved these changes
Jun 5, 2025
mbuhot
reviewed
Jun 5, 2025
lib/open_api_spex/schema.ex
Outdated
| |> has_regex_pattern?() | ||
| end | ||
|
|
||
| def has_regex_pattern?(enumerable) |
There was a problem hiding this comment.
This guard is giving a warning CI:
==> open_api_spex
Compiling 80 files (.ex)
warning: incompatible types:
map() !~ [dynamic()]
in expression:
# lib/open_api_spex/schema.ex:544
is_list(enumerable)
where "enumerable" was given the type map() in:
# lib/open_api_spex/schema.ex:544
is_map_key(enumerable, :__struct__)
where "enumerable" was given the type [dynamic()] in:
# lib/open_api_spex/schema.ex:544
is_list(enumerable)
Conflict found at
│
544 │ when not is_struct(enumerable) and (is_list(enumerable) or is_map(enumerable)) do
│ ~
│
└─ lib/open_api_spex/schema.ex:544:43: OpenApiSpex.Schema.has_regex_pattern?/1
Compilation failed due to warnings while using the --warnings-as-errors option
Error: Process completed with exit code 1.
zorbash
reviewed
Jun 11, 2025
| @@ -253,32 +253,59 @@ defmodule OpenApiSpex do | |||
| prevent "... protocol has already been consolidated ..." | |||
| compiler warnings. | |||
| """ | |||
| def should_use_runtime_compilation?(body) do | |||
There was a problem hiding this comment.
I don't think this should be a public function. It's also hijacking the @doc for defmacro schema/2.
There was a problem hiding this comment.
I'll submit a change to fix this, but that method is called from elsewhere, so I think it needs to be public, no? Unless I'm missing something. The @doc issue is easier to fix (I think). :)
- Fix type incompatibility warning in has_regex_pattern?/1 by splitting function clauses - Make should_use_runtime_compilation?/1 undocumented (@doc false) Addresses feedback in open-api-spex#670 (review)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Including:
This ensures backward compatibility while providing a clear migration path for OTP 28+ users to move from regex patterns to string patterns.