@superblocksteam/sdk 2.0.99 → 2.0.100-next.0

package/src/telemetry/logging.ts

@@ -8,6 +8,7 @@ import type winston from "winston";
 const activeTransports: winston.transport[] = [];
 
 if (process.env.SUPERBLOCKS_IS_CSB === "true") {
+  // TODO(alex): Revisit this for cloud-prem if we want logger to write to stdout
   activeTransports.push(
     new transports.File({
       format: format.json(),

package/src/version-control.mts

@@ -1,7 +1,7 @@
 import * as https from "https";
 import path from "node:path";
 import { dirname } from "path";
-import { ExportViewMode } from "@superblocksteam/shared";
+import { DEFAULT_BRANCH, ExportViewMode } from "@superblocksteam/shared";
 import {
   RESOURCE_CONFIG_PATH,
   SUPERBLOCKS_HOME_FOLDER_NAME,
@@ -46,13 +46,13 @@ import type {
 } from "@superblocksteam/util";
 import type { SimpleGit, StatusResult } from "simple-git";
 
+export { DEFAULT_BRANCH };
+
 const LATEST_EDITS_MODE = "latest-edits";
 export const DRAFT_MODE = "draft";
 const MOST_RECENT_COMMIT_MODE = "most-recent-commit";
 const DEPLOYED_MODE = "deployed";
 
-export const DEFAULT_BRANCH = "main";
-
 export const modeFlagValuesMap: Record<string, string> = {
   [LATEST_EDITS_MODE]: "Latest edits",
   [DRAFT_MODE]: "Draft",
@@ -556,6 +556,8 @@ export async function writeApplicationToDisk({
   resource,
   projectRootFolder,
   appRelativePath,
+  directoryContentsHash,
+  branch,
   featureFlags,
   migrateFromSinglePage,
   preferredApiRepresentation,
@@ -566,6 +568,8 @@ export async function writeApplicationToDisk({
     | CodeModeApplicationWrapper;
   projectRootFolder: string;
   appRelativePath?: string;
+  directoryContentsHash?: string;
+  branch?: string;
   featureFlags: FeatureFlags;
   migrateFromSinglePage?: boolean;
   preferredApiRepresentation?: ApiRepresentation;
@@ -585,6 +589,8 @@ export async function writeApplicationToDisk({
       sdk,
       resource,
       appDirName,
+      directoryContentsHash,
+      branch,
       featureFlags,
     );
     return {
@@ -774,6 +780,8 @@ async function writeCodeModeApplicationToDisk(
   sdk: SuperblocksSdk,
   resource: CodeModeApplicationWrapper,
   appDirName: string,
+  directoryContentsHash: string | undefined,
+  branch: string | undefined,
   featureFlags: FeatureFlags,
 ): Promise<void> {
   // Find the existing application config and existing file paths
@@ -798,11 +806,18 @@ async function writeCodeModeApplicationToDisk(
 
   // This writes to DBFS
   try {
-    await sdk.dbfsGetApplication({
-      applicationId: resource.application.id,
-      branch: DEFAULT_BRANCH,
-      localDirectoryPath: appDirName,
-    });
+    if (directoryContentsHash) {
+      await sdk.dbfsGetDirectoryByHash({
+        hash: directoryContentsHash,
+        localDirectoryPath: appDirName,
+      });
+    } else {
+      await sdk.dbfsGetApplication({
+        applicationId: resource.application.id,
+        branch: branch ?? DEFAULT_BRANCH,
+        localDirectoryPath: appDirName,
+      });
+    }
   } catch (e: any) {
     // This is most likely to happen if the application is not initialized
     logger.error(e.message);

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

@@ -61,7 +61,13 @@ export function generateApiBuildManifestPlugin(root: string) {
   let buildManifest: {
     apis: Record<string, { api: DeleteMeLibraryApi; scopeId: string }>;
     apiDependencies: ApiDependency[];
-    sdkApis: Record<string, { entryPoint: string }>;
+    sdkApis: Record<
+      string,
+      {
+        entryPoint: string;
+        integrations?: Array<{ key: string; pluginId: string; id: string }>;
+      }
+    >;
   } = { apis: {}, apiDependencies: [], sdkApis: {} };
 
   return {

package/test/version-control.test.mts

@@ -2,7 +2,7 @@ import os from "node:os";
 import path from "node:path";
 import { readAppApiYamlFile, LoopType } from "@superblocksteam/util";
 import fs from "fs-extra";
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import { stringify as ymlstringify } from "yaml";
 import { FeatureFlags } from "../src/flag.js";
 import {
@@ -14,8 +14,10 @@ import {
 } from "../src/version-control.mjs";
 import type {
   ApplicationWrapper,
+  CodeModeApplicationWrapper,
   MultiPageApplicationWrapperWithComponents,
 } from "../src/client.js";
+import type { SuperblocksSdk } from "../src/sdk.js";
 import type { ApiWithPb } from "../src/types/common.js";
 import type { ApiRepresentation } from "../src/version-control.mjs";
 import type {
@@ -930,6 +932,84 @@ describe("version-control", () => {
       "superblocks.git.split.large.step.lines": 10,
     });
 
+    it("should use the requested branch for code mode applications", async () => {
+      const dbfsGetApplication = vi.fn().mockResolvedValue(undefined);
+      const dbfsGetDirectoryByHash = vi.fn().mockResolvedValue(undefined);
+      const codeModeApp: CodeModeApplicationWrapper = {
+        type: "code-mode",
+        application: {
+          id: "d7278b3b-f355-4374-baae-cdcca40fb502",
+          name: "Code Mode App",
+        },
+      };
+
+      const resourceConfig = await writeApplicationToDisk({
+        sdk: {
+          dbfsGetDirectoryByHash,
+          dbfsGetApplication,
+        } as unknown as SuperblocksSdk,
+        resource: codeModeApp,
+        projectRootFolder: testDir,
+        branch: "feature/mcp-checkout",
+        featureFlags: mockFeatureFlags,
+      });
+
+      expect(resourceConfig.location).toBe("apps/code_mode_app");
+      expect(dbfsGetApplication).toHaveBeenCalledWith({
+        applicationId: "d7278b3b-f355-4374-baae-cdcca40fb502",
+        branch: "feature/mcp-checkout",
+        localDirectoryPath: path.join(testDir, "apps/code_mode_app"),
+      });
+      expect(dbfsGetDirectoryByHash).not.toHaveBeenCalled();
+
+      const config = await expectSuperblocksJsonFileExists(
+        `${testDir}/apps/code_mode_app/`,
+      );
+      expect(config).toMatchObject({
+        configType: "APPLICATION_V2",
+        id: "d7278b3b-f355-4374-baae-cdcca40fb502",
+      });
+    });
+
+    it("should use a historical directory hash for code mode applications when provided", async () => {
+      const dbfsGetApplication = vi.fn().mockResolvedValue(undefined);
+      const dbfsGetDirectoryByHash = vi.fn().mockResolvedValue(undefined);
+      const codeModeApp: CodeModeApplicationWrapper = {
+        type: "code-mode",
+        application: {
+          id: "d7278b3b-f355-4374-baae-cdcca40fb502",
+          name: "Code Mode App",
+        },
+      };
+
+      const resourceConfig = await writeApplicationToDisk({
+        sdk: {
+          dbfsGetDirectoryByHash,
+          dbfsGetApplication,
+        } as unknown as SuperblocksSdk,
+        resource: codeModeApp,
+        projectRootFolder: testDir,
+        directoryContentsHash: "dir-hash-123",
+        branch: "feature/mcp-checkout",
+        featureFlags: mockFeatureFlags,
+      });
+
+      expect(resourceConfig.location).toBe("apps/code_mode_app");
+      expect(dbfsGetDirectoryByHash).toHaveBeenCalledWith({
+        hash: "dir-hash-123",
+        localDirectoryPath: path.join(testDir, "apps/code_mode_app"),
+      });
+      expect(dbfsGetApplication).not.toHaveBeenCalled();
+
+      const config = await expectSuperblocksJsonFileExists(
+        `${testDir}/apps/code_mode_app/`,
+      );
+      expect(config).toMatchObject({
+        configType: "APPLICATION_V2",
+        id: "d7278b3b-f355-4374-baae-cdcca40fb502",
+      });
+    });
+
     it("should write multi-pageapp to disk", async () => {
       // Setup
       const resourceId = "9736f700-88d6-49fc-a519-245a20af248b";