@superblocksteam/sdk 1.5.0 → 1.5.2

package/dist/socket/signing.js

@@ -4,9 +4,9 @@ exports.verifyResources = exports.signResource = void 0;
 const tslib_1 = require("tslib");
 const axios_1 = tslib_1.__importDefault(require("axios"));
 const utils_1 = require("../utils");
-async function signResource({ token, branchName, resource, agentUrls, }) {
+async function signResource({ token, branchName, resource, agentUrl, }) {
     const requestResource = {
-        branchName: branchName !== null && branchName !== void 0 ? branchName : "main",
+        branchName: branchName ?? "main",
     };
     if (resource.api) {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
@@ -15,67 +15,56 @@ async function signResource({ token, branchName, resource, agentUrls, }) {
     else {
         requestResource.literal = resource.literal;
     }
-    try {
-        const resp = await callAgentFallBack({
-            baseUrls: agentUrls,
-            path: "v1/signature/sign",
-            method: "post",
-            token: token,
-            data: { resource: requestResource },
-        });
-        return resp.signature;
-    }
-    catch (e) {
-        throw new Error("No agents available to sign the resource");
-    }
+    const resp = await callAgent({
+        baseUrl: agentUrl,
+        path: "v1/signature/sign",
+        method: "post",
+        token: token,
+        data: { resource: requestResource },
+    });
+    return resp.signature;
 }
 exports.signResource = signResource;
-async function verifyResources({ agentUrls, token, branchName, resources, }) {
-    try {
-        await callAgentFallBack({
-            baseUrls: agentUrls,
-            path: "v1/signature/verify",
-            method: "post",
-            token: token,
-            data: {
-                resources: resources.map((res) => {
-                    if (res.api) {
-                        return {
-                            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                            api: (0, utils_1.getSanitizedApi)(res.api),
-                            branchName: branchName !== null && branchName !== void 0 ? branchName : "main",
-                        };
-                    }
+async function verifyResources({ agentUrl, token, branchName, resources, }) {
+    await callAgent({
+        baseUrl: agentUrl,
+        path: "v1/signature/verify",
+        method: "post",
+        token: token,
+        data: {
+            resources: resources.map((res) => {
+                if (res.api) {
                     return {
-                        ...res,
-                        branchName: branchName !== null && branchName !== void 0 ? branchName : "main",
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        api: (0, utils_1.getSanitizedApi)(res.api),
+                        branchName: branchName ?? "main",
                     };
-                }),
-            },
-        });
-    }
-    catch (e) {
-        throw new Error("No agents available to verify the resource");
-    }
+                }
+                return {
+                    ...res,
+                    branchName: branchName ?? "main",
+                };
+            }),
+        },
+    });
 }
 exports.verifyResources = verifyResources;
-async function callAgentFallBack({ baseUrls, path, method, token, data, }) {
-    for (const baseUrl of baseUrls) {
-        try {
-            const url = new URL(path, baseUrl);
-            const config = {
-                url: url.toString(),
-                method: method,
-                headers: {
-                    Authorization: "Bearer " + token,
-                },
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                data: data,
-            };
-            const resp = await (0, axios_1.default)(config);
-            return resp.data;
-        }
-        catch (e) { }
+async function callAgent({ baseUrl, path, method, token, data, }) {
+    try {
+        const url = new URL(path, baseUrl);
+        const config = {
+            url: url.toString(),
+            method: method,
+            headers: {
+                Authorization: "Bearer " + token,
+            },
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            data: data,
+        };
+        const resp = await (0, axios_1.default)(config);
+        return resp.data;
+    }
+    catch (error) {
+        throw new Error(`Failed to request the agent ${baseUrl}. Error: ${error}`);
     }
-    throw new Error("Failed to request ");
 }

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
 import { Agent, AgentType, Api } from "./types";
-export declare function getAgentUrls(agents: Agent[], agentType: AgentType): string[];
+export declare function getAgentUrl(agents: Agent[], agentType: AgentType, profile?: string, healthCheck?: boolean): Promise<string>;
 export declare const sanitizeV2RequestBody: (apiBody: Record<string, unknown>) => Record<string, unknown>;
 export declare const getSanitizedApi: (api: Api) => any;

package/dist/utils.js

@@ -1,12 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSanitizedApi = exports.sanitizeV2RequestBody = exports.getAgentUrls = void 0;
+exports.getSanitizedApi = exports.sanitizeV2RequestBody = exports.getAgentUrl = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
 const types_1 = require("./types");
-function getAgentUrls(agents, agentType) {
-    const filtered = agents.filter((a) => a.type === agentType && a.status === types_1.AgentStatus.ACTIVE);
-    return filtered.map((f) => f.url);
+async function getAgentUrl(agents, agentType, profile, healthCheck = true) {
+    let filtered = agents.filter((a) => a.type === agentType && a.status === types_1.AgentStatus.ACTIVE);
+    if (profile) {
+        filtered = agents.filter((a) => a.tags.profile &&
+            (a.tags.profile.includes("*") || a.tags.profile.includes(profile)));
+    }
+    if (healthCheck) {
+        const coroutines = [];
+        for (const agent of filtered) {
+            const p = (async () => {
+                const url = new URL("health", agent.url);
+                const config = {
+                    url: url.toString(),
+                    method: "get",
+                    headers: {},
+                };
+                await (0, axios_1.default)(config);
+                return agent.url;
+            })();
+            coroutines.push(p);
+        }
+        try {
+            return await Promise.any(coroutines);
+        }
+        catch (e) {
+            throw new Error("No available agents");
+        }
+    }
+    else {
+        const randomIndex = Math.floor(Math.random() * filtered.length);
+        return filtered[randomIndex].url;
+    }
 }
-exports.getAgentUrls = getAgentUrls;
+exports.getAgentUrl = getAgentUrl;
 const sanitizeV2RequestBody = (apiBody) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const traverseJSON = (obj) => {
@@ -26,8 +57,7 @@ const sanitizeV2RequestBody = (apiBody) => {
 };
 exports.sanitizeV2RequestBody = sanitizeV2RequestBody;
 const getSanitizedApi = (api) => {
-    var _a, _b;
-    const sanitizedBlocks = (_b = ((_a = api.blocks) !== null && _a !== void 0 ? _a : [])) === null || _b === void 0 ? void 0 : _b.map((block) => (0, exports.sanitizeV2RequestBody)(block));
+    const sanitizedBlocks = (api.blocks ?? [])?.map((block) => (0, exports.sanitizeV2RequestBody)(block));
     return {
         ...api,
         blocks: sanitizedBlocks,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/sdk",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "Superblocks JS SDK",
   "main": "./dist/index.js",
   "exports": {
@@ -31,7 +31,7 @@
     "typescript": "^5.1.3"
   },
   "dependencies": {
-    "@superblocksteam/util": "1.5.0",
+    "@superblocksteam/util": "1.5.2",
     "axios": "^1.3.5",
     "isomorphic-ws": "^5.0.0"
   },

package/src/client.ts

@@ -17,7 +17,7 @@ import { BranchNotCheckedOutError, CommitAlreadyExistsError } from "./errors";
 import { signingEnabled } from "./flag";
 import { connectToISocketRPCServer } from "./socket";
 import { AgentType, RemoteCommitDto, UserMeDto } from "./types";
-import { getAgentUrls } from "./utils";
+import { getAgentUrl } from "./utils";
 
 const BASE_BUCKETEER_URL = "api";
 const BASE_SERVER_PUBLIC_API_URL = "api/v1/public";
@@ -422,10 +422,18 @@ export async function registerComponents(
       superblocksBaseUrl
     );
     const organization = userMe.organizations[0];
-    if (organization.agentType == AgentType.ONPREMISE && signingEnabled(userMe.flagBootstrap)) {
-      const agentUrls = getAgentUrls(userMe.agents, organization.agentType);
+    if (
+      organization.agentType == AgentType.ONPREMISE &&
+      signingEnabled(userMe.flagBootstrap)
+    ) {
+      const profile = process.env.SUPERBLOCKS_PROFILE;
+      const agentUrl = await getAgentUrl(
+        userMe.agents,
+        organization.agentType,
+        profile
+      );
       const socket = await connectToISocketRPCServer({
-        agentUrls,
+        agentUrl,
         superblocksBaseUrl,
         token,
       });
@@ -554,7 +562,7 @@ You can reduce your component bundle size by uploading static assets to a separa
         [CLI_VERSION_HEADER]: cliVersion,
         [COMPONENT_EVENT_HEADER]: ComponentEvent.UPLOAD,
         [SUPERBLOCKS_URL_HEADER]: superblocksBaseUrl,
-          ...formHeaders,
+        ...formHeaders,
       },
     };
 
@@ -566,13 +574,15 @@ You can reduce your component bundle size by uploading static assets to a separa
       superblocksBaseUrl
     );
     const organization = userMe.organizations[0];
-    const signingRequired = organization.agentType == AgentType.ONPREMISE && signingEnabled(userMe.flagBootstrap);
-    let agentUrls: string[] = [];
+    let agentUrl: string | undefined;
+    const signingRequired =
+      organization.agentType == AgentType.ONPREMISE &&
+      signingEnabled(userMe.flagBootstrap);
     if (signingRequired) {
-      agentUrls = getAgentUrls(userMe.agents, organization.agentType);
+      agentUrl = await getAgentUrl(userMe.agents, organization.agentType);
     }
     const socket = await connectToISocketRPCServer({
-      agentUrls,
+      agentUrl,
       superblocksBaseUrl,
       token,
     });
@@ -665,14 +675,15 @@ export async function pushApplication({
   injectedHeaders: Record<string, string>;
   applicationConfig: PushApplicationWithCommitConfig;
 }): Promise<RemoteCommitDto | undefined> {
-  const serverURL = new URL(
-    `${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(
-      branch
-    )}/push`,
-    superblocksBaseUrl
-  );
-  let serverResponse;
-
+  const handleHttpError = (status: number) => {
+    if (status === 405) {
+      throw new BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
+    } else if (status === 409) {
+      throw new CommitAlreadyExistsError(
+        `Commit ${applicationConfig.commitId} already exists`
+      );
+    }
+  };
   try {
     const userMe = await fetchCurrentUser(
       cliVersion,
@@ -680,10 +691,18 @@ export async function pushApplication({
       superblocksBaseUrl
     );
     const organization = userMe.organizations[0];
-    if (organization.agentType == AgentType.ONPREMISE && signingEnabled(userMe.flagBootstrap)) {
-      const agentUrls = getAgentUrls(userMe.agents, organization.agentType);
+    if (
+      organization.agentType == AgentType.ONPREMISE &&
+      signingEnabled(userMe.flagBootstrap)
+    ) {
+      const profile = process.env.SUPERBLOCKS_PROFILE;
+      const agentUrl = await getAgentUrl(
+        userMe.agents,
+        organization.agentType,
+        profile
+      );
       const socket = await connectToISocketRPCServer({
-        agentUrls,
+        agentUrl,
         superblocksBaseUrl,
         token,
       });
@@ -697,8 +716,21 @@ export async function pushApplication({
         page: applicationConfig.page,
       });
       socket.close();
+      handleHttpError(resp.responseMeta.status);
+      if (resp.responseMeta.status !== 200) {
+        // Get the raw error message from the server and throw it. The outer try-catch block will wrap it in a nicer error message
+        const message: string =
+          (resp?.responseMeta?.message as string) ?? JSON.stringify(resp?.data);
+        throw new Error(message);
+      }
       return resp.data;
     } else {
+      const serverURL = new URL(
+        `${BASE_SERVER_PUBLIC_API_URL}/applications/${applicationId}/branches/${encodeURIComponent(
+          branch
+        )}/push`,
+        superblocksBaseUrl
+      );
       const config: AxiosRequestConfig = {
         method: "post",
         url: serverURL.toString(),
@@ -709,29 +741,31 @@ export async function pushApplication({
         },
         data: applicationConfig,
       };
-      serverResponse = await axios<ResponseWithMeta<RemoteCommitDto>>(config);
-    }
-  } catch (e) {
-    if (axios.isAxiosError(e)) {
-      const respCode =
-        e.response?.data?.responseMeta?.status ?? e.response?.status;
-      if (respCode === 405) {
-        throw new BranchNotCheckedOutError(
-          `Branch ${branch} is not checked out`
+      try {
+        const serverResponse = await axios<ResponseWithMeta<RemoteCommitDto>>(
+          config
         );
-      } else if (respCode === 409) {
-        throw new CommitAlreadyExistsError(
-          `Commit ${applicationConfig.commitId} already exists`
+        return serverResponse?.data?.data;
+      } catch (e) {
+        if (!axios.isAxiosError(e)) {
+          throw e;
+        }
+        handleHttpError(
+          e.response?.data?.responseMeta?.status ?? e.response?.status
         );
+        const message =
+          (e.response?.data?.responseMeta?.message as string) ??
+          JSON.stringify(e.response?.data) ??
+          e.response?.statusText;
+        throw new Error(message);
       }
-      const message: string =
-        (e.response?.data?.responseMeta?.message as string) ??
-        JSON.stringify(e.response?.data) ??
-        e.response?.statusText;
-
-      throw new Error(
-        `Could not push application ${message ? "\n" + message : ""}`
-      );
+    }
+  } catch (e) {
+    if (
+      e instanceof BranchNotCheckedOutError ||
+      e instanceof CommitAlreadyExistsError
+    ) {
+      throw e;
     }
     throw new Error(
       `Could not push application ${
@@ -739,8 +773,6 @@ export async function pushApplication({
       }`
     );
   }
-
-  return serverResponse?.data?.data;
 }
 
 export async function pushApi({
@@ -760,14 +792,21 @@ export async function pushApi({
   branch: string;
   injectedHeaders: Record<string, string>;
 }): Promise<{ commitId: string } | undefined> {
+  const handleHttpError = (status: number) => {
+    if (status === 405) {
+      throw new BranchNotCheckedOutError(`Branch ${branch} is not checked out`);
+    } else if (status === 409) {
+      throw new CommitAlreadyExistsError(
+        `Commit ${apiConfig.commitId} already exists`
+      );
+    }
+  };
   const serverURL = new URL(
     `${BASE_SERVER_PUBLIC_API_URL}/apis/${apiId}/branches/${encodeURIComponent(
       branch
     )}/push`,
     superblocksBaseUrl
   );
-  let serverResponse;
-
   try {
     const userMe = await fetchCurrentUser(
       cliVersion,
@@ -775,10 +814,13 @@ export async function pushApi({
       superblocksBaseUrl
     );
     const organization = userMe.organizations[0];
-    if (organization.agentType == AgentType.ONPREMISE && signingEnabled(userMe.flagBootstrap)) {
-      const agentUrls = getAgentUrls(userMe.agents, organization.agentType);
+    if (
+      organization.agentType == AgentType.ONPREMISE &&
+      signingEnabled(userMe.flagBootstrap)
+    ) {
+      const agentUrl = await getAgentUrl(userMe.agents, organization.agentType);
       const socket = await connectToISocketRPCServer({
-        agentUrls,
+        agentUrl,
         superblocksBaseUrl,
         token,
       });
@@ -790,6 +832,13 @@ export async function pushApi({
         commitMessage: apiConfig.commitMessage,
       });
       socket.close();
+      handleHttpError(resp.responseMeta.status);
+      if (resp.responseMeta.status !== 200) {
+        // Get the raw error message from the server and throw it. The outer try-catch block will wrap it in a nicer error message
+        const message: string =
+          (resp?.responseMeta?.message as string) ?? JSON.stringify(resp?.data);
+        throw new Error(message);
+      }
       return resp.data;
     } else {
       const config: AxiosRequestConfig = {
@@ -802,27 +851,29 @@ export async function pushApi({
         },
         data: apiConfig,
       };
-      serverResponse = await axios<ResponseWithMeta<{ commitId: string }>>(
-        config
-      );
+      try {
+        const serverResponse = await axios<
+          ResponseWithMeta<{ commitId: string }>
+        >(config);
+        return serverResponse?.data?.data;
+      } catch (e) {
+        if (!axios.isAxiosError(e)) {
+          throw e;
+        }
+        handleHttpError(e.response?.data?.responseMeta?.status);
+        const message =
+          (e.response?.data?.responseMeta?.message as string) ??
+          JSON.stringify(e.response?.data) ??
+          e.response?.statusText;
+        throw new Error(message);
+      }
     }
   } catch (e) {
-    if (axios.isAxiosError(e)) {
-      if (e.response?.data?.responseMeta?.status === 405) {
-        throw new BranchNotCheckedOutError(
-          `Branch ${branch} is not checked out`
-        );
-      } else if (e.response?.data?.responseMeta?.status === 409) {
-        throw new CommitAlreadyExistsError(
-          `Commit ${apiConfig.commitId} already exists`
-        );
-      }
-      const message: string =
-        (e.response?.data?.responseMeta?.message as string) ??
-        JSON.stringify(e.response?.data) ??
-        e.response?.statusText;
-
-      throw new Error(`Could not push api ${message ? "\n" + message : ""}`);
+    if (
+      e instanceof BranchNotCheckedOutError ||
+      e instanceof CommitAlreadyExistsError
+    ) {
+      throw e;
     }
     throw new Error(
       `Could not push api ${
@@ -830,6 +881,4 @@ export async function pushApi({
       }`
     );
   }
-
-  return serverResponse?.data?.data;
 }

package/src/socket/handlers.ts

@@ -49,6 +49,7 @@ type ResponseDto<T> = {
 export type ResponseMeta = {
   status: number;
   success: boolean;
+  message?: string;
   error?: APIResponseError;
 };
 
@@ -117,11 +118,11 @@ export interface ServerMethods {
 }
 
 export function createRequestHandlers({
-  agentUrls,
+  agentUrl,
   token,
 }: {
   token: string;
-  agentUrls: string[];
+  agentUrl?: string;
 }) {
   const requestHandlers: MethodHandlers<ClientMethods, ServerMethods, unknown> =
     {
@@ -135,8 +136,13 @@ export function createRequestHandlers({
               branchName: string;
               toSign: AppToSign;
             }) => {
+              if (!agentUrl) {
+                throw new Error(
+                  "Agent url not specified. This shouldn't happen."
+                );
+              }
               const signature = await signResource({
-                agentUrls,
+                agentUrl,
                 token: token,
                 branchName,
                 resource: {
@@ -158,8 +164,13 @@ export function createRequestHandlers({
             }) => {
               const signatures: Signature[] = [];
               for (const { apiPb } of toSign) {
+                if (!agentUrl) {
+                  throw new Error(
+                    "Agent url not specified. This shouldn't happen."
+                  );
+                }
                 const signature = await signResource({
-                  agentUrls,
+                  agentUrl,
                   token: token,
                   branchName,
                   resource: { api: apiPb },
@@ -178,8 +189,13 @@ export function createRequestHandlers({
               toVerify: AppToVerify;
             }) => {
               try {
+                if (!agentUrl) {
+                  throw new Error(
+                    "Agent url not specified. This shouldn't happen."
+                  );
+                }
                 await verifyResources({
-                  agentUrls,
+                  agentUrl,
                   token,
                   branchName,
                   resources: [
@@ -207,8 +223,13 @@ export function createRequestHandlers({
               toVerify: ApiToVerify[];
             }) => {
               try {
+                if (!agentUrl) {
+                  throw new Error(
+                    "Agent url not specified. This shouldn't happen."
+                  );
+                }
                 await verifyResources({
-                  agentUrls,
+                  agentUrl,
                   token,
                   branchName,
                   resources: toVerify.map(({ apiPb }) => ({

package/src/socket/index.ts

@@ -10,15 +10,15 @@ export type StdISocketRPCClient = ISocketClient<ServerMethods>;
 
 export async function connectToISocketRPCServer({
   superblocksBaseUrl,
-  agentUrls,
+  agentUrl,
   token,
 }: {
   superblocksBaseUrl: string;
-  agentUrls: string[];
   token: string;
+  agentUrl?: string;
 }): Promise<StdISocketRPCClient> {
   const requestHandlers = createRequestHandlers({
-    agentUrls,
+    agentUrl,
     token,
   });
   const authorization = `Bearer ${token}`;