@ghom/orm 1.8.4 → 1.8.6

package/.github/workflows/test.yml

@@ -20,10 +20,46 @@ jobs:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
+    services:
+      postgres:
+        # Docker command:
+        # docker run --name pg_orm -e POSTGRES_PASSWORD=postgres -e POSTGRES_USER=postgres -e POSTGRES_DB=postgres -p 5432:5432 -d postgres
+        image: postgres
+
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_USER: postgres
+          POSTGRES_DB: postgres
+
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+      mysql:
+        # Docker command:
+        # docker run --name mysql_orm -e MYSQL_ROOT_PASSWORD=mysql -e MYSQL_DATABASE=mysql -p 3306:3306 -d mysql:5.7
+        image: mysql:5.7
+
+        env:
+          MYSQL_ROOT_PASSWORD: mysql
+          MYSQL_DATABASE: mysql
+
+        options: >-
+          --health-cmd "mysqladmin ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 3306:3306
+
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
       - name: Setup Node
         uses: actions/setup-node@v3
@@ -36,5 +72,17 @@ jobs:
       - name: Build the source
         run: npm run build
 
-      - name: Start the tests
+      - name: Start the tests on SQLite
+        run: npm run test
+
+      - name: Start the tests on PostgreSQL
+        run: npm run test
+        env:
+          DB_CLIENT: pg
+          DB_CONNECTION: postgres://postgres:postgres@localhost:5432/postgres
+
+      - name: Start the tests on MySQL
         run: npm run test
+        env:
+          DB_CLIENT: mysql2
+          DB_CONNECTION: mysql://root:mysql@localhost:3306/mysql

package/dist/app/backup.d.ts

@@ -1,6 +1,7 @@
+import { Knex } from "knex";
 import { ORM } from "./orm.js";
 import { Table } from "./table.js";
 export declare function backupTable(table: Table, dirname?: string): Promise<void>;
-export declare function restoreBackup(table: Table, dirname?: string): Promise<void>;
-export declare function disableForeignKeys(orm: ORM): Promise<void>;
-export declare function enableForeignKeys(orm: ORM): Promise<void>;
+export declare function restoreBackup(table: Table, trx: Knex.Transaction | Knex, dirname?: string): Promise<void>;
+export declare function enableForeignKeys(orm: ORM, trx?: Knex.Transaction | Knex): Promise<void>;
+export declare function disableForeignKeys(orm: ORM, run: (trx: Knex.Transaction | Knex) => unknown): Promise<void>;

package/dist/app/backup.js

@@ -53,14 +53,14 @@ export async function backupTable(table, dirname) {
         console.error(`\nError while backing up table ${util.styleText(table.orm.config.loggerStyles?.highlight ?? DEFAULT_LOGGER_HIGHLIGHT, table.options.name)}:`, error);
     }
 }
