feat: use GraphQL to fetch Unity releases

#16

Author: mob-sakai

src/index.ts

@@ -1,29 +1,9 @@
 import { UnityChangeset as UnityChangesetClass } from "./unityChangeset.ts";
+import { getUnityReleases, UnityReleaseStream } from "./unityGraphQL.ts";
 
 export const UnityChangeset = UnityChangesetClass;
 export type UnityChangeset = UnityChangesetClass;
 
-const REGEXP_HUB_LINKS = /unityhub:\/\/\d{4}\.\d+\.\d+(a|b|f)\d+\/\w{12}/g;
-const REGEXP_UNITY_VERSION = /\d{4}\.\d+\.\d+(a|b|f)\d+/g;
-const UNITY_CHANGESETS_DB_URL =
-  "https://mob-sakai.github.io/unity-changeset/db";
-const UNITY_RSS_URLS: string[] = [
-  "https://unity.com/releases/editor/lts-releases.xml",
-  "https://unity.com/releases/editor/tech-and-preview-releases.xml",
-  "https://unity.com/releases/editor/beta-releases.xml",
-  "https://unity.com/releases/editor/alpha-releases.xml",
-];
-
-/*
-Unity release URLs for each lifecycle.
-*/
-const UNITY_RELEASE_URLS: { [key: string]: string } = {
-  "p": "https://unity.com/releases/editor/whats-new/",
-  "f": "https://unity.com/releases/editor/whats-new/",
-  "a": "https://unity.com/releases/editor/alpha/",
-  "b": "https://unity.com/releases/editor/beta/",
-};
-
 /*
  * Get an Unity changeset from specific Unity version.
  * @param version The Unity version.
@@ -32,35 +12,13 @@ const UNITY_RELEASE_URLS: { [key: string]: string } = {
 export async function getUnityChangeset(
   version: string,
 ): Promise<UnityChangeset> {
-  const db = await loadDb();
-  const results = db.filter((c) => c.version === version);
-  return results.length > 0
-    ? results[0]
-    : getUnityChangesetFromReleasePage(version);
-}
-
-async function getUnityChangesetFromReleasePage(
-  version: string,
-): Promise<UnityChangeset> {
-  const match = version.match(/^(\d+\.\d+\.\d+)(a|b|f|p)\d+$/);
-  const lifecycle = match?.[2] as string;
-  const releaseUrl = UNITY_RELEASE_URLS[lifecycle];
-  const shortVersion = match?.[1] as string;
-  const releasePageUrl = releaseUrl +
-    (lifecycle == "f" ? shortVersion : version);
-  const response = await fetch(releasePageUrl);
-  const text = await response.text();
-  const matchLink = text.match(REGEXP_HUB_LINKS);
-  if (!matchLink) {
-    throw new Error(`No changeset found at '${releasePageUrl}'`);
+  const changesets = (await getUnityReleases(version, []))
+    .filter((c) => c.version === version);
+  if (0 < changesets.length) {
+    return changesets[0];
   }
 
-  const changeset = UnityChangeset.createFromHref(matchLink[0]);
-  if (changeset.version !== version) {
-    throw new Error(`No changeset found at '${releasePageUrl}'`);
-  }
-
-  return changeset;
+  throw Error(`The given version '${version}' was not found.`);
 }
 
 /*
@@ -143,6 +101,9 @@ export function listChangesets(
 ): Promise<string> {
   return searchChangesets(searchMode)
     .then((results) => filterChangesets(results, filterOptions))
+    .then((results) =>
+      results.sort((a, b) => b.versionNumber - a.versionNumber)
+    )
     .then((results) => groupChangesets(results, groupMode))
     .then((results) => {
       switch (outputMode) {
@@ -174,51 +135,22 @@ export function listChangesets(
     });
 }
 
-async function loadDb(): Promise<UnityChangeset[]> {
-  const response = await fetch(UNITY_CHANGESETS_DB_URL);
-  const text = await response.text();
-  const lines = text.split("\n");
-  return lines
-    .map((line) => UnityChangeset.createFromDb(line));
-}
-
-async function findVersions(url: string): Promise<string[]> {
-  const response = await fetch(url);
-  const text = await response.text();
-  const lines = text.split("\n");
-
-  const versions = lines
-    .map((l) => l.match(REGEXP_UNITY_VERSION))
-    .filter((m) => m)
-    .map((m) => m?.[0] as string);
-  return Array.from(new Set<string>(versions));
-}
-
-export async function searchChangesets(
+export function searchChangesets(
   searchMode: SearchMode,
 ): Promise<UnityChangeset[]> {
-  const results = await loadDb();
-  const versions = await Promise.all(UNITY_RSS_URLS
-    .map((url) => findVersions(url)));
-  const appendResults = await Promise.all(
-    versions
-      .flat()
-      .filter((v) => !results.some((r) => r.version === v))
-      .map((v) => getUnityChangesetFromReleasePage(v)),
-  );
-  const allResults = results
-    .concat(appendResults)
-    .sort((a, b) => b.versionNumber - a.versionNumber);
-
   switch (searchMode) {
     case SearchMode.All:
-      return allResults;
+      return getUnityReleases(".", []);
     case SearchMode.Default:
-      return allResults
-        .filter((c) => !c.preRelease);
+      return getUnityReleases(".", [
+        UnityReleaseStream.LTS,
+        UnityReleaseStream.TECH,
+      ]);
     case SearchMode.PreRelease:
-      return allResults
-        .filter((c) => c.preRelease);
+      return getUnityReleases(".", [
+        UnityReleaseStream.BETA,
+        UnityReleaseStream.ALPHA,
+      ]);
     default:
       throw Error(`The given search mode '${searchMode}' was not supported`);
   }

src/unityChangeset.ts

@@ -1,4 +1,3 @@
-const REGEXP_HUB_LINK = /^unityhub:\/\/(\d{4}\.\d+\.\d+(a|b|f|p)\d+)\/(\w{12})$/;
 const REGEXP_UNITY = /^(\d+)\.(\d+)\.(\d+)([a-zA-Z]+)(\d+)/;
 const REGEXP_UNITY_NUM = /^(\d+)\.?(\d+)?\.?(\d+)?([a-zA-Z]+)?(\d+)?/;
 
@@ -24,38 +23,10 @@ export class UnityChangeset {
     }
   }
 
-  get preRelease(): boolean {
-    switch (this.lifecycle) {
-      case "a":
-        return true;
-      case "b":
-        return true;
-      default:
-        return false;
-    }
-  }
-
   toString = (): string => {
     return `${this.version}\t${this.changeset}`;
   };
 
-  /*
-   * Convert a Unity version to a number.
-   */
-  static isValid = (href: string): boolean => {
-    return REGEXP_HUB_LINK.test(href);
-  };
-
-  static createFromDb = (line: string): UnityChangeset => {
-    const splited = line.split("\t");
-    return new UnityChangeset(splited[0], splited[1]);
-  };
-
-  static createFromHref = (href: string): UnityChangeset => {
-    const match = href.match(REGEXP_HUB_LINK);
-    return new UnityChangeset(match?.[1] as string, match?.[3] as string);
-  };
-
   static toNumber = (version: string, max: boolean): number => {
     const match = version.toString().match(REGEXP_UNITY_NUM);
     if (match === null) return 0;

src/unityGraphQL.ts

@@ -0,0 +1,72 @@
+import { UnityChangeset } from "./unityChangeset.ts";
+import { gql, GraphQLClient } from "npm:[email protected]";
+
+const UNITY_GRAPHQL_ENDPOINT: string = "https://services.unity.com/graphql";
+
+export enum UnityReleaseStream {
+  LTS = "LTS",
+  TECH = "TECH",
+  BETA = "BETA",
+  ALPHA = "ALPHA",
+}
+
+interface UnityReleasesResponse {
+  getUnityReleases: {
+    totalCount: number;
+    edges: { node: { version: string; shortRevision: string } }[];
+    pageInfo: { hasNextPage: boolean };
+  };
+}
+
+export async function getUnityReleases(
+  version: string,
+  stream: UnityReleaseStream[] = [],
+): Promise<UnityChangeset[]> {
+  const client = new GraphQLClient(UNITY_GRAPHQL_ENDPOINT);
+  const query = gql`
+query GetRelease($limit: Int, $skip: Int, $version: String!, $stream: [UnityReleaseStream!])
+{
+  getUnityReleases(
+    limit: $limit
+    skip: $skip
+    stream: $stream
+    version: $version
+    entitlements: []
+  ) {
+    totalCount
+    edges {
+      node {
+        version
+        shortRevision
+      }
+    }
+    pageInfo {
+      hasNextPage
+    }
+  }
+}
+`;
+  const variables = {
+    limit: 1000,
+    skip: 0,
+    version: version,
+    stream: stream,
+  };
+
+  const results: UnityChangeset[] = [];
+  while (true) {
+    const data: UnityReleasesResponse = await client.request(query, variables);
+    results.push(
+      ...data.getUnityReleases.edges.map((edge) =>
+        new UnityChangeset(edge.node.version, edge.node.shortRevision)
+      ),
+    );
+    if (data.getUnityReleases.pageInfo.hasNextPage === false) {
+      break;
+    }
+
+    variables.skip += variables.limit;
+  }
+
+  return results;
+}