Skip to content

Same agent Smaller bill. The tools and infrastructure to get more work from your AI. Fewer tokens. Less compute. Lower cost.

fix(client): do not record the vault encryption migration when it did not encrypt (#1523)

Ehsan95c22abaab1e
diff --git a/src/client/src/__tests__/clickhouse/migrations/encrypt-vault-values-migration.test.ts b/src/client/src/__tests__/clickhouse/migrations/encrypt-vault-values-migration.test.ts
index 22d4d18a..7bdcdb3b 100644
--- a/src/client/src/__tests__/clickhouse/migrations/encrypt-vault-values-migration.test.ts
+++ b/src/client/src/__tests__/clickhouse/migrations/encrypt-vault-values-migration.test.ts
@@ -60,4 +60,71 @@ describe("EncryptVaultValuesMigration", () => {
expect(query).toContain("UPDATE value = 'enc:v1:plain\\\\value\\'secret'");
expect(query).toContain("WHERE id = 'secret\\\\1'");
});
+
+ it("leaves the migration pending when the vault table cannot be read", async () => {
+ (dataCollector as jest.Mock).mockReset();
+ (dataCollector as jest.Mock).mockResolvedValueOnce({
+ data: undefined,
+ err: "default: Authentication failed: password is incorrect",
+ });
+
+ const result = await EncryptVaultValuesMigration();
+
+ expect(prisma.clickhouseMigrations.create).not.toHaveBeenCalled();
+ expect(result).toEqual({
+ migrationExist: false,
+ queriesRun: false,
+ err: "default: Authentication failed: password is incorrect",
+ });
+ });
+
+ it("leaves the migration pending when a secret fails to encrypt", async () => {
+ (dataCollector as jest.Mock).mockReset();
+ (dataCollector as jest.Mock)
+ .mockResolvedValueOnce({
+ data: [
+ { id: "secret-1", value: "plaintext-1" },
+ { id: "secret-2", value: "plaintext-2" },
+ ],
+ err: null,
+ })
+ .mockResolvedValueOnce({ err: null })
+ .mockResolvedValueOnce({ err: "TABLE_IS_READ_ONLY" });
+
+ const result = await EncryptVaultValuesMigration();
+
+ expect(prisma.clickhouseMigrations.create).not.toHaveBeenCalled();
+ expect(result).toEqual({
+ migrationExist: false,
+ queriesRun: false,
+ err: "Vault encryption migration: 1 of 2 secrets still hold plaintext, leaving the migration pending",
+ });
+ });
+
+ it("records the migration when the vault holds no rows to encrypt", async () => {
+ (dataCollector as jest.Mock).mockReset();
+ (dataCollector as jest.Mock).mockResolvedValueOnce({ data: [], err: null });
+
+ const result = await EncryptVaultValuesMigration();
+
+ expect(prisma.clickhouseMigrations.create).toHaveBeenCalledTimes(1);
+ expect(result).toEqual({ migrationExist: false, queriesRun: true });
+ });
+
+ it("leaves the migration pending when the vault read is not a row list", async () => {
+ (dataCollector as jest.Mock).mockReset();
+ (dataCollector as jest.Mock).mockResolvedValueOnce({
+ data: undefined,
+ err: null,
+ });
+
+ const result = await EncryptVaultValuesMigration();
+
+ expect(prisma.clickhouseMigrations.create).not.toHaveBeenCalled();
+ expect(result).toEqual({
+ migrationExist: false,
+ queriesRun: false,
+ err: "Vault encryption migration: unexpected vault read result",
+ });
+ });
});
diff --git a/src/client/src/clickhouse/migrations/encrypt-vault-values-migration.ts b/src/client/src/clickhouse/migrations/encrypt-vault-values-migration.ts
index 2086cab1..67dbe38a 100644
--- a/src/client/src/clickhouse/migrations/encrypt-vault-values-migration.ts
+++ b/src/client/src/clickhouse/migrations/encrypt-vault-values-migration.ts
@@ -48,12 +48,18 @@ export default async function EncryptVaultValuesMigration(
dbConfig.id
);
- if (readErr || !data || !Array.isArray(data)) {
+ if (readErr) {
consoleLog(
- `Vault encryption migration: no data to migrate or error: ${readErr}`
+ `Vault encryption migration: could not read the vault table: ${readErr}`
);
- await markMigrationComplete(dbConfig.id);
- return { migrationExist: false, queriesRun: true };
+ return { migrationExist: false, queriesRun: false, err: readErr };
+ }
+
+ if (!data || !Array.isArray(data)) {
+ const unexpectedRead =
+ "Vault encryption migration: unexpected vault read result";
+ consoleLog(unexpectedRead);
+ return { migrationExist: false, queriesRun: false, err: unexpectedRead };
}
const plaintextSecrets = (data as any[]).filter(
@@ -66,6 +72,8 @@ export default async function EncryptVaultValuesMigration(
return { migrationExist: false, queriesRun: true };
}
+ let failedCount = 0;
+
for (const secret of plaintextSecrets) {
const encrypted = escapeClickHouseString(encryptValue(secret.value));
const secretId = escapeClickHouseString(secret.id);
@@ -82,12 +90,19 @@ export default async function EncryptVaultValuesMigration(
);
if (updateErr) {
+ failedCount += 1;
consoleLog(
`Vault encryption migration: failed to encrypt secret ${secret.id}: ${updateErr}`
);
}
}
+ if (failedCount > 0) {
+ const pendingErr = `Vault encryption migration: ${failedCount} of ${plaintextSecrets.length} secrets still hold plaintext, leaving the migration pending`;
+ consoleLog(pendingErr);
+ return { migrationExist: false, queriesRun: false, err: pendingErr };
+ }
+
consoleLog(
`Vault encryption migration: encrypted ${plaintextSecrets.length} secrets`
);
@@ -97,7 +112,7 @@ export default async function EncryptVaultValuesMigration(
return { migrationExist: false, queriesRun: true };
} catch (migrationError) {
consoleLog(`Vault encryption migration error: ${migrationError}`);
- return { migrationExist: false, queriesRun: false };
+ return { migrationExist: false, queriesRun: false, err: migrationError };
}
}