-export async function restoreBackup(table, dirname) {
+export async function restoreBackup(table, trx, dirname) {
     if (!table.orm)
         throw new Error("missing ORM");
     const chunkDir = path.join(table.orm.config.backups?.location ?? DEFAULT_BACKUP_LOCATION, dirname ?? "");
     const chunkFiles = fs
         .readdirSync(chunkDir)
         .filter((file) => file.split("_chunk_")[0] === table.options.name);
-    await table.query.truncate();
+    await trx(table.options.name).del();
     try {
         const limit = 1000; // Limite par requête
         for (let chunkFile of chunkFiles) {
@@ -74,13 +74,13 @@ export async function restoreBackup(table, dirname) {
                     if (rows.length > limit) {
                         const rowsCopy = rows.slice();
                         rows = [];
-                        await table.query.insert(rowsCopy);
+                        await trx(table.options.name).insert(rowsCopy);
                     }
                 })
                     .on("end", async () => {
                     // Insérer les données dans la table une fois le fichier entièrement lu
                     if (rows.length > 0)
-                        await table.query.insert(rows);
+                        await trx(table.options.name).insert(rows);
                     console.log(`Restored chunk ${util.styleText(table.orm.config.loggerStyles?.highlight ??
                         DEFAULT_LOGGER_HIGHLIGHT, chunkFile)} into table ${util.styleText(table.orm.config.loggerStyles?.highlight ??
                         DEFAULT_LOGGER_HIGHLIGHT, table.options.name)}.`);
@@ -95,25 +95,53 @@ export async function restoreBackup(table, dirname) {
     }
     console.log(`Backup of table ${util.styleText(table.orm.config.loggerStyles?.highlight ?? DEFAULT_LOGGER_HIGHLIGHT, table.options.name)} restored.`);
 }
-export async function disableForeignKeys(orm) {
-    const result = await Promise.allSettled([
-        orm.raw("SET session_replication_role = replica;"),
-        orm.raw("PRAGMA foreign_keys = OFF;"),
-        orm.raw("SET FOREIGN_KEY_CHECKS = 0;"), // for mysql2
-    ]);
-    const errors = result.filter((r) => r.status === "rejected");
-    if (errors.length === 3) {
-        throw new Error("Failed to disable foreign key constraints.");
-    }
+export async function enableForeignKeys(orm, trx) {
+    const ctx = trx ?? orm;
+    await orm.clientBasedOperation({
+        mysql2: () => ctx.raw("SET FOREIGN_KEY_CHECKS = 1;"),
+        sqlite3: () => ctx.raw("PRAGMA foreign_keys = 1;"),
+        pg: () => ctx.raw("SET session_replication_role = DEFAULT;"),
+    });
+    console.log("Foreign key constraints enabled.");
 }
-export async function enableForeignKeys(orm) {
-    const result = await Promise.allSettled([
-        orm.raw("SET session_replication_role = DEFAULT;"),
-        orm.raw("PRAGMA foreign_keys = ON;"),
-        orm.raw("SET FOREIGN_KEY_CHECKS = 1;"), // for mysql2
-    ]);
-    const errors = result.filter((r) => r.status === "rejected");
-    if (errors.length === 3) {
-        throw new Error("Failed to enable foreign key constraints.");
+export async function disableForeignKeys(orm, run) {
+    const trx = orm.clientBasedOperation({
+        sqlite3: () => orm.database,
+    }) ?? (await orm.database.transaction());
+    const ran = await orm.clientBasedOperation({
+        mysql2: async () => {
+            const result = await trx.raw("SELECT @@FOREIGN_KEY_CHECKS;");
+            const check = result?.[0] && result[0]["@@FOREIGN_KEY_CHECKS"] != 0;
+            if (check)
+                await trx.raw("SET FOREIGN_KEY_CHECKS = 0;");
+            return check;
+        },
+        sqlite3: async () => {
+            const result = await trx.raw("PRAGMA foreign_keys;");
+            const check = result?.[0] && result[0].foreign_keys != 0;
+            if (check)
+                await trx.raw("PRAGMA foreign_keys = 0;");
+            return check;
+        },
+        pg: async () => {
+            const result = await trx.raw("SHOW session_replication_role;");
+            const check = result?.rows?.[0] &&
+                result.rows[0].session_replication_role !== "replica";
+            if (check)
+                await trx.raw("SET session_replication_role = replica;");
+            return check;
+        },
+    });
+    console.log(`Foreign key constraints ${ran ? "" : "already "}disabled.`);
+    try {
+        await run(trx);
+        await enableForeignKeys(orm, trx);
+        if (trx.isTransaction)
+            await trx.commit();
+    }
+    catch (error) {
+        if (trx.isTransaction)
+            await trx.rollback();
+        throw error;
     }
 }

package/dist/app/orm.d.ts

@@ -63,6 +63,7 @@ export declare class ORM {
         raw: (sql: string, anyDataUpdated?: boolean) => Knex.Raw;
         invalidate: () => void;
     };
+    clientBasedOperation<Return>(operation: Partial<Record<"pg" | "mysql2" | "sqlite3", () => Return>>): Return | undefined;
     /**
      * Create a backup of the database. <br>
      * The backup will be saved in the location specified in the config.

package/dist/app/orm.js

@@ -55,7 +55,8 @@ export class ORM {
                 table.integer("version").notNullable();
             },
         }));
-        for (const table of this.cachedTables.sort((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0))) {
+        const sortedTables = this.cachedTables.toSorted((a, b) => (b.options.priority ?? 0) - (a.options.priority ?? 0));
+        for (const table of sortedTables) {
             table.orm = this;
             await table.make();
         }
@@ -77,36 +78,30 @@ export class ORM {
             this.cachedTables.forEach((table) => table.cache.invalidate());
         },
     };
+    clientBasedOperation(operation) {
+        const client = (this.config.database?.client ?? "sqlite3");
+        return operation[client]?.();
+    }
     /**
      * Create a backup of the database. <br>
      * The backup will be saved in the location specified in the config.
      */
     async createBackup(dirname) {
-        try {
-            for (let table of this.cachedTables) {
-                await backupTable(table, dirname);
-            }
-            console.log("Database backup created.");
-        }
-        catch (error) {
-            console.error("Error while creating backup of the database.", error);
+        for (let table of this.cachedTables) {
+            await backupTable(table, dirname);
         }
+        console.log("Database backup created.");
     }
     /**
      * Restore the database from the backup. <br>
      * @warning This will delete all the data in the tables.
      */
     async restoreBackup(dirname) {
-        try {
-            await disableForeignKeys(this);
+        await disableForeignKeys(this, async (trx) => {
             for (let table of this.cachedTables) {
-                await restoreBackup(table, dirname);
+                await restoreBackup(table, trx, dirname);
             }
-            await enableForeignKeys(this);
-            console.log("Database restored from backup.");
-        }
-        catch (error) {
-            console.error("Error while restoring backup of the database.", error);
-        }
+        });
+        console.log("Database restored from backup.");
     }
 }

package/dist/app/table.js

@@ -45,7 +45,7 @@ export class Table {
         return this.query
             .select(this.db.raw("count(*) as total"))
             .whereRaw(where ?? "1=1")
-            .then((rows) => rows[0].total);
+            .then((rows) => +(rows?.[0] ?? { total: 0 }).total);
     }
     async hasColumn(name) {
         return this.db.schema.hasColumn(this.options.name, name);
@@ -60,7 +60,7 @@ export class Table {
         return this.getColumns().then(Object.keys);
     }
     async isEmpty() {
-        return this.count().then((count) => +count === 0);
+        return this.count().then((count) => count === 0);
     }
     async make() {
         if (!this.orm)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghom/orm",
-  "version": "1.8.4",
+  "version": "1.8.6",
   "license": "MIT",
   "type": "module",
   "main": "dist/index.js",

package/readme.md

@@ -1,7 +1,11 @@
-# TypeScript KnexJS ORM & handler
+# @ghom/orm
+
+### TypeScript Knex ORM & table handler including a backup system and a cache.
 
 ![test workflow badge](https://github.com/GhomKrosmonaute/orm/actions/workflows/test.yml/badge.svg)
 
+> Compatible with [PostgreSQL](https://www.npmjs.com/package/pg), [MySQL](https://www.npmjs.com/package/mysql2), and [SQLite](https://www.npmjs.com/package/sqlite3).
+
 ## Install
 
 ```bash

package/tests/.mysql2.env

@@ -0,0 +1,2 @@
+DB_CLIENT=mysql2
+DB_CONNECTION=mysql2://root:mysql@localhost:3306/mysql

package/tests/.pg.env

@@ -0,0 +1,2 @@
+DB_CLIENT=pg
+DB_CONNECTION=postgres://postgres:postgres@localhost:5432/postgres

package/tests/tables/a.js

@@ -10,6 +10,7 @@ export default new Table({
     table.increments("id").primary().notNullable()
     table
       .integer("b_id")
+      .unsigned()
       .references("id")
       .inTable("b")
       .onDelete("cascade")
@@ -17,8 +18,8 @@ export default new Table({
   },
   async then({ query }) {
     await query.insert({
-      id: 0,
-      b_id: 0,
+      id: 1,
+      b_id: 1,
     })
   },
 })

package/tests/tables/b.js

@@ -9,6 +9,7 @@ export default new Table({
     0: (table) =>
       table
         .integer("c_id")
+        .unsigned()
         .references("id")
         .inTable("c")
         .onDelete("cascade")
@@ -20,8 +21,8 @@ export default new Table({
   },
   async then({ query }) {
     await query.insert({
-      id: 0,
-      c_id: 0,
+      id: 1,
+      c_id: 1,
     })
   },
 })

package/tests/tables/c.js

@@ -10,6 +10,8 @@ export default new Table({
     table.increments("id").primary().notNullable()
   },
   async then({ query }) {
-    await query.insert({ id: 0 })
+    await query.insert({
+      id: 1,
+    })
   },
 })

package/tests/test.js

@@ -3,7 +3,12 @@ import { rimraf } from "rimraf"
 import path from "path"
 import fs from "fs"
 
-dotenv.config({ path: "./.env" })
+dotenv.config({
+  // path: path.join(process.cwd(), "tests", ".pg.env"),
+  // path: path.join(process.cwd(), "tests", ".mysql2.env"),
+})
+
+process.env.DEBUG = "knex*"
 
 import { ORM } from "../"
 
@@ -16,6 +21,10 @@ const orm = new ORM({
   backups: {
     location: path.join(process.cwd(), "backups"),
   },
+  database: process.env.DB_CLIENT && {
+    client: process.env.DB_CLIENT,
+    connection: process.env.DB_CONNECTION,
+  },
 })
 
 beforeAll(async () => {
@@ -37,23 +46,15 @@ describe("table management", () => {
     expect(orm.hasCachedTable("c")).toBeTruthy()
   })
 
-  test("migrations ran", async () => {
+  test("table migrations ran", async () => {
     expect(await b.hasColumn("c_id")).toBeTruthy()
   })
 
-  test("then ran", async () => {
+  test("table then ran", async () => {
     const rows = await a.query.select()
 
     expect(rows.length).toBe(1)
   })
-
-  test("cascade delete", async () => {
-    expect(await a.isEmpty()).toBeFalsy()
-
-    await c.query.del()
-
-    expect(await a.isEmpty()).toBeTruthy()
-  })
 })
 
 describe("table column types", () => {
@@ -63,7 +64,7 @@ describe("table column types", () => {
         .database("a")
         .columnInfo("id")
         .then((info) => info.type),
-    ).toBe("integer")
+    ).toMatch(/^int/)
   })
 
   test("integer", async () => {
@@ -72,24 +73,12 @@ describe("table column types", () => {
         .database("a")
         .columnInfo("b_id")
         .then((info) => info.type),
-    ).toBe("integer")
+    ).toMatch(/^int/)
   })
 })
 
 describe("database extraction", () => {
-  beforeAll(async () => {
-    await c.query.insert({ id: 0 })
-    await b.query.insert({
-      id: 0,
-      c_id: 0,
-    })
-    await a.query.insert({
-      id: 0,
-      b_id: 0,
-    })
-  })
-
-  test("extract CSV", async () => {
+  test("create backup", async () => {
     await orm.createBackup()
 
     expect(
@@ -103,22 +92,24 @@ describe("database extraction", () => {
     ).toBeTruthy()
   })
 
-  test("empty tables", async () => {
-    await a.query.del()
-    await b.query.del()
+  test("cascade delete", async () => {
+    expect(await a.isEmpty()).toBeFalsy()
+
     await c.query.del()
 
     expect(await a.isEmpty()).toBeTruthy()
-    expect(await b.isEmpty()).toBeTruthy()
-    expect(await c.isEmpty()).toBeTruthy()
   })
 
-  test("import CSV", async () => {
+  test("restore backup", async () => {
     await orm.restoreBackup()
 
     expect(await a.isEmpty()).toBeFalsy()
     expect(await b.isEmpty()).toBeFalsy()
     expect(await c.isEmpty()).toBeFalsy()
+  }, 10_000)
+
+  afterAll(async () => {
+    await rimraf(orm.config.backups.location)
   })
 })
 
@@ -206,6 +197,9 @@ describe("data caching", () => {
 })
 
 afterAll(async () => {
+  await orm.database.schema.dropTable("migration")
+  await orm.database.schema.dropTable("a")
+  await orm.database.schema.dropTable("b")
+  await orm.database.schema.dropTable("c")
   await orm.database.destroy()
-  await rimraf(orm.config.backups.location)
 })

package/tsconfig.json

@@ -3,10 +3,10 @@
     "strict": true,
     "rootDir": "src",
     "outDir": "dist",
-    "module": "esnext",
-    "target": "esnext",
-    "lib": ["es2020", "dom"],
-    "moduleResolution": "Node",
+    "module": "NodeNext",
+    "target": "ESNext",
+    "lib": ["ESNext"],
+    "moduleResolution": "NodeNext",
     "esModuleInterop": true,
     "declaration": true,
     "typeRoots": ["./node_modules/@types", "./dist/typings"]

package/tests/.env

@@ -1 +0,0 @@
-DEBUG=knex*