[INTERNAL] ui5-workspace.yaml schema (#543)

JIRA: CPOUI5FOUNDATION-584

Provide ui5-workspace.yaml schema that complies with the [local dependency resolution spec](https://github.com/SAP/ui5-tooling/blob/rfc-local-dependency-resolution/rfcs/0006-local-dependency-resolution.md#workspace-configuration-file)

For further details, check the [RFC 0006 Local Dependency Resolution](https://github.com/SAP/ui5-tooling/blob/rfc-local-dependency-resolution/rfcs/0006-local-dependency-resolution.md)

Author: d3xter666

lib/validation/ValidationError.js

@@ -49,7 +49,14 @@ class ValidationError extends Error {
 			separator += chalk.grey.dim("\u2500".repeat(process.stdout.columns || 80));
 		}
 		separator += "\n\n";
-		let message = chalk.red(`Invalid ui5.yaml configuration for project ${this.project.id}`) + "\n\n";
+		let message;
+
+		if (this.project) { // ui5-workspace.yaml is project independent, so in that case, no project is available
+			message = chalk.red(`Invalid ui5.yaml configuration for project ${this.project.id}`) + "\n\n";
+		} else {
+			message = chalk.red(`Invalid workspace configuration.`) + "\n\n";
+		}
+
 		message += this.errors.map((error) => {
 			return this.formatError(error);
 		}).join(separator);

lib/validation/schema/ui5-workspace.json

@@ -0,0 +1,54 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema",
+	"$id": "http://ui5.sap/schema/ui5-workspace.json",
+	"title": "ui5-workspace.yaml",
+	"description": "Schema for UI5 Tooling Workspace Configuration File (ui5-workspace.yaml)",
+	"$comment": "See https://sap.github.io/ui5-tooling/",
+	"type": "object",
+	"required": ["specVersion", "metadata", "dependencyManagement"],
+	"properties": {
+		"additionalProperties": false,
+		"specVersion": {
+			"enum": ["workspace/1.0"],
+			"errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"workspace/1.0\"\nFor details see: // TODO: Add link to Documentation"
+		},
+		"metadata": {
+			"$ref": "#/definitions/metadata"
+		},
+		"dependencyManagement": {
+			"$ref": "#/definitions/dependencyManagement"
+		}
+	},
+	"definitions": {
+		"metadata": {
+			"type": "object",
+			"required": ["name"],
+			"properties": {
+				"additionalProperties": false,
+				"name": {
+					"type": "string",
+					"errorMessage": "Workspace name is not provided. There must be a wokrspace name defined."
+				}
+			}
+		},
+		"dependencyManagement": {
+			"type": "object",
+			"properties": {
+				"additionalProperties": false,
+				"resolutions": {
+					"type": "array",
+					"additionalProperties": false,
+					"items": {
+						"type": "object",
+						"additionalProperties": false,
+						"properties": {
+							"path": {
+								"type": "string"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

lib/validation/validator.js

@@ -1,28 +1,48 @@
 import {fileURLToPath} from "node:url";
 import {readFile} from "node:fs/promises";
 
-async function loadSchema(schemaPath) {
-	const filePath = schemaPath.replace("http://ui5.sap/schema/", "");
-	const schemaFile = await readFile(
-		fileURLToPath(new URL(`./schema/${filePath}`, import.meta.url)), {encoding: "utf8"}
-	);
-	return JSON.parse(schemaFile);
-}
+/**
+ * @module @ui5/project/validation/validator
+ * @description A collection of validation related APIs
+ * @public
+ */
+
+/**
+ * @enum {string}
+ * @private
+ * @readonly
+ */
+export const SCHEMA_VARIANTS = {
+	"ui5": "ui5.json",
+	"ui5-workspace": "ui5-workspace.json"
+};
 
 class Validator {
-	constructor({Ajv, ajvErrors}) {
+	constructor({Ajv, ajvErrors, schemaName}) {
+		if (!schemaName && !SCHEMA_VARIANTS[schemaName]) {
+			throw new Error(
+				`"schemaName" is missing or incorrect. The available schemaName variants are ${Object.keys(
+					SCHEMA_VARIANTS
+				).join(", ")}`
+			);
+		}
+
+		this._schemaName = SCHEMA_VARIANTS[schemaName];
+
 		this.ajv = new Ajv({
 			allErrors: true,
 			jsonPointers: true,
-			loadSchema
+			loadSchema: Validator.loadSchema
 		});
 		ajvErrors(this.ajv);
 	}
 
 	_compileSchema() {
+		const schemaName = this._schemaName;
+
 		if (!this._compiling) {
 			this._compiling = Promise.resolve().then(async () => {
-				const schema = await loadSchema("ui5.json");
+				const schema = await Validator.loadSchema(schemaName);
 				const validate = await this.ajv.compileAsync(schema);
 				return validate;
 			});
@@ -46,18 +66,33 @@ class Validator {
 			});
 		}
 	}
+
+	static async loadSchema(schemaPath) {
+		const filePath = schemaPath.replace("http://ui5.sap/schema/", "");
+		const schemaFile = await readFile(
+			fileURLToPath(new URL(`./schema/${filePath}`, import.meta.url)), {encoding: "utf8"}
+		);
+		return JSON.parse(schemaFile);
+	}
 }
 
-let validator;
+const validator = Object.create(null);
 
-/**
- * @module @ui5/project/validation/validator
- * @description A collection of validation related APIs
- * @public
- */
+async function _validate(schemaName, options) {
+	if (!validator[schemaName]) {
+		validator[schemaName] = (async () => {
+			const {default: Ajv} = await import("ajv");
+			const {default: ajvErrors} = await import("ajv-errors");
+			return new Validator({Ajv, ajvErrors, schemaName});
+		})();
+	}
+
+	const schemaValidator = await validator[schemaName];
+	await schemaValidator.validate(options);
+}
 
 /**
- * Validates the given configuration.
+ * Validates the given ui5 configuration.
  *
  * @public
  * @function
@@ -76,12 +111,28 @@ let validator;
  * @returns {Promise<undefined>} Returns a Promise that resolves when the validation succeeds
  */
 export async function validate(options) {
-	if (!validator) {
-		const {default: Ajv} = await import("ajv");
-		const {default: ajvErrors} = await import("ajv-errors");
-		validator = new Validator({Ajv, ajvErrors});
-	}
-	await validator.validate(options);
+	await _validate("ui5", options);
+}
+
+/**
+ * Validates the given ui5-workspace configuration.
+ *
+ * @public
+ * @function
+ * @static
+ * @param {object} options
+ * @param {object} options.config ui5-workspace Configuration to validate
+ * @param {object} [options.yaml] YAML information
+ * @param {string} options.yaml.path Path of the YAML file
+ * @param {string} options.yaml.source Content of the YAML file
+ * @param {number} [options.yaml.documentIndex=0] Document index in case the YAML file contains multiple documents
+ * @throws {@ui5/project/validation/ValidationError}
+ *   Rejects with a {@link @ui5/project/validation/ValidationError ValidationError}
+ *   when the validation fails.
+ * @returns {Promise<undefined>} Returns a Promise that resolves when the validation succeeds
+ */
+export async function validateWorkspace(options) {
+	await _validate("ui5-workspace", options);
 }
 
 export {

test/lib/validation/schema/specVersion/kind/extension.js

@@ -22,7 +22,7 @@ async function assertValidation(t, config, expectedErrors = undefined) {
 }
 
 test.before((t) => {
-	t.context.validator = new Validator({Ajv, ajvErrors});
+	t.context.validator = new Validator({Ajv, ajvErrors, schemaName: "ui5"});
 	t.context.ajvCoverage = new AjvCoverage(t.context.validator.ajv, {
 		includes: ["schema/specVersion/kind/extension.json"]
 	});

test/lib/validation/schema/specVersion/kind/extension/project-shim.js

@@ -23,7 +23,7 @@ async function assertValidation(t, config, expectedErrors = undefined) {
 }
 
 test.before((t) => {
-	t.context.validator = new Validator({Ajv, ajvErrors});
+	t.context.validator = new Validator({Ajv, ajvErrors, schemaName: "ui5"});
 	t.context.ajvCoverage = new AjvCoverage(t.context.validator.ajv, {
 		includes: ["schema/specVersion/kind/extension/project-shim.json"]
 	});

test/lib/validation/schema/specVersion/kind/extension/server-middleware.js

@@ -23,7 +23,7 @@ async function assertValidation(t, config, expectedErrors = undefined) {
 }
 
 test.before((t) => {
-	t.context.validator = new Validator({Ajv, ajvErrors});
+	t.context.validator = new Validator({Ajv, ajvErrors, schemaName: "ui5"});
 	t.context.ajvCoverage = new AjvCoverage(t.context.validator.ajv, {
 		includes: ["schema/specVersion/kind/extension/server-middleware.json"]
 	});

test/lib/validation/schema/specVersion/kind/extension/task.js

@@ -23,7 +23,7 @@ async function assertValidation(t, config, expectedErrors = undefined) {
 }
 
 test.before((t) => {
-	t.context.validator = new Validator({Ajv, ajvErrors});
+	t.context.validator = new Validator({Ajv, ajvErrors, schemaName: "ui5"});
 	t.context.ajvCoverage = new AjvCoverage(t.context.validator.ajv, {
 		includes: ["schema/specVersion/kind/extension/task.json"]
 	});

test/lib/validation/schema/specVersion/kind/project.js

@@ -22,7 +22,7 @@ async function assertValidation(t, config, expectedErrors = undefined) {
 }
 
 test.before((t) => {
-	t.context.validator = new Validator({Ajv, ajvErrors});
+	t.context.validator = new Validator({Ajv, ajvErrors, schemaName: "ui5"});
 	t.context.ajvCoverage = new AjvCoverage(t.context.validator.ajv, {
 		includes: ["schema/specVersion/kind/project.json"]
 	});

test/lib/validation/schema/specVersion/kind/project/application.js

@@ -28,7 +28,7 @@ async function assertValidation(t, config, expectedErrors = undefined) {
 }
 
 test.before((t) => {
-	t.context.validator = new Validator({Ajv, ajvErrors});
+	t.context.validator = new Validator({Ajv, ajvErrors, schemaName: "ui5"});
 	t.context.ajvCoverage = new AjvCoverage(t.context.validator.ajv, {
 		includes: ["schema/specVersion/kind/project/application.json"]
 	});

test/lib/validation/schema/specVersion/kind/project/library.js

@@ -28,7 +28,7 @@ async function assertValidation(t, config, expectedErrors = undefined) {
 }
 
 test.before((t) => {
-	t.context.validator = new Validator({Ajv, ajvErrors});
+	t.context.validator = new Validator({Ajv, ajvErrors, schemaName: "ui5"});
 	t.context.ajvCoverage = new AjvCoverage(t.context.validator.ajv, {
 		includes: ["schema/specVersion/kind/project/library.json"]
 	});