refactor: Improve error handling

Author: dimovpetar

src/tools/run_manifest_validation/runValidation.ts

@@ -9,68 +9,79 @@ import {getManifestSchema} from "../../utils/ui5Manifest.js";
 const log = getLogger("tools:run_manifest_validation:runValidation");
 const schemaCache = new Map<string, Promise<object>>();
 
-async function createUI5ManifestValidateFunction(ui5Schema: object) {
-	const ajv = new Ajv2020.default({
-		allErrors: true, // Collect all errors, not just the first one
-		strict: false, // Allow additional properties that are not in schema
-		unicodeRegExp: false,
-		loadSchema: async (uri) => {
-			// Check cache first to prevent infinite loops
-			if (schemaCache.has(uri)) {
-				log.info(`Loading cached schema: ${uri}`);
+// Configuration constants
+const AJV_SCHEMA_PATHS = {
+	draft06: "node_modules/ajv/dist/refs/json-schema-draft-06.json",
+	draft07: "node_modules/ajv/dist/refs/json-schema-draft-07.json",
+} as const;
 
-				try {
-					const schema = await schemaCache.get(uri)!;
-					return schema;
-				} catch {
-					schemaCache.delete(uri);
-				}
-			}
-
-			log.info(`Loading external schema: ${uri}`);
-			let fetchSchema: Promise<object>;
-
-			try {
-				if (uri.includes("adaptive-card.json")) {
-					// Special handling for Adaptive Card schema to fix unsupported "id" property
-					// According to the JSON Schema spec Draft 06 (used by Adaptive Card schema),
-					// "$id" should be used instead of "id"
-					fetchSchema = fetchCdn(uri)
-						.then((response) => {
-							if ("id" in response && typeof response.id === "string") {
-								const typedResponse = response as Record<string, unknown>;
-								typedResponse.$id = response.id;
-								delete typedResponse.id;
-							}
-							return response;
-						});
-				} else {
-					fetchSchema = fetchCdn(uri);
+async function createUI5ManifestValidateFunction(ui5Schema: object) {
+	try {
+		const ajv = new Ajv2020.default({
+			allErrors: true, // Collect all errors, not just the first one
+			strict: false, // Allow additional properties that are not in schema
+			unicodeRegExp: false,
+			loadSchema: async (uri) => {
+				// Check cache first to prevent infinite loops
+				if (schemaCache.has(uri)) {
+					log.info(`Loading cached schema: ${uri}`);
+
+					try {
+						const schema = await schemaCache.get(uri)!;
+						return schema;
+					} catch {
+						schemaCache.delete(uri);
+					}
 				}
 
-				schemaCache.set(uri, fetchSchema);
-				return fetchSchema;
-			} catch (error) {
-				log.warn(`Failed to load external schema ${uri}:` +
-					`${error instanceof Error ? error.message : String(error)}`);
+				log.info(`Loading external schema: ${uri}`);
+				let fetchSchema: Promise<object>;
 
-				throw error;
-			}
-		},
-	});
-	const draft06MetaSchema = JSON.parse(
-		await readFile("node_modules/ajv/dist/refs/json-schema-draft-06.json", "utf-8")
-	) as AnySchemaObject;
-	const draft07MetaSchema = JSON.parse(
-		await readFile("node_modules/ajv/dist/refs/json-schema-draft-07.json", "utf-8")
-	) as AnySchemaObject;
+				try {
+					if (uri.includes("adaptive-card.json")) {
+						// Special handling for Adaptive Card schema to fix unsupported "id" property
+						// According to the JSON Schema spec Draft 06 (used by Adaptive Card schema),
+						// "$id" should be used instead of "id"
+						fetchSchema = fetchCdn(uri)
+							.then((response) => {
+								if ("id" in response && typeof response.id === "string") {
+									const typedResponse = response as Record<string, unknown>;
+									typedResponse.$id = response.id;
+									delete typedResponse.id;
+								}
+								return response;
+							});
+					} else {
+						fetchSchema = fetchCdn(uri);
+					}
+
+					schemaCache.set(uri, fetchSchema);
+					return fetchSchema;
+				} catch (error) {
+					log.warn(`Failed to load external schema ${uri}:` +
+						`${error instanceof Error ? error.message : String(error)}`);
+
+					throw error;
+				}
+			},
+		});
+		const draft06MetaSchema = JSON.parse(
+			await readFile(AJV_SCHEMA_PATHS.draft06, "utf-8")
+		) as AnySchemaObject;
+		const draft07MetaSchema = JSON.parse(
+			await readFile(AJV_SCHEMA_PATHS.draft07, "utf-8")
+		) as AnySchemaObject;
 
-	ajv.addMetaSchema(draft06MetaSchema, "http://json-schema.org/draft-06/schema#");
-	ajv.addMetaSchema(draft07MetaSchema, "http://json-schema.org/draft-07/schema#");
+		ajv.addMetaSchema(draft06MetaSchema, "http://json-schema.org/draft-06/schema#");
+		ajv.addMetaSchema(draft07MetaSchema, "http://json-schema.org/draft-07/schema#");
 
-	const validate = await ajv.compileAsync(ui5Schema);
+		const validate = await ajv.compileAsync(ui5Schema);
 
-	return validate;
+		return validate;
+	} catch (error) {
+		throw new Error(`Failed to create UI5 manifest validate function: ` +
+			`${error instanceof Error ? error.message : String(error)}`);
+	}
 }
 
 async function readManifest(path: string) {

src/tools/run_manifest_validation/schema.ts

@@ -35,27 +35,6 @@ export const outputSchema = {
 				.describe("The data validated by the keyword."),
 		})
 	).describe("Array of validation error objects as returned by Ajv."),
-
-	// errors: z.array(
-	// 	z.object({
-	// 		path: z.array(
-	// 			z.any()
-	// 		).describe("An array of property keys or array offsets," +
-	// 			"indicating where inside objects or arrays the instance was found"),
-	// 		property: z.string()
-	// 			.describe("Describes the property path. Starts with instance, and is delimited with a dot (.)"),
-	// 		message: z.string()
-	// 			.describe("A human-readable message for debugging use."),
-	// 		instance: z.any()
-	// 			.describe("The instance that failed"),
-	// 		name: z.string()
-	// 			.describe("The keyword within the schema that failed."),
-	// 		argument: z.any()
-	// 			.describe("Provides information about the keyword that failed."),
-	// 		stack: z.string()
-	// 			.describe("A human-readable string representing the error."),
-	// 	}).describe("Single schema error object.")
-	// ),
 };
-export const outputSchemaObject = z.object(outputSchema);
-export type RunSchemaValidationResult = z.infer<typeof outputSchemaObject>;
+const _outputSchemaObject = z.object(outputSchema);
+export type RunSchemaValidationResult = z.infer<typeof _outputSchemaObject>;