ajv complie performance

[chunlampang]

Problem

querySyntax is repeating the JSON content, which case the result JSON string very large and take a long time to complie.

Solution

Use Type.Ref

1. can prevent repeating the JSON content
2. reduce the complie time.
3. less memory usage to store the repeated schema

feathers/packages/typebox/src/index.ts

Lines 166 to 197 in a21b2cf

	export const querySyntax = <
	T extends TObject,
	X extends { [K in keyof T['properties']]?: { [key: string]: TSchema } }
	>(
	type: T,
	extensions: X = {} as X,
	options: ObjectOptions = { additionalProperties: false }
	) => {
	const propertySchema = queryProperties(type, extensions)
	const $or = Type.Array(propertySchema)
	const $and = Type.Array(Type.Union([propertySchema, Type.Object({ $or })]))
	return Type.Intersect(
	[
	Type.Partial(
	Type.Object(
	{
	$limit: Type.Number({ minimum: 0 }),
	$skip: Type.Number({ minimum: 0 }),
	$sort: sortDefinition(type),
	$select: arrayOfKeys(type),
	$and,
	$or
	},
	{ additionalProperties: false }
	)
	),
	propertySchema
	],
	options
	)
	}

Improvement: use Type.Ref
The following code changed $and, $or to use Ref.

export const querySyntax = <
  T extends TObject,
  X extends { [K in keyof T['properties']]?: { [key: string]: TSchema } }
>(
  type: T,
  extensions: X = {} as X,
  options: ObjectOptions = { additionalProperties: false }
) => {

  if (!type.$id) {
    // type.$id = genId(); // or original approach
  }

  if (!options.$id)
    options.$id = type.$id + '.query'

  const propId = options.$id + '.prop';
  let propertySchema = ajv.getSchema(propId)?.schema;

  if (!propertySchema) {// check already register
    propertySchema = queryProperties(type, extensions)
    propertySchema.$id = propId
    ajv.compile(propertySchema) // register to ajv
  }

  const propertySchemaRef = Type.Ref(propertySchema);

  const $or = Type.Array(propertySchemaRef); //       !!!!! by Ref instead of copying json 
  const $and = Type.Array(Type.Union([propertySchemaRef, Type.Object({ $or })]));

  return Type.Intersect(
    [
      Type.Partial(
        Type.Object(
          {
            $limit: Type.Number({ minimum: 0 }),
            $skip: Type.Number({ minimum: 0 }),
            $sort: sortDefinition(type),
            $select: arrayOfKeys(type),
            $and,
            $or
          },
          { additionalProperties: false }
        )
      ),
      propertySchema
    ],
    options
  )
} 

This improvement can also apply to $gte, $gt etc

Difficulty

The ajv instance inside the above sample is came from validators.ts which is outside the library. May need to redesign.