Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

feat(secret): integrate abort signal handling for client disconnections

Victor Hugo dos Santosba1eb158048d
diff --git a/backend/src/services/secret-v2-bridge/secret-reference-fns.test.ts b/backend/src/services/secret-v2-bridge/secret-reference-fns.test.ts
index 000faa48ec..64de15c510 100644
--- a/backend/src/services/secret-v2-bridge/secret-reference-fns.test.ts
+++ b/backend/src/services/secret-v2-bridge/secret-reference-fns.test.ts
@@ -1,32 +1,40 @@
import { describe, expect, it, vi } from "vitest";
+import { ClientClosedRequestError } from "@app/lib/errors";
+
import { expandSecretReferencesFactory } from "./secret-reference-fns";
vi.mock("@app/lib/logger", () => ({ logger: { error: vi.fn(), warn: vi.fn() } }));
vi.mock("../project-folder-grant/project-folder-grant-fns", () => ({ isCrossProjectEnabled: vi.fn() }));
+type Args = Parameters<typeof expandSecretReferencesFactory>[0];
+
+const makeDALs = () => {
+ const findBySecretPath = vi
+ .fn<Args["folderDAL"]["findBySecretPath"]>()
+ .mockResolvedValue({ id: "folder" } as Awaited<ReturnType<Args["folderDAL"]["findBySecretPath"]>>);
+ const findByFolderId = vi.fn<Args["secretDAL"]["findByFolderId"]>().mockResolvedValue([
+ {
+ id: "secret",
+ _id: "secret",
+ key: "SOURCE",
+ version: 1,
+ type: "shared",
+ folderId: "folder",
+ createdAt: new Date(0),
+ updatedAt: new Date(0),
+ encryptedValue: Buffer.from("resolved"),
+ tags: [],
+ secretMetadata: [],
+ userId: null
+ }
+ ]);
+ return { findBySecretPath, findByFolderId };
+};
+
describe("expandSecretReferencesFactory", () => {
it("should share one folder read when resolving concurrent references to the same folder", async () => {
- type Args = Parameters<typeof expandSecretReferencesFactory>[0];
- const findBySecretPath = vi
- .fn<Args["folderDAL"]["findBySecretPath"]>()
- .mockResolvedValue({ id: "folder" } as Awaited<ReturnType<Args["folderDAL"]["findBySecretPath"]>>);
- const findByFolderId = vi.fn<Args["secretDAL"]["findByFolderId"]>().mockResolvedValue([
- {
- id: "secret",
- _id: "secret",
- key: "SOURCE",
- version: 1,
- type: "shared",
- folderId: "folder",
- createdAt: new Date(0),
- updatedAt: new Date(0),
- encryptedValue: Buffer.from("resolved"),
- tags: [],
- secretMetadata: [],
- userId: null
- }
- ]);
+ const { findBySecretPath, findByFolderId } = makeDALs();
const { expandSecretReferences } = expandSecretReferencesFactory({
projectId: "project",
folderDAL: { findBySecretPath },
@@ -50,4 +58,53 @@ describe("expandSecretReferencesFactory", () => {
expect(findBySecretPath).toHaveBeenCalledOnce();
expect(findByFolderId).toHaveBeenCalledOnce();
});
+
+ it("does no lookups once the signal has already aborted", async () => {
+ const { findBySecretPath, findByFolderId } = makeDALs();
+ const controller = new AbortController();
+ controller.abort();
+ const { expandSecretReferences } = expandSecretReferencesFactory({
+ projectId: "project",
+ folderDAL: { findBySecretPath },
+ secretDAL: { findByFolderId },
+ decryptSecretValue: (value) => value?.toString(),
+ canExpandValue: vi.fn(() => true),
+ abortSignal: controller.signal
+ });
+
+ await expect(
+ expandSecretReferences({ secretKey: "KEY", value: `\${SOURCE}`, environment: "prod", secretPath: "/shared" })
+ ).rejects.toBeInstanceOf(ClientClosedRequestError);
+ expect(findBySecretPath).not.toHaveBeenCalled();
+ expect(findByFolderId).not.toHaveBeenCalled();
+ });
+
+ it("stops before the next reference lookup when the signal aborts mid-expansion", async () => {
+ const { findBySecretPath, findByFolderId } = makeDALs();
+ const controller = new AbortController();
+ findBySecretPath.mockImplementationOnce(async () => {
+ controller.abort();
+ return { id: "folder" } as Awaited<ReturnType<Args["folderDAL"]["findBySecretPath"]>>;
+ });
+ const { expandSecretReferences } = expandSecretReferencesFactory({
+ projectId: "project",
+ folderDAL: { findBySecretPath },
+ secretDAL: { findByFolderId },
+ decryptSecretValue: (value) => value?.toString(),
+ canExpandValue: vi.fn(() => true),
+ abortSignal: controller.signal
+ });
+
+ await expect(
+ expandSecretReferences({
+ secretKey: "KEY",
+ value: `\${prod.a.SOURCE} \${prod.b.SOURCE}`,
+ environment: "prod",
+ secretPath: "/shared"
+ })
+ ).rejects.toBeInstanceOf(ClientClosedRequestError);
+ // Only the read of the secret being expanded ran; neither referenced folder was loaded.
+ expect(findBySecretPath).toHaveBeenCalledOnce();
+ expect(findBySecretPath).toHaveBeenCalledWith("project", "prod", "/shared", undefined);
+ });
});
diff --git a/backend/src/services/secret-v2-bridge/secret-reference-fns.ts b/backend/src/services/secret-v2-bridge/secret-reference-fns.ts
index e89d373c69..7ba8f26186 100644
--- a/backend/src/services/secret-v2-bridge/secret-reference-fns.ts
+++ b/backend/src/services/secret-v2-bridge/secret-reference-fns.ts
@@ -3,7 +3,7 @@ import path from "node:path";
import { Knex } from "knex";
import RE2 from "re2";
-import { ForbiddenRequestError } from "@app/lib/errors";
+import { ForbiddenRequestError, throwIfClientDisconnected } from "@app/lib/errors";
import { logger } from "@app/lib/logger";
import { TKmsServiceFactory } from "../kms/kms-service";
@@ -109,6 +109,7 @@ type TInterpolateSecretArg = {
// same-project relative references; cross-project reads must stay raw so source
// project imports are not resolved through the target project context.
crossProjectSecretDAL?: Pick<TSecretV2BridgeDALFactory, "findByFolderId">;
+ abortSignal?: AbortSignal;
tx?: Knex;
};
@@ -126,6 +127,7 @@ export const expandSecretReferencesFactory = ({
projectDAL,
kmsService,
crossProjectSecretDAL,
+ abortSignal,
tx
}: TInterpolateSecretArg) => {
const secretCache: Record<string, Record<string, { value: string; tags: string[]; exists: boolean }>> = {};
@@ -232,6 +234,8 @@ export const expandSecretReferencesFactory = ({
if (!dto.value) return { expandedValue: "", stackTrace };
+ throwIfClientDisconnected(abortSignal);
+
// Track visited secrets to prevent circular references
const createSecretId = (env: string, secretPath: string, key: string) => `${env}:${secretPath}:${key}`;
@@ -281,6 +285,8 @@ export const expandSecretReferencesFactory = ({
}
for (const interpolationSyntax of refs) {
+ throwIfClientDisconnected(abortSignal);
+
const interpolationKey = interpolationSyntax.slice(2, interpolationSyntax.length - 1);
const entities = interpolationKey.trim().split(".");
diff --git a/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.test.ts b/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.test.ts
index 1ff8d4e7e2..6b9336b52c 100644
--- a/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.test.ts
+++ b/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.test.ts
@@ -1,6 +1,7 @@
import { beforeEach, describe, expect, test, vi } from "vitest";
import { TSecretFolders } from "@app/db/schemas";
+import { ClientClosedRequestError } from "@app/lib/errors";
import { logger } from "@app/lib/logger";
import { buildHierarchy, expandSecretReferencesGroupedByPath, generatePaths } from "./secret-v2-bridge-fns";
@@ -280,6 +281,23 @@ describe("expandSecretReferencesGroupedByPath", () => {
expect(secrets.find((s) => s.secretKey === "B2")?.secretValue).toBe("ref-B2");
});
+ test("throws ClientClosedRequestError instead of reporting expansions cut short by a disconnect", async () => {
+ const controller = new AbortController();
+ const secrets = [makeSecret("/a", "A1"), makeSecret("/b", "B1")];
+
+ await expect(
+ expandSecretReferencesGroupedByPath({
+ secrets,
+ environment: "dev",
+ abortSignal: controller.signal,
+ expandSecretReferences: async () => {
+ controller.abort();
+ throw new ClientClosedRequestError();
+ }
+ })
+ ).rejects.toBeInstanceOf(ClientClosedRequestError);
+ });
+
test("keeps the mapping correct across many paths", async () => {
const pathCount = 2000;
const secrets = Array.from({ length: pathCount }, (_, i) => makeSecret(`/p-${i}`, `K${i}`));
diff --git a/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.ts b/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.ts
index caec3f6dee..dc600a3e4f 100644
--- a/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.ts
+++ b/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.ts
@@ -20,7 +20,7 @@ import {
InternalMetadataType,
TInternalMetadata
} from "@app/ee/services/secret-approval-request/secret-approval-request-types";
-import { BadRequestError, NotFoundError } from "@app/lib/errors";
+import { BadRequestError, NotFoundError, throwIfClientDisconnected } from "@app/lib/errors";
import { groupBy } from "@app/lib/fn";
import { logger } from "@app/lib/logger";
import { alphaNumericNanoId } from "@app/lib/nanoid";
@@ -564,14 +564,17 @@ type TExpandableSecret = {
export type TSecretReferenceExpansionError = { path: string; error: string };
// Expands every secret's value in place and returns one entry per failed expansion, tagged with the
-// secret's path.
+// secret's path. Throws ClientClosedRequestError instead when abortSignal fired, since expansions cut
+// short by the disconnect would otherwise be reported as reference errors.
export const expandSecretReferencesGroupedByPath = async <T extends TExpandableSecret>({
secrets,
environment,
- expandSecretReferences
+ expandSecretReferences,
+ abortSignal
}: {
secrets: T[];
environment: string;
+ abortSignal?: AbortSignal;
expandSecretReferences: (input: {
value?: string;
secretPath: string;
@@ -602,6 +605,8 @@ export const expandSecretReferencesGroupedByPath = async <T extends TExpandableS
)
);
+ throwIfClientDisconnected(abortSignal);
+
const errors: TSecretReferenceExpansionError[] = [];
settledPromises.forEach((outerResult, outerIndex) => {
const groupedPath = groupedPaths[outerIndex];
@@ -1455,6 +1460,7 @@ type TCreateRelativeImportExpanderArg = {
decryptSecretValue: (value?: Buffer | null) => string;
canExpandValue: (environment: string, secretPath: string, secretKey: string, secretTagSlugs: string[]) => boolean;
userId?: string;
+ abortSignal?: AbortSignal;
};
export const createRelativeImportExpander = ({
@@ -1466,7 +1472,8 @@ export const createRelativeImportExpander = ({
folderDAL,
decryptSecretValue,
canExpandValue,
- userId
+ userId,
+ abortSignal
}: TCreateRelativeImportExpanderArg): {
expandImportedSecretReferences: (inputSecret: {
value?: string;
@@ -1545,7 +1552,8 @@ export const createRelativeImportExpander = ({
}
return canExpandValue(environment, secretPath, secretKey, secretTagSlugs);
},
- userId
+ userId,
+ abortSignal
});
relativeImportExpanders.set(expanderKey, expander);
diff --git a/backend/src/services/secret-v2-bridge/secret-v2-bridge-service.ts b/backend/src/services/secret-v2-bridge/secret-v2-bridge-service.ts
index f942bde510..25d400fc3c 100644
--- a/backend/src/services/secret-v2-bridge/secret-v2-bridge-service.ts
+++ b/backend/src/services/secret-v2-bridge/secret-v2-bridge-service.ts
@@ -1649,7 +1649,8 @@ export const secretV2BridgeServiceFactory = ({
kmsService,
// mainExpanderSecretDAL may be import-aware in relative mode. Keep cross-project
// reads on the raw DAL so source imports are not resolved through this target project.
- crossProjectSecretDAL: secretDAL
+ crossProjectSecretDAL: secretDAL,
+ abortSignal
});
if (shouldExpandSecretReferences) {
@@ -1657,7 +1658,8 @@ export const secretV2BridgeServiceFactory = ({
const errors = await expandSecretReferencesGroupedByPath({
secrets: decryptedSecrets,
environment,
- expandSecretReferences
+ expandSecretReferences,
+ abortSignal
});
if (errors.length > 0) {
throw new ForbiddenRequestError({
@@ -1704,7 +1706,8 @@ export const secretV2BridgeServiceFactory = ({
secretName: expandSecretKey,
secretTags: expandSecretTags
}),
- userId: expandPersonalOverrides ? actorId : undefined
+ userId: expandPersonalOverrides ? actorId : undefined,
+ abortSignal
});
const importedSecrets = await fnSecretsV2FromImports({
@@ -1761,6 +1764,8 @@ export const secretV2BridgeServiceFactory = ({
kmsService
});
+ throwIfClientDisconnected(abortSignal);
+
const payload = { secrets: decryptedSecrets, imports: importedSecrets };
const serializedPayload = Buffer.from(JSON.stringify(payload));
const computedEtag = `"${generateCacheKeyFromBuffer(serializedPayload)}"`;
diff --git a/backend/src/services/secret/secret-fns.ts b/backend/src/services/secret/secret-fns.ts
index ed77030270..f9d2395e6b 100644
--- a/backend/src/services/secret/secret-fns.ts
+++ b/backend/src/services/secret/secret-fns.ts
@@ -17,7 +17,7 @@ import { ProjectPermissionSecretActions } from "@app/ee/services/permission/proj
import { getConfig } from "@app/lib/config/env";
import { buildSecretBlindIndexFromName } from "@app/lib/crypto";
import { crypto, SymmetricKeySize } from "@app/lib/crypto/cryptography";
-import { BadRequestError, NotFoundError } from "@app/lib/errors";
+import { BadRequestError, NotFoundError, throwIfClientDisconnected } from "@app/lib/errors";
import { groupBy, unique } from "@app/lib/fn";
import { recordLegacyRootKeyUsageMetric } from "@app/lib/telemetry/metrics";
import { getAllSecretReferences } from "@app/services/secret-v2-bridge/secret-reference-fns";
@@ -153,13 +153,20 @@ type TInterpolateSecretArg = {
secretEncKey: string;
secretDAL: Pick<TSecretDALFactory, "findByFolderId">;
folderDAL: Pick<TSecretFolderDALFactory, "findBySecretPath">;
+ abortSignal?: AbortSignal;
};
const MAX_SECRET_REFERENCE_DEPTH = 5;
const INTERPOLATION_PATTERN_STRING = String.raw`\${([a-zA-Z0-9-_.]+)}`;
const INTERPOLATION_TEST_REGEX = new RE2(INTERPOLATION_PATTERN_STRING);
-export const interpolateSecrets = ({ projectId, secretEncKey, secretDAL, folderDAL }: TInterpolateSecretArg) => {
+export const interpolateSecrets = ({
+ projectId,
+ secretEncKey,
+ secretDAL,
+ folderDAL,
+ abortSignal
+}: TInterpolateSecretArg) => {
const secretCache: Record<string, Record<string, string>> = {};
const getCacheUniqueKey = (environment: string, secretPath: string) => `${environment}-${secretPath}`;
@@ -227,6 +234,7 @@ export const interpolateSecrets = ({ projectId, secretEncKey, secretDAL, folderD
let expandedValue = value;
if (refs.length > 0) {
for (const interpolationSyntax of refs) {
+ throwIfClientDisconnected(abortSignal);
const interpolationKey = interpolationSyntax.slice(2, interpolationSyntax.length - 1);
const entities = interpolationKey.trim().split(".");
diff --git a/backend/src/services/secret/secret-service.ts b/backend/src/services/secret/secret-service.ts
index 8f6493e122..87f8af35ac 100644
--- a/backend/src/services/secret/secret-service.ts
+++ b/backend/src/services/secret/secret-service.ts
@@ -33,7 +33,7 @@ import { TSecretApprovalRequestServiceFactory } from "@app/ee/services/secret-ap
import { getConfig } from "@app/lib/config/env";
import { buildSecretBlindIndexFromName, SymmetricKeySize } from "@app/lib/crypto";
import { crypto } from "@app/lib/crypto/cryptography";
-import { BadRequestError, ForbiddenRequestError, NotFoundError } from "@app/lib/errors";
+import { BadRequestError, ForbiddenRequestError, NotFoundError, throwIfClientDisconnected } from "@app/lib/errors";
import { groupBy, pick } from "@app/lib/fn";
import { logger } from "@app/lib/logger";
import { alphaNumericNanoId } from "@app/lib/nanoid";
@@ -636,7 +636,8 @@ export const secretServiceFactory = ({
actorOrgId,
actorAuthMethod,
includeImports,
- recursive
+ recursive,
+ abortSignal
}: TGetSecretsDTO) => {
const { permission } = await permissionService.getProjectPermission({
actor,
@@ -695,12 +696,15 @@ export const secretServiceFactory = ({
const groupedPaths = groupBy(paths, (p) => p.folderId);
+ throwIfClientDisconnected(abortSignal);
+
const secrets = await secretDAL.findByFolderIds(
paths.map((p) => p.folderId),
actorId
);
if (includeImports) {
+ throwIfClientDisconnected(abortSignal);
const secretImports = await secretImportDAL.findByFolderIds(paths.map((p) => p.folderId));
const allowedImports = secretImports.filter(({ importEnv, importPath, isReplication }) =>
!isReplication &&
@@ -1510,9 +1514,12 @@ export const secretServiceFactory = ({
actorAuthMethod,
path,
includeImports,
- recursive
+ recursive,
+ abortSignal
});
+ throwIfClientDisconnected(abortSignal);
+
const decryptedSecrets = secrets.map((el) => decryptSecretRaw({ ...el, secretValueHidden: false }, botKey));
const filteredSecrets = tagSlugs.length
? decryptedSecrets.filter((secret) => Boolean(secret.tags?.find((el) => tagSlugs.includes(el.slug))))
@@ -1572,10 +1579,12 @@ export const secretServiceFactory = ({
folderDAL,
projectId,
secretDAL,
- secretEncKey: botKey
+ secretEncKey: botKey,
+ abortSignal
});
if (expandSecretReferences) {
+ throwIfClientDisconnected(abortSignal);
const secretsGroupByPath = groupBy(filteredSecrets, (i) => i.secretPath);
await Promise.allSettled(
Object.keys(secretsGroupByPath).map((groupedPath) =>
@@ -1611,6 +1620,7 @@ export const secretServiceFactory = ({
)
)
);
+ throwIfClientDisconnected(abortSignal);
}
return {
diff --git a/backend/src/services/secret/secret-types.ts b/backend/src/services/secret/secret-types.ts
index 1b68703984..29388f8903 100644
--- a/backend/src/services/secret/secret-types.ts
+++ b/backend/src/services/secret/secret-types.ts
@@ -123,6 +123,7 @@ export type TGetSecretsDTO = {
recursive?: boolean;
limit?: number;
offset?: number;
+ abortSignal?: AbortSignal;
} & TProjectPermission;
export type TGetASecretDTO = {