Skip to content
TypeScript

fix(contracts): a stored secret reference is always sensitive (#31403)

Yordis Prieto9529ee34f02b
diff --git a/packages/contracts/src/providerInstance.test.ts b/packages/contracts/src/providerInstance.test.ts
new file mode 100644
index 00000000000..ea73ffb231e
--- /dev/null
+++ b/packages/contracts/src/providerInstance.test.ts
@@ -0,0 +1,19 @@
+import * as Schema from "effect/Schema";
+import { describe, expect, it } from "vite-plus/test";
+
+import { ProviderInstanceEnvironmentVariable } from "./providerInstance.ts";
+
+const decodeEnvironmentVariable = Schema.decodeUnknownSync(ProviderInstanceEnvironmentVariable);
+
+describe("ProviderInstanceEnvironmentVariable", () => {
+ it("treats a stored reference as sensitive even when the flag is missing or false", () => {
+ const secret = { provider: "onepassword", reference: "op://Private/item/field" };
+ expect(decodeEnvironmentVariable({ name: "API_KEY", secret })).toMatchObject({
+ value: secret,
+ sensitive: true,
+ });
+ expect(decodeEnvironmentVariable({ name: "API_KEY", sensitive: false, secret }).sensitive).toBe(
+ true,
+ );
+ });
+});
diff --git a/packages/contracts/src/providerInstance.ts b/packages/contracts/src/providerInstance.ts
index 61fee930c31..1a93350bbdf 100644
--- a/packages/contracts/src/providerInstance.ts
+++ b/packages/contracts/src/providerInstance.ts
@@ -53,7 +53,7 @@ export const ProviderInstanceEnvironmentVariable = StoredProviderInstanceEnviron
typeof StoredProviderInstanceEnvironmentVariable.Type
>({
decode: ({ secret, ...variable }) =>
- secret === undefined ? variable : { ...variable, value: secret },
+ secret === undefined ? variable : { ...variable, value: secret, sensitive: true },
encode: ({ value, ...variable }) =>
typeof value === "string"
? { ...variable, value }