feat: handle sub-schema validation (#853)

Author: MFori

package.json

@@ -61,7 +61,7 @@
     "dependencies": {
         "@apify/actor-templates": "^0.1.5",
         "@apify/consts": "^2.36.0",
-        "@apify/input_schema": "^3.12.0",
+        "@apify/input_schema": "^3.17.0",
         "@apify/utilities": "^2.15.1",
         "@crawlee/memory-storage": "^3.12.0",
         "@oclif/core": "~4.3.0",

src/commands/run.ts

@@ -29,7 +29,7 @@ import { getAjvValidator, getDefaultsFromInputSchema, readInputSchema } from '..
 import { error, info, warning } from '../lib/outputs.js';
 import { replaceSecretsValue } from '../lib/secrets.js';
 import {
-	Ajv,
+	Ajv2019,
 	checkIfStorageIsEmpty,
 	getLocalInput,
 	getLocalKeyValueStorePath,
@@ -456,7 +456,7 @@ export class RunCommand extends ApifyCommand<typeof RunCommand> {
 		}
 
 		// Step 1: validate the input schema
-		const validator = new Ajv({ strict: false, unicodeRegExp: false });
+		const validator = new Ajv2019({ strict: false, unicodeRegExp: false });
 		validateInputSchema(validator, inputSchema); // This one throws an error in a case of invalid schema.
 
 		const defaults = getDefaultsFromInputSchema(inputSchema);

src/commands/validate-schema.ts

@@ -8,7 +8,7 @@ import { ApifyCommand } from '../lib/apify_command.js';
 import { LOCAL_CONFIG_PATH } from '../lib/consts.js';
 import { readInputSchema } from '../lib/input_schema.js';
 import { info, success } from '../lib/outputs.js';
-import { Ajv } from '../lib/utils.js';
+import { Ajv2019 } from '../lib/utils.js';
 
 export class ValidateInputSchemaCommand extends ApifyCommand<typeof ValidateInputSchemaCommand> {
 	static override description = `Validates Actor input schema from one of these locations (in priority order):
@@ -44,7 +44,7 @@ export class ValidateInputSchemaCommand extends ApifyCommand<typeof ValidateInpu
 			info({ message: `Validating input schema embedded in '${LOCAL_CONFIG_PATH}'` });
 		}
 
-		const validator = new Ajv({ strict: false });
+		const validator = new Ajv2019({ strict: false });
 		validateInputSchema(validator, inputSchema); // This one throws an error in a case of invalid schema.
 		success({ message: 'Input schema is valid.' });
 	}

src/lib/input_schema.ts

@@ -9,7 +9,7 @@ import { validateInputSchema } from '@apify/input_schema';
 
 import { ACTOR_SPECIFICATION_FOLDER } from './consts.js';
 import { warning } from './outputs.js';
-import { Ajv, getJsonFileContent, getLocalConfig, getLocalKeyValueStorePath } from './utils.js';
+import { Ajv2019, getJsonFileContent, getLocalConfig, getLocalKeyValueStorePath } from './utils.js';
 
 const DEFAULT_INPUT_SCHEMA_PATHS = [
 	'.actor/INPUT_SCHEMA.json',
@@ -85,7 +85,7 @@ export const createPrefilledInputFileFromInputSchema = async (actorFolderDir: st
 			 * It is not possible to install the package here because it is private
 			 * We should move it to @apify/input_schema and use it from there.
 			 */
-			const validator = new Ajv({ strict: false });
+			const validator = new Ajv2019({ strict: false });
 			validateInputSchema(validator, inputSchema);
 
 			// inputFile = _.mapObject(inputSchema.properties as any, (fieldSchema) =>

src/lib/utils.ts

@@ -9,7 +9,7 @@ import { finished } from 'node:stream/promises';
 import { DurationFormatter as SapphireDurationFormatter, TimeTypes } from '@sapphire/duration';
 import { Timestamp } from '@sapphire/timestamp';
 import AdmZip from 'adm-zip';
-import _Ajv from 'ajv';
+import _Ajv2019 from 'ajv/dist/2019.js';
 import { type ActorRun, ApifyClient, type ApifyClientOptions, type Build } from 'apify-client';
 import archiver from 'archiver';
 import { AxiosHeaders } from 'axios';
@@ -48,7 +48,7 @@ import type { AuthJSON } from './types.js';
 
 // Export AJV properly: https://github.com/ajv-validator/ajv/issues/2132
 // Welcome to the state of JavaScript/TypeScript and CJS/ESM interop.
-export const Ajv = _Ajv as unknown as typeof import('ajv').default;
+export const Ajv2019 = _Ajv2019 as unknown as typeof import('ajv/dist/2019.js').default;
 
 export const httpsGet = async (url: string) => {
 	return new Promise<IncomingMessage>((resolve, reject) => {

test/__setup__/input-schemas/valid.json

@@ -56,7 +56,29 @@
 			"default": false,
 			"groupCaption": "Options",
 			"groupDescription": "Various options for this Actor"
-		}
+		},
+        "person": {
+            "title": "Person",
+            "type": "object",
+            "description": "An example of a nested object",
+            "editor": "schemaBased",
+            "properties": {
+                "firstName": {
+                    "type": "string",
+                    "title": "First Name",
+                    "description": "First name of the person",
+                    "editor": "textfield"
+                },
+                "lastName": {
+                    "type": "string",
+                    "title": "Last Name",
+                    "description": "Last name of the person",
+                    "editor": "textfield"
+                }
+            },
+            "additionalProperties": false,
+            "required": ["lastName"]
+        }
 	},
 	"required": ["queries"]
 }