chore: work around Ajv module bug in generated code #256
Conversation
This file contains 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
JavaScript module inconsistency strikes again.
In some cases, Ajv will inject `require` calls into generated code even
if you ask it to generate ESM. [This is a bug][0].
For example, here's something it adds if you use [the string `minLength`
or `maxLength` properties][1]:
// ...
const func2 = require("ajv/dist/runtime/ucs2length").default;
// ...
That won't work in an ESM environment.
As a workaround, I inject the following into our generated code:
import { createRequire } from 'node:module';
const require = createRequire(import.meta.url);
This, along with moving `ajv` to production dependencies, should work
around this issue until the bug is fixed.
[0]: ajv-validator/ajv#2209
[1]: https://json-schema.org/understanding-json-schema/reference/string#length
gmaclennan
added a commit
that referenced
this pull request
Sep 16, 2024
This is a different approach to the fix in #256 because that was not playing nicely with Rollup bundler.
gmaclennan
added a commit
that referenced
this pull request
Sep 16, 2024
This is a different approach to the fix in #256 because that was not playing nicely with Rollup bundler.
This was referenced Sep 16, 2024
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.
JavaScript module inconsistency strikes again.
In some cases, Ajv will inject
requirecalls into generated code even if you ask it to generate ESM. This is a bug.For example, here's something it adds if you use the string
minLengthormaxLengthproperties:That won't work in an ESM environment.
As a workaround, I inject the following into our generated code:
This, along with moving
ajvto production dependencies, should work around this issue until the bug is fixed.This isn't a problem today, but will immediately become a problem if we start using one of those validators. It's a bug waiting to happen.
I think this is a useful change on its own, but it should hopefully make an upcoming change easier.