feat: update for XLTS versions

- When retrieving changesets, XLTS versions are also supported.
- In the list command, `--xlts` is changed to a filter option and includes XLTS versions in the results when enabled.

Author: mob-sakai

src/cli.ts

@@ -52,13 +52,13 @@ new Command()
       .example("unity-changeset list --lts --latest-patch", "List changesets of the latest patch versions (LTS only).")
       // Search options.
       .group("Search options")
-      .option("--all", "Search all changesets (alpha/beta included)")
-      .option("--pre-release, --beta", "Search only pre-release (alpha/beta) changesets", { conflicts: ["all", "lts", "xlts"] })
-      .option("--lts", "Only the LTS versions", { conflicts: ["all", "pre-release", "xlts", "supported"] })
-      .option("--xlts", "Only the LTS/XLTS versions (require 'Enterprise' or 'Industry' license to install XLTS version)", { conflicts: ["all", "pre-release", "lts", "supported"] })
-      .option("--supported", "Only the supported versions (including Unity 6000)", { conflicts: ["all", "pre-release", "lts", "xlts"] })
+      .option("--all", "Search in all streams (alpha/beta included)")
+      .option("--supported", "Search in the 'SUPPORTED' stream (including Unity 6000)", { conflicts: ["all", "pre-release", "lts"] })
+      .option("--lts", "Search in the 'LTS' stream", { conflicts: ["all", "supported", "pre-release"] })
+      .option("--pre-release, --beta", "Search in the 'ALPHA' and 'BETA' streams", { conflicts: ["all", "supported", "lts"] })
       // Filter options.
       .group("Filter options")
+      .option("--xlts", "Include XLTS entitlement versions (require 'Enterprise' or 'Industry' license to install XLTS version)")
       .option("--min <version>", "Minimum version (included)")
       .option("--max <version>", "Maximum version (included)")
       .option("--grep <regex>", "Regular expression (e.g. '20(18|19).4.*')")
@@ -82,11 +82,9 @@ new Command()
             ? SearchMode.PreRelease
             : options.lts
               ? SearchMode.LTS
-              : options.xlts
-                ? SearchMode.XLTS
-                : options.supported
-                  ? SearchMode.SUPPORTED
-                  : SearchMode.Default;
+              : options.supported
+                ? SearchMode.Supported
+                : SearchMode.Default;
 
         // Group mode.
         const groupMode = (options.latestPatch || options.minorVersionOnly)
@@ -103,7 +101,7 @@ new Command()
           allLifecycles: (options.allLifecycles && !options.latestLifecycle)
             ? true
             : false,
-          lts: options.lts || false,
+          xlts: options.xlts || false,
         };
 
         // Output mode.

src/index.ts

