Added prisma TS package to Wasp, for running prisma format.

waspc/packages/prisma/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

waspc/packages/prisma/README.md

@@ -0,0 +1,23 @@
+This package contains useful tools for working with Prisma, especially PSL.
+
+## Setup
+Run `npm install`.
+
+## Usage
+
+Run `npm run build` to compile TS to JS. Do this after any changes to TS files, or if you have never run it before.
+
+### format
+Run `npm run format` and pass prisma schema source (so PSL) via stdin.
+It can even be an incomplete schema -> e.g. just model declarations.
+
+This will run `prisma format` on it and return formatted schema (PSL) + any warnings/errors.
+Note: `prisma format` does not just format stuff, but even fix some simple mistakes like incomplete relations!
+
+Response, on stdout, will be JSON of the following shape:
+```json
+{
+  "formattedSchemaPsl": "<psl>",
+  "errors": "<all errors as one big string>"  // undefined if no errors.
+}
+```

waspc/packages/prisma/eslintrc.cjs

@@ -0,0 +1,83 @@
+module.exports = {
+  "env": {
+    "es2020": true,
+    "node": true
+  },
+  "root": true,
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 11,
+    "sourceType": "module"
+  },
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "rules": {
+    "indent": [
+      "error",
+      "tab"
+    ],
+    "linebreak-style": [
+      "error",
+      "unix"
+    ],
+    "quotes": [
+      "error",
+      "single"
+    ],
+    "eol-last": [
+      "error",
+      "always"
+    ],
+    "no-multiple-empty-lines": [
+      "error",
+      {
+        "max": 2,
+        "maxEOF": 1
+      }
+    ],
+    "comma-spacing": [
+      "error",
+      { "before": false, "after": true }
+    ],
+    "space-before-function-paren": ["error", {
+      "anonymous": "always",
+      "named": "never",
+      "asyncArrow": "always"
+    }],
+    "comma-dangle": [
+      "error",
+      "always-multiline"
+    ],
+    "object-curly-spacing": [
+      "error",
+      "always"
+    ],
+    "padding-line-between-statements": [
+      "error",
+      { "blankLine": "always", "prev": "function", "next": "function" },
+      { "blankLine": "always", "prev": "function", "next": "export" },
+      { "blankLine": "always", "prev": "export", "next": "function" },
+      { "blankLine": "always", "prev": "export", "next": "export" }
+    ],
+    "no-duplicate-imports": "error",
+    "@typescript-eslint/semi": [
+      "error",
+      "always"
+    ],
+    "@typescript-eslint/member-delimiter-style": [
+      "error",
+      {
+        "multiline": {
+          "delimiter": "semi",
+          "requireLast": true
+        }
+      }
+    ],
+    "@typescript-eslint/explicit-module-boundary-types": "error"
+  }
+}

waspc/packages/prisma/jest.config.js

@@ -0,0 +1,6 @@
+export default {
+  transform: { '^.+\\.ts?$': 'ts-jest' },
+  testEnvironment: 'node',
+  testRegex: '/test/.*\\.test\\.ts$',
+  moduleFileExtensions: ['ts', 'js'],
+}

waspc/packages/prisma/package.json

@@ -0,0 +1,32 @@
+{
+  "author": "Wasp Team",
+  "license": "MIT",
+  "name": "wasp-prisma",
+  "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "build": "npx tsc",
+    "start": "npm run format",
+    "format": "node ./dist/format-cli.js",
+    "test": "jest"
+  },
+  "dependencies": {
+    "json5": "^2.2.3",
+    "prisma": "Prisma version here needs to be kept in sync with prisma version used in wasp-cli.",
+    "prisma": "^4.12.0",
+    "tmp-promise": "3.0.3",
+    "strip-ansi": "We are keeping strip-ansi at 6.0.0 because in v7 is switches to ecmascript modules, which is not supported directly by Jest.",
+    "strip-ansi": "^6.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.2",
+    "@types/node": "^18.11.18",
+    "@types/tmp": "^0.2.3",
+    "@typescript-eslint/eslint-plugin": "^5.48.0",
+    "@typescript-eslint/parser": "^5.48.0",
+    "eslint": "^8.31.0",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.1.3"
+  }
+}

waspc/packages/prisma/src/format-cli.ts

@@ -0,0 +1,21 @@
+import { formatSchema } from './format.js';
+
+async function main() {
+  const schemaPsl = await readWholeStdin();
+  const { formattedSchemaPsl, stderr, exitCode } = await formatSchema(schemaPsl);
+  console.log(JSON.stringify({ formattedSchemaPsl, errors: exitCode === 0 ? undefined : stderr }));
+}
+
+async function readWholeStdin(): Promise<string> {
+  return new Promise((resolve, reject) => {
+    let chunks = '';
+    process.stdin.on('data', (data) => {
+      chunks += data;
+    });
+    process.stdin.on('end', () => resolve(chunks));
+    process.stdin.on('close', () => resolve(chunks));
+    process.stdin.on('error', (err) => reject(err));
+  });
+}
+
+main().catch((err) => { console.error(err); process.exit(1); });

