Make names consistent

Author: thedrlambda

CHANGELOG.md

@@ -8,6 +8,19 @@
 -
 -->
 
+# 5.0.0
+## Breaking changes
+- Made service `group` actions consistent with others (eg. `mm delete` => `mm group XXX delete`, `mm group` => `mm group new`)
+- Made folder names more intuitive (eg. `event-catalogue` => `event-configuration`, `public` => `front-end`, `service-group-1` => `back-end`)
+- `mm org new` no longer asks for names for the service group and repo, since they can simply be renamed later
+## Fixes and improvements
+- More responsive. Generalized code for skipping server response if argument is given (ie. `mm rapids post`)
+- `dryrun` should work more reliably
+- Added short-hand for `version` (`-v`)
+- Made `start`, `init` (as npm), and `--init` (as tsc) into aliases for `register`
+- Prepared some of the features we are working on
+- On immediate post to a new service, don't ask for event type
+
 # 4.10.2
 ## Fixes and improvements
 - `keys` table fixed

Execute.ts

@@ -17,6 +17,7 @@ import { GRAY, INVISIBLE, NORMAL_COLOR, RED, WHITE, YELLOW } from "./prompt.js";
 import { PathTo, PathToOrganization, PathToRepository } from "./types.js";
 import { all, generateString } from "./utils.js";
 import { readdir, readFile } from "fs/promises";