@@ -1,4 +1,4 @@
-import { getUnityReleases, getUnityReleasesInLTS } from "./unityGraphQL.ts";
+import { getUnityReleases } from "./unityGraphQL.ts";
 import {
   UnityChangeset as UnityChangesetClass,
   UnityReleaseEntitlement,
@@ -30,7 +30,11 @@ export async function getUnityChangeset(
 
   let changesets: UnityChangeset[];
   try {
-    changesets = await getUnityReleases(sanitizedVersion, []);
+    changesets = await getUnityReleases(
+      sanitizedVersion,
+      searchModeToStreams(SearchMode.All),
+      [UnityReleaseEntitlement.XLTS],
+    );
   } catch {
     changesets = await getAllChangesetsFromDb();
   }
@@ -61,8 +65,7 @@ export enum SearchMode {
   Default = 2,
   PreRelease = 3,
   LTS = 4,
-  XLTS = 5,
-  SUPPORTED = 6,
+  Supported = 6,
 }
 
 /*
@@ -94,7 +97,7 @@ export interface FilterOptions {
   max: string;
   grep: string;
   allLifecycles: boolean;
-  lts: boolean;
+  xlts: boolean;
 }
 
 /*
@@ -184,22 +187,11 @@ export function listChangesets(
 export async function searchChangesets(
   searchMode: SearchMode,
 ): Promise<UnityChangeset[]> {
+  const streams = searchModeToStreams(searchMode);
   try {
-    switch (searchMode) {
-      case SearchMode.All:
-      case SearchMode.Default:
-      case SearchMode.PreRelease:
-      case SearchMode.SUPPORTED:
-        return await getUnityReleases(".", searchModeToStreams(searchMode));
-      case SearchMode.LTS:
-        return await getUnityReleasesInLTS();
-      case SearchMode.XLTS:
-        return await getUnityReleasesInLTS([UnityReleaseEntitlement.XLTS]);
-      default:
-        throw Error(`The given search mode '${searchMode}' was not supported`);
-    }
+    return await getUnityReleases(".", streams, [UnityReleaseEntitlement.XLTS]);
   } catch {
-    return await searchChangesetsFromDb(searchMode);
+    return await searchChangesetsFromDb(streams);
   }
 }
 
@@ -237,7 +229,7 @@ export function filterChangesets(
     (c) =>
       min <= c.versionNumber &&
       c.versionNumber <= max &&
-      (!options.lts || c.lts) &&
+      (options.xlts || !c.xlts) && // Include XLTS?
       (!regex || regex.test(c.version)) &&
       (!lc || lc.some((l) => l.minor == c.minor && l.lifecycle == c.lifecycle)),
   );
@@ -303,20 +295,17 @@ export function getAllChangesetsFromDb(): Promise<UnityChangeset[]> {
 
 /**
  * Searches for Unity changesets from the database based on the specified search mode.
- * @param searchMode - The search mode to use.
+ * @param streams - The array of release streams to filter by.
  * @returns A Promise that resolves to an array of UnityChangeset objects from the database.
  */
 export function searchChangesetsFromDb(
-  searchMode: SearchMode,
+  streams: UnityReleaseStream[],
 ): Promise<UnityChangeset[]> {
   return getAllChangesetsFromDb()
     .then((changesets: UnityChangeset[]) => {
       if (!changesets || !Array.isArray(changesets)) return [];
       if (changesets.length == 0) return [];
 
-      const streams = searchModeToStreams(searchMode);
-      return searchMode === SearchMode.XLTS
-        ? changesets.filter((c) => streams.includes(c.stream))
-        : changesets.filter((c) => streams.includes(c.stream) && !c.xlts);
+      return changesets.filter((c) => streams.includes(c.stream));
     });
 }

src/unityChangeset.test.ts

@@ -13,8 +13,10 @@ import {
   GroupMode,
   SearchMode,
   UnityChangeset,
+  UnityReleaseEntitlement,
   UnityReleaseStream,
 } from "./index.ts";
+import { searchModeToStreams } from "./utils.ts";
 
 Deno.test("UnityChangeset.toNumber min", () => {
   assertEquals(UnityChangeset.toNumber("2018.3", false), 201803000000);
@@ -56,7 +58,7 @@ Deno.test("scrapeBetaChangesets", async () => {
 
 // At least one changeset from unity 6000 version should be found.
 Deno.test("scrapeUnity6000Supported", async () => {
-  const changesets = await searchChangesets(SearchMode.SUPPORTED);
+  const changesets = await searchChangesets(SearchMode.Supported);
   assertNotEquals(changesets.length, 0);
 
   const unity6000 = changesets.find(c => c.version.startsWith("6000"));
@@ -68,7 +70,7 @@ Deno.test("scrapeUnity6000Supported", async () => {
   { searchMode: SearchMode.All },
   { searchMode: SearchMode.Default },
   { searchMode: SearchMode.PreRelease },
-  { searchMode: SearchMode.SUPPORTED },
+  { searchMode: SearchMode.Supported },
 ].forEach((testcase) => {
   Deno.test(`filterChangesets(${JSON.stringify(testcase.searchMode)})`, async () => {
     const changesets = await searchChangesets(testcase.searchMode);
@@ -85,7 +87,7 @@ const changesetsForTest = [
   new UnityChangeset("2018.3.2f1", "000000000000"),
   new UnityChangeset("2018.4.0f1", "000000000000", UnityReleaseStream.LTS),
   new UnityChangeset("2018.4.1f1", "000000000000", UnityReleaseStream.LTS),
-  new UnityChangeset("2018.4.2f1", "000000000000", UnityReleaseStream.LTS),
+  new UnityChangeset("2018.4.2f1", "000000000000", UnityReleaseStream.LTS, [UnityReleaseEntitlement.XLTS]),
   new UnityChangeset("2019.1.0a1", "000000000000"),
   new UnityChangeset("2019.1.0a2", "000000000000"),
   new UnityChangeset("2019.1.0b1", "000000000000"),
@@ -103,11 +105,11 @@ const changesetsForTest = [
 
 // filterChangesets
 [
-  { options: { min: "2018.3", max: "2018.4", grep: "", allLifecycles: false, lts: false, }, expected: 6, },
-  { options: { min: "2018.3", max: "", grep: "2018", allLifecycles: false, lts: false, }, expected: 6, },
-  { options: { min: "", max: "", grep: "", allLifecycles: false, lts: true }, expected: 3, },
-  { options: { min: "2019", max: "", grep: "", allLifecycles: true, lts: false, }, expected: 13, },
-  { options: { min: "2019", max: "", grep: "b", allLifecycles: true, lts: false, }, expected: 4, },
+  { options: { min: "2018.3", max: "2018.4", grep: "", allLifecycles: false, xlts: false, }, expected: 5, },
+  { options: { min: "2018.3", max: "", grep: "2018", allLifecycles: false, xlts: false, }, expected: 5, },
+  { options: { min: "2019", max: "", grep: "", allLifecycles: true, xlts: false, }, expected: 13, },
+  { options: { min: "2019", max: "", grep: "b", allLifecycles: true, xlts: false, }, expected: 4, },
+  { options: { min: "", max: "", grep: "", allLifecycles: false, xlts: true, }, expected: 14, },
 ].forEach((testcase) => {
   Deno.test(`filterChangesets(${JSON.stringify(testcase.options)})`, () => {
     const changesets = filterChangesets(changesetsForTest, testcase.options);
@@ -129,6 +131,6 @@ const changesetsForTest = [
 });
 
 Deno.test("scrapeArchivedChangesetsFromDb", async () => {
-  const changesets = await searchChangesetsFromDb(SearchMode.Default);
+  const changesets = await searchChangesetsFromDb(searchModeToStreams(SearchMode.Default));
   assertNotEquals(changesets.length, 0);
 });

src/unityGraphQL.ts

@@ -183,69 +183,3 @@ query GetRelease($limit: Int, $skip: Int, $version: String!, $stream: [UnityRele
 
   return results;
 }
-
-/**
- * Retrieves Unity releases in LTS from the GraphQL API based on entitlements.
- * @param entitlements - The array of entitlements to filter by.
- * @returns A Promise that resolves to an array of UnityChangeset objects.
- * @throws Error if the API response is invalid.
- */
-export async function getUnityReleasesInLTS(
-  entitlements: UnityReleaseEntitlement[] = [],
-): Promise<UnityChangeset[]> {
-  const client = new GraphQLClient(UNITY_GRAPHQL_ENDPOINT);
-  const query = gql`
-query GetReleaseMajorVersions($entitlements: [UnityReleaseEntitlement!])
-{
-  getUnityReleaseMajorVersions(
-    stream: []
-    platform: []
-    architecture: []
-    entitlements: $entitlements
-  ) {
-    version
-  }
-}
-`;
-
-  const variables = {
-    entitlements: entitlements,
-  };
-
-  const cacheKey = getCacheKey(query, variables);
-  let data: UnityReleasesMajorVersionsResponse;
-
-  const cached = cache.get(cacheKey);
-  if (cached && isCacheValid(cached.timestamp)) {
-    data = cached.data as UnityReleasesMajorVersionsResponse;
-  } else {
-    data = await requestWithErrorHandling<UnityReleasesMajorVersionsResponse>(
-      client,
-      query,
-      variables,
-    );
-    cache.set(cacheKey, { data, timestamp: Date.now() });
-  }
-
-  if (!data.getUnityReleaseMajorVersions) {
-    throw new Error(
-      "Invalid response from Unity GraphQL API: missing getUnityReleaseMajorVersions",
-    );
-  }
-
-  const results = await Promise.all(data.getUnityReleaseMajorVersions
-    .map(async (v) => {
-      if (!v.version) {
-        throw new Error(
-          "Invalid response from Unity GraphQL API: missing version in major versions",
-        );
-      }
-      return await getUnityReleases(
-        v.version,
-        [UnityReleaseStream.LTS],
-        entitlements,
-      );
-    }));
-
-  return results.flat();
-}

src/utils.ts

@@ -40,11 +40,10 @@ export function searchModeToStreams(
         UnityReleaseStream.BETA,
       ];
     case SearchMode.LTS:
-    case SearchMode.XLTS:
       return [
         UnityReleaseStream.LTS,
       ];
-    case SearchMode.SUPPORTED:
+    case SearchMode.Supported:
       return [
         UnityReleaseStream.SUPPORTED,
       ];