PIT: remove reminders from commit history

2026-09-22 13:39:35 +00:00 · 2025-05-28 15:51:51 -03:00
parent 48619ed24c
commit c4809bbb54
5 changed files with 200 additions and 36 deletions
--- a/backend/src/services/folder-commit/folder-commit-schemas.ts
+++ b/backend/src/services/folder-commit/folder-commit-schemas.ts
@@ -27,10 +27,8 @@ const secretVersionSchema = z.object({
  secretKey: z.string(),
  secretComment: z.string(),
  skipMultilineEncoding: z.boolean().nullable().optional(),
-  secretReminderRepeatDays: z.number().nullable().optional(),
  tags: z.array(z.string()).nullable().optional(),
  metadata: z.unknown().nullable().optional(),
-  secretReminderNote: z.string().nullable().optional(),
  secretValue: z.string()
 });

--- a/backend/src/services/folder-commit/folder-commit-service.ts
+++ b/backend/src/services/folder-commit/folder-commit-service.ts
@@ -100,11 +100,8 @@ type SecretChange = BaseChange & {
    secretKey?: string;
    secretComment?: string;
    skipMultilineEncoding?: boolean | null;
-    secretReminderRepeatDays?: number | null;
-    secretReminderNote?: string | null;
    metadata?: unknown;
    tags?: string[] | null;
-    secretReminderRecipients?: string[] | null;
    secretValue?: string;
  }[];
 };
@@ -770,6 +767,89 @@ export const folderCommitServiceFactory = ({
    );
  };

+  const compareSecretVersions = async (
+    version1: TSecretVersionsV2 & { tags: { id: string }[] },
+    version2: TSecretVersionsV2 & { tags: { id: string }[] },
+    projectId: string
+  ) => {
+    const { decryptor: secretManagerDecryptor } = await kmsService.createCipherPairWithDataKey({
+      type: KmsDataKey.SecretManager,
+      projectId
+    });
+    const objectsEqual = (o1: unknown, o2: unknown): boolean => {
+      if (typeof o1 !== "object" || o1 === null || typeof o2 !== "object" || o2 === null) {
+        return o1 === o2;
+      }
+
+      const obj1 = o1 as Record<string, unknown>;
+      const obj2 = o2 as Record<string, unknown>;
+      return (
+        Object.keys(obj1).length === Object.keys(obj2).length && Object.keys(obj1).every((p) => obj1[p] === obj2[p])
+      );
+    };
+
+    const arraysEqual = (a1: unknown[], a2: unknown[]) =>
+      a1.length === a2.length && a1.every((obj1) => a2.some((obj2) => objectsEqual(obj1, obj2)));
+
+    const version1Reshaped = {
+      ...version1,
+      encryptedValue: version1.encryptedValue
+        ? secretManagerDecryptor({ cipherTextBlob: version1.encryptedValue }).toString()
+        : "",
+      encryptedComment: version1.encryptedComment
+        ? secretManagerDecryptor({ cipherTextBlob: version1.encryptedComment }).toString()
+        : "",
+      metadata: version1.metadata as { key: string; value: string }[],
+      tags: version1.tags.map((tag) => tag.id)
+    };
+    const version2Reshaped = {
+      ...version2,
+      encryptedValue: version2.encryptedValue
+        ? secretManagerDecryptor({ cipherTextBlob: version2.encryptedValue }).toString()
+        : "",
+      encryptedComment: version2.encryptedComment
+        ? secretManagerDecryptor({ cipherTextBlob: version2.encryptedComment }).toString()
+        : "",
+      metadata: version2.metadata as { key: string; value: string }[],
+      tags: version2.tags.map((tag) => tag.id)
+    };
+    return (
+      version1Reshaped.key === version2Reshaped.key &&
+      version1Reshaped.encryptedValue === version2Reshaped.encryptedValue &&
+      version1Reshaped.encryptedComment === version2Reshaped.encryptedComment &&
+      version1Reshaped.skipMultilineEncoding === version2Reshaped.skipMultilineEncoding &&
+      arraysEqual(version1Reshaped.metadata, version2Reshaped.metadata) &&
+      version1Reshaped.tags.length === version2Reshaped.tags.length &&
+      version1Reshaped.tags.every((tag) => version2Reshaped.tags.includes(tag))
+    );
+  };
+
+  const filterIgnoredChanges = async (
+    changes: {
+      type: string;
+      secretVersionId?: string;
+      folderVersionId?: string;
+      isUpdate?: boolean;
+      folderId?: string;
+    }[],
+    projectId: string,
+    tx?: Knex
+  ) => {
+    let filteredChanges = [...changes];
+    for (const change of changes) {
+      if (change.type === ChangeType.ADD && change.isUpdate && change.secretVersionId) {
+        const secretVersions = await secretVersionV2BridgeDAL.findByIdAndPreviousVersion(change.secretVersionId, tx);
+        const comparison = await compareSecretVersions(secretVersions[0], secretVersions[1], projectId);
+        if (comparison) {
+          filteredChanges = filteredChanges.filter(
+            (filteredChange) => filteredChange.secretVersionId !== change.secretVersionId
+          );
+        }
+      }
+    }
+    return filteredChanges;
+  };
+
  /**
   * Creates a new commit with the provided changes
   */
