@highstate/backend 0.17.0 → 0.19.1

package/src/database/_generated/project/internal/prismaNamespaceBrowser.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * WARNING: This is an internal file that is subject to change!
@@ -23,28 +24,30 @@ export const Decimal = runtime.Decimal
 
 
 export const NullTypes = {
-  DbNull: runtime.objectEnumValues.classes.DbNull as (new (secret: never) => typeof runtime.objectEnumValues.instances.DbNull),
-  JsonNull: runtime.objectEnumValues.classes.JsonNull as (new (secret: never) => typeof runtime.objectEnumValues.instances.JsonNull),
-  AnyNull: runtime.objectEnumValues.classes.AnyNull as (new (secret: never) => typeof runtime.objectEnumValues.instances.AnyNull),
+  DbNull: runtime.NullTypes.DbNull as (new (secret: never) => typeof runtime.DbNull),
+  JsonNull: runtime.NullTypes.JsonNull as (new (secret: never) => typeof runtime.JsonNull),
+  AnyNull: runtime.NullTypes.AnyNull as (new (secret: never) => typeof runtime.AnyNull),
 }
 /**
  * Helper for filtering JSON entries that have `null` on the database (empty on the db)
  *
  * @see https://www.prisma.io/docs/concepts/components/prisma-client/working-with-fields/working-with-json-fields#filtering-on-a-json-field
  */
-export const DbNull = runtime.objectEnumValues.instances.DbNull
+export const DbNull = runtime.DbNull
+
 /**
  * Helper for filtering JSON entries that have JSON `null` values (not empty on the db)
  *
  * @see https://www.prisma.io/docs/concepts/components/prisma-client/working-with-fields/working-with-json-fields#filtering-on-a-json-field
  */
-export const JsonNull = runtime.objectEnumValues.instances.JsonNull
+export const JsonNull = runtime.JsonNull
+
 /**
  * Helper for filtering JSON entries that are `Prisma.DbNull` or `Prisma.JsonNull`
  *
  * @see https://www.prisma.io/docs/concepts/components/prisma-client/working-with-fields/working-with-json-fields#filtering-on-a-json-field
  */
-export const AnyNull = runtime.objectEnumValues.instances.AnyNull
+export const AnyNull = runtime.AnyNull
 
 
 export const ModelName = {

package/src/database/_generated/project/models/ApiKey.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `ApiKey` model and its related types.

package/src/database/_generated/project/models/Artifact.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `Artifact` model and its related types.

package/src/database/_generated/project/models/HubModel.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `HubModel` model and its related types.

package/src/database/_generated/project/models/InstanceCustomStatus.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `InstanceCustomStatus` model and its related types.

package/src/database/_generated/project/models/InstanceEvaluationState.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `InstanceEvaluationState` model and its related types.

package/src/database/_generated/project/models/InstanceLock.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `InstanceLock` model and its related types.

package/src/database/_generated/project/models/InstanceModel.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `InstanceModel` model and its related types.

package/src/database/_generated/project/models/InstanceOperationState.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `InstanceOperationState` model and its related types.

package/src/database/_generated/project/models/InstanceState.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `InstanceState` model and its related types.

package/src/database/_generated/project/models/Operation.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `Operation` model and its related types.

package/src/database/_generated/project/models/OperationLog.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `OperationLog` model and its related types.

package/src/database/_generated/project/models/Page.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `Page` model and its related types.

package/src/database/_generated/project/models/Secret.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `Secret` model and its related types.

package/src/database/_generated/project/models/ServiceAccount.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `ServiceAccount` model and its related types.

package/src/database/_generated/project/models/Terminal.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `Terminal` model and its related types.

package/src/database/_generated/project/models/TerminalSession.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `TerminalSession` model and its related types.

package/src/database/_generated/project/models/TerminalSessionLog.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `TerminalSessionLog` model and its related types.

package/src/database/_generated/project/models/Trigger.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `Trigger` model and its related types.

package/src/database/_generated/project/models/UnlockMethod.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `UnlockMethod` model and its related types.

package/src/database/_generated/project/models/UserCompositeViewport.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `UserCompositeViewport` model and its related types.

package/src/database/_generated/project/models/UserProjectViewport.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `UserProjectViewport` model and its related types.

package/src/database/_generated/project/models/Worker.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `Worker` model and its related types.

package/src/database/_generated/project/models/WorkerUnitRegistration.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `WorkerUnitRegistration` model and its related types.

package/src/database/_generated/project/models/WorkerVersion.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `WorkerVersion` model and its related types.

package/src/database/_generated/project/models/WorkerVersionLog.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This file exports the `WorkerVersionLog` model and its related types.

package/src/database/_generated/project/models.ts

@@ -1,6 +1,7 @@
 
 /* !!! This is code generated by Prisma. Do not edit directly. !!! */
 /* eslint-disable */
+// biome-ignore-all lint: generated file
 // @ts-nocheck 
 /*
  * This is a barrel export file for all models and their related types.

package/src/database/abstractions.ts

@@ -31,11 +31,5 @@ export interface ProjectDatabaseBackend {
    * @param projectId The ID of the project to open the database for.
    * @param masterKey The master key to decrypt the project database. If not provided, the encryption is assumed to be disabled.
    */
-  openProjectDatabase(
-    projectId: string,
-    masterKey?: string,
-  ): Promise<[database: ProjectDatabase, url: string]>
+  openProjectDatabase(projectId: string, masterKey?: string): Promise<ProjectDatabase>
 }
