Merge pull request #72 from nhost/feat/link-env

Feat/link env

Author: Johan Eliasson

README.md

@@ -28,10 +28,12 @@ npm install -g nhost
 To quickly get started, run the following commands:
 
 ```
-nhost login        # Login
-cd <PROJECT>       # Change directory to your project
-nhost init         # Only run once to initiate project locally
-nhost dev          # Start local Nhost backend
+nhost login            # Login
+cd <PROJECT>           # Change directory to your project
+nhost init             # Only run once to initiate project locally
+nhost dev              # Start local Nhost backend
+nhost link             # Link with existing Nhost project
+nhost env [ls, pull]   # List or pull environment variables from Nhost
 ```
 
 ## Dependencies

package-lock.json

@@ -13,12 +13,12 @@
     "@oclif/plugin-help": "^2.2.3",
     "@oclif/plugin-warn-if-update-available": "^1.7.0",
     "chalk": "^4.1.0",
+    "cli-ux": "^5.5.1",
     "detect-port": "^1.3.0",
     "email-prompt": "^0.3.2",
     "email-validator": "^2.0.4",
     "inquirer": "^7.3.2",
     "js-yaml": "^3.13.1",
-    "load-json-file": "^6.2.0",
     "node-fetch": "^2.6.0",
     "nunjucks": "^3.2.1",
     "ora": "^4.0.4",

package.json

@@ -0,0 +1,51 @@
+const { Command } = require("@oclif/command");
+const yaml = require("js-yaml");
+const util = require("util");
+const fs = require("fs");
+const { cli } = require("cli-ux");
+const readFile = util.promisify(fs.readFile);
+const { validateAuth } = require("../../util/login");
+
+class DownCommand extends Command {
+  async run() {
+    const projectConfig = yaml.safeLoad(
+      await readFile(`.nhost/nhost.yaml`, { encoding: "utf8" })
+    );
+    const projectId = projectConfig.project_id;
+
+    // get env vars from remote
+    const userData = await validateAuth();
+
+    const projects = [
+      ...userData.user.projects,
+      ...userData.user.teams.flatMap(({ team }) => team.projects),
+    ];
+
+    const project = projects.find((project) => project.id === projectId);
+    console.log(`Environment variables for ${project.name}.\n`);
+
+    cli.table(
+      project.project_env_vars,
+      {
+        name: {
+          header: "name",
+          minWidth: 20,
+        },
+        dev_value: {
+          header: "value (dev)",
+        },
+      },
+      {
+        printLine: this.log,
+      }
+    );
+  }
+  async catch(error) {
+    console.log("");
+    console.log(error);
+  }
+}
+
+DownCommand.description = `List environment variables`;
+
+module.exports = DownCommand;

src/commands/env/ls.js