@@ -792,6 +872,17 @@ export const folderCommitServiceFactory = ({
        throw new NotFoundError({ message: `Folder with ID ${data.folderId} not found` });
      }

+      const project = await projectDAL.findProjectByEnvId(folder.envId, tx);
+
+      if (!project) {
+        return;
+      }
+
+      const changes = await filterIgnoredChanges(data.changes, project.id, tx);
+      if (changes.length === 0) {
+        return;
+      }
+
      const newCommit = await folderCommitDAL.create(
        {
          actorMetadata: metadata,
@@ -804,7 +895,7 @@ export const folderCommitServiceFactory = ({
      );

      const batchSize = 500;
-      const chunks = chunkArray(data.changes, batchSize);
+      const chunks = chunkArray(changes, batchSize);

      await Promise.all(
        chunks.map(async (chunk) => {
@@ -822,7 +913,7 @@ export const folderCommitServiceFactory = ({
      );

      await Promise.all(
-        data.changes.map(async (change) => {
+        changes.map(async (change) => {
          if (change.type === ChangeType.DELETE && change.folderId) {
            await createDeleteCommitForNestedFolders({
              folderId: change.folderId,
@@ -1486,7 +1577,9 @@ export const folderCommitServiceFactory = ({
        },
        tx
      );
-      await createFolderCheckpoint({ folderId, folderCommitId: newCommit.id, force: true, tx });
+      if (newCommit) {
+        await createFolderCheckpoint({ folderId, folderCommitId: newCommit.id, force: true, tx });
+      }
    }
  };

--- a/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.ts
+++ b/backend/src/services/secret-v2-bridge/secret-v2-bridge-fns.ts
@@ -288,30 +288,6 @@ export const fnSecretBulkUpdate = async ({
    tx
  );

-  const commitChanges = secretVersions
-    .filter(({ type }) => type === SecretType.Shared)
-    .map((sv) => ({
-      type: CommitType.ADD,
-      isUpdate: true,
-      secretVersionId: sv.id
-    }));
-  if (commitChanges.length > 0) {
-    await folderCommitService.createCommit(
-      {
-        actor: {
-          type: actorType || ActorType.PLATFORM,
-          metadata: {
-            id: actor?.actorId
-          }
-        },
-        message: "Secret Updated",
-        folderId,
-        changes: commitChanges
-      },
-      tx
-    );
-  }
-
  await secretDAL.upsertSecretReferences(
    inputSecrets
      .filter(({ data: { references } }) => Boolean(references))
@@ -382,6 +358,31 @@ export const fnSecretBulkUpdate = async ({
    },
    { tx }
  );
+
+  const commitChanges = secretVersions
+    .filter(({ type }) => type === SecretType.Shared)
+    .map((sv) => ({
+      type: CommitType.ADD,
+      isUpdate: true,
+      secretVersionId: sv.id
+    }));
+  if (commitChanges.length > 0) {
+    await folderCommitService.createCommit(
+      {
+        actor: {
+          type: actorType || ActorType.PLATFORM,
+          metadata: {
+            id: actor?.actorId
+          }
+        },
+        message: "Secret Updated",
+        folderId,
+        changes: commitChanges
+      },
+      tx
+    );
+  }
+
  return secretsWithTags.map((secret) => ({ ...secret, _id: secret.id }));
 };

--- a/backend/src/services/secret-v2-bridge/secret-version-dal.ts
+++ b/backend/src/services/secret-v2-bridge/secret-version-dal.ts
@@ -4,7 +4,7 @@ import { Knex } from "knex";
 import { TDbClient } from "@app/db";
 import { SecretVersionsV2Schema, TableName, TSecretVersionsV2, TSecretVersionsV2Update } from "@app/db/schemas";
 import { BadRequestError, DatabaseError } from "@app/lib/errors";
-import { ormify, selectAllTableCols, sqlNestRelationships, TFindOpt } from "@app/lib/knex";
+import { buildFindFilter, ormify, selectAllTableCols, sqlNestRelationships, TFindOpt } from "@app/lib/knex";
 import { logger } from "@app/lib/logger";
 import { QueueName } from "@app/queue";

@@ -371,6 +371,79 @@ export const secretVersionV2BridgeDALFactory = (db: TDbClient) => {
    }
  };

+  const findByIdAndPreviousVersion = async (secretVersionId: string, tx?: Knex) => {
+    try {
+      const targetSecretVersion = await (tx || db.replicaNode())(TableName.SecretVersionV2)
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        .where(buildFindFilter({ id: secretVersionId }, TableName.SecretVersionV2))
+        .leftJoin(
+          TableName.SecretVersionV2Tag,
+          `${TableName.SecretVersionV2}.id`,
+          `${TableName.SecretVersionV2Tag}.${TableName.SecretVersionV2}Id`
+        )
+        .leftJoin(
+          TableName.SecretTag,
+          `${TableName.SecretVersionV2Tag}.${TableName.SecretTag}Id`,
+          `${TableName.SecretTag}.id`
+        )
+        .select(selectAllTableCols(TableName.SecretVersionV2))
+        .select(db.ref("id").withSchema(TableName.SecretTag).as("tagId"))
+        .select(db.ref("color").withSchema(TableName.SecretTag).as("tagColor"))
+        .select(db.ref("slug").withSchema(TableName.SecretTag).as("tagSlug"))
+        .first();
+      if (targetSecretVersion) {
+        const previousSecretVersion = await (tx || db.replicaNode())(TableName.SecretVersionV2)
+          .where(
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises
+            buildFindFilter(
+              { version: targetSecretVersion.version - 1, secretId: targetSecretVersion.secretId },
+              TableName.SecretVersionV2
+            )
+          )
+          .leftJoin(
+            TableName.SecretVersionV2Tag,
+            `${TableName.SecretVersionV2}.id`,
+            `${TableName.SecretVersionV2Tag}.${TableName.SecretVersionV2}Id`
+          )
+          .leftJoin(
+            TableName.SecretTag,
+            `${TableName.SecretVersionV2Tag}.${TableName.SecretTag}Id`,
+            `${TableName.SecretTag}.id`
+          )
+          .select(selectAllTableCols(TableName.SecretVersionV2))
+          .select(db.ref("id").withSchema(TableName.SecretTag).as("tagId"))
+          .select(db.ref("color").withSchema(TableName.SecretTag).as("tagColor"))
+          .select(db.ref("slug").withSchema(TableName.SecretTag).as("tagSlug"))
+          .first();
+        if (!previousSecretVersion) return [];
+        const docs = [previousSecretVersion, targetSecretVersion];
+
+        const data = sqlNestRelationships({
+          data: docs,
+          key: "id",
+          parentMapper: (el) => ({ _id: el.id, ...SecretVersionsV2Schema.parse(el) }),
+          childrenMapper: [
+            {
+              key: "tagId",
+              label: "tags" as const,
+              mapper: ({ tagId: id, tagColor: color, tagSlug: slug }) => ({
+                id,
+                color,
+                slug,
+                name: slug
+              })
+            }
+          ]
+        });
+
+        return data;
+      }
+      return [];
+    } catch (error) {
+      throw new DatabaseError({ error, name: "FindByIdAndPreviousVersion" });
+    }
+  };
+
  return {
    ...secretVersionV2Orm,
    pruneExcessVersions,
@@ -379,6 +452,7 @@ export const secretVersionV2BridgeDALFactory = (db: TDbClient) => {
    findLatestVersionByFolderId,
    findVersionsBySecretIdWithActors,
    findBySecretId,
-    findByIdsWithLatestVersion
+    findByIdsWithLatestVersion,
+    findByIdAndPreviousVersion
  };
 };
--- a/backend/src/services/secret/secret-service.ts
+++ b/backend/src/services/secret/secret-service.ts
@@ -3351,10 +3351,8 @@ export const secretServiceFactory = ({
      secretKey: v.secretKey,
      secretComment: v.secretComment,
      skipMultilineEncoding: v.skipMultilineEncoding,
-      secretReminderRepeatDays: v.secretReminderRepeatDays,
      tags: v.tags?.map((tag) => tag.slug),
      metadata: v.metadata,
-      secretReminderNote: v.secretReminderNote,
      secretValue: v.secretValue
    }));
  };