waspc/packages/prisma/src/format.ts

@@ -0,0 +1,32 @@
+import * as tmp from 'tmp-promise'
+import fs from 'fs';
+import { spawn } from 'child_process';
+import stripAnsi from 'strip-ansi';
+import util from 'util'
+
+// tmp-promise by default closes and unlinks the files on process exit.
+
+export async function formatSchema(schemaPsl : string) : Promise<{ formattedSchemaPsl: string, stderr: string, exitCode: number }> {
+  const tmpPrismaSchemaFile = await tmp.file({ prefix: 'prisma-', postfix: '.schema' });
+  await util.promisify(fs.writeFile)(tmpPrismaSchemaFile.path, schemaPsl, 'utf8');
+
+  let stderr = '';
+  let exitCode: number;
+  {
+    const process = spawn("npx", ["prisma", "format", "--schema", tmpPrismaSchemaFile.path], {});
+    process.stderr.on('data', (data) => { stderr += data; });
+    exitCode = await new Promise((resolve, reject) => {
+      process.on('error', reject);
+      process.on('close', (code) => { resolve(code || 0); });
+    });
+  }
+
+  const formattedSchemaPsl = await util.promisify(fs.readFile)(tmpPrismaSchemaFile.path, 'utf8');
+  await tmpPrismaSchemaFile.cleanup();
+
+  return {
+    formattedSchemaPsl,
+    stderr: stripAnsi(stderr),
+    exitCode: exitCode,
+  };
+}

waspc/packages/prisma/test/format.test.ts

@@ -0,0 +1,58 @@
+import * as path from 'path';
+import fs from 'fs';
+import util from 'util'
+import { formatSchema } from '../src/format';
+
+/**
+ * Get an absolute path to a test file.
+ * @param filename Name of test file inside __dirname/formatTests directory.
+ */
+function testFilePath(filename: string): string {
+  return path.join(__dirname, 'formatTests', filename);
+}
+
+const testSchemaPsls = {
+  simpleFormatted: testFilePath('simple/formatted.schema'),
+  simpleUnformatted: testFilePath('simple/unformatted.schema'),
+  simplePartialRelation: testFilePath('simple/partial-relation.schema'),
+  simplePartialRelationFixed: testFilePath('simple/partial-relation-fixed.schema'),
+  simpleBroken: testFilePath('simple/broken.schema'),
+};
+
+async function fetchTestSchemaPsl(testSchemaName: keyof typeof testSchemaPsls): Promise<string> {
+  return util.promisify(fs.readFile)(testSchemaPsls[testSchemaName], 'utf8');
+}
+
+describe('format.ts', () => {
+  describe('for a simple schema with User and Task models', () => {
+    let formattedSchemaPsl: string;
+    beforeAll(async () => {
+      formattedSchemaPsl = await fetchTestSchemaPsl("simpleFormatted");
+    });
+
+    test('already formatted prisma schema is returned as it was', async () => {
+      expect(await formatSchema(formattedSchemaPsl)).toEqual({
+        formattedSchemaPsl, stderr: '', exitCode: 0,
+      });
+    });
+
+    test('unformatted prisma schema is correctly formatted', async () => {
+      expect(await formatSchema(await fetchTestSchemaPsl("simpleUnformatted"))).toEqual({
+        formattedSchemaPsl, stderr: '', exitCode: 0,
+      });
+    });
+
+    test('prisma schema with partial relation is correctly fixed', async () => {
+      expect(await formatSchema(await fetchTestSchemaPsl("simplePartialRelation"))).toEqual({
+        formattedSchemaPsl: await fetchTestSchemaPsl("simplePartialRelationFixed"), stderr: '', exitCode: 0,
+      });
+    });
+
+    test('if prisma schema is broken, errors are reported and exit code is not 0', async () => {
+      const result = await formatSchema(await fetchTestSchemaPsl("simpleBroken"))
+      expect(result.exitCode).not.toEqual(0);
+      expect(result.stderr).toContain('Error: Prisma schema validation');
+    });
+  })
+});
+

waspc/packages/prisma/test/formatTests/simple/broken.schema

@@ -0,0 +1,9 @@
+model User {
+  id    Int    @id @default(autoincrement())
+  tasks Task[]
+}
+
+model Task {
+  id     Int  @id @default(autoincrement())
+  user   User @relation(fields: [userId], references: [id])
+}