@@ -0,0 +1,118 @@
+const { Command } = require("@oclif/command");
+const chalk = require("chalk");
+const yaml = require("js-yaml");
+const util = require("util");
+const fs = require("fs");
+
+const { validateAuth } = require("../../util/login");
+
+class DownCommand extends Command {
+  async run() {
+    this.log(`Overwriting existing .env.development file`);
+    const projectConfig = yaml.safeLoad(
+      fs.readFileSync(`.nhost/nhost.yaml`, { encoding: "utf8" })
+    );
+    const projectId = projectConfig.project_id;
+
+    // get env vars from remote
+    const userData = await validateAuth();
+
+    const projects = [
+      ...userData.user.projects,
+      ...userData.user.teams.flatMap(({ team }) => team.projects),
+    ];
+
+    const project = projects.find((project) => project.id === projectId);
+    this.log(
+      `Downloading development environment variables for project: ${project.name}`
+    );
+
+    const envFile = `.env.development`;
+
+    var envFileContent = fs.readFileSync(envFile, { encoding: "utf8" });
+
+    const existingEnvVars = envFileContent
+      .split("\n")
+      .filter((row) => {
+        return row;
+      })
+      .map((row) => {
+        const [name, value] = row.split("=");
+        return {
+          name,
+          value,
+        };
+      });
+
+    const remoteEnvVars = project.project_env_vars.map((v) => {
+      return { name: v.name, value: v.dev_value };
+    });
+
+    remoteEnvVars.push({
+      name: "REGISTRATION_CUSTOM_FIELDS",
+      value: project.hbp_REGISTRATION_CUSTOM_FIELDS,
+    });
+
+    remoteEnvVars.push({
+      name: "JWT_CUSTOM_FIELDS",
+      value: project.backend_user_fields,
+    });
+
+    remoteEnvVars.push({
+      name: "DEFAULT_ALLOWED_USER_ROLES",
+      value: project.hbp_DEFAULT_ALLOWED_USER_ROLES,
+    });
+
+    remoteEnvVars.push({
+      name: "ALLOWED_USER_ROLES",
+      value: project.hbp_allowed_user_roles,
+    });
+
+    const updatedProjectEnvVarIndexs = [];
+
+    // update env vars already in .env.development
+    const envVars = existingEnvVars.map((existingEnvVar) => {
+      const i = remoteEnvVars.findIndex(
+        (pEnvVar) => pEnvVar.name == existingEnvVar.name
+      );
+      if (i === -1) {
+        return existingEnvVar;
+      }
+
+      const tmpEnvVar = remoteEnvVars[i];
+      updatedProjectEnvVarIndexs.push(i);
+
+      const res = {
+        name: existingEnvVar.name,
+        value: tmpEnvVar.value,
+      };
+      return res;
+    });
+
+    // add env vars not already in .env.development
+    remoteEnvVars
+      .filter((_, i) => {
+        // filter if the env var was alrady updated
+        return !updatedProjectEnvVarIndexs.includes(i);
+      })
+      .forEach((envVar) => {
+        // add new env var
+        envVars.push({
+          name: envVar.name,
+          value: envVar.value,
+        });
+      });
+
+    fs.writeFileSync(
+      envFile,
+      envVars.map((envVar) => `${envVar.name}=${envVar.value}`).join("\n"),
+      { flag: "w" }
+    );
+
+    this.log(`${chalk.white("✅  .env.development file updated")}`);
+  }
+}
+
+DownCommand.description = `Sync remote environment variables to your local environment`;
+
+module.exports = DownCommand;

src/commands/env/pull.js

@@ -151,6 +151,9 @@ class InitCommand extends Command {
       (project) => project.id === selectedProjectId
     );
 
+    const remoteHasuraVersion = project.hasura_gqe_version;
+    const dockerImage = `nhost/hasura-cli-docker:${remoteHasuraVersion}`;
+
     // create root nhost folder
     await mkdir(nhostDir);
     // .nhost is used for nhost specific configuration
