ENG-815:

There are circular dependencies within `packages/database`,
especially of stepdefs.ts on dbDotEnv, which is why I made it a mjs module.

The alternative is to not compile stepdefs; cucumber can use it by reference.
Then dbDotEnv can then be a mts module.
We then have to compile it first (in a bootstrap stage) and then require it everywhere.
Ensure stepdef and scripts are type-checked, now that they're not compiled.

Author: maparent

apps/roam/scripts/compile.ts

@@ -18,18 +18,7 @@ const getVersion = (): string => {
 const getBuildDate = (): string => {
   return new Date().toISOString().split("T")[0]; // YYYY-MM-DD format
 };
-let envContents = null;
-
-try {
-  const dbDotEnv = require("@repo/database/dbDotEnv");
-  envContents = dbDotEnv.envContents;
-} catch (error) {
-  if ((error as Error).message.includes("Cannot find module")) {
-    console.error("Build the database module before compiling roam");
-    process.exit(1);
-  }
-  throw error;
-}
+const { envContents } = require("@repo/database/dbDotEnv");
 
 // https://github.com/evanw/esbuild/issues/337#issuecomment-954633403
 const importAsGlobals = (

apps/roam/scripts/deploy.ts

@@ -2,7 +2,7 @@ import { put } from "@vercel/blob";
 import fs, { readFileSync } from "fs";
 import { join } from "path";
 import { compile } from "./compile";
-import { config } from "@repo/database/dbDotEnv";
+const { config } = require("@repo/database/dbDotEnv");
 import { execSync } from "child_process";
 
 if (process.env.NODE_ENV !== "production") {

apps/website/app/utils/supabase/middleware.ts

@@ -1,6 +1,6 @@
 import { createServerClient } from "@supabase/ssr";
 import { NextResponse, type NextRequest } from "next/server";
-import { envContents } from "@repo/database/dbDotEnv";
+const { envContents } = require("@repo/database/dbDotEnv");
 
 // Inspired by https://supabase.com/ui/docs/nextjs/password-based-auth
 

apps/website/app/utils/supabase/server.ts

@@ -1,7 +1,7 @@
 import { createServerClient, type CookieOptions } from "@supabase/ssr";
 import { cookies } from "next/headers";
 import type { Database } from "@repo/database/dbTypes";
-import { envContents } from "@repo/database/dbDotEnv";
+const { envContents } = require("@repo/database/dbDotEnv");
 
 // Inspired by https://supabase.com/ui/docs/nextjs/password-based-auth
 

apps/website/next.config.ts

@@ -1,5 +1,5 @@
 import type { NextConfig } from "next";
-import { config } from "@repo/database/dbDotEnv";
+const { config } = require("@repo/database/dbDotEnv");
 
 config();
 

packages/database/features/step-definitions/stepdefs.ts

@@ -2,7 +2,7 @@ import assert from "assert";
 import { Given, When, Then, world, type DataTable } from "@cucumber/cucumber";
 import { createClient } from "@supabase/supabase-js";
 import { Constants, type Database, type Enums } from "@repo/database/dbTypes";
-import { getVariant, config } from "@repo/database/dbDotEnv";
+const { getVariant, config } = require("@repo/database/dbDotEnv");
 
 import {
   spaceAnonUserEmail,

packages/database/package.json

@@ -6,28 +6,30 @@
   "exports": {
     "./lib/*": "./src/lib/*.ts",
     "./dbDotEnv": {
-      "types": "./types/dbDotEnv.d.ts",
-      "import": "./src/dbDotEnv.mjs",
-      "default": "./src/dbDotEnv.mjs"
+      "types": "./dist/src/dbDotEnv.d.mts",
+      "import": "./dist/src/dbDotEnv.mjs",
+      "require": "./dist/src/dbDotEnv.mjs",
+      "default": "./dist/src/dbDotEnv.mjs"
     },
     "./dbTypes": "./src/dbTypes.ts",
     "./inputTypes": "./src/inputTypes.ts"
   },
   "typesVersions": {
     "*": {
       "./dbDotEnv": [
-        "types/dbDotEnv.d.ts"
+        "dist/src/dbDotEnv.d.mts"
       ]
     }
   },
   "scripts": {
     "init": "supabase login",
-    "setup": "npm run genenv && npm run migrate",
+    "setup": "npm run bootstrap && npm run genenv && npm run migrate",
+    "bootstrap": "tsc -p tsconfig_bootstrap.json",
     "dev": "npm run setup && npm run serve",
     "build": "npm run setup && tsc",
     "serve": "tsx scripts/serve.ts",
     "stop": "supabase stop",
-    "check-types": "tsc --noEmit --skipLibCheck",
+    "check-types": "tsc -p tsconfig_lint.json",
     "check-schema": "tsx scripts/lintSchemas.ts && supabase stop && npm run dbdiff",
     "lint": "eslint . && tsx scripts/lintSchemas.ts && tsx scripts/lintFunctions.ts",
     "lint:fix": "eslint --fix . && tsx scripts/lintSchemas.ts -f && tsx scripts/lintFunctions.ts",

packages/database/scripts/genTypes.ts

@@ -1,7 +1,7 @@
 import { execSync } from "node:child_process";
 import { writeFileSync } from "fs";
 import { join, dirname } from "path";
-import { getVariant } from "@repo/database/dbDotEnv";
+import { getVariant } from "../src/dbDotEnv.mts";
 
 const __dirname = dirname(__filename);
 const projectRoot = join(__dirname, "..");

packages/database/scripts/serve.ts

@@ -1,7 +1,7 @@
 import { execSync } from "node:child_process";
 import { writeFileSync } from "fs";
 import { join, dirname } from "path";
-import { getVariant } from "@repo/database/dbDotEnv";
+import { getVariant } from "../src/dbDotEnv.mts";
 
 const __dirname = dirname(__filename);
 const projectRoot = join(__dirname, "..");

packages/database/src/dbDotEnv.mjs packages/database/src/dbDotEnv.mtspackages/database/src/dbDotEnv.mjs renamed to packages/database/src/dbDotEnv.mts

@@ -3,9 +3,12 @@ import { join, dirname, basename } from "node:path";
 import { fileURLToPath } from "node:url";
 import dotenv from "dotenv";
 
-// Note: This file is written as mjs so it can be used before typescript compilation.
-// This means the corresponding .d.ts file is currently maintained by hand.
-// Remember to update it as needed.
+export type Variant =
+  | "none"
+  | "local"
+  | "branch"
+  | "production"
+  | "implicit";
 
 const findRoot = () => {
   let dir = fileURLToPath(import.meta.url);
@@ -15,24 +18,28 @@ const findRoot = () => {
   return dir;
 };
 
-export const getVariant = () => {
+const VARIANTS = new Set<Variant>([
+    "none",
+    "local",
+    "branch",
+    "production",
+    "implicit",
+  ]);
+
+export const getVariant = (): Variant => {
   const processHasVars =
     !!process.env["SUPABASE_URL"] && !!process.env["SUPABASE_ANON_KEY"];
   const useDbArgPos = (process.argv || []).indexOf("--use-db");
   let variant =
-    useDbArgPos > 0
+    (useDbArgPos > 0
       ? process.argv[useDbArgPos + 1]
-      : process.env["SUPABASE_USE_DB"];
+      : process.env["SUPABASE_USE_DB"]) as Variant | undefined;
   if (variant === undefined) {
     dotenv.config();
-    variant = process.env["SUPABASE_USE_DB"];
+    variant = process.env["SUPABASE_USE_DB"] as Variant | undefined;
   }
 
-  if (
-    ["local", "branch", "production", "none", "implicit", undefined].indexOf(
-      variant,
-    ) === -1
-  ) {
+  if (variant !== undefined && !VARIANTS.has(variant)) {
     throw new Error("Invalid variant: " + variant);
   }
 
@@ -61,14 +68,14 @@ export const getVariant = () => {
   return variant;
 };
 
-export const envFilePath = () => {
+export const envFilePath = (): string | null => {
   const variant = getVariant();
   if (variant === "implicit" || variant === "none") return null;
   const name = join(findRoot(), `.env.${variant}`);
   return existsSync(name) ? name : null;
 };
 
-export const envContents = () => {
+export const envContents = (): Partial<Record<string, string>> => {
   const path = envFilePath();
   if (!path) {
     // Fallback to process.env when running in production environments
@@ -85,7 +92,7 @@ export const envContents = () => {
 
 let configDone = false;
 
-export const config = () => {
+export const config = (): void => {
   if (configDone) return;
   const path = envFilePath();
   if (path) dotenv.config({ path });