refactor: migrate to ESM (#524)

hi-ogawa · Dec 27, 2023 · 502b4cb · 502b4cb
1 parent fdbb919
commit 502b4cb
Show file tree

Hide file tree

Showing 34 changed files with 143 additions and 122 deletions.
diff --git a/app/db/config.ts b/app/db/config.ts
@@ -0,0 +1,15 @@
+import { type ConnectionOptions } from "mysql2";
+import { serverConfig } from "../utils/config";
+
+export function dbConfig() {
+  return {
+    host: serverConfig.APP_MYSQL_HOST,
+    port: serverConfig.APP_MYSQL_PORT,
+    user: serverConfig.APP_MYSQL_USER,
+    password: serverConfig.APP_MYSQL_PASSWORD,
+    database: serverConfig.APP_MYSQL_DATABASE,
+    ssl: serverConfig.APP_MYSQL_SSL ? {} : undefined,
+    multipleStatements: true,
+    timezone: "+00:00", // planetscale and development mysql image have UTC localtime
+  } satisfies ConnectionOptions;
+}
diff --git a/app/db/drizzle-client.server.ts b/app/db/drizzle-client.server.ts
@@ -17,7 +17,7 @@ import type { Connection } from "mysql2";
 import { createConnection } from "mysql2/promise";
 import { uninitialized } from "../utils/misc";
 import type { PaginationMetadata, PaginationParams } from "../utils/pagination";
-import knexfile from "./knexfile.server";
+import { dbConfig } from "./config";
 import type { DeckCache, PracticeActionType, PracticeQueueType } from "./types";
 
 //
@@ -353,8 +353,7 @@ export async function initializeDrizzleClient() {
   db = globalThis.__drizzleClient ??= await inner();
 
   async function inner() {
-    const config = knexfile();
-    const connection = await createConnection(config.connection);
+    const connection = await createConnection(dbConfig());
     return drizzle(connection, {
       logger: process.env["DEBUG"]?.includes("drizzle"), // enable query logging by DEBUG=drizzle
     });

diff --git a/app/db/knexfile.mts b/app/db/knexfile.mts
@@ -0,0 +1,16 @@
+import type { Knex } from "knex";
+import { initializeConfigServer } from "../utils/config";
+import { dbConfig } from "./config";
+
+export default function knexfile() {
+  initializeConfigServer();
+
+  return {
+    client: "mysql2",
+    connection: dbConfig(),
+    migrations: {
+      directory: "migrations",
+      stub: "__migration-stub.ts",
+    },
+  } satisfies Knex.Config;
+}
diff --git a/app/db/knexfile.server.ts b/app/db/knexfile.server.ts
diff --git a/app/db/migrations/20220226100116_create-user.js b/app/db/migrations/20220226100116_create-user.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     CREATE TABLE users (
       id           BIGINT AUTO_INCREMENT,
@@ -20,7 +20,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     DROP TABLE users;
   `);

diff --git a/app/db/migrations/20220402105114_add-user-settings.js b/app/db/migrations/20220402105114_add-user-settings.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE users ADD settings JSON DEFAULT NULL;
   `);
@@ -12,7 +12,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE users DROP COLUMN settings;
   `);

diff --git a/app/db/migrations/20220403010151_add-users-not-null-constraint.js b/app/db/migrations/20220403010151_add-users-not-null-constraint.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE users MODIFY createdAt DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP
   `);
@@ -15,7 +15,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE users MODIFY updatedAt DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
   `);

diff --git a/app/db/migrations/20220403022654_add-default-users-settings.js b/app/db/migrations/20220403022654_add-default-users-settings.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     UPDATE users SET settings = JSON_OBJECT() WHERE settings IS NULL
   `);
@@ -15,7 +15,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE users MODIFY settings JSON DEFAULT NULL
   `);

diff --git a/app/db/migrations/20220408030906_change-users-settings.js b/app/db/migrations/20220408030906_change-users-settings.js
@@ -1,8 +1,10 @@
+import * as assert from "assert/strict";
+
 /**
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   if (process.env.MIGRATION_UNIT_TEST) await testUp.before(knex);
 
   await knex.raw(`
@@ -21,7 +23,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   if (process.env.MIGRATION_UNIT_TEST) await testDown.before(knex);
 
   await knex.raw(`
@@ -48,7 +50,7 @@ const testUp = {
     const [rows] = await knex.raw(
       `SELECT language1, language2 FROM users ORDER BY username`
     );
-    require("assert").deepStrictEqual(rows, [
+    assert.deepEqual(rows, [
       { language1: null, language2: null },
       { language1: "fr", language2: null },
       { language1: "fr", language2: "en" },
@@ -70,7 +72,7 @@ const testDown = {
     const [rows] = await knex.raw(
       `SELECT settings FROM users ORDER BY username`
     );
-    require("assert").deepStrictEqual(rows, [
+    assert.deepEqual(rows, [
       { settings: { language1: null, language2: null } },
       { settings: { language1: "fr", language2: null } },
       { settings: { language1: "fr", language2: "en" } },

diff --git a/app/db/migrations/20220410120806_create-videos.js b/app/db/migrations/20220410120806_create-videos.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     CREATE TABLE videos (
       id                    BIGINT AUTO_INCREMENT,
@@ -43,7 +43,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     DROP TABLE captionEntries;
   `);

diff --git a/app/db/migrations/20220411031243_create-bookmarks.js b/app/db/migrations/20220411031243_create-bookmarks.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     CREATE TABLE bookmarkEntries (
       id                    BIGINT AUTO_INCREMENT,
@@ -26,7 +26,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     DROP TABLE bookmarkEntries;
   `);

diff --git a/app/db/migrations/20220417071104_create-practice-system.js b/app/db/migrations/20220417071104_create-practice-system.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     CREATE TABLE decks (
       id                    BIGINT AUTO_INCREMENT,
@@ -51,7 +51,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`DROP TABLE practiceActions`);
   await knex.raw(`DROP TABLE practiceEntries`);
   await knex.raw(`DROP TABLE decks`);

diff --git a/app/db/migrations/20220504095705_add-deck-options.js b/app/db/migrations/20220504095705_add-deck-options.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE decks
       ADD newEntriesPerDay INTEGER NOT NULL DEFAULT 50,
@@ -16,7 +16,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE decks
       DROP newEntriesPerDay,

diff --git a/app/db/migrations/20220507021215_modify-createdAt-updatedAt-not-null.js b/app/db/migrations/20220507021215_modify-createdAt-updatedAt-not-null.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   for (const table of TABLES) {
     await knex.raw(`
       ALTER TABLE ${table} MODIFY createdAt DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP;
@@ -15,7 +15,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   for (const table of TABLES) {
     await knex.raw(`
       ALTER TABLE ${table} MODIFY updatedAt DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP;

diff --git a/app/db/migrations/20220508102506_add-deck-randomize.js b/app/db/migrations/20220508102506_add-deck-randomize.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE decks ADD randomMode BOOL NOT NULL DEFAULT FALSE
   `);
@@ -12,7 +12,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE decks DROP randomMode
   `);

diff --git a/app/db/migrations/20220528054447_add-user-timezone.js b/app/db/migrations/20220528054447_add-user-timezone.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE users ADD timezone VARCHAR(32) NOT NULL DEFAULT '+00:00'
   `);
@@ -12,7 +12,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE users DROP timezone
   `);

diff --git a/app/db/migrations/20220709023840_add-videos-bookmark-entries-count.js b/app/db/migrations/20220709023840_add-videos-bookmark-entries-count.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE videos ADD bookmarkEntriesCount INT NOT NULL DEFAULT 0
   `);
@@ -12,7 +12,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE videos DROP bookmarkEntriesCount
   `);

diff --git a/app/db/migrations/20220709054554_add-practiceEntries-practiceActionsCount.js b/app/db/migrations/20220709054554_add-practiceEntries-practiceActionsCount.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE practiceEntries ADD practiceActionsCount INT NOT NULL DEFAULT 0
   `);
@@ -12,7 +12,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE practiceEntries DROP practiceActionsCount
   `);

diff --git a/app/db/migrations/20220709064132_add-decks-practiceEntriesCountByQueueType.js b/app/db/migrations/20220709064132_add-decks-practiceEntriesCountByQueueType.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE decks ADD practiceEntriesCountByQueueType JSON NOT NULL DEFAULT (JSON_OBJECT('NEW', 0, 'LEARN', 0, 'REVIEW', 0))
   `);
@@ -12,7 +12,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE decks DROP practiceEntriesCountByQueueType
   `);

diff --git a/app/db/migrations/20220709082116_create-index-practiceActions-createdAt.js b/app/db/migrations/20220709082116_create-index-practiceActions-createdAt.js
@@ -2,7 +2,7 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.up = async function (knex) {
+export const up = async function (knex) {
   await knex.raw(`
     ALTER TABLE practiceActions ADD KEY practiceActions_createdAt_key (createdAt)
   `);
@@ -12,7 +12,7 @@ exports.up = async function (knex) {
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> }
  */
-exports.down = async function (knex) {
+export const down = async function (knex) {
   await knex.raw(`
     ALTER TABLE practiceActions DROP KEY practiceActions_createdAt_key
   `);