@superblocksteam/sdk 2.0.21-next.9 → 2.0.21

package/src/cli-replacement/dev.mts

@@ -101,6 +101,11 @@ async function installPackages(cwd: string, logger: Logger) {
   }
 }
 
+export enum DevServerAutoUpgradeMode {
+  SKIP = "skip-upgrade",
+  FORCE = "force-ugprade",
+}
+
 export async function dev(options: {
   /* cwd is required */
   cwd: string;
@@ -120,8 +125,8 @@ export async function dev(options: {
   /* For redirecting output, like when running outside of the CLI */
   logger?: (...messages: (string | Error)[]) => void;
 
-  /* For a child process when restarting the dev server for automatic upgrades */
-  skipAutoUpgrade?: boolean;
+  /* Optionally force auto-upgrade (for testing purposes), or skip it for a child process when restarting the dev server for automatic upgrades */
+  autoUpgradeMode?: DevServerAutoUpgradeMode;
 
   /* To cancel the dev server */
   signal?: AbortSignal;
@@ -140,7 +145,7 @@ export async function dev(options: {
     uploadFirst,
     skipSync,
     applicationConfig,
-    skipAutoUpgrade,
+    autoUpgradeMode,
     tokenManager,
     getCurrentToken,
     updateTokenManagerManually,
@@ -153,6 +158,7 @@ export async function dev(options: {
   let aiService: AiService | undefined;
   const tracer = getTracer();
   const logger = getLogger(options.logger);
+  const skipAutoUpgrade = autoUpgradeMode === DevServerAutoUpgradeMode.SKIP;
 
   // Add check for node_modules
   if (!fs.existsSync(path.join(cwd, "node_modules"))) {
@@ -265,6 +271,7 @@ export async function dev(options: {
           organizationId: currentUser.organizations[0].id,
           fsOperationQueue,
           draftInterface: syncService as DraftInterface,
+          rpcClient,
           tracer,
           logger,
         });
@@ -294,7 +301,7 @@ export async function dev(options: {
 
         const packageJsonBefore = await readPkgJson(cwd);
 
-        if (downloadFirst) {
+        if (downloadFirst && !isSynced) {
           await tracer.startActiveSpan("downloadFirst", async (span) => {
             logger.info(
               `Starting download of branch '${applicationConfig.branchName}'`,
@@ -307,10 +314,10 @@ export async function dev(options: {
 
         let hasCliUpdated = false;
         let upgradePromises: Promise<void>[] = [];
-        if (
-          !skipAutoUpgrade &&
-          (!process.env.PACKAGE_SUFFIX || process.env.PACKAGE_SUFFIX === "")
-        ) {
+        const forceUpgrade =
+          options.autoUpgradeMode === DevServerAutoUpgradeMode.FORCE;
+        // Determine whether we must try to auto-upgrade the CLI
+        if (!skipAutoUpgrade || forceUpgrade) {
           await tracer.startActiveSpan(
             "versionCheckAndUpgrade",
             async (span) => {
@@ -328,6 +335,7 @@ export async function dev(options: {
                 const result = await checkVersionsAndWritePackageJson(
                   lockService,
                   applicationConfigWithTokenConfigAndUserInfo,
+                  forceUpgrade,
                 );
                 hasCliUpdated = result.cliUpdated;
                 upgradePromises = result.upgradePromises;

package/src/client.ts

@@ -51,7 +51,7 @@ const BASE_SERVER_PUBLIC_API_URL_v2 = "api/v2/public";
 const BASE_SERVER_API_URL_V2 = "api/v2";
 const BASE_SERVER_API_URL_V3 = "api/v3";
 
-const SUPERBLOCKS_MAX_FILE_SIZE_MB = 10;
+const SUPERBLOCKS_MAX_FILE_SIZE_MB = 30;
 
 const CLI_VERSION_HEADER = "x-superblocks-cli-version";
 const SUPERBLOCKS_URL_HEADER = "x-superblocks-url";
@@ -326,7 +326,9 @@ export async function fetchApplication({
     return data;
   } catch (e) {
     if (axios.isAxiosError(e) && e.response?.status === 404) {
-      throw new NotFoundError(`Application ${applicationId} was not found`);
+      throw new NotFoundError(
+        `Application ${applicationId} was not found with branch ${branch}, are you sure you are on the correct application and branch?`,
+      );
     }
     throw new Error(
       `Could not fetch application: ${

package/src/dbfs/client.ts

@@ -1,5 +1,6 @@
 import { unreachable } from "@superblocksteam/util";
 import { connectToISocketRPCServer } from "../socket/index.js";
+import { getLogger } from "../telemetry/logging.js";
 import { doDownloadDirectoryToLocal, doUploadLocalDirectory } from "./local.js";
 
 // TODO(code-mode): this is re-implemented in the vite-plugin-file-sync package
@@ -74,7 +75,7 @@ export async function uploadLocalApplication(
       rpcClient,
       localDirectoryPath,
     );
-    console.log(`New application directory hash: ${directoryHash}`);
+    getLogger().info(`New application directory hash: ${directoryHash}`);
     await rpcClient.call.v3.application.liveEditDirectoryContents.set({
       applicationId,
       branchName: branch,
@@ -124,7 +125,7 @@ export async function printDirectoryEntries(
           unreachable(entry);
         }
       }
-      console.log(
+      getLogger().info(
         `${entry.type}${executable ? "x" : " "} ${hash} ${entry.name}${
           target ? ` -> ${target}` : ""
         }`,

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

@@ -158,14 +158,20 @@ export async function createDevServer({
     }
 
     // hold the request until the vite server is initialized
-    vitePromise.then(() => {
-      // If the server is already closed, don't hold the request
-      if (isViteServerInitialized) {
-        next();
-      } else {
-        res.status(500).send("Dev server is not running");
-      }
-    });
+    vitePromise
+      .then(() => {
+        // If the server is already closed, don't hold the request
+        if (isViteServerInitialized) {
+          next();
+        } else {
+          res.status(500).send("Dev server is not running");
+        }
+      })
+      .catch((e) => {
+        // This should never happen, but if it does,
+        logger.error("Error holding request", getErrorMeta(e));
+        res.status(500).send("Error holding request");
+      });
   });
 
   app.get("/_sb_health", async (_req, res) => {
@@ -174,14 +180,16 @@ export async function createDevServer({
   });
 
   // Attach the vite server to the express app
-  app.get("/_sb_connect", async (_req, res) => {
+  app.get("/_sb_connect", async (req, res) => {
+    const reqOrigin = req.headers.origin ?? "";
+
     res.setHeader("Content-Type", "application/json");
     if (isViteServerInitialized) {
-      console.log("Vite server already initialized");
+      logger.info("Vite server already initialized");
       res.send(JSON.stringify(healthResponse));
       return;
     }
-    console.log("Starting vite server");
+    logger.info("Starting vite server");
     isViteServerInitialized = true;
     // TODO(code-mode): should this include any validation checks, such as getting a token?
     startVite({
@@ -195,11 +203,19 @@ export async function createDevServer({
       aiService,
       logger: loggerOverride,
       httpServer,
-    }).then((result) => {
-      viteResolve();
-      viteCreationResults = result;
-      res.send(JSON.stringify(healthResponse));
-    }, viteReject);
+      connectionOrigin: reqOrigin,
+    }).then(
+      (result) => {
+        logger.info("Vite server initialized");
+        viteResolve();
+        viteCreationResults = result;
+        res.send(JSON.stringify(healthResponse));
+      },
+      (e) => {
+        logger.error("Error initializing vite server", getErrorMeta(e));
+        viteReject(e);
+      },
+    );
   });
 
   app.post("/_sb_disconnect", async (req, res) => {
@@ -301,10 +317,12 @@ async function startVite({
   syncService,
   lockService,
   aiService,
+  connectionOrigin,
   logger: loggerOverride,
 }: CreateDevServerOptions & {
   app: express.Express;
   httpServer: http.Server;
+  connectionOrigin: string;
 }): Promise<{
   viteServer: ViteDevServer;
   dispose: () => void;
@@ -340,6 +358,7 @@ async function startVite({
     port: hmrPort,
     clientPort: port,
     server: httpServer,
+    overlay: false,
   };
 
   // https://codesandbox.io/docs/learn/environment/preview-urls#using-environment-variables
@@ -358,6 +377,7 @@ async function startVite({
       httpServer,
       tracer,
       logger,
+      connectionOrigin,
     },
     { isCustomBuildEnabled },
   );

package/src/index.ts

@@ -149,7 +149,7 @@ export {
   type SocketFileInfo,
 } from "./cli-replacement/socket-utils.mjs";
 
-export { dev } from "./cli-replacement/dev.mjs";
+export { dev, DevServerAutoUpgradeMode } from "./cli-replacement/dev.mjs";
 
 export { getLogger } from "./telemetry/logging.js";
 

package/src/telemetry/attributes.ts

@@ -5,3 +5,4 @@ export const ATTR_SUPERBLOCKS_BASE_URL = "superblocks.base_url";
 export const ATTR_SUPERBLOCKS_CLI_TOKEN = "superblocks.cli_token";
 export const ATTR_SUPERBLOCKS_IS_CSB = "superblocks.is_csb";
 export const ATTR_SUPERBLOCKS_USER_ID = "user-id";
+export const ATTR_SUPERBLOCKS_CSB_ID = "csb_id";

package/src/telemetry/index.ts

@@ -1,3 +1,4 @@
+import os from "node:os";
 import { logs as logsAPI } from "@opentelemetry/api-logs";
 import { AsyncLocalStorageContextManager } from "@opentelemetry/context-async-hooks";
 import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
@@ -7,7 +8,6 @@ import { HttpInstrumentation } from "@opentelemetry/instrumentation-http";
 import { Resource } from "@opentelemetry/resources";
 import { NodeSDK, logs, api } from "@opentelemetry/sdk-node";
 import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";
-import { ATTR_DEPLOYMENT_ENVIRONMENT_NAME } from "@opentelemetry/semantic-conventions/incubating";
 import {
   OBS_TAG_APPLICATION_ID,
   OBS_TAG_BRANCH,
@@ -17,8 +17,10 @@ import {
 import ddTrace from "dd-trace";
 import packageJson from "../../package.json" with { type: "json" };
 import {
+  ATTR_DEPLOYMENT_ENVIRONMENT,
   ATTR_SUPERBLOCKS_BASE_URL,
   ATTR_SUPERBLOCKS_CLI_TOKEN,
+  ATTR_SUPERBLOCKS_CSB_ID,
   ATTR_SUPERBLOCKS_IS_CSB,
   ATTR_SUPERBLOCKS_USER_ID,
 } from "./attributes.js";
@@ -61,9 +63,12 @@ export async function configureTelemetry(
     version: packageJson.version,
     plugins: false,
     tags: {
-      "superblocks.base_url": config.superblocksHostname,
-      "superblocks.cli_token": config.token,
-      "superblocks.is_csb": process.env.SUPERBLOCKS_IS_CSB,
+      [ATTR_SUPERBLOCKS_BASE_URL]: config.superblocksHostname,
+      [ATTR_SUPERBLOCKS_CLI_TOKEN]: config.token,
+      [ATTR_SUPERBLOCKS_IS_CSB]: !!process.env.SUPERBLOCKS_IS_CSB,
+      [ATTR_SUPERBLOCKS_CSB_ID]: process.env.SUPERBLOCKS_IS_CSB
+        ? os.hostname()
+        : undefined,
       [OBS_TAG_APPLICATION_ID]: applicationConfig?.id,
       [OBS_TAG_BRANCH]: applicationConfig?.branchName,
     },
@@ -78,10 +83,13 @@ export async function configureTelemetry(
     resource: Resource.default().merge(
       new Resource({
         [ATTR_SERVICE_NAME]: config.serviceName,
-        [ATTR_DEPLOYMENT_ENVIRONMENT_NAME]: process.env.SUPERBLOCKS_CLI_ENV,
+        [ATTR_DEPLOYMENT_ENVIRONMENT]: process.env.SUPERBLOCKS_CLI_ENV,
         [ATTR_SUPERBLOCKS_BASE_URL]: config.superblocksHostname,
         [ATTR_SUPERBLOCKS_CLI_TOKEN]: config.token,
-        [ATTR_SUPERBLOCKS_IS_CSB]: process.env.SUPERBLOCKS_IS_CSB,
+        [ATTR_SUPERBLOCKS_IS_CSB]: !!process.env.SUPERBLOCKS_IS_CSB,
+        [ATTR_SUPERBLOCKS_CSB_ID]: process.env.SUPERBLOCKS_IS_CSB
+          ? os.hostname()
+          : undefined,
         [OBS_TAG_APPLICATION_ID]: applicationConfig?.id,
         [OBS_TAG_BRANCH]: applicationConfig?.branchName,
         [OBS_TAG_USER_EMAIL]: applicationConfig?.userEmail,

package/src/telemetry/logging.ts

@@ -1,9 +1,22 @@
 import { SeverityNumber } from "@opentelemetry/api-logs";
 import { createLogger, format, transports } from "winston";
 import { getLogger as getTracedLogger } from "./index.js";
+import type { AnyValueMap } from "@opentelemetry/api-logs";
 import type winston from "winston";
 
-const activeTransports: winston.transport[] = [
+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: "debug",
+    }),
+  );
+}
+
+activeTransports.push(
   new transports.Console({
     format: format.combine(
       format.colorize(),
@@ -23,7 +36,7 @@ const activeTransports: winston.transport[] = [
       }),
     ),
   }),
-];
+);
 
 const winstonLogger = createLogger({
   level: "debug",
@@ -82,6 +95,7 @@ const logger: Logger = Object.freeze({
       severityNumber: SeverityNumber.ERROR,
       severityText: "ERROR",
       body: message,
+      attributes: meta as unknown as AnyValueMap,
     });
     winstonLogger.error(message, meta);
   },

package/src/version-control.mts

@@ -20,6 +20,7 @@ import * as semver from "semver";
 import { simpleGit } from "simple-git";
 import slugify from "slugify";
 import { parse, stringify as ymlstringify } from "yaml";
+import { getLogger } from "./telemetry/logging.js";
 import type {
   ApplicationWrapper,
   MultiPageApplicationWrapper,
@@ -97,6 +98,7 @@ export type ApiRepresentation = {
 const DEFAULT_FILE_VERSION = "0.1.0";
 const SPLIT_LARGE_API_STEPS_VERSION = "0.2.0";
 const LATEST_FILE_VERSION = SPLIT_LARGE_API_STEPS_VERSION;
+const logger = getLogger();
 
 export function getApiRepresentation(
   featureFlags: FeatureFlags,
@@ -173,7 +175,7 @@ async function downloadFile(
     try {
       await fs.unlink(fullPath);
     } catch {
-      console.log("Failed to delete file", fullPath);
+      logger.warn(`Failed to delete file ${fullPath}`);
     }
 
     return Promise.resolve(fullPath);
@@ -469,7 +471,7 @@ export async function writeResourceToDisk(
       createdFiles
         .filter((createdFiles) => createdFiles.length)
         .forEach((createdFile) => {
-          console.log(`Unable to download ${createdFile}`);
+          logger.warn(`Unable to download ${createdFile}`);
         });
 
       return {
@@ -746,7 +748,7 @@ async function writeV1ApplicationToDisk(
   createdFiles
     .filter((createdFiles) => createdFiles.length)
     .forEach((createdFile) => {
-      console.log(`Unable to download ${createdFile}`);
+      logger.warn(`Unable to download ${createdFile}`);
     });
 
   // do a post-migration cleanup if necessary
@@ -797,9 +799,9 @@ async function writeCodeModeApplicationToDisk(
       branch: DEFAULT_BRANCH,
       localDirectoryPath: appDirName,
     });
-  } catch (e) {
+  } catch (e: any) {
     // This is most likely to happen if the application is not initialized
-    console.log(e);
+    logger.error(e.message);
     throw e;
   }
 }