fix: fallback to 1.71.49 for old supported UI5 versions (#608)

* fix: customer issue fix

* fix: work on pr comment

* fix: version negotiation logic change

* fix: readme styling

Author: vadson71

.changeset/unlucky-trainers-hang.md

@@ -0,0 +1,7 @@
+---
+"@ui5-language-assistant/context": patch
+"vscode-ui5-language-assistant": patch
+"@ui5-language-assistant/vscode-ui5-language-assistant-bas-ext": patch
+---
+
+Issue 538 fix, for UI5 versions 1.38 and below the fallback 1.71.49 is used

README.md

@@ -35,6 +35,18 @@ It currently contains:
 [npm-bas-ext-url]: https://www.npmjs.com/package/@ui5-language-assistant/vscode-ui5-language-assistant-bas-ext
 [npm-bas-ext-image]: https://img.shields.io/npm/v/@ui5-language-assistant/vscode-ui5-language-assistant-bas-ext.svg
 
+## Limitations
+
+### UI5 version and framework.
+
+This extension derives the UI5 version in the following sequence:
+
+1. The `minUI5Version` from the manifest.json file (see note)
+2. Lookup in CDN for UI5 version and negotiate to the closest LTS version (see note).
+3. If it is not found or the version is 1.38 or older, then default back to 1.71 (latest patch level). The framework (SAPUI5/OpenUI5) is derived from the ui5.yaml file. This defaults to SAPUI5.
+
+Note: If `minUI5Version` not found in the manifest.json or lookup in CDN fails, then fall back to default 1.71.49 version
+
 ## Support
 
 Please open [issues](https://github.com/SAP/ui5-language-assistant/issues) on github.

packages/context/src/ui5-model.ts

@@ -361,29 +361,40 @@ export async function negotiateVersionWithFetcher(
   let isFallback = false;
   let isIncorrectVersion = false;
   let versions = versionMap[framework];
+
+  let adjustedVersion: string = version || DEFAULT_UI5_VERSION;
+
+  if (version && !isVersionSupported(version)) {
+    // version is out of support in LA, using default version
+    getLogger().warn(
+      `The version specified as minUI5Version in your manifest.json is not supported by Language Assistant, the fallback version ${DEFAULT_UI5_VERSION} is used instead`
+    );
+    adjustedVersion = "1.71";
+    isIncorrectVersion = true;
+  }
+
   if (!version) {
     // no version defined, using default version
     getLogger().warn(
       "No version defined! Please check the minUI5Version in your manifest.json!"
     );
-    version = DEFAULT_UI5_VERSION;
     isFallback = true;
-  } else if (resolvedVersions[framework]?.[version]) {
+  } else if (resolvedVersions[framework]?.[adjustedVersion]) {
     // version already resolved?
-    const versionDefined = version;
-    version = resolvedVersions[framework]?.[version];
-    if (versionDefined !== version) {
+    const versionDefined = adjustedVersion;
+    adjustedVersion = resolvedVersions[framework]?.[adjustedVersion];
+    if (versionDefined !== adjustedVersion) {
       isIncorrectVersion = true;
     }
   } else if (
     !(await getVersionInfo(
       versionInfoJsonFetcher,
       modelCachePath,
       framework,
-      version
+      adjustedVersion
     ))
   ) {
-    const requestedVersion = version;
+    const requestedVersion = adjustedVersion;
     // no version information found, try to negotiate the version
     if (!versions) {
       // retrieve the version mapping (only exists for SAPUI5 so far)
@@ -414,51 +425,65 @@ export async function negotiateVersionWithFetcher(
       versions = versionMap[framework];
     }
     // coerce the version (check for invalid version, which indicates development scenario)
-    const parsedVersion = semver.coerce(version);
+    const parsedVersion = semver.coerce(adjustedVersion);
     if (parsedVersion) {
       if (versions[`${parsedVersion.major}.${parsedVersion.minor}`]) {
         // lookup for a valid major.minor entry
-        version =
+        adjustedVersion =
           versions[`${parsedVersion.major}.${parsedVersion.minor}`].version;
       }
       if (
         !(await getVersionInfo(
           versionInfoJsonFetcher,
           modelCachePath,
           framework,
-          version
+          adjustedVersion
         ))
       ) {
         // find closest supported version
-        version =
+        adjustedVersion =
           semverMinSatisfying(
             Object.values(versions).map((entry) => {
               return entry.version;
             }) as string[],
-            `^${version}`
+            `^${adjustedVersion}`
           ) || versions["latest"].version;
 
         isIncorrectVersion = true;
       }
     } else {
       // development scenario => use latest version
-      version = versions["latest"].version;
+      adjustedVersion = versions["latest"].version;
       isIncorrectVersion = true;
     }
     // store the resolved version
     if (requestedVersion) {
-      if (requestedVersion !== version) {
+      if (requestedVersion !== adjustedVersion) {
         isIncorrectVersion = true;
       }
       if (!resolvedVersions[framework]) {
         resolvedVersions[framework] = Object.create(null);
       }
-      resolvedVersions[framework][requestedVersion] = version;
+      resolvedVersions[framework][requestedVersion] = adjustedVersion;
     }
   }
   return {
-    version: version ?? DEFAULT_UI5_VERSION,
+    version: adjustedVersion,
     isFallback,
     isIncorrectVersion,
   };
 }
+
+// Versions 1.38 and older are not supported because of missing features in the API, while the LA relies on that API for validation.
+// See https://github.com/SAP/ui5-language-assistant/issues/538 for details
+function isVersionSupported(version: string | undefined): boolean {
+  const versionDetails = semver.coerce(version);
+  if (!versionDetails) {
+    return false;
+  }
+  return !(
+    versionDetails.major === 1 &&
+    versionDetails.minor &&
+    versionDetails.minor <= 38
+  );
+}

packages/context/test/unit/ui5-model.test.ts

@@ -520,7 +520,7 @@ describe("the UI5 language assistant ui5 model", () => {
       expect(objNegotiatedVersionWithFetcher.isIncorrectVersion).toBeTrue();
     });
 
-    it("resolve invalid versions (should be latest)", async () => {
+    it("resolve invalid versions (should be fallback)", async () => {
       let objNegotiatedVersionWithFetcher = await negotiateVersionWithFetcher(
         async (): Promise<FetchResponse> => {
           return createResponse(true, 200, versionMap[FRAMEWORK]);
@@ -551,7 +551,7 @@ describe("the UI5 language assistant ui5 model", () => {
       expect(objNegotiatedVersionWithFetcher.isIncorrectVersion).toBeFalse();
     });
 
-    it("resolve invalid versions OpenUI5 (should be latest)", async () => {
+    it("resolve invalid versions OpenUI5 (should be fallback)", async () => {
       const objNegotiatedVersionWithFetcher = await negotiateVersionWithFetcher(
         async (): Promise<FetchResponse> => {
           return createResponse(true, 200, versionMap[OPEN_FRAMEWORK]);
@@ -567,5 +567,39 @@ describe("the UI5 language assistant ui5 model", () => {
       expect(objNegotiatedVersionWithFetcher.isFallback).toBeTrue();
       expect(objNegotiatedVersionWithFetcher.isIncorrectVersion).toBeFalse();
     });
+
+    it("resolve unsupported versions (should be latest)", async () => {
+      const objNegotiatedVersionWithFetcher = await negotiateVersionWithFetcher(
+        async (): Promise<FetchResponse> => {
+          return createResponse(true, 200, versionMap[OPEN_FRAMEWORK]);
+        },
+        async (): Promise<FetchResponse> => {
+          return createResponse(false, 404);
+        },
+        cachePath,
+        FRAMEWORK,
+        "1.38"
+      );
+      expect(objNegotiatedVersionWithFetcher.version).toEqual("1.71.50");
+      expect(objNegotiatedVersionWithFetcher.isFallback).toBeFalse();
+      expect(objNegotiatedVersionWithFetcher.isIncorrectVersion).toBeTrue();
+    });
+
+    it("resolve wrong versions (should be latest)", async () => {
+      const objNegotiatedVersionWithFetcher = await negotiateVersionWithFetcher(
+        async (): Promise<FetchResponse> => {
+          return createResponse(true, 200, versionMap[OPEN_FRAMEWORK]);
+        },
+        async (): Promise<FetchResponse> => {
+          return createResponse(false, 404);
+        },
+        cachePath,
+        FRAMEWORK,
+        "a.b"
+      );
+      expect(objNegotiatedVersionWithFetcher.version).toEqual("1.71.50");
+      expect(objNegotiatedVersionWithFetcher.isFallback).toBeFalse();
+      expect(objNegotiatedVersionWithFetcher.isIncorrectVersion).toBeTrue();
+    });
   });
 });