@credibledata/cred-cli 0.0.100 → 0.0.103

package/src/clientconfiguration.ts

@@ -1,8 +1,14 @@
+import crypto from "crypto";
 import fs from "fs";
 import { jwtDecode } from "jwt-decode";
 import kleur from "kleur";
 import os from "os";
-import { ALL_ENVIRONMENTS, ASCII_TITLE, Environment } from "./constants";
+import {
+   ALL_ENVIRONMENTS,
+   ASCII_TITLE,
+   controlPlanesByEnv,
+   Environment,
+} from "./constants";
 import { logger } from "./logger";
 
 interface ConfigFile {
@@ -33,6 +39,15 @@ interface JwtPayload {
    sub?: string;
 }
 
+/**
+ * Thrown when `.cred` exists but cannot be used: either it does not parse as
+ * JSON or it parses but lacks the required top-level shape. Distinct from fs
+ * errors (ENOENT, EACCES) so callers that want to recover — `cred login` —
+ * can target *only* a corrupt-content failure and leave permission/IO errors
+ * to surface loudly.
+ */
+export class InvalidConfigError extends Error {}
+
 export class ClientConfiguration {
    private configPath = `${os.homedir()}/.cred`;
    private config: ConfigFile;
@@ -44,28 +59,35 @@ export class ClientConfiguration {
    }
 
    public loadConfig(): ConfigFile {
+      let fileContents: Buffer | undefined;
       try {
-         const fileContents = fs.readFileSync(this.configPath);
-         this.config = JSON.parse(fileContents.toString());
-         if (
-            !this.config.activeEnvironment ||
-            !this.config.configPerEnvironment
-         ) {
-            throw new Error(
-               "Corrupted config file found, restoring to default settings.",
-            );
-         }
+         fileContents = fs.readFileSync(this.configPath);
       } catch (error) {
-         logger.warn(error);
-         const configPerEnvironment: ConfigFile["configPerEnvironment"] = {};
-         for (const env of ALL_ENVIRONMENTS) {
-            configPerEnvironment[env] = {};
+         if ((error as NodeJS.ErrnoException)?.code === "ENOENT") {
+            // First-time setup: create a default config on disk.
+            this.config = this.defaultConfig();
+            this.writeConfig();
+            return this.config;
          }
-         this.config = {
-            configPerEnvironment,
-            activeEnvironment: "production",
-         };
-         fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+         throw error;
+      }
+
+      try {
+         this.config = JSON.parse(fileContents.toString());
+      } catch (error) {
+         // Non-atomic writes from older binaries, or a manually corrupted file,
+         // can leave `.cred` unparseable. Fail loud rather than silently
+         // overwriting — a silent reset erases the access token for every
+         // subsequent caller on the same machine.
+         throw new InvalidConfigError(
+            `Failed to parse ${this.configPath}: ${error}. The file may be corrupt; re-run \`cred login\` to reset.`,
+         );
+      }
+
+      if (!this.config.activeEnvironment || !this.config.configPerEnvironment) {
+         throw new InvalidConfigError(
+            `Invalid config structure in ${this.configPath}; re-run \`cred login\` to reset.`,
+         );
       }
 
       for (const env of ALL_ENVIRONMENTS) {
@@ -77,13 +99,86 @@ export class ClientConfiguration {
       return this.config;
    }
 
+   /**
+    * Ensure `.cred` is usable, recovering from a corrupt file if needed.
+    *
+    * `loadConfig` deliberately fails loud on a corrupt/invalid file so a read
+    * path never silently erases tokens. But `cred login` exists precisely to
+    * (re)establish config, so it must be able to get past a bad file — that is
+    * what the "re-run `cred login` to reset" message promises. We make the
+    * message true here: the bad file is renamed aside (never deleted, so a
+    * support engineer can still inspect it) and a fresh default is written.
+    *
+    * Only an {@link InvalidConfigError} triggers recovery. fs errors such as
+    * EACCES are real environment problems and are rethrown — resetting would
+    * just fail to write anyway, and we must not mask a permissions issue as a
+    * successful reset.
+    *
+    * @returns the path the corrupt file was backed up to, or null if the
+    *          existing config was already valid.
+    */
+   public recoverIfCorrupt(): string | null {
+      try {
+         this.loadConfig();
+         return null;
+      } catch (error) {
+         if (!(error instanceof InvalidConfigError)) {
+            throw error;
+         }
+         const backupPath = `${this.configPath}.corrupt-${crypto
+            .randomBytes(8)
+            .toString("hex")}`;
+         fs.renameSync(this.configPath, backupPath);
+         logger.warn(
+            `Existing config at ${this.configPath} was invalid and could not be read. ` +
+               `Backed it up to ${backupPath} and reset to defaults.`,
+         );
+         this.config = this.defaultConfig();
+         this.writeConfig();
+         return backupPath;
+      }
+   }
+
+   private defaultConfig(): ConfigFile {
+      const configPerEnvironment: ConfigFile["configPerEnvironment"] = {};
+      for (const env of ALL_ENVIRONMENTS) {
+         configPerEnvironment[env] = {};
+      }
+      return { configPerEnvironment, activeEnvironment: "production" };
+   }
+
+   // Atomic: write to a sibling temp file, then rename into place.
+   // Readers either see the old file or the new file, never a truncated
+   // zero-byte snapshot (the window that `writeFileSync` exposes between
+   // open(O_TRUNC) and write).
+   //
+   // The temp suffix uses 16 bytes of crypto-random hex so the temp
+   // path is unguessable — a predictable name (pid + Date.now()) lets a
+   // co-located attacker pre-create a symlink at that path and trick
+   // us into clobbering an arbitrary file (CodeQL js/insecure-temporary-file).
+   // O_EXCL on open further refuses to follow a pre-existing entry.
+   private writeConfig(): void {
+      const tmp = `${this.configPath}.${crypto.randomBytes(16).toString("hex")}.tmp`;
+      const fd = fs.openSync(
+         tmp,
+         fs.constants.O_WRONLY | fs.constants.O_CREAT | fs.constants.O_EXCL,
+         0o600,
+      );
+      try {
+         fs.writeFileSync(fd, JSON.stringify(this.config));
+      } finally {
+         fs.closeSync(fd);
+      }
+      fs.renameSync(tmp, this.configPath);
+   }
+
    public setOrganization(organizationName: string) {
       this.loadConfig();
       // TODO: Validate organization exists and user has access.
       const environment = this.getEnvironment();
       this.config.configPerEnvironment[environment].organization =
          organizationName;
-      fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+      this.writeConfig();
    }
 
    public setProject(projectName: string) {
@@ -91,7 +186,7 @@ export class ClientConfiguration {
       // TODO: Validate project exists and user has access.
       const environment = this.getEnvironment();
       this.config.configPerEnvironment[environment].project = projectName;
-      fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+      this.writeConfig();
    }
 
    public getOrganization() {
@@ -112,7 +207,7 @@ export class ClientConfiguration {
       this.config.configPerEnvironment[environment].isServiceAccountToken =
          !userToken;
       this.config.configPerEnvironment[environment].accessToken = accessToken;
-      fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+      this.writeConfig();
    }
 
    public getAuthenticationHeader() {
@@ -135,7 +230,7 @@ export class ClientConfiguration {
       const environment = this.getEnvironment();
       this.config.configPerEnvironment[environment].jwtAccessToken =
          jwtAccessToken;
-      fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+      this.writeConfig();
    }
 
    public getJwtAccessToken(): string | undefined {
@@ -154,7 +249,7 @@ export class ClientConfiguration {
          username,
          email,
       };
-      fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+      this.writeConfig();
    }
 
    public getVSCodeUser(): { username: string; email: string } | undefined {
@@ -167,7 +262,7 @@ export class ClientConfiguration {
       this.loadConfig();
       const environment = this.getEnvironment();
       this.config.configPerEnvironment[environment].refreshToken = refreshToken;
-      fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+      this.writeConfig();
    }
 
    public getRefreshToken(): string | undefined {
@@ -192,13 +287,13 @@ export class ClientConfiguration {
       this.loadConfig();
       const environment = this.getEnvironment();
       this.config.configPerEnvironment[environment] = {};
-      fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+      this.writeConfig();
    }
 
    public setEnvironment(environment: Environment) {
       this.loadConfig();
       this.config.activeEnvironment = environment;
-      fs.writeFileSync(this.configPath, JSON.stringify(this.config));
+      this.writeConfig();
    }
 
    public getEnvironment() {
@@ -245,14 +340,20 @@ export class ClientConfiguration {
    public printStatus() {
       this.loadConfig();
       const tokenStatus = this.isTokenValid();
+      const cell = this.getEnvironment();
+
+      // The cell prints on both branches, and before anything else: an org and an
+      // environment name alone do not identify a cell (two cells can both hold a
+      // `demo`), and a stale token is most often a token for the wrong one.
+      console.log(kleur.green(ASCII_TITLE));
+      logger.info(`Cell: ${kleur.green(cell)} (${controlPlanesByEnv[cell]})`);
 
       if (tokenStatus.valid) {
          const organization = this.getOrganization();
          const project = this.getProject();
 
-         console.log(kleur.green(ASCII_TITLE));
          logger.info(`Organization: ${kleur.green(organization || "Not set")}`);
-         logger.info(`Project: ${kleur.green(project || "Not set")}`);
+         logger.info(`Environment: ${kleur.green(project || "Not set")}`);
       } else {
          logger.error("Failed to get status");
          logger.error(

package/src/commands/add.ts

@@ -1,10 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { Command } from "commander";
 import { controlPlanesByEnv, Environment } from "../constants";
 import { createConnections } from "./connection/createconnections";
 import { addMember } from "./group/addmember";
 import { createGroup } from "./group/creategroup";
 import { createGroupAccessToken } from "./groupaccesstoken/createToken";
-import { createProject } from "./project/createproject";
+import { createEnvironment } from "./environment/createenvironment";
+import { warnProjectDeprecated } from "./legacy";
+import { createPermission } from "./permission/createpermission";
 
 export const registerAddCommands = (cli: Command, environment: Environment) => {
    const add = cli
@@ -12,14 +15,41 @@ export const registerAddCommands = (cli: Command, environment: Environment) => {
       .description("Add a resource")
       .argument("<resource>", "The resource to add");
 
+   const addEnvironmentAction = (environmentName: string, options: any) => {
+      createEnvironment(
+         controlPlanesByEnv[environment],
+         environmentName,
+         options.readmeFile,
+         options.replication,
+         options.debug,
+         options.yes,
+      );
+   };
+
+   add.command("environment")
+      .description("Add an environment.")
+      .argument("<environmentName>", "The name of the environment to create.")
+      .option("--debug")
+      .option("-y, --yes", "Skip confirmation.")
+      .option(
+         "--readmeFile <readmeFile>",
+         "The path to the readme file for the environment.",
+      )
+      .option(
+         "--replication <replicationCount>",
+         "The replication count (must be at least 1).",
+         parseInt,
+      )
+      .action(addEnvironmentAction);
+
    add.command("project")
-      .description("Add a project.")
-      .argument("<projectName>", "The name of the project to create.")
+      .description("[deprecated] Alias for 'add environment'.")
+      .argument("<projectName>", "The name of the environment to create.")
       .option("--debug")
       .option("-y, --yes", "Skip confirmation.")
       .option(
          "--readmeFile <readmeFile>",
-         "The path to the readme file for the project.",
+         "The path to the readme file for the environment.",
       )
       .option(
          "--replication <replicationCount>",
@@ -27,14 +57,8 @@ export const registerAddCommands = (cli: Command, environment: Environment) => {
          parseInt,
       )
       .action((projectName, options) => {
-         createProject(
-            controlPlanesByEnv[environment],
-            projectName,
-            options.readmeFile,
-            options.replication,
-            options.debug,
-            options.yes,
-         );
+         warnProjectDeprecated("add environment");
+         addEnvironmentAction(projectName, options);
       });
 
    add.command("connection")
@@ -102,6 +126,48 @@ export const registerAddCommands = (cli: Command, environment: Environment) => {
          );
       });
 
+   add.command("permission")
+      .description(
+         "Grant a user or group a permission on the organization, an environment, or a package.",
+      )
+      .argument(
+         "<userGroupId>",
+         "Who to grant it to [user:{email}|group:{groupName}|user:*]",
+      )
+      .argument(
+         "<role>",
+         "The role to grant (organization: admin|modeler|member; environment: admin|modeler|viewer; package: viewer)",
+      )
+      .option(
+         "--environment <environmentName>",
+         "Grant on this environment instead of the organization.",
+      )
+      .option(
+         "--package <packageName>",
+         "Grant on this package. Uses --environment, or the current environment.",
+      )
+      .option(
+         "--notifyPeople",
+         "Email the person about the new access. Applies to an environment or a package; an organization grant always notifies a user subject.",
+         false,
+      )
+      .option("--debug")
+      .option("-y, --yes", "Skip confirmation.")
+      .action((userGroupId, role, options) => {
+         createPermission(
+            controlPlanesByEnv[environment],
+            userGroupId,
+            role,
+            options.debug || false,
+            {
+               environment: options.environment,
+               package: options.package,
+               notifyPeople: options.notifyPeople === true,
+               yes: options.yes === true,
+            },
+         );
+      });
+
    add.command("group-access-token")
       .description("Create an access token for a group.")
       .argument("<groupName>", "The name of the group")

package/src/commands/connection/createconnections.spec.ts

@@ -270,6 +270,13 @@ describe("create-connections", () => {
       getConfirmationStub = sandbox.stub();
       readFileSyncStub = sandbox.stub(fs, "readFileSync");
 
+      // Short-circuit loadConfig — createconnections calls getOrganization
+      // before it checks doesConfigExists, so we need to stub it or loadConfig
+      // would run against the stubbed readFileSync.
+      sandbox
+         .stub(ClientConfiguration.prototype, "getOrganization")
+         .returns("");
+      sandbox.stub(ClientConfiguration.prototype, "getProject").returns("");
       sandbox
          .stub(ClientConfiguration.prototype, "doesConfigExists")
          .returns(false);
@@ -309,6 +316,9 @@ describe("create-connections", () => {
       sandbox
          .stub(ClientConfiguration.prototype, "doesConfigExists")
          .returns(true);
+      sandbox
+         .stub(ClientConfiguration.prototype, "getOrganization")
+         .returns("test-org");
       sandbox.stub(ClientConfiguration.prototype, "getProject").returns("");
       sandbox
          .stub(ConnectionsApi.prototype, "createConnection")
@@ -330,7 +340,7 @@ describe("create-connections", () => {
       expect(createConnectionStub.called).to.be.false;
       expect(
          loggerStub.error.calledWith(
-            sinon.match("Please, make sure to set a project"),
+            sinon.match("Please, make sure to set an environment"),
          ),
       ).to.be.true;
    });

package/src/commands/connection/createconnections.ts

@@ -18,15 +18,15 @@ export const createConnections = async (
 ) => {
    const clientConfig = new ClientConfiguration();
    const organizationName = clientConfig.getOrganization();
-   const projectName = clientConfig.getProject();
+   const environmentName = clientConfig.getProject();
 
    if (!clientConfig.doesConfigExists()) {
       logger.error("Please, make sure that you are logged in");
       return;
    }
 
-   if (!projectName) {
-      logger.error("Please, make sure to set a project");
+   if (!environmentName) {
+      logger.error("Please, make sure to set an environment");
       return;
    }
 
@@ -92,7 +92,7 @@ export const createConnections = async (
 
          await connectionsApi.createConnection(
             organizationName,
-            projectName,
+            environmentName,
             connection,
             false,
             {

package/src/commands/connection/deleteconnection.spec.ts

@@ -131,7 +131,7 @@ describe("delete-connection", () => {
       expect(deleteConnectionStub.called).to.be.false;
       expect(
          loggerStub.error.calledWith(
-            sinon.match("Please, make sure to set a project"),
+            sinon.match("Please, make sure to set an environment"),
          ),
       ).to.be.true;
    });

package/src/commands/connection/deleteconnection.ts

@@ -14,15 +14,15 @@ export const deleteConnection = async (
 ) => {
    const clientConfig = new ClientConfiguration();
    const organizationName = clientConfig.getOrganization();
-   const projectName = clientConfig.getProject();
+   const environmentName = clientConfig.getProject();
 
    if (!clientConfig.doesConfigExists()) {
       logger.error("Please, make sure that you are logged in");
       return;
    }
 
-   if (!projectName) {
-      logger.error("Please, make sure to set a project");
+   if (!environmentName) {
+      logger.error("Please, make sure to set an environment");
       return;
    }
 
@@ -41,7 +41,7 @@ export const deleteConnection = async (
    try {
       await connectionsApi.deleteConnection(
          organizationName,
-         projectName,
+         environmentName,
          connectionName,
          {
             baseURL: controlPlane,

package/src/commands/connection/listconnections.spec.ts

@@ -113,7 +113,7 @@ describe("list-connections", () => {
       expect(listConnectionsStub.called).to.be.false;
       expect(
          loggerStub.error.calledWith(
-            sinon.match("Please, make sure to set a project"),
+            sinon.match("Please, make sure to set an environment"),
          ),
       ).to.be.true;
    });

package/src/commands/connection/listconnections.ts

@@ -19,15 +19,15 @@ export const listConnections = async (
 ) => {
    const clientConfig = new ClientConfiguration();
    const organizationName = clientConfig.getOrganization();
-   const projectName = clientConfig.getProject();
+   const environmentName = clientConfig.getProject();
 
    if (!clientConfig.doesConfigExists()) {
       logger.error("Please, make sure that you are logged in");
       return;
    }
 
-   if (!projectName) {
-      logger.error("Please, make sure to set a project");
+   if (!environmentName) {
+      logger.error("Please, make sure to set an environment");
       return;
    }
 
@@ -35,7 +35,7 @@ export const listConnections = async (
       const { limit, offset } = parsePaginationParams(page, pageSize);
       const response = await connectionsApi.listConnections(
          organizationName,
-         projectName,
+         environmentName,
          limit,
          offset,
          {