improvements: fetch accountId instead of asking the user for the value

improvements: fetch accountId instead of asking the user for the value

Author: jgoux

README.md

@@ -31,29 +31,31 @@ This plugin gives you a new and isolated database for your preview deployments i
 
 [[plugins]]
  package = "@snaplet/netlify-preview-database-plugin"
-
-  [plugins.inputs]
-    databaseEnvVar = "DATABASE_URL"
-    databaseCreateCommand = "snaplet db create --git --latest"
-    databaseUrlCommand = "snaplet db url --git"
-    reset = false
 ```
 **Note:** We check the deploy context associated with the build. You can configure your settings by deploy context.
 
-#### Inputs (All inputs are optional)
+#### Inputs
 
 ```yaml
 - name: databaseEnvVar
+  required: false
   description: Database environment variable name
+  default: "DATABASE_URL"
 
 - name: databaseCreateCommand
-  description: Command used to generate the preview database
+  required: false
+  description: Command used to generate the instant database
+  default: "snaplet db create --git --latest"
 
 - name: databaseUrlCommand
-  description: Command used to get the preview database url
+  required: false
+  description: Command used to get the instant database url
+  default: "snaplet db url --git"
 
 - name: reset
+  required: false
   description: Reset the database state on each commit
+  default: false
 ```
 
 ### 3. Set environment variables
@@ -69,7 +71,7 @@ This plugin gives you a new and isolated database for your preview deployments i
 
 [[plugins]]
 # ...
-	
+
   [context.deploy-preview.environment]
   SNAPLET_ACCESS_TOKEN="<YOUR_SNAPLET_ACCESS_TOKEN>"
 ```
@@ -78,7 +80,6 @@ This plugin gives you a new and isolated database for your preview deployments i
 
 ```
 NETLIFY_ACCESS_TOKEN=// API Access token found in Netlify user settings.
-NETLIFY_ACCOUNT_ID=// Account ID found in team settings
 SNAPLET_ACCESS_TOKEN=// CLI Access token found in Snaplet UI
 SNAPLET_PROJECT_ID=// Project ID found in Snaplet project settings.
 ```

manifest.yml

@@ -2,13 +2,21 @@ name: snaplet-netlify-plugin-preview-db
 
 inputs:
   - name: databaseEnvVar
+    required: false
     description: Database environment variable name
+    default: "DATABASE_URL"
 
   - name: databaseCreateCommand
+    required: false
     description: Command used to generate the instant database
+    default: "snaplet db create --git --latest"
 
   - name: databaseUrlCommand
+    required: false
     description: Command used to get the instant database url
+    default: "snaplet db url --git"
 
   - name: reset
+    required: false
     description: Reset the database state on each commit
+    default: false

package.json

@@ -1,7 +1,8 @@
 {
   "name": "@snaplet/netlify-preview-database-plugin",
-  "version": "1.0.2",
-  "main": "src/index.mjs",
+  "version": "1.1.0",
+  "type": "module",
+  "main": "src/index.js",
   "license": "MIT",
   "description": "Create preview databases for Netlify preview deployments",
   "repository": "https://github.com/snaplet/netlify-preview-database-plugin",
@@ -18,4 +19,4 @@
   "dependencies": {
     "node-fetch": "^3.2.10"
   }
-}
+}

src/create.sh

@@ -0,0 +1,27 @@
+import { getPreviewDatabaseUrl } from "./getPreviewDatabaseUrl.js";
+
+export async function createPreviewDatabase(ctx, options) {
+  const { databaseCreateCommand, databaseUrlCommand, reset } = options;
+
+  let databaseUrl = null;
+  try {
+    databaseUrl = await getPreviewDatabaseUrl(ctx, { databaseUrlCommand });
+  } catch (_) { }
+
+  const previewDatabaseIsDeployed = Boolean(databaseUrl);
+
+  if (!previewDatabaseIsDeployed) {
+    console.log("Creating a preview database...");
+    await ctx.run.command(databaseCreateCommand, { env: { PATH: `/opt/buildhome/.local/bin/:${process.env.PATH}` } });
+    console.log("Preview database created");
+    databaseUrl = await getPreviewDatabaseUrl(ctx, { databaseUrlCommand });
+  }
+
+  if (previewDatabaseIsDeployed && reset) {
+    console.log("Resetting the preview database state...");
+    await ctx.run.command(databaseCreateCommand, { env: { PATH: `/opt/buildhome/.local/bin/:${process.env.PATH}` } });
+    console.log("Preview database state reset");
+  }
+
+  return databaseUrl;
+}

src/createPreviewDatabase.js

@@ -0,0 +1,7 @@
+export async function getPreviewDatabaseUrl(ctx, options) {
+  const { databaseUrlCommand } = options;
+
+  const { stdout: databaseUrl } = await ctx.run.command(databaseUrlCommand, { env: { PATH: `/opt/buildhome/.local/bin/:${process.env.PATH}` }, stdio: "pipe" });
+
+  return databaseUrl;
+}

src/getPreviewDatabaseUrl.js

@@ -0,0 +1,32 @@
+import { createPreviewDatabase } from "./createPreviewDatabase.js"
+import { installSnapletCLI } from "./installSnapletCLI.js";
+import { setEnvironmentVariable } from "./setEnvironmentVariable.js";
+
+export async function onPreBuild({
+  utils: { run },
+  constants,
+  netlifyConfig,
+  inputs: {
+    databaseEnvVar,
+    databaseCreateCommand,
+    databaseUrlCommand,
+    reset,
+  },
+}) {
+  if (process.env.CONTEXT === "deploy-preview") {
+    await installSnapletCLI({ run });
+
+    const databaseUrl = await createPreviewDatabase({ run }, {
+      databaseCreateCommand,
+      databaseUrlCommand,
+      reset,
+    });
+
+    await setEnvironmentVariable({
+      siteId: constants.SITE_ID,
+      branch: netlifyConfig.build.environment.BRANCH,
+      key: databaseEnvVar,
+      value: databaseUrl,
+    });
+  }
+};

src/index.js

@@ -0,0 +1,3 @@
+export async function installSnapletCLI(ctx) {
+  await ctx.run.command("curl -sL https://app.snaplet.dev/get-cli/ | bash", { shell: true, stdio: "ignore" });
+}

src/index.mjs

@@ -0,0 +1,17 @@
+import fetch from "node-fetch";
+
+export async function netlify(path, options) {
+  const response = await fetch(`https://api.netlify.com/api/v1/${path}`, {
+    headers: {
+      Authorization: `Bearer ${process.env.NETLIFY_ACCESS_TOKEN}`,
+      "Content-Type": "application/json",
+    },
+    ...options
+  });
+
+  if (!response.ok) {
+    throw new Error(`Netlify API error: ${response.status} ${response.statusText}`);
+  }
+
+  return await response.json();
+}