refactor(ui5Manifest): Add cache

Author: dimovpetar

src/utils/ui5Manifest.ts

@@ -1,39 +1,61 @@
 import {getLogger} from "@ui5/logger";
 import {fetchCdn} from "./cdnHelper.js";
+import {Mutex} from "async-mutex";
 
 const log = getLogger("utils:ui5Manifest");
-const MAPPING_URL = "https://raw.githubusercontent.com/SAP/ui5-manifest/main/mapping.json";
+
 const LATEST_SCHEMA_URL = "https://raw.githubusercontent.com/SAP/ui5-manifest/main/schema.json";
-const schemaCache = new Map<string, Promise<object>>();
+const schemaCache = new Map<string, object>();
+const fetchSchemaMutex = new Mutex();
+
+let UI5ToManifestVersionMapping: Record<string, string> | null = null;
+const MAPPING_URL = "https://raw.githubusercontent.com/SAP/ui5-manifest/main/mapping.json";
+const ui5ToManifestVersionMappingMutex = new Mutex();
+
+async function getUI5toManifestVersionMapping() {
+	const release = await ui5ToManifestVersionMappingMutex.acquire();
+
+	try {
+		if (UI5ToManifestVersionMapping) {
+			log.info("Loading cached UI5 to manifest version mapping");
+			return UI5ToManifestVersionMapping;
+		}
 
-async function getUI5toManifestVersionMap() {
-	const mapping = await fetchCdn(MAPPING_URL);
+		log.info("Fetching UI5 to manifest version mapping");
+		const mapping = await fetchCdn(MAPPING_URL);
+		log.info(`Fetched UI5 to manifest version mapping from ${MAPPING_URL}`);
 
-	return mapping as Record<string, string>;
+		UI5ToManifestVersionMapping = mapping as Record<string, string>;
+
+		return UI5ToManifestVersionMapping;
+	} finally {
+		release();
+	}
 }
 
 async function fetchSchema(manifestVersion: string) {
-	if (schemaCache.has(manifestVersion)) {
-		log.info(`Loading cached schema for manifest version: ${manifestVersion}`);
-
-		try {
-			const schema = await schemaCache.get(manifestVersion)!;
-			return schema;
-		} catch {
-			schemaCache.delete(manifestVersion);
+	const release = await fetchSchemaMutex.acquire();
+
+	try {
+		if (schemaCache.has(manifestVersion)) {
+			log.info(`Loading cached schema for manifest version: ${manifestVersion}`);
+			return schemaCache.get(manifestVersion)!;
 		}
-	}
 
-	log.info(`Fetching schema for manifest version: ${manifestVersion}`);
-	schemaCache.set(manifestVersion, fetchCdn(LATEST_SCHEMA_URL));
-	const schema = await schemaCache.get(manifestVersion)!;
-	log.info(`Fetched UI5 manifest schema from ${LATEST_SCHEMA_URL}`);
+		log.info(`Fetching schema for manifest version: ${manifestVersion}`);
+		const schema = await fetchCdn(LATEST_SCHEMA_URL);
+		log.info(`Fetched UI5 manifest schema from ${LATEST_SCHEMA_URL}`);
+
+		schemaCache.set(manifestVersion, schema);
 
-	return schema;
+		return schema;
+	} finally {
+		release();
+	}
 }
 
 export async function getLatestManifestVersion() {
-	const versionMap = await getUI5toManifestVersionMap();
+	const versionMap = await getUI5toManifestVersionMapping();
 
 	if (!versionMap.latest) {
 		throw new Error("Could not determine latest manifest version.");

test/lib/utils/ui5Manifest.ts

@@ -6,6 +6,7 @@ const test = anyTest as TestFn<{
 	sinon: sinonGlobal.SinonSandbox;
 	fetchCdnStub: sinonGlobal.SinonStub;
 	getLatestManifestVersion: typeof import("../../../src/utils/ui5Manifest.js").getLatestManifestVersion;
+	getManifestSchema: typeof import("../../../src/utils/ui5Manifest.js").getManifestSchema;
 }>;
 
 test.beforeEach(async (t) => {
@@ -15,13 +16,14 @@ test.beforeEach(async (t) => {
 	t.context.fetchCdnStub = fetchCdnStub;
 
 	// Import the module with mocked dependencies
-	const {getLatestManifestVersion} = await esmock("../../../src/utils/ui5Manifest.js", {
+	const {getLatestManifestVersion, getManifestSchema} = await esmock("../../../src/utils/ui5Manifest.js", {
 		"../../../src/utils/cdnHelper.js": {
 			fetchCdn: fetchCdnStub,
 		},
 	});
 
 	t.context.getLatestManifestVersion = getLatestManifestVersion;
+	t.context.getManifestSchema = getManifestSchema;
 });
 
 test.afterEach.always((t) => {
@@ -43,6 +45,23 @@ test("getLatestManifestVersion returns correct version from CDN data", async (t)
 	t.true(fetchCdnStub.calledOnce);
 });
 
+test("getLatestManifestVersion uses cache on subsequent calls", async (t) => {
+	const {fetchCdnStub, getLatestManifestVersion} = t.context;
+	const mockData = {
+		"latest": "1.79.0",
+		"1.141": "1.79.0",
+		"1.140": "1.78.0",
+	};
+	fetchCdnStub.resolves(mockData);
+
+	const latestVersion1 = await getLatestManifestVersion();
+	const latestVersion2 = await getLatestManifestVersion();
+
+	t.is(latestVersion1, "1.79.0");
+	t.is(latestVersion2, "1.79.0");
+	t.true(fetchCdnStub.calledOnce);
+});
+
 test("getLatestManifestVersion handles fetch errors", async (t) => {
 	const {fetchCdnStub, getLatestManifestVersion} = t.context;
 
@@ -78,3 +97,63 @@ test("getLatestManifestVersion handles missing latest version", async (t) => {
 	);
 	t.true(fetchCdnStub.calledOnce);
 });
+
+test("getManifestSchema throws error for unsupported versions", async (t) => {
+	const {getManifestSchema} = t.context;
+
+	await t.throwsAsync(
+		async () => {
+			await getManifestSchema("1.78.0");
+		},
+		{
+			message: "Only 'latest' manifest version is supported, but got '1.78.0'.",
+		}
+	);
+});
+
+test("getManifestSchema fetches schema for 'latest' version", async (t) => {
+	const {fetchCdnStub, getManifestSchema} = t.context;
+	const mockSchema = {
+		$schema: "http://json-schema.org/draft-07/schema#",
+		type: "object",
+	};
+	fetchCdnStub.resolves(mockSchema);
+
+	const schema = await getManifestSchema("latest");
+
+	t.deepEqual(schema, mockSchema);
+	t.true(fetchCdnStub.calledOnce);
+});
+
+test("getManifestSchema uses cache on subsequent calls", async (t) => {
+	const {fetchCdnStub, getManifestSchema} = t.context;
+	const mockSchema = {
+		$schema: "http://json-schema.org/draft-07/schema#",
+		type: "object",
+	};
+	fetchCdnStub.resolves(mockSchema);
+
+	const schema1 = await getManifestSchema("latest");
+	const schema2 = await getManifestSchema("latest");
+
+	t.deepEqual(schema1, mockSchema);
+	t.deepEqual(schema2, mockSchema);
+	t.true(fetchCdnStub.calledOnce);
+});
+
+test("getManifestSchema handles fetch errors", async (t) => {
+	const {fetchCdnStub, getManifestSchema} = t.context;
+
+	// Mock fetch error
+	fetchCdnStub.rejects(new Error("Network error"));
+
+	await t.throwsAsync(
+		async () => {
+			await getManifestSchema("latest");
+		},
+		{
+			message: "Network error",
+		}
+	);
+	t.true(fetchCdnStub.calledOnce);
+});