@superblocksteam/sdk 2.0.6-next.44 → 2.0.6-next.46

package/src/cli-replacement/dev.mts

@@ -1,7 +1,6 @@
 import "../dev-utils/dev-tracer.js";
 
 import * as child_process from "node:child_process";
-import * as fsp from "node:fs/promises";
 import path from "node:path";
 import { promisify } from "node:util";
 import { maskUnixSignals } from "@superblocksteam/util";
@@ -18,7 +17,7 @@ import fs from "fs-extra";
 import { resolveCommand } from "package-manager-detector";
 import { detect } from "package-manager-detector/detect";
 
-import { getLogger } from "../dev-utils/dev-logger.mjs";
+import { getErrorMeta, getLogger } from "../dev-utils/dev-logger.mjs";
 import { createDevServer } from "../dev-utils/dev-server.mjs";
 import tracer from "../dev-utils/dev-tracer.js";
 import { SuperblocksSdk } from "../sdk.js";
@@ -27,6 +26,7 @@ import {
   getCurrentCliVersion,
   getCurrentLibraryVersionWithoutPM,
 } from "./automatic-upgrades.js";
+import { AUTO_UPGRADE_EXIT_CODE } from "./automatic-upgrades.js";
 import type { DevLogger } from "../dev-utils/dev-logger.mjs";
 import type { ApplicationConfig } from "../types/common.js";
 import type { DraftInterface } from "@superblocksteam/vite-plugin-file-sync/draft-interface";
