make replicated secrets more intuitive

backend/src/ee/services/secret-replication/secret-replication-dal.ts

@@ -9,6 +9,16 @@ export type TSecretReplicationDALFactory = ReturnType<typeof secretReplicationDA
 export const secretReplicationDALFactory = (db: TDbClient) => {
   const orm = ormify(db, TableName.SecretVersion);
 
+  /**
+   *  Retrieves secret versions based on the specified filter criteria.
+   *
+   * @param {Object} filter - The filter criteria for querying secret versions.
+   * @param {string} filter.folderId - The ID of the folder containing the secrets.
+   * @param {Array<Object>} filter.secrets - An array of secret objects containing the ID and version of each secret.
+   * @param {Knex} [tx] - An optional Knex transaction object. If provided, the query will be executed within this transaction.
+   *
+   * @returns {Promise<Array<Object>>} A promise that resolves to an array of secret version documents that match the filter criteria.
+   */
   const findSecretVersions = async (
     filter: { folderId: string; secrets: { id: string; version: number }[] },
     tx?: Knex

backend/src/ee/services/secret-replication/secret-replication-service.ts

@@ -84,7 +84,7 @@ export const secretReplicationServiceFactory = ({
       pickOnlyImportIds,
       _deDupeReplicationQueue: deDupeReplicationQueue,
       _deDupeQueue: deDupeQueue
-    } = job.data;
+    } = job.data; // source import details (this is where the secrets are to be synced from)
 
     // filter for  initial filling
     let secretImports = await secretImportDAL.find({
@@ -97,8 +97,10 @@ export const secretReplicationServiceFactory = ({
       : secretImports;
     if (!secretImports.length || !secrets.length) return;
 
-    // unfiltered secrets to be replicated
+    // unfiltered secrets to be replicated (will fetch the latest versions in case another queue already processed this request)
     const toBeReplicatedSecrets = await secretReplicationDAL.findSecretVersions({ folderId, secrets });
+
+    // case: https://www.notion.so/infisical/Secret-Replication-6907fbe3130c4124976f7cba1b9fc4c7
     const replicatedSecrets = toBeReplicatedSecrets.filter(
       ({ version, latestReplicatedVersion, secretBlindIndex }) =>
         secretBlindIndex && (version === 1 || latestReplicatedVersion <= version)