@@ -198,7 +201,7 @@ class InitCommand extends Command {
 
     try {
       // clear current migration information from remote
-      const qres = await fetch(`${hasuraEndpoint}/v1/query`, {
+      await fetch(`${hasuraEndpoint}/v1/query`, {
         method: "POST",
         headers: {
           "Content-Type": "application/json",
@@ -216,20 +219,20 @@ class InitCommand extends Command {
 
       // create migrations from remote
       spinner.text = "Create migrations";
-      let command = `hasura migrate create "init" --from-server --schema "public" --schema "auth" ${commonOptions}`;
+      let command = `docker run --rm -v $(pwd):/hasuracli ${dockerImage} migrate create "init" --from-server --schema "public" --schema "auth" ${commonOptions}`;
       await exec(command, { cwd: nhostDir });
 
-      // mark this migration as applied (--skip-execution) on the remote server
-      // so that it doesn't get run again when promoting local
-      // changes to that environment
+      // // mark this migration as applied (--skip-execution) on the remote server
+      // // so that it doesn't get run again when promoting local
+      // // changes to that environment
       const initMigration = fs.readdirSync(migrationDirectory)[0];
       const version = initMigration.match(/^\d+/)[0];
-      command = `hasura migrate apply --version "${version}" --skip-execution ${commonOptions}`;
+      command = `docker run --rm -v $(pwd):/hasuracli nhost/hasura-cli-docker migrate apply --version "${version}" --skip-execution ${commonOptions}`;
       await exec(command, { cwd: nhostDir });
 
       // create metadata from remote
       spinner.text = "Create Hasura metadata";
-      command = `hasura metadata export ${commonOptions}`;
+      command = `docker run --rm -v $(pwd):/hasuracli ${dockerImage}  metadata export ${commonOptions}`;
       await exec(command, { cwd: nhostDir });
 
       // auth.roles and auth.providers plus any enum compatible tables that might exist
@@ -255,7 +258,7 @@ class InitCommand extends Command {
         ""
       );
       if (fromTables) {
-        command = `hasura seeds create enum ${fromTables} ${commonOptions}`;
+        command = `docker run --rm -v $(pwd):/hasuracli ${dockerImage} seeds create roles_and_providers ${fromTables} ${commonOptions}`;
         await exec(command, { cwd: nhostDir });
       }
 
@@ -291,22 +294,23 @@ class InitCommand extends Command {
 
       // write ENV variables to .env.development
       spinner.text = "Adding env vars to .env.development";
-      await this._writeToFileSync(
+      await writeFile(
         envFile,
         project.project_env_vars
           .map((envVar) => `${envVar.name}=${envVar.dev_value}`)
           .join("\n")
       );
 
-      await this._writeToFileSync(
+      await writeFile(
         envFile,
         `\nREGISTRATION_CUSTOM_FIELDS=${project.hbp_REGISTRATION_CUSTOM_FIELDS}\n`
       );
 
       if (project.backend_user_fields) {
         await this._writeToFileSync(
           envFile,
-          `\JWT_CUSTOM_FIELDS=${project.backend_user_fields}\n`
+          `JWT_CUSTOM_FIELDS=${project.backend_user_fields}\n`,
+          { flag: "a" }
         );
       }
 

src/commands/init.js

@@ -0,0 +1,69 @@
+const { Command } = require("@oclif/command");
+const fs = require("fs");
+const chalk = require("chalk");
+const util = require("util");
+const mkdir = util.promisify(fs.mkdir);
+const exists = util.promisify(fs.exists);
+const writeFile = util.promisify(fs.writeFile);
+
+const selectProject = require("../util/projects");
+const { readAuthFile, getCustomApiEndpoint } = require("../util/config");
+const { validateAuth } = require("../util/login");
+
+class LinkCommand extends Command {
+  async run() {
+    const workingDir = ".";
+    const dotNhost = `${workingDir}/.nhost`;
+    const apiUrl = getCustomApiEndpoint();
+    const auth = readAuthFile();
+    let userData;
+    try {
+      userData = await validateAuth(apiUrl, auth);
+    } catch (err) {
+      return this.log(`${chalk.red("Error!")} ${err.message}`);
+    }
+
+    // personal and team projects
+    const projects = [
+      ...userData.user.projects,
+      ...userData.user.teams.flatMap(({ team }) => team.projects),
+    ];
+
+    if (projects.length === 0) {
+      return this.log(
+        `\nWe couldn't find any projects related to this account, go to ${chalk.bold.underline(
+          "https://console.nhost.io/new"
+        )} and create one`
+      );
+    }
+
+    let selectedProjectId;
+    try {
+      selectedProjectId = await selectProject(projects);
+    } catch (err) {
+      return this.log(`${chalk.red("Error!")} ${err.message}`);
+    }
+
+    const project = projects.find(
+      (project) => project.id === selectedProjectId
+    );
+
+    // .nhost is used for nhost specific configuration
+    if (!(await exists(dotNhost))) {
+      await mkdir(dotNhost);
+    }
+    await writeFile(
+      `${dotNhost}/nhost.yaml`,
+      `project_id: ${selectedProjectId}`
+    );
+
+    console.log(`Project linked: ${project.name}`);
+  }
+}
+
+LinkCommand.description = `Link Nhost Project 2
+...
+Link Nhost project
+`;
+
+module.exports = LinkCommand;

src/commands/link.js

@@ -1,11 +1,11 @@
 const fs = require("fs");
+const chalk = require("chalk");
 const util = require("util");
 const exists = util.promisify(fs.exists);
 const unlink = util.promisify(fs.unlink);
 const path = require("path");
 const { homedir } = require("os");
 const writeJSON = require("write-json-file");
-const loadJSON = require("load-json-file");
 
 const NHOST_DIR = path.join(homedir(), ".nhost");
 const authPath = path.join(NHOST_DIR, "auth.json");
@@ -66,6 +66,8 @@ async function writeAuthFile(data) {
       mode: 0o600,
     });
   } catch (err) {
+    console.log(chalk.bold.red("Error!"));
+    console.log("Could not read auth file. Run `nhost login` first.");
     throw err;
   }
 }
@@ -79,7 +81,13 @@ async function deleteAuthFile() {
 }
 
 function readAuthFile() {
-  return loadJSON.sync(authPath);
+  try {
+    return require(authPath);
+  } catch (error) {
+    console.log(chalk.bold.red("Error!"));
+    console.log("Could not read auth file. Run `nhost login` first.");
+    throw error;
+  }
 }
 
 async function authFileExists() {