+import { DEFAULT_EVENT_CATALOGUE_NAME } from "./config.js";
 
 interface Envelope {
   messageId: string;
@@ -550,9 +551,15 @@ ${NORMAL_COLOR}`);
       sessionId = "s" + Math.random();
       resp.cookie("sessionId", sessionId);
     }
+    const api_json_path = this.pathToRoot
+      .with(DEFAULT_EVENT_CATALOGUE_NAME)
+      .with("api.json")
+      .toString();
     const api_json: ApiJson = JSON.parse(
       await readFile(
-        this.pathToRoot.with("event-catalogue").with("api.json").toString(),
+        existsSync(api_json_path)
+          ? api_json_path
+          : this.pathToRoot.with("event-catalogue").with("api.json").toString(),
         "utf-8"
       )
     );

config.ts

@@ -8,9 +8,16 @@ export const SSH_HOST = `${API_URL}`;
 export const SSH_USER = `mist`;
 export const GIT_HOST = `ssh://${SSH_USER}@${API_URL}`;
 
-export const SPECIAL_FOLDERS = ["event-catalogue", "public"];
-
 export const DEFAULT_SERVICE_GROUP_NAME = "back-end";
 export const DEFAULT_REPOSITORY_NAME = "service-1";
 export const DEFAULT_PUBLIC_NAME = "front-end";
 export const DEFAULT_EVENT_CATALOGUE_NAME = "event-configuration";
+
+export const SPECIAL_FOLDERS = [
+  DEFAULT_EVENT_CATALOGUE_NAME,
+  DEFAULT_PUBLIC_NAME,
+];
+
+export const SERVICE_GROUP = "service group";
+export const REPOSITORY = "code repository";
+export const CLONE = "checkout";

contexts.ts

@@ -1,8 +1,9 @@
-import fs, { existsSync } from "fs";
+import { existsSync } from "fs";
+import { lstat, readdir } from "fs/promises";
 import path from "path";
+import { REPOSITORY, SERVICE_GROUP, SPECIAL_FOLDERS } from "./config.js";
 import { GREEN, NORMAL_COLOR } from "./prompt.js";
 import { Path, directoryNames, fetchOrgRaw } from "./utils.js";
-import { lstat, readdir } from "fs/promises";
 
 async function downOrg(cmd: string) {
   try {
@@ -45,7 +46,7 @@ async function upOrg(cmd: string) {
 
 const SERVICE_CONTEXT = async (cmd: string) => {
   try {
-    let hint = `You can only run '${cmd}' from inside a service folder.`;
+    let hint = `You can only run '${cmd}' from inside a ${REPOSITORY}.`;
     const bfs = ["."];
     while (bfs.length !== 0) {
       const cur = bfs.shift()!;
@@ -68,18 +69,18 @@ const SERVICE_CONTEXT = async (cmd: string) => {
   }
 };
 const NOT_SERVICE_CONTEXT = (cmd: string) => {
-  let hint = `You cannot run '${cmd}' from inside a service folder.`;
+  let hint = `You cannot run '${cmd}' from inside a ${REPOSITORY}.`;
   hint += `\nUse '${GREEN}cd ..${NORMAL_COLOR}' or one of these:`;
   return Promise.resolve(hint);
 };
 const SERVICE_GROUP_CONTEXT = async (cmd: string) => {
   try {
     const struct = await fetchOrgRaw();
-    const serviceGroups = await directoryNames(new Path(struct.pathToRoot!), [
-      "event-catalogue",
-      "public",
-    ]);
-    let hint = `You can only run '${cmd}' from inside a service group.`;
+    const serviceGroups = await directoryNames(
+      new Path(struct.pathToRoot!),
+      SPECIAL_FOLDERS
+    );
+    let hint = `You can only run '${cmd}' from inside a ${SERVICE_GROUP}.`;
     hint += `\nUse '${GREEN}cd ${path
       .join(struct.pathToRoot!, serviceGroups[0].name)
       .replace(/\\/g, "\\\\")}${NORMAL_COLOR}' or one of these:`;

newCommands/envvar.ts

@@ -208,8 +208,6 @@ async function envvar_key_random(
   try {
     const value = +(await shortText("Length", "How many bytes", "32").then());
     const bytes = randomBytes(value);
-    console.log(bytes.toString("base64"));
-    console.log(bytes.toString("hex"));
     return envvar_key_visible_value(
       pathToOrganization,
       organizationId,

newCommands/event.ts

@@ -6,6 +6,7 @@ import { key_create } from "./apikey.js";
 import { outputGit } from "../printUtils.js";
 import { Str } from "@merrymake/utils";
 import { isDryrun } from "../dryrun.js";
+import { DEFAULT_EVENT_CATALOGUE_NAME } from "../config.js";
 
 export async function do_event(
   apikeyId: string,
@@ -46,7 +47,7 @@ async function event_key(apikeyId: string) {
       "Which events would you like to allow and disallow?",
       events,
       (s) => event_key_events(apikeyId, s),
-      "No events in event-catalogue. Make sure you have added events to the event-catalogue and deployed it."
+      `No events in ${DEFAULT_EVENT_CATALOGUE_NAME}. Make sure you have added events to the ${DEFAULT_EVENT_CATALOGUE_NAME} and deployed it.`
     );
   } catch (e) {
     throw e;

newCommands/fetch.ts

@@ -1,7 +1,7 @@
 import { Promise_all, Str } from "@merrymake/utils";
 import { existsSync } from "fs";
 import { chmod, mkdir, readFile, rename, writeFile } from "fs/promises";
-import { GIT_HOST } from "../config.js";
+import { GIT_HOST, SPECIAL_FOLDERS } from "../config.js";
 import { addToExecuteQueue, finish } from "../exitMessages.js";
 import { outputGit } from "../printUtils.js";
 import {
@@ -33,10 +33,7 @@ export type ToBeStructure = {
 };
 
 async function getCurrentStructure(pathToOrganization: PathToOrganization) {
-  const folders = await directoryNames(pathToOrganization, [
-    "event-catalogue",
-    "public",
-  ]);
+  const folders = await directoryNames(pathToOrganization, SPECIAL_FOLDERS);
   const groups: AsIsStructure = {};
   await Promise_all(
     ...folders.map(async (f) => {

newCommands/group.ts

@@ -14,19 +14,21 @@ import {
 import { sshReq } from "../utils.js";
 import { repo_create } from "./repo.js";
 import { isDryrun } from "../dryrun.js";
+import { outputGit } from "../printUtils.js";
+import { SERVICE_GROUP } from "../config.js";
 
 export async function do_deleteServiceGroup(
   serviceGroup: ServiceGroup,
   displayName: string
 ) {
   if (isDryrun()) {
-    output("DRYRUN: Would delete service group");
+    output(`DRYRUN: Would delete ${SERVICE_GROUP}`);
     return;
   }
   try {
-    console.log(`Deleting service group '${displayName}'...`);
+    outputGit(`Deleting ${SERVICE_GROUP} '${displayName}'...`);
     const reply = await sshReq(`group-delete`, serviceGroup.id.toString());
-    console.log(reply);
+    outputGit(reply);
     if (existsSync(serviceGroup.pathTo.toString()))
       await rename(
         serviceGroup.pathTo.toString(),
@@ -54,7 +56,7 @@ export async function deleteServiceGroup(organization: Organization) {
         const folderName = Str.toFolderName(group.name);
         return {
           long: folderName,
-          text: `Delete ${group.name} (${folderName})`,
+          text: `Delete ${SERVICE_GROUP} ${group.name} permanently`,
           action: () =>
             deleteServiceGroupId(
               {
@@ -67,7 +69,7 @@ export async function deleteServiceGroup(organization: Organization) {
       });
       return {
         options,
-        header: "Which service group would you like to delete?",
+        header: `Which ${SERVICE_GROUP} would you like to delete?`,
       };
     }).then();
   } catch (e) {
@@ -81,11 +83,11 @@ export async function do_createServiceGroup(
   displayName: string
 ) {
   if (isDryrun()) {
-    output("DRYRUN: Would create service group");
+    output(`DRYRUN: Would create ${SERVICE_GROUP}`);
     return new ServiceGroupId("dryrun_id");
   }
   try {
-    console.log(`Creating service group '${displayName}'...`);
+    outputGit(`Creating ${SERVICE_GROUP} '${displayName}'...`);
     const reply = await sshReq(
       `group-create`,
       displayName,
@@ -114,7 +116,7 @@ export async function group_new(organization: Organization) {
     )
       num++;
     const displayName = await shortText(
-      "Service group name",
+      `${SERVICE_GROUP[0].toUpperCase() + SERVICE_GROUP.substring(1)} name`,
       "Used to share envvars.",
       "service-group-" + num
     ).then();
@@ -140,11 +142,11 @@ export async function do_renameServiceGroup(
   newDisplayName: string
 ) {
   if (isDryrun()) {
-    output("DRYRUN: Would rename service group");
+    output(`DRYRUN: Would rename ${SERVICE_GROUP}`);
     return;
   }
   try {
-    console.log(`Renaming service group to '${newDisplayName}'...`);
+    outputGit(`Renaming ${SERVICE_GROUP} to '${newDisplayName}'...`);
     const reply = await sshReq(
       `group-modify`,
       `--displayName`,
@@ -168,7 +170,7 @@ async function group_edit_rename(
 ) {
   try {
     const newDisplayName = await shortText(
-      "Service group name",
+      `${SERVICE_GROUP[0].toUpperCase() + SERVICE_GROUP.substring(1)} name`,
       "Used to share envvars.",
       oldDisplayName
     ).then();
@@ -195,7 +197,7 @@ async function group_edit(serviceGroup: ServiceGroup, displayName: string) {
       [
         {
           long: "rename",
-          text: `rename it`,
+          text: `rename ${SERVICE_GROUP}`,
           action: () =>
             group_edit_rename(
               serviceGroup.pathTo,
@@ -205,14 +207,14 @@ async function group_edit(serviceGroup: ServiceGroup, displayName: string) {
         },
         {
           long: "delete",
-          text: `delete it permanently`,
+          text: `delete ${SERVICE_GROUP} '${displayName}' permanently`,
           action: () => deleteServiceGroupId(serviceGroup, displayName),
         },
       ],
       async () => {
         return {
           options: [],
-          header: `How would you like to edit '${displayName}'?`,
+          header: `How would you like to edit the ${SERVICE_GROUP}?`,
         };
       }
     ).then((x) => x);
@@ -227,7 +229,7 @@ export async function group(organization: Organization) {
         {
           long: "new",
           short: "n",
-          text: `create new service group`,
+          text: `create a new ${SERVICE_GROUP}`,
           action: () => group_new(organization),
         },
       ],
@@ -255,7 +257,7 @@ export async function group(organization: Organization) {
         });
         return {
           options,
-          header: "Which service group would you like to manage?",
+          header: `Which ${SERVICE_GROUP} would you like to manage?`,
         };
       }
     ).then();

newCommands/help.ts

@@ -11,6 +11,7 @@ import {
 import { sshReq, urlReq } from "../utils.js";
 import { Str } from "@merrymake/utils";
 import { getCommand } from "../mmCommand.js";
+import { REPOSITORY, SERVICE_GROUP } from "../config.js";
 
 async function do_help(ctx: {
   repositoryId: RepositoryId | undefined;
@@ -46,17 +47,17 @@ async function do_help(ctx: {
     );
   }
   if (ctx.serviceGroup === undefined) {
-    outputGit(`Warning: Not inside service group.`);
+    outputGit(`Warning: Not inside ${SERVICE_GROUP}.`);
   } else {
     outputGit(
-      `${GRAY}Inside service group (${ctx.serviceGroup.id}).${NORMAL_COLOR}`
+      `${GRAY}Inside ${SERVICE_GROUP} (${ctx.serviceGroup.id}).${NORMAL_COLOR}`
     );
   }
   if (!existsSync("merrymake.json")) {
-    outputGit(`Warning: Not inside service repo.`);
+    outputGit(`Warning: Not inside ${REPOSITORY}.`);
   } else {
     outputGit(
-      `${GRAY}Inside service repo (${ctx.repositoryId}).${NORMAL_COLOR}`
+      `${GRAY}Inside ${REPOSITORY} (${ctx.repositoryId}).${NORMAL_COLOR}`
     );
   }
 }

newCommands/index.ts

@@ -31,6 +31,8 @@ import { role } from "./role.js";
 import { rollback } from "./rollback.js";
 import { update } from "./update.js";
 import { upgrade } from "./upgrade.js";
+import { REPOSITORY, SERVICE_GROUP } from "../config.js";
+import { Str } from "@merrymake/utils";
 
 function partitionLast(str: string, radix: string) {
   const index = str.lastIndexOf(radix);
@@ -135,7 +137,7 @@ export async function index() {
           options.push({
             long: "deploy",
             short: "d",
-            text: "deploy this repository with git",
+            text: `deploy this ${REPOSITORY} with git`,
             weight: 900,
             action: () => deploy(monorepo),
           });
@@ -144,7 +146,7 @@ export async function index() {
           options.push({
             long: "rollback",
             short: "r",
-            text: "rollback individual hooks or the entire service to a stable version",
+            text: `rollback individual hooks or the entire ${REPOSITORY} to a stable version`,
             weight: 800,
             action: () => rollback(repositoryId),
           });
@@ -153,7 +155,7 @@ export async function index() {
           options.push({
             long: "build",
             short: "b",
-            text: "build this service locally",
+            text: `build this ${REPOSITORY} locally`,
             weight: 800,
             action: () => build(),
           });
@@ -177,15 +179,15 @@ export async function index() {
             {
               long: "envvar",
               short: "e",
-              text: "add or edit an envvar in this service group",
+              text: `add or edit an envvar in this ${SERVICE_GROUP}`,
               weight: 800,
               action: () =>
                 envvar(organization!.pathTo, organization!.id, serviceGroup.id),
             },
             {
               long: "repo",
               short: "r",
-              text: "add or edit a repository",
+              text: `add or edit a ${REPOSITORY}`,
               weight: 700,
               action: () => repo(organization!, serviceGroup),
             }
@@ -198,7 +200,10 @@ export async function index() {
             options.push({
               long: "fetch",
               short: "f",
-              text: "fetch updates to service groups and repos",
+              text: `fetch updates to ${Str.plural(
+                2,
+                SERVICE_GROUP
+              )}s and ${Str.plural(2, REPOSITORY)}`,
               weight: 600,
               action: () => fetch(organization),
             });
@@ -219,7 +224,7 @@ export async function index() {
               {
                 long: "group",
                 short: "g",
-                text: "add or edit a service group",
+                text: `add or edit a ${SERVICE_GROUP}`,
                 weight: 500,
                 action: () => group(organization),
               },