Improve executor up output

Rhys Sullivan committed 7 months ago

Commit fb045991 parent 4d51a6c2 files · +38 −4Browse files

Unified · Split

2 files

.changeset/tidy-pandas-fix.md +5 −0
apps/executor/src/cli/main.ts +33 −4

@@ -0,0 +1,5 @@
	1	---
	2	"executor": patch
	3	---
	4
	5	Make `executor up` output more helpful and less debug-oriented.

apps/executor/src/cli/main.ts+33−4

     `workspaceId: ${status.installation?.workspaceId ?? "unavailable"}`,
   ].join("\n");
+const appendUrlPath = (baseUrl: string, pathname: string): string =>
+  new URL(pathname, baseUrl.endsWith("/") ? baseUrl : `${baseUrl}/`).toString();
+const renderUpSummary = (input: {
+  started: boolean;
+  status: LocalServerStatus;
+}): string =>
+  [
+    input.started ? "Executor is ready." : "Executor is already running.",
+    `API: ${input.status.baseUrl}`,
+    `MCP: ${appendUrlPath(input.status.baseUrl, "mcp")}`,
+    `OpenAPI: ${appendUrlPath(input.status.baseUrl, "v1/openapi.json")}`,
+    `Workspace: ${input.status.installation?.workspaceId ?? "unavailable"}`,
+    "",
+    "Try next:",
+    `  ${CLI_NAME} call 'return 1 + 1'`,
+    `  ${CLI_NAME} status`,
+    `  ${CLI_NAME} down`,
+  ].join("\n");
 const getDoctorReport = (baseUrl: string) =>
   getServerStatus(baseUrl).pipe(
     Effect.map((status) => {
   Effect.gen(function* () {
     const reachable = yield* isServerReachable(baseUrl);
     if (reachable) {
-      return;
+      return {
+        started: false,
+      } as const;
     }
     const url = new URL(baseUrl);
     yield* startServerInBackground(port);
     yield* waitForReachability(baseUrl, true);
+    return {
+      started: true,
+    } as const;
   });
   },
   ({ baseUrl }) =>
     ensureServer(baseUrl).pipe(
-      Effect.zipRight(getServerStatus(baseUrl)),
+      Effect.flatMap(({ started }) =>
-      Effect.flatMap((status) => printText(renderStatus(status))),
+        getServerStatus(baseUrl).pipe(
+          Effect.flatMap((status) => printText(renderUpSummary({ started, status }))),
+        )
+      ),
     ),
-).pipe(Command.withDescription("Ensure the local executor server is running"));
+).pipe(Command.withDescription("Start the local executor server if needed and show how to use it"));
 const downCommand = Command.make(
   "down",