@astrojs/db 0.6.1 → 0.6.2

package/README.md

@@ -0,0 +1,38 @@
+# @astrojs/db (experimental) 💿
+
+This **[Astro integration][astro-integration]** enables the usage of [SQLite](https://www.sqlite.org/) in Astro Projects.
+
+## Documentation
+
+Read the [`@astrojs/db` docs][docs]
+
+## Support
+
+- Get help in the [Astro Discord][discord]. Post questions in our `#support` forum, or visit our dedicated `#dev` channel to discuss current development and more!
+
+- Check our [Astro Integration Documentation][astro-integration] for more on integrations.
+
+- Submit bug reports and feature requests as [GitHub issues][issues].
+
+## Contributing
+
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! These links will help you get started:
+
+- [Contributor Manual][contributing]
+- [Code of Conduct][coc]
+- [Community Guide][community]
+
+## License
+
+MIT
+
+Copyright (c) 2023–present [Astro][astro]
+
+[astro]: https://astro.build/
+[docs]: https://docs.astro.build/en/guides/integrations-guide/db/
+[contributing]: https://github.com/withastro/astro/blob/main/CONTRIBUTING.md
+[coc]: https://github.com/withastro/.github/blob/main/CODE_OF_CONDUCT.md
+[community]: https://github.com/withastro/.github/blob/main/COMMUNITY_GUIDE.md
+[discord]: https://astro.build/chat/
+[issues]: https://github.com/withastro/astro/issues
+[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/

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

@@ -1,9 +1,11 @@
+import { red } from "kleur/colors";
 import { getManagedAppTokenOrExit } from "../../../tokens.js";
 import {} from "../../../types.js";
 import { getRemoteDatabaseUrl } from "../../../utils.js";
 import {
   createCurrentSnapshot,
   createEmptySnapshot,
+  formatDataLossMessage,
   getMigrationQueries,
   getProductionCurrentSnapshot
 } from "../../migration-queries.js";
@@ -17,7 +19,7 @@ async function cmd({
   const productionSnapshot = await getProductionCurrentSnapshot({ appToken: appToken.token });
   const currentSnapshot = createCurrentSnapshot(dbConfig);
   const isFromScratch = isForceReset || JSON.stringify(productionSnapshot) === "{}";
-  const { queries: migrationQueries } = await getMigrationQueries({
+  const { queries: migrationQueries, confirmations } = await getMigrationQueries({
     oldSnapshot: isFromScratch ? createEmptySnapshot() : productionSnapshot,
     newSnapshot: currentSnapshot
   });
@@ -26,6 +28,12 @@ async function cmd({
   } else {
     console.log(`Database schema is out of date.`);
   }
+  if (isForceReset) {
+    console.log(`Force-pushing to the database. All existing data will be erased.`);
+  } else if (confirmations.length > 0) {
+    console.log("\n" + formatDataLossMessage(confirmations) + "\n");
+    throw new Error("Exiting.");
+  }
   if (isDryRun) {
     console.log("Statements:", JSON.stringify(migrationQueries, void 0, 2));
   } else {

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

@@ -2,6 +2,7 @@ import { getManagedAppTokenOrExit } from "../../../tokens.js";
 import {
   createCurrentSnapshot,
   createEmptySnapshot,
+  formatDataLossMessage,
   getMigrationQueries,
   getProductionCurrentSnapshot
 } from "../../migration-queries.js";
@@ -9,20 +10,36 @@ async function cmd({
   dbConfig,
   flags
 }) {
+  const isJson = flags.json;
   const appToken = await getManagedAppTokenOrExit(flags.token);
   const productionSnapshot = await getProductionCurrentSnapshot({ appToken: appToken.token });
   const currentSnapshot = createCurrentSnapshot(dbConfig);
-  const { queries: migrationQueries } = await getMigrationQueries({
+  const { queries: migrationQueries, confirmations } = await getMigrationQueries({
     oldSnapshot: JSON.stringify(productionSnapshot) !== "{}" ? productionSnapshot : createEmptySnapshot(),
     newSnapshot: currentSnapshot
   });
+  const result = { exitCode: 0, message: "", code: "", data: void 0 };
   if (migrationQueries.length === 0) {
-    console.log(`Database schema is up to date.`);
+    result.code = "MATCH";
+    result.message = `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.`);
+    result.code = "NO_MATCH";
+    result.message = `Database schema is out of date.
+Run 'astro db push' to push up your latest changes.`;
+  }
+  if (confirmations.length > 0) {
+    result.code = "DATA_LOSS";
+    result.exitCode = 1;
+    result.data = confirmations;
+    result.message = formatDataLossMessage(confirmations, !isJson);
+  }
+  if (isJson) {
+    console.log(JSON.stringify(result));
+  } else {
+    console.log(result.message);
   }
   await appToken.destroy();
+  process.exit(result.exitCode);
 }
 export {
   cmd

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

@@ -19,3 +19,4 @@ export declare function getProductionCurrentSnapshot({ appToken, }: {
 }): Promise<DBSnapshot>;
 export declare function createCurrentSnapshot({ tables }: DBConfig): DBSnapshot;
 export declare function createEmptySnapshot(): DBSnapshot;
+export declare function formatDataLossMessage(confirmations: string[], isColor?: boolean): string;

package/dist/core/cli/migration-queries.js

@@ -2,6 +2,7 @@ import deepDiff from "deep-diff";
 import { SQLiteAsyncDialect } from "drizzle-orm/sqlite-core";
 import * as color from "kleur/colors";
 import { customAlphabet } from "nanoid";
+import stripAnsi from "strip-ansi";
 import { hasPrimaryKey } from "../../runtime/index.js";
 import {
   getCreateIndexQueries,
@@ -113,24 +114,13 @@ async function getCollectionChangeQueries({
   if (dataLossCheck.dataLoss) {
     const { reason, columnName } = dataLossCheck;
     const reasonMsgs = {
-      "added-required": `New column ${color.bold(
+      "added-required": `You added new required column '${color.bold(
         collectionName + "." + columnName
-      )} is required with no default value.
-This requires deleting existing data in the ${color.bold(
-        collectionName
-      )} collection.`,
-      "added-unique": `New column ${color.bold(
+      )}' with no default value.
+      This cannot be executed on an existing table.`,
+      "updated-type": `Updating existing column ${color.bold(
         collectionName + "." + columnName
-      )} is marked as unique.
-This requires deleting existing data in the ${color.bold(
-        collectionName
-      )} collection.`,
-      "updated-type": `Updated column ${color.bold(
-        collectionName + "." + columnName
-      )} cannot convert data to new column data type.
-This requires deleting existing data in the ${color.bold(
-        collectionName
-      )} collection.`
+      )} to a new type that cannot be handled automatically.`
     };
     confirmations.push(reasonMsgs[reason]);
   }
@@ -260,9 +250,6 @@ function canRecreateTableWithoutDataLoss(added, updated) {
     if (!a.schema.optional && !hasDefault(a)) {
       return { dataLoss: true, columnName, reason: "added-required" };
     }
-    if (!a.schema.optional && a.schema.unique) {
-      return { dataLoss: true, columnName, reason: "added-unique" };
-    }
   }
   for (const [columnName, u] of Object.entries(updated)) {
     if (u.old.type !== u.new.type && !canChangeTypeWithoutQuery(u.old, u.new)) {
@@ -353,9 +340,26 @@ function createCurrentSnapshot({ tables = {} }) {
 function createEmptySnapshot() {
   return { experimentalVersion: 1, schema: {} };
 }
+function formatDataLossMessage(confirmations, isColor = true) {
+  const messages = [];
+  messages.push(color.red("\u2716 We found some schema changes that cannot be handled automatically:"));
+  messages.push(``);
+  messages.push(...confirmations.map((m, i) => color.red(`  (${i + 1}) `) + m));
+  messages.push(``);
+  messages.push(`To resolve, revert these changes or update your schema, and re-run the command.`);
+  messages.push(
+    `You may also run 'astro db push --force-reset' to ignore all warnings and force-push your local database schema to production instead. All data will be lost and the database will be reset.`
+  );
+  let finalMessage = messages.join("\n");
+  if (!isColor) {
+    finalMessage = stripAnsi(finalMessage);
+  }
+  return finalMessage;
+}
 export {
   createCurrentSnapshot,
   createEmptySnapshot,
+  formatDataLossMessage,
   getCollectionChangeQueries,
   getMigrationQueries,
   getProductionCurrentSnapshot

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/db",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "",
   "license": "MIT",
   "type": "module",
@@ -67,6 +67,7 @@
     "open": "^10.0.3",
     "ora": "^7.0.1",
     "prompts": "^2.4.2",
+    "strip-ansi": "^7.1.0",
     "yargs-parser": "^21.1.1",
     "zod": "^3.22.4"
   },
@@ -82,7 +83,7 @@
     "mocha": "^10.2.0",
     "typescript": "^5.2.2",
     "vite": "^5.1.4",
-    "astro": "4.4.11",
+    "astro": "4.4.12",
     "astro-scripts": "0.0.14"
   },
   "scripts": {