-
-export const backendDatabaseVersion = 1
-export const projectDatabaseVersion = 2

package/src/database/index.ts

@@ -2,5 +2,6 @@ export * from "./abstractions"
 export * from "./factory"
 export { getOrCreateBackendIdentity } from "./local"
 export * from "./manager"
+export * from "./migration"
 export * from "./prisma"
 export * from "./well-known"

package/src/database/local/backend.ts

@@ -1,14 +1,14 @@
 import type { Logger } from "pino"
+import type { BackendDatabaseBackend } from "../abstractions"
 import type { BackendDatabase } from "../prisma"
 import { randomBytes } from "node:crypto"
 import { hostname } from "node:os"
-import { PrismaLibSQL } from "@prisma/adapter-libsql"
+import { PrismaLibSql } from "@prisma/adapter-libsql"
 import { armor, Decrypter, Encrypter, identityToRecipient } from "age-encryption"
 import { z } from "zod"
 import { codebaseConfig, getCodebaseHighstatePath } from "../../common"
 import { PrismaClient } from "../_generated/backend/sqlite/client"
-import { type BackendDatabaseBackend, backendDatabaseVersion } from "../abstractions"
-import { migrateDatabase } from "../migrate"
+import { migrateDatabase, migrationPacks } from "../migration"
 import { ensureWellKnownEntitiesCreated } from "../well-known"
 import {
   type BackendIdentityConfig,
@@ -94,7 +94,6 @@ async function createMasterKey(config: BackendIdentityConfig, logger: Logger) {
 }
 
 type DatabaseInitializationResult = {
-  shouldMigrate: boolean
   masterKey?: string
   metaFile: DatabaseMetaFile
   created: boolean
@@ -115,12 +114,11 @@ async function ensureDatabaseInitialized(
     const masterKey = encryptionEnabled ? await createMasterKey(config, logger) : undefined
 
     const metaFile: DatabaseMetaFile = {
-      version: backendDatabaseVersion,
+      version: 0,
       masterKey: masterKey?.armoredMasterKey,
     }
 
     return {
-      shouldMigrate: true,
       masterKey: masterKey?.masterKey,
       metaFile,
       created: true,
@@ -128,15 +126,8 @@ async function ensureDatabaseInitialized(
     }
   }
 
-  if (meta.version > backendDatabaseVersion) {
-    throw new Error(
-      `Database version (${meta.version}) is newer than expected (${backendDatabaseVersion}). You likely need to update the Highstate.`,
-    )
-  }
-
   if (!encryptionEnabled) {
     return {
-      shouldMigrate: meta.version < backendDatabaseVersion,
       masterKey: undefined,
       metaFile: meta,
       created: false,
@@ -158,7 +149,6 @@ async function ensureDatabaseInitialized(
   const masterKey = await decrypter.decrypt(encryptedMasterKey, "text")
 
   return {
-    shouldMigrate: meta.version < backendDatabaseVersion,
     masterKey,
     metaFile: meta,
     created: false,
@@ -183,23 +173,16 @@ export async function createLocalBackendDatabaseBackend(
   let databasePath = config.HIGHSTATE_BACKEND_DATABASE_LOCAL_PATH
   databasePath ??= await getCodebaseHighstatePath(config, logger)
 
-  const { shouldMigrate, masterKey, metaFile, created, initialRecipient } =
-    await ensureDatabaseInitialized(
-      databasePath,
-      config.HIGHSTATE_ENCRYPTION_ENABLED,
-      config,
-      logger,
-    )
+  const { masterKey, metaFile, created, initialRecipient } = await ensureDatabaseInitialized(
+    databasePath,
+    config.HIGHSTATE_ENCRYPTION_ENABLED,
+    config,
+    logger,
+  )
 
   const databaseUrl = `file:${databasePath}/backend.db`
 
-  if (shouldMigrate) {
-    await migrateDatabase(databaseUrl, "backend/sqlite", masterKey, logger)
-
-    await writeMetaFile(databasePath, { ...metaFile, version: backendDatabaseVersion })
-  }
-
-  const adapter = new PrismaLibSQL({
+  const adapter = new PrismaLibSql({
     url: databaseUrl,
     encryptionKey: masterKey,
   })
@@ -208,6 +191,14 @@ export async function createLocalBackendDatabaseBackend(
     adapter,
   })
 
+  await migrateDatabase(
+    prismaClient,
+    migrationPacks["backend/sqlite"],
+    metaFile.version,
+    async version => await writeMetaFile(databasePath, { ...metaFile, version }),
+    logger,
+  )
+
   const database = prismaClient as BackendDatabase
 
   await ensureWellKnownEntitiesCreated(database)
@@ -216,8 +207,6 @@ export async function createLocalBackendDatabaseBackend(
 
   await ensureInitialUnlockMethod(database, created, initialRecipient, backendLogger)
 
-  backendLogger.info("database is ready")
-
   return new LocalBackendDatabaseBackend(
     database,
     databasePath,

package/src/database/local/project.ts

@@ -2,30 +2,25 @@ import type { Logger } from "pino"
 import type { z } from "zod"
 import type { ProjectDatabaseBackend } from "../abstractions"
 import { mkdir } from "node:fs/promises"
-import { PrismaLibSQL } from "@prisma/adapter-libsql"
+import { PrismaLibSql } from "@prisma/adapter-libsql"
 import { type codebaseConfig, getCodebaseHighstatePath } from "../../common"
 import { ProjectDatabase } from "../prisma"
 
 export class LocalProjectDatabaseBackend implements ProjectDatabaseBackend {
   constructor(private readonly highstatePath: string) {}
 
-  async openProjectDatabase(
-    projectId: string,
-    masterKey?: string,
-  ): Promise<[database: ProjectDatabase, url: string]> {
+  async openProjectDatabase(projectId: string, masterKey?: string): Promise<ProjectDatabase> {
     const databasePath = `${this.highstatePath}/projects/${projectId}`
     await mkdir(databasePath, { recursive: true })
 
     const databaseUrl = `file:${databasePath}/project.db`
 
-    const adapter = new PrismaLibSQL({
+    const adapter = new PrismaLibSql({
       url: databaseUrl,
       encryptionKey: masterKey,
     })
 
-    const database = new ProjectDatabase({ adapter })
-
-    return [database, databaseUrl]
+    return new ProjectDatabase({ adapter })
   }
 
   static async create(

package/src/database/manager.ts

@@ -1,16 +1,12 @@
 import type { Logger } from "pino"
 import type { ProjectUnlockBackend } from "../unlock"
+import type { BackendDatabaseBackend, ProjectDatabaseBackend } from "./abstractions"
 import type { BackendDatabase, ProjectDatabase } from "./prisma"
 import { LRUCache } from "lru-cache"
 import z from "zod"
 import { createProjectLogger } from "../common"
-import { BackendError, ProjectLockedError, ProjectNotFoundError } from "../shared"
-import {
-  type BackendDatabaseBackend,
-  type ProjectDatabaseBackend,
-  projectDatabaseVersion,
-} from "./abstractions"
-import { migrateDatabase } from "./migrate"
+import { ProjectLockedError, ProjectNotFoundError } from "../shared"
+import { migrateDatabase, migrationPacks } from "./migration"
 
 export const databaseManagerConfig = z.object({
   HIGHSTATE_ENCRYPTION_ENABLED: z.stringbool().default(true),
@@ -132,13 +128,16 @@ export class DatabaseManagerImpl implements DatabaseManager {
     const masterKey = await this.getProjectMasterKey(projectId)
     const hexMasterKey = masterKey?.toString("hex")
 
-    const [database, databaseUrl] = await this.projectDatabaseBackend.openProjectDatabase(
-      projectId,
-      hexMasterKey,
-    )
+    const database = await this.projectDatabaseBackend.openProjectDatabase(projectId, hexMasterKey)
 
     // can safely apply migrations here, because no one knows about the database yet
-    await migrateDatabase(databaseUrl, "project", hexMasterKey, logger)
+    await migrateDatabase(
+      database,
+      migrationPacks.project,
+      0, // current version
+      () => Promise.resolve(), // project will be created later
+      logger,
+    )
 
     this.projectDatabases.set(projectId, database)
 
@@ -151,50 +150,45 @@ export class DatabaseManagerImpl implements DatabaseManager {
       return cachedDatabase
     }
 
+    const logger = createProjectLogger(this.logger, projectId)
     const masterKey = await this.getProjectMasterKey(projectId)
     const hexMasterKey = masterKey?.toString("hex")
 
     // TODO: is it really necessary to migrate the database inside the transaction?
     let database = await this.backend.$transaction(async tx => {
-      const databaseEntity = await tx.project.findUnique({
+      const project = await tx.project.findUnique({
         where: { id: projectId },
         select: { databaseVersion: true },
       })
 
-      if (!databaseEntity) {
+      if (!project) {
         throw new ProjectNotFoundError(projectId)
       }
 
-      if (databaseEntity.databaseVersion > projectDatabaseVersion) {
-        throw new BackendError(
-          `Project database version (${databaseEntity.databaseVersion}) is newer than expected (${projectDatabaseVersion}).`,
-        )
-      }
-
-      if (databaseEntity.databaseVersion === projectDatabaseVersion) {
-        return
-      }
-
-      const [database, databaseUrl] = await this.projectDatabaseBackend.openProjectDatabase(
+      const database = await this.projectDatabaseBackend.openProjectDatabase(
         projectId,
         hexMasterKey,
       )
 
-      if (databaseEntity.databaseVersion < projectDatabaseVersion) {
-        await migrateDatabase(databaseUrl, "project", hexMasterKey, this.logger)
-      }
-
-      await tx.project.update({
-        where: { id: projectId },
-        data: { databaseVersion: projectDatabaseVersion },
-      })
+      await migrateDatabase(
+        database,
+        migrationPacks.project,
+        project.databaseVersion,
+        async version => {
+          await tx.project.update({
+            where: { id: projectId },
+            data: { databaseVersion: version },
+          })
+        },
+        logger,
+      )
 
       return database
     })
 
     if (!database) {
       // open database if was not migrated in the transaction
-      const [_database] = await this.projectDatabaseBackend.openProjectDatabase(
+      const _database = await this.projectDatabaseBackend.openProjectDatabase(
         projectId,
         hexMasterKey,
       )