@astrojs/db 0.4.1 → 0.6.0

package/dist/core/cli/commands/push/index.js

@@ -1,180 +1,61 @@
-import { createClient } from "@libsql/client";
-import { drizzle as drizzleProxy } from "drizzle-orm/sqlite-proxy";
-import { drizzle as drizzleLibsql } from "drizzle-orm/libsql";
-import { SQLiteAsyncDialect } from "drizzle-orm/sqlite-core";
-import { red } from "kleur/colors";
-import prompts from "prompts";
-import { recreateTables, seedData } from "../../../queries.js";
 import { getManagedAppTokenOrExit } from "../../../tokens.js";
-import { tablesSchema } from "../../../types.js";
+import {} from "../../../types.js";
 import { getRemoteDatabaseUrl } from "../../../utils.js";
-import { getMigrationQueries } from "../../migration-queries.js";
 import {
+  createCurrentSnapshot,
   createEmptySnapshot,
-  getMigrations,
-  getMigrationStatus,
-  loadInitialSnapshot,
-  loadMigration,
-  MIGRATION_NEEDED,
-  MIGRATIONS_NOT_INITIALIZED,
-  MIGRATIONS_UP_TO_DATE
-} from "../../migrations.js";
-import { MISSING_SESSION_ID_ERROR } from "../../../errors.js";
-async function cmd({ config, flags }) {
+  getMigrationQueries,
+  getProductionCurrentSnapshot
+} from "../../migration-queries.js";
+async function cmd({
+  dbConfig,
+  flags
+}) {
   const isDryRun = flags.dryRun;
+  const isForceReset = flags.forceReset;
   const appToken = await getManagedAppTokenOrExit(flags.token);
-  const migration = await getMigrationStatus(config);
-  if (migration.state === "no-migrations-found") {
-    console.log(MIGRATIONS_NOT_INITIALIZED);
-    process.exit(1);
-  } else if (migration.state === "ahead") {
-    console.log(MIGRATION_NEEDED);
-    process.exit(1);
-  }
-  const allLocalMigrations = await getMigrations();
-  let missingMigrations = [];
-  try {
-    const { data } = await prepareMigrateQuery({
-      migrations: allLocalMigrations,
-      appToken: appToken.token
-    });
-    missingMigrations = data;
-  } catch (error) {
-    if (error instanceof Error) {
-      if (error.message.startsWith("{")) {
-        const { error: { code } = { code: "" } } = JSON.parse(error.message);
-        if (code === "TOKEN_UNAUTHORIZED") {
-          console.error(MISSING_SESSION_ID_ERROR);
-        }
-      }
-    }
-    console.error(error);
-    process.exit(1);
+  const productionSnapshot = await getProductionCurrentSnapshot({ appToken: appToken.token });
+  const currentSnapshot = createCurrentSnapshot(dbConfig);
+  const isFromScratch = isForceReset || JSON.stringify(productionSnapshot) === "{}";
+  const { queries: migrationQueries } = await getMigrationQueries({
+    oldSnapshot: isFromScratch ? createEmptySnapshot() : productionSnapshot,
+    newSnapshot: currentSnapshot
+  });
+  if (migrationQueries.length === 0) {
+    console.log("Database schema is up to date.");
+  } else {
+    console.log(`Database schema is out of date.`);
   }
-  if (missingMigrations.length === 0) {
-    console.log(MIGRATIONS_UP_TO_DATE);
+  if (isDryRun) {
+    console.log("Statements:", JSON.stringify(migrationQueries, void 0, 2));
   } else {
-    console.log(`Pushing ${missingMigrations.length} migrations...`);
+    console.log(`Pushing database schema updates...`);
     await pushSchema({
-      migrations: missingMigrations,
+      statements: migrationQueries,
       appToken: appToken.token,
       isDryRun,
-      currentSnapshot: migration.currentSnapshot
+      currentSnapshot
     });
   }
-  console.info("Pushing data...");
-  await pushData({ config, appToken: appToken.token, isDryRun });
   await appToken.destroy();
   console.info("Push complete!");
 }
 async function pushSchema({
-  migrations,
+  statements,
   appToken,
   isDryRun,
   currentSnapshot
 }) {
-  const initialSnapshot = migrations.find((m) => m === "0000_snapshot.json");
-  const filteredMigrations = migrations.filter((m) => m !== "0000_snapshot.json");
-  const missingMigrationContents = await Promise.all(filteredMigrations.map(loadMigration));
-  const initialMigrationBatch = initialSnapshot ? (await getMigrationQueries({
-    oldSnapshot: createEmptySnapshot(),
-    newSnapshot: await loadInitialSnapshot()
-  })).queries : [];
-  const confirmations = missingMigrationContents.reduce((acc, curr) => {
-    return [...acc, ...curr.confirm || []];
-  }, []);
-  if (confirmations.length > 0) {
-    const response = await prompts([
-      ...confirmations.map((message, index) => ({
-        type: "confirm",
-        name: String(index),
-        message: red("Warning: ") + message + "\nContinue?",
-        initial: true
-      }))
-    ]);
-    if (Object.values(response).length === 0 || Object.values(response).some((value) => value === false)) {
-      process.exit(1);
-    }
-  }
-  const queries = missingMigrationContents.reduce((acc, curr) => {
-    return [...acc, ...curr.db];
-  }, initialMigrationBatch);
-  await runMigrateQuery({ queries, migrations, snapshot: currentSnapshot, appToken, isDryRun });
-}
-const sqlite = new SQLiteAsyncDialect();
-async function pushData({
-  config,
-  appToken,
-  isDryRun
-}) {
-  const queries = [];
-  if (config.db?.data) {
-    const libsqlClient = createClient({ url: ":memory:" });
-    await recreateTables({
-      db: drizzleLibsql(libsqlClient),
-      tables: tablesSchema.parse(config.db.tables ?? {})
-    });
-    for (const [collectionName, { writable }] of Object.entries(config.db.tables ?? {})) {
-      if (!writable) {
-        queries.push({
-          sql: `DELETE FROM ${sqlite.escapeName(collectionName)}`,
-          args: []
-        });
-      }
-    }
-    const db = await drizzleProxy(async (sqlQuery, params, method) => {
-      const stmt = { sql: sqlQuery, args: params };
-      queries.push(stmt);
-      const { rows } = await libsqlClient.execute(stmt);
-      const rowValues = [];
-      for (const row of rows) {
-        if (row != null && typeof row === "object") {
-          rowValues.push(Object.values(row));
-        }
-      }
-      if (method === "get") {
-        return { rows: rowValues[0] };
-      }
-      return { rows: rowValues };
-    });
-    await seedData({
-      db,
-      mode: "build",
-      data: config.db.data
-    });
-  }
-  const url = new URL("/db/query", getRemoteDatabaseUrl());
-  if (isDryRun) {
-    console.info("[DRY RUN] Batch data seed:", JSON.stringify(queries, null, 2));
-    return new Response(null, { status: 200 });
-  }
-  return await fetch(url, {
-    method: "POST",
-    headers: new Headers({
-      Authorization: `Bearer ${appToken}`
-    }),
-    body: JSON.stringify(queries)
-  });
-}
-async function runMigrateQuery({
-  queries: baseQueries,
-  migrations,
-  snapshot,
-  appToken,
-  isDryRun
-}) {
-  const queries = ["pragma defer_foreign_keys=true;", ...baseQueries];
   const requestBody = {
-    snapshot,
-    migrations,
-    sql: queries,
+    snapshot: currentSnapshot,
+    sql: statements,
     experimentalVersion: 1
   };
   if (isDryRun) {
     console.info("[DRY RUN] Batch query:", JSON.stringify(requestBody, null, 2));
     return new Response(null, { status: 200 });
   }
-  const url = new URL("/migrations/run", getRemoteDatabaseUrl());
+  const url = new URL("/db/push", getRemoteDatabaseUrl());
   return await fetch(url, {
     method: "POST",
     headers: new Headers({
@@ -183,27 +64,6 @@ async function runMigrateQuery({
     body: JSON.stringify(requestBody)
   });
 }
-async function prepareMigrateQuery({
-  migrations,
-  appToken
-}) {
-  const url = new URL("/migrations/prepare", getRemoteDatabaseUrl());
-  const requestBody = {
-    migrations,
-    experimentalVersion: 1
-  };
-  const result = await fetch(url, {
-    method: "POST",
-    headers: new Headers({
-      Authorization: `Bearer ${appToken}`
-    }),
-    body: JSON.stringify(requestBody)
-  });
-  if (result.status >= 400) {
-    throw new Error(await result.text());
-  }
-  return await result.json();
-}
 export {
   cmd
 };

package/dist/core/cli/commands/shell/index.d.ts

@@ -1,6 +1,8 @@
 import type { AstroConfig } from 'astro';
 import type { Arguments } from 'yargs-parser';
-export declare function cmd({ flags }: {
-    config: AstroConfig;
+import type { DBConfigInput } from '../../../types.js';
+export declare function cmd({ flags, }: {
+    dbConfig: DBConfigInput;
+    astroConfig: AstroConfig;
     flags: Arguments;
 }): Promise<void>;

package/dist/core/cli/commands/shell/index.js

@@ -2,7 +2,9 @@ import { sql } from "drizzle-orm";
 import { createRemoteDatabaseClient } from "../../../../runtime/db-client.js";
 import { getManagedAppTokenOrExit } from "../../../tokens.js";
 import { getRemoteDatabaseUrl } from "../../../utils.js";
-async function cmd({ flags }) {
+async function cmd({
+  flags
+}) {
   const query = flags.query;
   const appToken = await getManagedAppTokenOrExit(flags.token);
   const db = createRemoteDatabaseClient(appToken.token, getRemoteDatabaseUrl());

package/dist/core/cli/commands/verify/index.d.ts

@@ -1,6 +1,8 @@
 import type { AstroConfig } from 'astro';
 import type { Arguments } from 'yargs-parser';
-export declare function cmd({ config, flags }: {
-    config: AstroConfig;
+import type { DBConfig } from '../../../types.js';
+export declare function cmd({ dbConfig, flags, }: {
+    astroConfig: AstroConfig;
+    dbConfig: DBConfig;
     flags: Arguments;
 }): Promise<void>;

package/dist/core/cli/commands/verify/index.js

@@ -1,42 +1,28 @@
+import { getManagedAppTokenOrExit } from "../../../tokens.js";
 import {
-  getMigrationStatus,
-  MIGRATION_NEEDED,
-  MIGRATIONS_NOT_INITIALIZED,
-  MIGRATIONS_UP_TO_DATE
-} from "../../migrations.js";
-import { getMigrationQueries } from "../../migration-queries.js";
-async function cmd({ config, flags }) {
-  const status = await getMigrationStatus(config);
-  const { state } = status;
-  if (flags.json) {
-    if (state === "ahead") {
-      const { queries: migrationQueries } = await getMigrationQueries({
-        oldSnapshot: status.oldSnapshot,
-        newSnapshot: status.newSnapshot
-      });
-      const newFileContent = {
-        diff: status.diff,
-        db: migrationQueries
-      };
-      status.newFileContent = JSON.stringify(newFileContent, null, 2);
-    }
-    console.log(JSON.stringify(status));
-    process.exit(state === "up-to-date" ? 0 : 1);
-  }
-  switch (state) {
-    case "no-migrations-found": {
-      console.log(MIGRATIONS_NOT_INITIALIZED);
-      process.exit(1);
-    }
-    case "ahead": {
-      console.log(MIGRATION_NEEDED);
-      process.exit(1);
-    }
-    case "up-to-date": {
-      console.log(MIGRATIONS_UP_TO_DATE);
-      return;
-    }
+  createCurrentSnapshot,
+  createEmptySnapshot,
+  getMigrationQueries,
+  getProductionCurrentSnapshot
+} from "../../migration-queries.js";
+async function cmd({
+  dbConfig,
+  flags
+}) {
+  const appToken = await getManagedAppTokenOrExit(flags.token);
+  const productionSnapshot = await getProductionCurrentSnapshot({ appToken: appToken.token });
+  const currentSnapshot = createCurrentSnapshot(dbConfig);
+  const { queries: migrationQueries } = await getMigrationQueries({
+    oldSnapshot: JSON.stringify(productionSnapshot) !== "{}" ? productionSnapshot : createEmptySnapshot(),
+    newSnapshot: currentSnapshot
+  });
+  if (migrationQueries.length === 0) {
+    console.log(`Database schema is up to date.`);
+  } else {
+    console.log(`Database schema is out of date.`);
+    console.log(`Run 'astro db push' to push up your latest changes.`);
   }
+  await appToken.destroy();
 }
 export {
   cmd

package/dist/core/cli/index.d.ts

@@ -1,6 +1,6 @@
 import type { AstroConfig } from 'astro';
 import type { Arguments } from 'yargs-parser';
-export declare function cli({ flags, config }: {
+export declare function cli({ flags, config: astroConfig, }: {
     flags: Arguments;
     config: AstroConfig;
 }): Promise<void>;

package/dist/core/cli/index.js

@@ -1,40 +1,49 @@
-import { STUDIO_CONFIG_MISSING_CLI_ERROR } from "../errors.js";
-async function cli({ flags, config }) {
+import { loadDbConfigFile } from "../load-file.js";
+import { dbConfigSchema } from "../types.js";
+async function cli({
+  flags,
+  config: astroConfig
+}) {
   const args = flags._;
   const command = args[2] === "db" ? args[3] : args[2];
-  if (!config.db?.studio) {
-    console.log(STUDIO_CONFIG_MISSING_CLI_ERROR);
-    process.exit(1);
-  }
+  const { mod } = await loadDbConfigFile(astroConfig.root);
+  const dbConfig = dbConfigSchema.parse(mod?.default ?? {});
   switch (command) {
     case "shell": {
       const { cmd } = await import("./commands/shell/index.js");
-      return await cmd({ config, flags });
+      return await cmd({ astroConfig, dbConfig, flags });
+    }
+    case "gen": {
+      console.log('"astro db gen" is no longer needed! Visit the docs for more information.');
+      return;
     }
-    case "gen":
     case "sync": {
-      const { cmd } = await import("./commands/gen/index.js");
-      return await cmd({ config, flags });
+      console.log('"astro db sync" is no longer needed! Visit the docs for more information.');
+      return;
     }
     case "push": {
       const { cmd } = await import("./commands/push/index.js");
-      return await cmd({ config, flags });
+      return await cmd({ astroConfig, dbConfig, flags });
     }
     case "verify": {
       const { cmd } = await import("./commands/verify/index.js");
-      return await cmd({ config, flags });
+      return await cmd({ astroConfig, dbConfig, flags });
+    }
+    case "execute": {
+      const { cmd } = await import("./commands/execute/index.js");
+      return await cmd({ astroConfig, dbConfig, flags });
     }
     case "login": {
       const { cmd } = await import("./commands/login/index.js");
-      return await cmd({ config, flags });
+      return await cmd({ astroConfig, dbConfig, flags });
     }
     case "logout": {
       const { cmd } = await import("./commands/logout/index.js");
-      return await cmd({ config, flags });
+      return await cmd();
     }
     case "link": {
       const { cmd } = await import("./commands/link/index.js");
-      return await cmd({ config, flags });
+      return await cmd();
     }
     default: {
       if (command == null) {
@@ -59,8 +68,8 @@ astro logout         End your authenticated session with Astro Studio
 astro link           Link this directory to an Astro Studio project
 
 astro db gen         Creates snapshot based on your schema
-astro db push        Pushes migrations to Astro Studio
-astro db verify      Verifies migrations have been pushed and errors if not`;
+astro db push        Pushes schema updates to Astro Studio
+astro db verify      Tests schema updates /w Astro Studio (good for CI)`;
   }
 }
 export {

package/dist/core/cli/migration-queries.d.ts

@@ -1,26 +1,21 @@
-import { type DBTable, type DBSnapshot } from '../types.js';
-/** Dependency injected for unit testing */
-type AmbiguityResponses = {
-    collectionRenames: Record<string, string>;
-    columnRenames: {
-        [collectionName: string]: Record<string, string>;
-    };
-};
-export declare function getMigrationQueries({ oldSnapshot, newSnapshot, ambiguityResponses, }: {
+import { type DBConfig, type DBSnapshot, type DBTable } from '../types.js';
+export declare function getMigrationQueries({ oldSnapshot, newSnapshot, }: {
     oldSnapshot: DBSnapshot;
     newSnapshot: DBSnapshot;
-    ambiguityResponses?: AmbiguityResponses;
 }): Promise<{
     queries: string[];
     confirmations: string[];
 }>;
-export declare function getCollectionChangeQueries({ collectionName, oldCollection, newCollection, ambiguityResponses, }: {
+export declare function getCollectionChangeQueries({ collectionName, oldCollection, newCollection, }: {
     collectionName: string;
     oldCollection: DBTable;
     newCollection: DBTable;
-    ambiguityResponses?: AmbiguityResponses;
 }): Promise<{
     queries: string[];
     confirmations: string[];
 }>;
-export {};
+export declare function getProductionCurrentSnapshot({ appToken, }: {
+    appToken: string;
+}): Promise<DBSnapshot>;
+export declare function createCurrentSnapshot({ tables }: DBConfig): DBSnapshot;
+export declare function createEmptySnapshot(): DBSnapshot;