feat: add --db [url] global option to use cached database instead of GraphQL

Author: mob-sakai

README.md

@@ -113,6 +113,7 @@ deno install -A -f -n unity-changeset https://deno.land/x/unity_changeset/src/cl
 
     -h, --help     - Show this help.
     -V, --version  - Show the version number for this program.
+    --db [url]     - Use cached database instead of GraphQL API. If `url` is not specified, use the default database.
 ```
 
 ```

src/cli.ts

@@ -30,8 +30,9 @@ new Command()
   .description("Find Unity changesets.")
   .example("unity-changeset 2018.4.36f1", "Get changeset of Unity 2018.4.36f1 ('6cd387d23174' will be output).")
   .arguments("<version>")
-  .action((_, version) => {
-    getUnityChangeset(version)
+  .option("--db [url]", "Use cached database instead of GraphQL API. If `url` is not specified, use the default database.")
+  .action((options, version) => {
+    getUnityChangeset(version, options.db)
       .then((c) => console.log(c.changeset))
       .catch(() => {
         console.error("The given version was not found.");
@@ -74,6 +75,9 @@ new Command()
       .option("--minor-version-only, --minor-versions", "Outputs only the minor version (no changesets)", { conflicts: ["version-only"] })
       .option("--json", "Output in json format")
       .option("--pretty-json", "Output in pretty json format")
+      // Database options.
+      .group("Database options")
+      .option("--db [url]", "Use cached database instead of GraphQL API. If `url` is not specified, use the default database.")
       .action((options) => {
         // Search mode.
         const searchMode = options.all
@@ -118,7 +122,7 @@ new Command()
             ? FormatMode.PrettyJson
             : FormatMode.None;
 
-        listChangesets(searchMode, filterOptions, groupMode, outputMode, formatMode)
+        listChangesets(searchMode, filterOptions, groupMode, outputMode, formatMode, options.db)
           .then((result) => console.log(result));
       }),
   )

src/index.ts

@@ -20,23 +20,34 @@ export { UnityReleaseEntitlement, UnityReleaseStream };
 /**
  * Retrieves the Unity changeset for a specific version.
  * @param version - The Unity version string (e.g., "2020.1.14f1").
+ * @param db - Optional database URL or true to use the default database.
  * @returns A Promise that resolves to the UnityChangeset object.
  * @throws Error if the version is not found.
  */
 export async function getUnityChangeset(
   version: string,
+  db?: string | true,
 ): Promise<UnityChangeset> {
   const sanitizedVersion = sanitizeVersion(version);
 
   let changesets: UnityChangeset[];
-  try {
-    changesets = await getUnityReleases(
-      sanitizedVersion,
-      searchModeToStreams(SearchMode.All),
-      [UnityReleaseEntitlement.XLTS],
-    );
-  } catch {
-    changesets = await getAllChangesetsFromDb();
+
+  // Database mode.
+  if (db) {
+    const dbUrl = db === true ? UNITY_CHANGESETS_DB_URL : db;
+    changesets = await getAllChangesetsFromDb(dbUrl);
+  } else {
+    // GraphQL mode.
+    try {
+      changesets = await getUnityReleases(
+        sanitizedVersion,
+        searchModeToStreams(SearchMode.All),
+        [UnityReleaseEntitlement.XLTS],
+      );
+    } catch {
+      // Fallback to default database mode.
+      changesets = await getAllChangesetsFromDb(UNITY_CHANGESETS_DB_URL);
+    }
   }
 
   if (!changesets || !Array.isArray(changesets)) {
@@ -133,6 +144,7 @@ export enum FormatMode {
  * @param groupMode - The group mode to use.
  * @param outputMode - The output mode for the results.
  * @param formatMode - The format mode for the output.
+ * @param db - Optional database URL or true to use the default database.
  * @returns A Promise that resolves to a formatted string of the results.
  */
 export function listChangesets(
@@ -141,8 +153,9 @@ export function listChangesets(
   groupMode: GroupMode,
   outputMode: OutputMode,
   formatMode: FormatMode,
+  db?: string | true,
 ): Promise<string> {
-  return searchChangesets(searchMode)
+  return searchChangesets(searchMode, db)
     .then((results) => filterChangesets(results, filterOptions))
     .then((results) =>
       results.sort((a, b) => b.versionNumber - a.versionNumber)
@@ -181,17 +194,28 @@ export function listChangesets(
 /**
  * Searches for Unity changesets based on the specified search mode.
  * @param searchMode - The search mode to use.
+ * @param db - Optional database URL or true to use the default database.
  * @returns A Promise that resolves to an array of UnityChangeset objects.
  * @throws Error if the search mode is not supported.
  */
 export async function searchChangesets(
   searchMode: SearchMode,
+  db?: string | true,
 ): Promise<UnityChangeset[]> {
   const streams = searchModeToStreams(searchMode);
+
+  // Database mode.
+  if (db) {
+    const dbUrl = db === true ? UNITY_CHANGESETS_DB_URL : db;
+    return searchChangesetsFromDb(streams, dbUrl);
+  }
+
   try {
+    // GraphQL mode.
     return await getUnityReleases(".", streams, [UnityReleaseEntitlement.XLTS]);
   } catch {
-    return await searchChangesetsFromDb(streams);
+    // Fallback to default database mode.
+    return await searchChangesetsFromDb(streams, UNITY_CHANGESETS_DB_URL);
   }
 }
 
@@ -271,37 +295,42 @@ export function groupChangesets(
 
 /**
  * Retrieves all Unity changesets from the database.
+ * @param db - Database URL. If not specified, use the default database.
  * @returns A Promise that resolves to an array of all UnityChangeset objects from the database.
  * @throws Error if the database cannot be fetched or is invalid.
  */
-export function getAllChangesetsFromDb(): Promise<UnityChangeset[]> {
-  return fetch(UNITY_CHANGESETS_DB_URL)
+export function getAllChangesetsFromDb(
+  db: string = UNITY_CHANGESETS_DB_URL,
+): Promise<UnityChangeset[]> {
+  return fetch(db)
     .then((res) => {
       if (!res.ok) {
         throw Error(
           `The Unity changeset database could not be fetched: ${res.status} ${res.statusText}`,
         );
       }
 
-      return res.json() as Promise<UnityChangeset[]>;
+      return res.json() as Promise<any[]>;
     })
     .then((data) => {
       if (!Array.isArray(data)) {
         throw new Error("Invalid changeset database format: expected array");
       }
-      return data;
+      return data.map((item) => new UnityChangeset(item.version, item.changeset, item.stream, item.entitlements));
     });
 }
 
 /**
  * Searches for Unity changesets from the database based on the specified search mode.
  * @param streams - The array of release streams to filter by.
+ * @param db - Database URL. If not specified, use the default database.
  * @returns A Promise that resolves to an array of UnityChangeset objects from the database.
  */
 export function searchChangesetsFromDb(
   streams: UnityReleaseStream[],
+  db: string = UNITY_CHANGESETS_DB_URL,
 ): Promise<UnityChangeset[]> {
-  return getAllChangesetsFromDb()
+  return getAllChangesetsFromDb(db)
     .then((changesets: UnityChangeset[]) => {
       if (!changesets || !Array.isArray(changesets)) return [];
       if (changesets.length == 0) return [];

src/unityChangeset.test.ts

@@ -70,10 +70,11 @@ Deno.test("UnityChangeset.toString", () => {
 [
   { version: "2018.3.0f1", expected: "f023c421e164" },
   { version: "2018.3.0f2", expected: "6e9a27477296" },
-  { version: "2018.3.0f3", expected: undefined },
-  { version: "2019.1.0a9", expected: "0acd256790e8" },
-  { version: "2019.1.0b1", expected: "83b3ba1f99df" },
-  { version: "6000.1.0f1", expected: "9ea152932a88" },
+  { version: "2018.3.0f3", expected: undefined }, // Not existing version
+  { version: "2019.1.0a9", expected: "0acd256790e8" }, // Alpha
+  { version: "2019.1.0b1", expected: "83b3ba1f99df" }, // Beta
+  { version: "6000.1.0f1", expected: "9ea152932a88" }, // Supported
+  { version: "2022.3.67f2", expected: "6bedba8691df" }, // XLTS
 ].forEach((testcase) => {
   Deno.test(`getUnityChangeset (${testcase.version})`, async () => {
     if (testcase.expected) {
@@ -111,6 +112,7 @@ Deno.test("scrapeUnity6000Supported", async () => {
   { searchMode: SearchMode.Default },
   { searchMode: SearchMode.PreRelease },
   { searchMode: SearchMode.Supported },
+  { searchMode: SearchMode.LTS },
 ].forEach((testcase) => {
   Deno.test(`filterChangesets(${JSON.stringify(testcase.searchMode)})`, async () => {
     const changesets = await searchChangesets(testcase.searchMode);