build(plugin-satp-hermes): dist/lib/knex/knexfile.ts not under rootDir

1. Moved the typescript knex sources into the appropriate directory to match the established patterns we use for building the code (./src/main/typescript/) This fixed the problem of the bundler not finding the knexfile sources. 2. Also refactored the runtime require calls of the knex files to be build-time import statements instead. This came with the benefit that we no longer require the linter to be turned off and also that compile time checks are in effect. In the future if we want to go back to importing the knex files dynamically we could do so by adding a parameter to the log repository constructor parameter object which could be holding the path to a knex file to be included at runtime. (though I would only do this if we have no other choice - by default we should always thrive to use the compiler and do as much at build time as possible). Fixes #3708 Signed-off-by: Peter Somogyvari <[email protected]>
hyperledger-cacti · Jan 17, 2025 · a8da82b · a8da82b
1 parent 1737df4
commit a8da82b
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 10 deletions.
diff --git a/...n-satp-hermes/src/knex/knexfile-remote.ts → ...c/main/typescript/knex/knexfile-remote.ts b/...n-satp-hermes/src/knex/knexfile-remote.ts → ...c/main/typescript/knex/knexfile-remote.ts
diff --git a/...s-plugin-satp-hermes/src/knex/knexfile.ts → ...rmes/src/main/typescript/knex/knexfile.ts b/...s-plugin-satp-hermes/src/knex/knexfile.ts → ...rmes/src/main/typescript/knex/knexfile.ts
diff --git a/...tions/20220331132128_create_logs_table.ts → ...tions/20220331132128_create_logs_table.ts b/...tions/20220331132128_create_logs_table.ts → ...tions/20220331132128_create_logs_table.ts
diff --git a/...0240130234303_create_remote_logs_table.ts → ...0240130234303_create_remote_logs_table.ts b/...0240130234303_create_remote_logs_table.ts → ...0240130234303_create_remote_logs_table.ts
diff --git a/.../seeds/1724235145_create_dummy_entries.ts → .../seeds/1724235145_create_dummy_entries.ts b/.../seeds/1724235145_create_dummy_entries.ts → .../seeds/1724235145_create_dummy_entries.ts
diff --git a/...ges/cactus-plugin-satp-hermes/src/main/typescript/repository/knex-local-log-repository.ts b/...ges/cactus-plugin-satp-hermes/src/main/typescript/repository/knex-local-log-repository.ts
@@ -2,15 +2,14 @@ import { LocalLog } from "../core/types";
 import { ILocalLogRepository } from "./interfaces/repository";
 import knex, { Knex } from "knex";
 
+import knexFile from "../knex/knexfile";
+
 export class KnexLocalLogRepository implements ILocalLogRepository {
   readonly database: Knex;
 
   public constructor(config: Knex.Config | undefined) {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const configFile = require("../../../knex/knexfile.ts")[
-      process.env.ENVIRONMENT || "development"
-    ];
-
+    const envName = process.env.ENVIRONMENT || "development";
+    const configFile = knexFile[envName];
     this.database = knex(config || configFile);
   }
 

diff --git a/...es/cactus-plugin-satp-hermes/src/main/typescript/repository/knex-remote-log-repository.ts b/...es/cactus-plugin-satp-hermes/src/main/typescript/repository/knex-remote-log-repository.ts
@@ -2,18 +2,17 @@ import { IRemoteLogRepository } from "./interfaces/repository";
 import { RemoteLog } from "../core/types";
 import knex, { Knex } from "knex";
 
+import knexFileRemote from "../knex/knexfile-remote";
+
 export class KnexRemoteLogRepository implements IRemoteLogRepository {
   readonly database: Knex;
 
   // for now we will ignore the config because it needs to be static
   // so that both gateways can have access to the same database
   // simulating a remote log storage
   public constructor(config: Knex.Config | undefined) {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const configFile = require("../../../knex/knexfile-remote.ts")[
-      process.env.ENVIRONMENT || "development"
-    ];
-
+    const envName = process.env.ENVIRONMENT || "development";
+    const configFile = knexFileRemote[envName];
     this.database = knex(config || configFile);
   }