@@ -93,7 +93,6 @@ async function installPackages(cwd: string, logger: DevLogger) {
 export async function dev(options: {
   /* cwd is required */
   cwd: string;
-  pidfilePath?: string;
   devServerPort?: number;
 
   /* user control of sync operations */
@@ -107,7 +106,7 @@ export async function dev(options: {
   /* For debugging purposes to get location of the cli */
   superblocksPath?: string;
   /* For redirecting output, like when running outside of the CLI */
-  logger?: (message: string) => void;
+  logger?: (...messages: (string | Error)[]) => void;
 
   /* For a child process when restarting the dev server for automatic upgrades */
   skipAutoUpgrade?: boolean;
@@ -119,7 +118,6 @@ export async function dev(options: {
 
   const {
     cwd,
-    pidfilePath,
     devServerPort,
     downloadFirst,
     uploadFirst,
@@ -128,12 +126,6 @@ export async function dev(options: {
     skipAutoUpgrade,
   } = options;
 
-  const cliVersion = await getCurrentCliVersion();
-  const libraryVersion = await getCurrentLibraryVersionWithoutPM();
-  logger.info(
-    `Running command: ${options.superblocksPath} dev${options.uploadFirst ? " --upload-first" : ""}${options.downloadFirst ? " --download-first" : ""} with baseUrl: ${applicationConfig?.superblocksBaseUrl}, cliVersion: ${cliVersion}, libraryVersion: ${libraryVersion?.alias} ${libraryVersion?.version}`,
-  );
-
   // Add check for node_modules
   if (!fs.existsSync(path.join(cwd, "node_modules"))) {
     throw new Error(
@@ -141,9 +133,13 @@ export async function dev(options: {
     );
   }
 
-  if (pidfilePath) {
-    await fsp.writeFile(pidfilePath, `${process.pid}\n`);
-  }
+  logger.info("Starting dev server");
+
+  const cliVersion = await getCurrentCliVersion();
+  const libraryVersion = await getCurrentLibraryVersionWithoutPM();
+  logger.info(
+    `Running command: ${options.superblocksPath} dev${options.uploadFirst ? " --upload-first" : ""}${options.downloadFirst ? " --download-first" : ""} with baseUrl: ${applicationConfig?.superblocksBaseUrl}, cliVersion: ${cliVersion}, libraryVersion: ${libraryVersion?.alias} ${libraryVersion?.version}`,
+  );
 
   const port = devServerPort ?? 5173;
 
@@ -188,17 +184,11 @@ export async function dev(options: {
         if (lockService) {
           try {
             await lockService!.acquireLock();
-
-            // TODO(code-mode): package naming is preventing upgrade in ephemeral environments
-            if (
-              !process.env.PACKAGE_SUFFIX ||
-              process.env.PACKAGE_SUFFIX === "" ||
-              !skipAutoUpgrade
-            ) {
-              await checkVersionsAndUpgrade(lockService, applicationConfig);
-            }
           } catch (error) {
-            logger.error("Failed to acquire lock on application", error);
+            logger.error(
+              "Failed to acquire lock on application",
+              getErrorMeta(error),
+            );
             passErrorToVSCode(
               (error as { context?: { message: string } }).context?.message,
               logger,
@@ -232,11 +222,10 @@ export async function dev(options: {
 
         if (isSynced) {
           logger.info("Local files are in sync with the server");
-          return;
+        } else {
+          logger.info("Local files are out of sync with the server");
         }
 
-        logger.info("Local files are out of sync with the server");
-
         if (!(downloadFirst || uploadFirst)) {
           throw new Error(
             "You must choose --download-first or --upload-first to use the dev command",
@@ -246,37 +235,70 @@ export async function dev(options: {
           throw new Error("Choose either --download-first or --upload-first");
         }
 
+        let hasPackageChanged = false;
+
         if (downloadFirst) {
-          logger.info(
-            "Starting directory sync from server before starting the local server",
-          );
+          logger.info("Starting download");
 
-          // Read package.json before download
           const packageJsonBefore = await readPkgJson(cwd);
-
           await syncService!.downloadDirectory();
-
-          // Read package.json after download and compare
           const packageJsonAfter = await readPkgJson(cwd);
 
-          // Check if package.json changed
           if (packageJsonBefore && packageJsonAfter) {
             const diff = diffJson(packageJsonBefore, packageJsonAfter);
-            const hasChanges = diff.some((part) => part.added || part.removed);
+            hasPackageChanged = diff.some((part) => part.added || part.removed);
+          } else if (packageJsonAfter) {
+            hasPackageChanged = true;
+            logger.info("package.json was created, installing packages…");
+          }
+        }
 
-            if (hasChanges) {
-              logger.info("package.json has changed, installing packages…");
-              await installPackages(cwd, logger);
+        let hasCliUpdated = false;
+        if (
+          !process.env.PACKAGE_SUFFIX ||
+          process.env.PACKAGE_SUFFIX === "" ||
+          !skipAutoUpgrade
+        ) {
+          if (lockService) {
+            const result = await checkVersionsAndUpgrade(
+              lockService,
+              applicationConfig,
+            );
+            if (result?.libraryUpdated) {
+              hasPackageChanged = true;
             }
+            hasCliUpdated = result?.cliUpdated ?? false;
+          } else {
+            logger.warn(
+              "Lock service is not available, skipping version check and upgrade",
+            );
           }
-        } else if (uploadFirst) {
+        }
+
+        if (hasPackageChanged) {
+          logger.info("Installing packages…");
+          await installPackages(cwd, logger);
+        }
+
+        if (hasPackageChanged || uploadFirst) {
           logger.info("Uploading local files to server before starting");
           await syncService!.uploadDirectory();
+          await syncService!.uploadDirectoryNowIfNeeded();
+        }
+
+        if (hasCliUpdated) {
+          logger.info("CLI was updated, restarting the dev server…");
+          process.exit(AUTO_UPGRADE_EXIT_CODE);
         }
       });
     } catch (error: any) {
       logger.error(error.message);
-      process.exit(1);
+      try {
+        await lockService?.shutdownAndExit();
+      } finally {
+        // this is redundant, but it's here to make sure the lock service is shutdown and the process exits
+        process.exit(1);
+      }
     }
   } else {
     logger.info("Skipping directory sync");
@@ -296,6 +318,10 @@ export async function dev(options: {
   options.signal?.addEventListener("abort", () => {
     logger.info("Server closed");
     httpServer.close();
+    lockService?.shutdownAndExit().catch(() => {
+      // this is redundant, but it's here to make sure the lock service is shutdown and the process exits
+      process.exit(1);
+    });
   });
 
   logger.debug(green(`Local server started at port ${port}`));

package/src/dev-utils/dev-logger.mts

@@ -1,39 +1,113 @@
 import { createLogger, format, transports } from "winston";
+import type winston from "winston";
 
-export type DevLogger = {
-  debug: (message: string, ...meta: any[]) => void;
-  info: (message: string, ...meta: any[]) => void;
-  warn: (message: string, ...meta: any[]) => void;
-  error: (message: string, ...meta: any[]) => void;
-};
+const activeTransports: winston.transport[] = [];
+
+if (process.env.SUPERBLOCKS_IS_CSB === "true") {
+  activeTransports.push(
+    new transports.File({
+      format: format.json(),
+      filename: `/tmp/dev-server.log`,
+      level: "info",
+    }),
+  );
+}
+
+activeTransports.push(
+  new transports.Console({
+    format: format.combine(
+      format.colorize(),
+      format.timestamp({
+        format: "HH:mm:ss.SSS",
+      }),
+      format.printf((props) => {
+        const { message, timestamp, error, level } = props;
+        const base =
+          process.env.SUPERBLOCKS_IS_CSB === "true"
+            ? `${timestamp} ${message}`
+            : `${message}`;
+        if (level === "error") {
+          return `${base} ${(error as ErrorMeta["error"]).message} ${(error as ErrorMeta["error"]).stack}`;
+        }
+        return base;
+      }),
+    ),
+  }),
+);
 
 const winstonLogger = createLogger({
-  level: "info",
+  level: "debug",
   exitOnError: false,
   format: format.json(),
-  transports: [
-    new transports.File({ filename: `/tmp/dev-server.log`, level: "info" }),
-    new transports.Console({
-      format: format.combine(
-        format.printf(({ message }) => `${message}`),
-        format.colorize({ message: true }),
-      ),
-      level: "debug",
-    }),
-  ],
+  transports: activeTransports,
+});
+
+interface ErrorMeta {
+  error: {
+    kind: string;
+    message: string;
+    stack?: string;
+  };
+}
+
+export interface DevLogger {
+  log: (...messages: string[]) => void;
+  debug: (...messages: string[]) => void;
+  info: (...messages: string[]) => void;
+  warn: (...messages: string[]) => void;
+  error: (message: string, meta?: ErrorMeta) => void;
+}
+const logger: DevLogger = Object.freeze({
+  debug: (...messages: string[]) =>
+    winstonLogger.debug(
+      messages.length > 0 ? messages.join(" ") : (messages[0] as string),
+    ),
+  log: (...messages: string[]) =>
+    winstonLogger.info(
+      messages.length > 0 ? messages.join(" ") : (messages[0] as string),
+    ),
+  info: (...messages: string[]) =>
+    winstonLogger.info(
+      messages.length > 0 ? messages.join(" ") : (messages[0] as string),
+    ),
+  warn: (...messages: string[]) =>
+    winstonLogger.warn(
+      messages.length > 0 ? messages.join(" ") : (messages[0] as string),
+    ),
+  error: (message: string, meta?: ErrorMeta) =>
+    winstonLogger.error(message, meta),
 });
 
 export function getLogger(
-  loggerOverride?: (message: string) => void,
+  loggerOverride?: (...messages: string[]) => void,
 ): DevLogger {
   if (!loggerOverride) {
-    return winstonLogger;
+    return logger;
   }
 
   return {
     debug: loggerOverride,
     info: loggerOverride,
     warn: loggerOverride,
-    error: loggerOverride,
+    log: loggerOverride,
+    error: loggerOverride as any,
+  };
+}
+
+export function getErrorMeta(error: unknown): ErrorMeta {
+  if (error instanceof Error) {
+    return {
+      error: {
+        kind: error.name,
+        message: error.message,
+        stack: error.stack,
+      },
+    };
+  }
+  return {
+    error: {
+      kind: "Unknown Error",
+      message: JSON.stringify(error),
+    },
   };
 }

package/src/dev-utils/dev-server.mts

@@ -18,7 +18,7 @@ import {
   customComponentsPlugin,
   isCustomComponentsEnabled,
 } from "./custom-build.mjs";
-import { getLogger } from "./dev-logger.mjs";
+import { getErrorMeta, getLogger } from "./dev-logger.mjs";
 import { buildManifestStubPlugin } from "./vite-plugin-build-manifest-stub.mjs";
 import { ddRumPlugin } from "./vite-plugin-dd-rum.mjs";
 import { superblocksCdnPlugin } from "./vite-plugin-sb-cdn.mjs";
@@ -188,13 +188,6 @@ export async function createDevServer({
     }, viteReject);
   });
 
-  // TODO(code-mode): remove this soon
-  app.get("/_sb_disconnect", async (_req, res) => {
-    console.log("GET /_sb_disconnect");
-    // TODO(code-mode): should this include any validation checks, such as getting a token?
-    await gracefulShutdown({ logger, serverInitiated: false });
-    res.send("ok");
-  });
   app.post("/_sb_disconnect", async (req, res) => {
     const { initiatedByEmail, switchingTo } = req.body;
     // TODO(code-mode): should this include any validation checks, such as getting a token?
@@ -207,7 +200,7 @@ export async function createDevServer({
       });
       res.send("ok");
     } catch (e) {
-      console.error("Error disconnecting from dev server", e);
+      logger.error("Error disconnecting from dev server", getErrorMeta(e));
       res.status(500).send("Error disconnecting from dev server");
     }
   });
@@ -261,7 +254,7 @@ async function startVite({
 }) {
   const viteLogger = createLogger();
   const logger = getLogger(loggerOverride);
-  viteLogger.info = logger.info;
+  viteLogger.info = (msg: string) => logger.info(msg);
   viteLogger.warn = (msg: string) => {
     logger.warn(yellow(msg));
   };
@@ -345,7 +338,6 @@ async function startVite({
           aiService,
           httpServer,
           tracer,
-          logger,
         },
         { isCustomBuildEnabled },
       ) as Plugin,

package/src/vite-plugin-generate-build-manifest.mts

@@ -53,7 +53,7 @@ type ApiDependency = {
 export function generateBuildManifestPlugin(root: string) {
   const viteLogger = createLogger();
   const logger = getLogger();
-  viteLogger.info = logger.info;
+  viteLogger.info = (msg: string) => logger.info(msg);
   viteLogger.warn = (msg: string) => {
     logger.warn(yellow(msg));
   };

package/src/vite-plugin-inject-sb-ids-transform.mts

@@ -29,7 +29,7 @@ const routesFileBaseName = "routes.json";
 export async function injectSuperblocksIdsPlugin(root: string) {
   const viteLogger = createLogger();
   const logger = getLogger();
-  viteLogger.info = logger.info;
+  viteLogger.info = (msg: string) => logger.info(msg);
   viteLogger.warn = (msg: string) => {
     logger.warn(yellow(msg));
   };