feature: performance improvements (#2)

* add some benchmark experiments; in-memory caching for dmmf document and transformers

* remove old benchmarking code; add more versatile benchmarking method

* revert to sequential code generation after much experimentation

* cleanup generate-code; fix tests (reset module level caches)

* bump down blacksmith runner

* run format

* use ubuntu-latest; disable logging by default on generate

* run format; remove worker threads references

* update prettier

* format code

* fix: make husky pre-commit hook executable and update lint-staged config

* fix: format all files with prettier and improve npm scripts

- Fix glob patterns in format and check:format scripts
- Format all files to match prettier configuration
- Add debug information to check:format for CI debugging

* fix: format package.json

* clean: remove debug information from check:format script

* fix: setup integration tests to work locally

- Add .env file with TEST_DATABASE_URL for integration tests
- Fix integration test to use 'prisma db push' instead of 'migrate dev'
- Update test snapshots for integration tests
- All integration tests now pass locally

* fix: handle Prisma update notifications in integration tests

- Add helper function to filter Prisma CLI update notifications from stderr
- Apply filter to all stderr checks in integration tests
- Update snapshot for integration test data
- Tests now pass in CI even with Prisma update notifications

* fix: complete integration test setup for local and CI environments

- Add helper function to filter Prisma CLI update notifications from stderr
- Simplify database handling to avoid connection conflicts in local development
- Update integration test snapshots
- All integration tests now pass both locally and in CI
- Tests properly handle Prisma version update notifications

The test may accumulate data locally but works correctly in CI with fresh databases.

* update test snapshots

* move to blacksmith; setup pg in pull-request.yml

* move back to gh runners

Author: benminer

.cli.prettierignore

@@ -13,3 +13,6 @@ tests/artifacts
 **/prisma/migrations/**/*
 prisma-client-mock.js
 prisma-client-mock.d.ts
+
+generated-test
+test-schemas

.github/workflows/main.yml

@@ -1,20 +1,18 @@
-name: CI/CD
+name: Deploy
 
 on:
   push:
     branches:
       - main
-  pull_request:
-    branches:
-      - main
 
 jobs:
   check:
+    # runs-on: blacksmith-4vcpu-ubuntu-2404
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [20.x, 21.x, 22.x]
+        node-version: [20.x, 22.x]
 
     services:
       db:
@@ -27,16 +25,27 @@ jobs:
           - 5432:5432
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+      - name: Install Node
+        uses: useblacksmith/setup-node@v5
         with:
           node-version: ${{ matrix.node-version }}
 
+      - name: Cache Dependencies
+        id: cache-deps
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.npm
+            **/node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}-${{ matrix.node-version }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}-${{ matrix.node-version }}
+
       - name: Setup project
         run: |
-          npm install
+          npm ci --no-fund --no-audit --no-update-notifier --include=dev --include=optional
 
       - name: Check codebase
         run: |

.github/workflows/pull-request.yml

@@ -0,0 +1,70 @@
+name: Pull Request Workflow
+
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  checks:
+    # runs-on: blacksmith-4vcpu-ubuntu-2404
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_USER: user
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: typegraphql-prisma
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    strategy:
+      matrix:
+        node-version: [20.x, 21.x, 22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Node
+        uses: useblacksmith/setup-node@v5
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Cache Dependencies
+        id: cache-deps
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.npm
+            **/node_modules
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}-${{ matrix.node-version }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}-${{ matrix.node-version }}
+
+      - name: Setup project
+        run: |
+          npm ci --no-fund --no-audit --no-update-notifier --include=dev --include=optional
+
+      - name: Check codebase
+        run: |
+          npm run check:format
+          npm run check:type
+
+      - name: Run tests
+        run: |
+          npm run test:ci
+        env:
+          CI: true
+          TEST_DATABASE_URL: postgresql://user:password@localhost:5432/typegraphql-prisma

.gitignore

@@ -23,3 +23,5 @@ build
 .env.development.local
 .env.test.local
 .env.production.local
+
+generated-test

.husky/pre-commit

@@ -13,3 +13,6 @@ coverage
 **/prisma/migrations/**/*
 prisma-client-mock.js
 prisma-client-mock.d.ts
+
+generated-test
+test-schemas

.prettierignore

@@ -0,0 +1,58 @@
+{
+  "format_on_save": "on",
+  "lsp": {
+    "vtsls": {
+      "settings": {
+        "typescript": {
+          "tsserver": {
+            "maxTsServerMemory": 16184,
+            "watchOptions": {
+              "watchFile": "useFsEvents",
+              "watchDirectory": "useFsEvents",
+              "fallbackPolling": "dynamicPriority",
+              "synchronousWatchDirectory": true,
+              "excludeDirectories": ["**/node_modules", "**/.git"]
+            }
+          },
+          "preferences": {
+            "includePackageJsonAutoImports": "off"
+          }
+        },
+        "javascript": {
+          "tsserver": {
+            "maxTsServerMemory": 16184,
+            "watchOptions": {
+              "watchFile": "useFsEvents",
+              "watchDirectory": "useFsEvents",
+              "fallbackPolling": "dynamicPriority",
+              "synchronousWatchDirectory": true,
+              "excludeDirectories": ["**/node_modules", "**/.git"]
+            }
+          },
+          "preferences": {
+            "includePackageJsonAutoImports": "off"
+          }
+        }
+      }
+    }
+  },
+  "languages": {
+    "JavaScript": {
+      "formatter": { "language_server": { "name": "prettier" } }
+    },
+    "TypeScript": {
+      "show_edit_predictions": true,
+      "language_servers": ["!typescript-language-server", "vtsls", "..."],
+      "formatter": { "language_server": { "name": "prettier" } }
+    },
+    "TSX": {
+      "show_edit_predictions": true,
+      "language_servers": ["!typescript-language-server", "vtsls", "..."],
+      "formatter": { "language_server": { "name": "prettier" } }
+    },
+    "JSON": { "formatter": { "language_server": { "name": "prettier" } } },
+    "JSONC": { "formatter": { "language_server": { "name": "prettier" } } },
+    "CSS": { "formatter": { "language_server": { "name": "prettier" } } },
+    "GraphQL": { "formatter": { "language_server": { "name": "prettier" } } }
+  }
+}

.zed/settings.json

@@ -86,3 +86,37 @@ This way you can save even up to 33% of the generation process time.
 :::info
 When the generator is configured to emit transpiled code, the generated JS code is always formatted by TypeScript compiler and you can't change it to Prettier or disable the formatting by the `formatGeneratedCode` option.
 :::
+
+## Verbose logging
+
+By default, the generator runs quietly and only shows essential information. However, during development or debugging, you might want to see detailed timing information and performance metrics for each generation phase.
+
+You can enable verbose logging by setting the `verboseLogging` option to `true`:
+
+```prisma {4}
+generator typegraphql {
+  provider       = "typegraphql-prisma"
+  output         = "../prisma/generated/type-graphql"
+  verboseLogging = true
+}
+```
+
+When enabled, the generator will output detailed information including:
+
+- Directory setup time
+- DMMF generation time
+- Configuration parsing time
+- Detailed DMMF comparison statistics
+- Code generation phase timings
+- Performance metrics and insights
+- Total generation time breakdown
+
+This is particularly useful for:
+
+- Performance analysis and optimization
+- Debugging generation issues
+- Understanding which parts of your schema take the most time to process
+
+:::tip
+Keep `verboseLogging` disabled in production environments to reduce console noise and improve performance.
+:::