Update DDL logic and bump hub dependency to v0.4.0

Improved schema outdated check in DDL by returning specific outdated class names and added documentation for schema generation. Updated the `hub` dependency to version 0.4.0 and adjusted tests to reflect changes. Also included minor refinements to comments and types.

Author: acrodrig

deno.json

@@ -17,7 +17,7 @@
     "@std/fmt": "jsr:@std/fmt@^1",
     "@std/fs": "jsr:@std/fs@^1",
     "@std/http": "jsr:@std/http@^1",
-    "hub": "jsr:@acr/hub@^0"
+    "hub": "jsr:@acr/hub@^0.4.0"
   },
   "publish": {
     "include": [

deno.lock

@@ -64,15 +64,23 @@ export class DDL {
     enhance = false,
     schemasFile?: string,
   ): Promise<Record<string, Schema>> {
-    const outdated = !schemas ? true : await DDL.outdatedSchemas(schemas, base);
-    if (!outdated) return schemas;
+    const outdated = !schemas ? undefined : await DDL.outdatedSchemas(schemas, base);
+    if (!outdated || outdated.length > 0) return schemas;
 
     // Generate and save
     schemas = await DDL.generateSchemas(classFiles, base, enhance);
     if (schemasFile) await Deno.writeTextFile(schemasFile, JSON.stringify(schemas, null, 2));
     return schemas;
   }
 
+  /**
+   * Generate schemas from class files
+   *
+   * @param classFiles - a map of class names to file paths
+   * @param base - the base directory where the files are located, needed for relative URLs in schema
+   * @param enhance - if true schemas will be enhanced with standard properties
+   * @returns a map of class names to schemas
+   */
   static async generateSchemas(classFiles: Record<string, string>, base?: string, enhance?: boolean): Promise<Record<string, Schema>> {
     // If DDL has no generator, throw an error
     if (!DDL.generator) throw new Error("DDL.generator must be set to a function that generates schemas from class files");
@@ -117,12 +125,13 @@ export class DDL {
     return schema;
   }
 
-  static async outdatedSchemas(schemas: Record<string, Schema> | Schema[], base = ""): Promise<boolean> {
-    for (const schema of Array.isArray(schemas) ? schemas : Object.values(schemas)) {
-      const outdated = await DDL.outdatedSchema(schema, base);
-      if (outdated) return true;
+  static async outdatedSchemas(schemas: Record<string, Schema>, base = ""): Promise<string[]> {
+    const outdated: string[] = [];
+    for (const [c, s] of Object.entries(schemas)) {
+      if (!(await DDL.outdatedSchema(s, base))) continue;
+      outdated.push(c);
     }
-    return false;
+    return outdated;
   }
 
   /**
@@ -162,7 +171,7 @@ export class DDL {
   static #defaultValue(column: Column, dbType: string) {
     const cd = column.default;
 
-    // Auto inserted/updated values
+    // Automatically inserted/updated values
     if (column.dateOn === "insert") return "CURRENT_TIMESTAMP";
     if (column.dateOn === "update") return "CURRENT_TIMESTAMP" + ((dbType !== DB.Provider.MYSQL) ? "" : " ON UPDATE CURRENT_TIMESTAMP");
 

src/ddl.ts

@@ -2,10 +2,14 @@
 
 import { assertEquals, assertExists, assertNotEquals } from "@std/assert";
 import { delay } from "@std/async";
+import { hub } from "hub";
 import { DDL } from "../src/ddl.ts";
 import type { Schema } from "../src/types.ts";
 import { createTables, dbInit, getProvider } from "./helpers.ts";
 
+// deno-lint-ignore no-global-assign
+console = hub("*", "debug", { fileLine: true });
+
 // See https://github.com/denoland/deno_std/blob/main/testing/_diff_test.ts
 
 const CI = Deno.env.has("CI");
@@ -24,6 +28,7 @@ DDL.generator = async function (classFiles: Record<string, string>, base?: strin
 import staticSchema from "../resources/account.json" with { type: "json" };
 
 // Generate dynamic schema to make sure it's the same result
+// const classFiles = { "Account": "resources/account.ts", "Point": "resources/point.ts" };
 const classFiles = { "Account": "resources/account.ts" };
 
 // Track bug https://github.com/denoland/deno/issues/28206
@@ -166,8 +171,6 @@ Deno.test("Actual Table", async function () {
 
 // Execute the table creation on the provided platform
 Deno.test("Schema Generation", async function () {
-  if (CI) return; // TODO: remove once https://github.com/denoland/deno/issues/28206 is fixed
-
   // Wait until the top of the second so that it runs within the same second
   await delay(1000 - (new Date()).getMilliseconds());