Skip to content

fix: keep the large array options on the build instead of the module #881

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.

Sign up for GitHub

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
nigrosimone wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: keep the large array options on the build instead of the module #881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ const Location = require('./lib/location')
const validate = require('./lib/schema-validator')
const mergeSchemas = require('./lib/merge-schemas')

let largeArraySize = 2e4
let largeArrayMechanism = 'default'
const DEFAULT_LARGE_ARRAY_SIZE = 2e4

const NAMED_FRAGMENT_REF = /^#[a-z_][-\w._]*$/i

Expand Down Expand Up @@ -190,9 +189,14 @@ function build (schema, options) {
}
}

// on the context, not the module: a build without these options must not inherit them
// from the build before it
context.largeArrayMechanism = 'default'
context.largeArraySize = DEFAULT_LARGE_ARRAY_SIZE

if (options.largeArrayMechanism) {
if (validLargeArrayMechanisms.has(options.largeArrayMechanism)) {
largeArrayMechanism = options.largeArrayMechanism
context.largeArrayMechanism = options.largeArrayMechanism
} else {
throw new Error(`Unsupported large array mechanism ${options.largeArrayMechanism}`)
}
Expand All @@ -203,11 +207,11 @@ function build (schema, options) {
let parsedNumber

if (largeArraySizeType === 'string' && Number.isFinite((parsedNumber = Number.parseInt(options.largeArraySize, 10)))) {
largeArraySize = parsedNumber
context.largeArraySize = parsedNumber
} else if (largeArraySizeType === 'number' && Number.isInteger(options.largeArraySize)) {
largeArraySize = options.largeArraySize
context.largeArraySize = options.largeArraySize
} else if (largeArraySizeType === 'bigint') {
largeArraySize = Number(options.largeArraySize)
context.largeArraySize = Number(options.largeArraySize)
} else {
throw new Error(`Unsupported large array size. Expected integer-like, got ${typeof options.largeArraySize} with value ${options.largeArraySize}`)
}
Expand Down Expand Up @@ -713,8 +717,8 @@ function buildArray (context, location, input) {
`
}

if (largeArrayMechanism === 'json-stringify') {
functionCode += `if (arrayLength >= ${largeArraySize}) return JSON.stringify(obj)\n`
if (context.largeArrayMechanism === 'json-stringify') {
functionCode += `if (arrayLength >= ${context.largeArraySize}) return JSON.stringify(obj)\n`
}

functionCode += `
Expand Down Expand Up @@ -798,8 +802,8 @@ function buildArray (context, location, input) {
`
}

if (largeArrayMechanism === 'json-stringify') {
inlinedCode += `if (arrayLength_${objVar} >= ${largeArraySize}) json += JSON.stringify(${objVar})\n else {`
if (context.largeArrayMechanism === 'json-stringify') {
inlinedCode += `if (arrayLength_${objVar} >= ${context.largeArraySize}) json += JSON.stringify(${objVar})\n else {`
}

inlinedCode += `
Expand Down Expand Up @@ -856,7 +860,7 @@ function buildArray (context, location, input) {
json += JSON_STR_END_ARRAY
`

if (largeArrayMechanism === 'json-stringify') {
if (context.largeArrayMechanism === 'json-stringify') {
inlinedCode += '}'
}

Expand Down
17 changes: 17 additions & 0 deletions test/array.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,3 +686,20 @@ buildTest({
largeArraySize: '10000',
largeArrayMechanism: 'default'
})

test('large array options do not leak into the next build', (t) => {
t.plan(2)

const schema = {
type: 'array',
items: { type: 'string', format: 'date' }
}
const dates = [new Date(0), new Date(0), new Date(0)]

const withOptions = build(schema, { largeArrayMechanism: 'json-stringify', largeArraySize: 3 })
t.assert.equal(withOptions(dates), JSON.stringify(dates))

// the options above were kept on the module and read by this build too
const withoutOptions = build(schema)
t.assert.equal(withoutOptions(dates), '["1970-01-01","1970-01-01","1970-01-01"]')
})