waspc/packages/prisma/test/formatTests/simple/formatted.schema

@@ -0,0 +1,10 @@
+model User {
+  id    Int    @id @default(autoincrement())
+  tasks Task[]
+}
+
+model Task {
+  id     Int  @id @default(autoincrement())
+  user   User @relation(fields: [userId], references: [id])
+  userId Int
+}

waspc/packages/prisma/test/formatTests/simple/partial-relation-fixed.schema

@@ -0,0 +1,10 @@
+model User {
+  id   Int    @id @default(autoincrement())
+  Task Task[]
+}
+
+model Task {
+  id     Int  @id @default(autoincrement())
+  user   User @relation(fields: [userId], references: [id])
+  userId Int
+}

waspc/packages/prisma/test/formatTests/simple/partial-relation.schema

@@ -0,0 +1,9 @@
+model User {
+  id    Int    @id @default(autoincrement())
+}
+
+model Task {
+  id     Int  @id @default(autoincrement())
+  user   User @relation(fields: [userId], references: [id])
+  userId Int
+}

waspc/packages/prisma/test/formatTests/simple/unformatted.schema

@@ -0,0 +1,10 @@
+model User {
+  id Int @id @default(autoincrement())
+  tasks Task[]
+}
+
+model Task {
+  id Int @id @default(autoincrement())
+  user User @relation(fields: [userId], references: [id])
+  userId Int
+}

waspc/packages/prisma/tsconfig.json

@@ -0,0 +1,104 @@
+{
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2020",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "ESNext",                                  /* Specify what module code is generated. */
+    "rootDir": "src",                                    /* Specify the root folder within your source files. */
+    "moduleResolution": "nodenext",                          /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": true,                                   /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "dist",                                    /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}

waspc/src/Wasp/Generator/Common.hs

@@ -49,6 +49,7 @@ data DbRootDir
 instance AppComponentRootDir DbRootDir
 
 prismaVersion :: SV.Version
+-- NOTE: If changing prisma version here, also change it in waspc/packages/prisma/package.json.
 prismaVersion = SV.Version 4 12 0
 
 makeJsonWithEntityData :: String -> Aeson.Value

waspc/src/Wasp/Package.hs

@@ -20,6 +20,14 @@ import Wasp.Node.Version (getAndCheckNodeVersion)
 data Package
   = DeployPackage
   | TsInspectPackage
+  | -- | TODO(martin): I implemented this ts package because I planned to use prisma's TS sdk
+    --   (@prisma/internals) inside it, but I ended up calling `prisma format` cli cmd directly,
+    --   which means I could have really done it from Haskell!
+    --   Therefore, reconsider if we should have this package, or if we should delete it and move
+    --   this functionality here, into Haskell.
+    --   It might make sense to keep it we will be maybe using @prisma/internals or some other
+    --   prisma packages via it in the future, if not then it is not worth keeping it.
+    PrismaPackage
 
 data PackagesDir
 
@@ -33,6 +41,7 @@ packagesDirInDataDir = [reldir|packages|]
 packageDirInPackagesDir :: Package -> Path' (Rel PackagesDir) (Dir PackageDir)
 packageDirInPackagesDir DeployPackage = [reldir|deploy|]
 packageDirInPackagesDir TsInspectPackage = [reldir|ts-inspect|]
+packageDirInPackagesDir PrismaPackage = [reldir|prisma|]
 
 scriptInPackageDir :: Path' (Rel PackageDir) (File PackageScript)
 scriptInPackageDir = [relfile|dist/index.js|]

waspc/src/Wasp/Psl/Format.hs

@@ -0,0 +1,16 @@
+module Wasp.Psl.Format () where
+
+import Data.Text (Text)
+import Wasp.Psl.Ast.Model (Model)
+
+-- | For given prisma schema source, returns formatted schema + any warnings/errors,
+-- by calling "prisma format" in the background.
+-- "prisma format" does more than just formatting -> it also applies some obvious fixes,
+-- like missing relationship fields. So it is kind of like compiling + formatting + fixing.
+prismaFormat :: Text -> IO (Maybe String, Text)
+prismaFormat prismaSchema = error "TODO"
+
+-- "prisma format" works even without other declarations but models! That is great.
+
+prismaFormatModels :: [Model] -> IO (Maybe String, [Model])
+prismaFormatModels models = error "TODO: implement via prismaFormat"

waspc/waspc.cabal

@@ -59,6 +59,9 @@ data-files:
   packages/ts-inspect/dist/**/*.js
   packages/ts-inspect/package.json
   packages/ts-inspect/package-lock.json
+  packages/prisma/dist/**/*.js
+  packages/prisma/package.json
+  packages/prisma/package-lock.json
 data-dir: data/
 
 source-repository head