feat(prisma/migrations): Default value on new column (#465)

- [x] Display a more concise error message for new column that failed the NON NULL constraint during the migration. - [x] Enable user to set default value on new NON NULL column. --------- Signed-off-by: Natoandro <[email protected]> Signed-off-by: Teo Stocco <[email protected]> Co-authored-by: Teo Stocco <[email protected]>
metatypedev · Oct 28, 2023 · 0702818 · 0702818
1 parent 3bf54cd
commit 0702818
Show file tree

Hide file tree

Showing 24 changed files with 427 additions and 42 deletions.
diff --git a/libs/common/src/typegraph/runtimes/prisma.rs b/libs/common/src/typegraph/runtimes/prisma.rs
@@ -90,6 +90,7 @@ pub struct ScalarProperty {
     pub injection: Option<ManagedInjection>,
     pub unique: bool,
     pub auto: bool,
+    pub default_value: Option<serde_json::Value>,
 }
 
 #[cfg_attr(feature = "codegen", derive(JsonSchema))]

diff --git a/typegate/deno.json b/typegate/deno.json
@@ -8,7 +8,7 @@
     "comment1": "echo cwd is by default the directory of deno.json",
     "comment2": "echo cannot restrict ffi to a lib https://github.com/denoland/deno/issues/15511",
     "run": "cd .. && deno run --config=typegate/deno.json --unstable --allow-run=hostname --allow-sys --allow-env --allow-hrtime --allow-write=tmp --allow-ffi --allow-read=.  --allow-net typegate/src/main.ts",
-    "test": "cd .. && deno test --trace-ops --config=typegate/deno.json --unstable --allow-run=cargo,hostname,target/debug/meta,git,python3,rm,mkdir --allow-sys --allow-env --allow-hrtime --allow-write=tmp,typegate/tests --allow-ffi --allow-read=. --allow-net"
+    "test": "cd .. && deno test --trace-ops --config=typegate/deno.json --unstable --allow-run=cargo,hostname,target/debug/meta,git,python3,rm,mkdir,bash --allow-sys --allow-env --allow-hrtime --allow-write=tmp,typegate/tests --allow-ffi --allow-read=. --allow-net"
   },
   "nodeModulesDir": false,
   "lock": "deno.lock",
@@ -36,6 +36,7 @@
     "outdent": "https://deno.land/x/[email protected]/mod.ts",
     "json-schema-faker": "npm:[email protected]",
     "ajv": "https://esm.sh/[email protected]?pin=v131",
-    "@typegraph/sdk/": "../typegraph/deno/src/"
+    "@typegraph/sdk/": "../typegraph/deno/src/",
+    "test-utils/": "./tests/utils/"
   }
 }
diff --git a/typegate/deno.lock b/typegate/deno.lock
diff --git a/typegate/src/runtimes/prisma/hooks/generate_schema.ts b/typegate/src/runtimes/prisma/hooks/generate_schema.ts
@@ -122,6 +122,10 @@ class FieldBuilder {
           }
         }
 
+        if (prop.defaultValue != null) {
+          tags.push(`@default(${JSON.stringify(prop.defaultValue)})`);
+        }
+
         const field = new ModelField(prop.key, typeName + quant, tags);
         return field;
       }

diff --git a/typegate/src/runtimes/prisma/hooks/run_migrations.ts b/typegate/src/runtimes/prisma/hooks/run_migrations.ts
@@ -7,6 +7,9 @@ import { PrismaRT } from "../mod.ts";
 import * as native from "native";
 import { nativeResult, pluralSuffix } from "../../../utils.ts";
 
+const NULL_CONSTRAINT_ERROR_REGEX =
+  /column (?<col>".+") of relation (?<table>".+") contains null values/;
+
 export const runMigrations: PushHandler = async (
   typegraph,
   secretManager,
@@ -51,7 +54,7 @@ export const runMigrations: PushHandler = async (
 
         const { reset_reason, applied_migrations } = applyRes.Ok;
         if (reset_reason != null) {
-          response.info(`Database reset: {reset_reason}`);
+          response.info(`Database reset: ${reset_reason}`);
         }
         if (applied_migrations.length === 0) {
           response.info(`${prefix} No migration applied.`);
@@ -90,7 +93,26 @@ export const runMigrations: PushHandler = async (
           );
 
         if (apply_err != null) {
-          response.error(apply_err);
+          const errors = apply_err.split(/\r?\n/).filter(
+            (line) => line.startsWith("ERROR: "),
+          )
+            .map((line) => line.slice("ERROR: ".length))
+            .map((err) => {
+              const match = NULL_CONSTRAINT_ERROR_REGEX.exec(err);
+              if (match != null) {
+                // TODO detect used for the typegraph language and write
+                // the message accordingly.
+                return `${err}: set a default value: add \`config={ "default": defaultValue }\` attribute to the type.`;
+              }
+              return err;
+            });
+
+          if (errors.length === 0) {
+            response.error(apply_err);
+          } else {
+            const formattedErrors = errors.map((err) => `\n- ${err}`).join("");
+            response.error(`Could not apply migration: ${formattedErrors}`);
+          }
         }
 
         if (created_migration_name != null) {

diff --git a/typegate/src/typegraph/types.ts b/typegate/src/typegraph/types.ts
@@ -287,6 +287,7 @@ export type Property = {
   injection?: ManagedInjection | null;
   unique: boolean;
   auto: boolean;
+  defaultValue?: any;
 } | {
   type: "relationship";
   key: string;

diff --git a/typegate/tests/e2e/cli/.gitignore b/typegate/tests/e2e/cli/.gitignore
@@ -0,0 +1 @@
+/migration.py