feat: updated ui to reflect secret import and approval

2026-09-22 13:39:35 +00:00 · 2024-05-02 19:47:33 +05:30
parent c9d6c5c5f7
commit 51c1487ed1
17 changed files with 103 additions and 47 deletions
--- a/backend/src/server/routes/index.ts
+++ b/backend/src/server/routes/index.ts
@@ -677,7 +677,9 @@ export const registerRoutes = async (
    secretApprovalPolicyService,
    secretBlindIndexDAL,
    secretApprovalRequestDAL,
-    secretApprovalRequestSecretDAL
+    secretApprovalRequestSecretDAL,
+    secretQueueService,
+    snapshotService
  });
  const secretRotationQueue = secretRotationQueueFactory({
    telemetryService,
--- a/backend/src/services/secret-import/secret-import-fns.ts
+++ b/backend/src/services/secret-import/secret-import-fns.ts
@@ -79,7 +79,7 @@ export const fnSecretsFromImports = async ({
  let secretsFromDeeperImports: TSecretImportSecrets[] = [];
  if (deeperImports.length) {
    secretsFromDeeperImports = await fnSecretsFromImports({
-      allowedImports: deeperImports,
+      allowedImports: deeperImports.filter(({ isReplication }) => !isReplication),
      secretImportDAL,
      folderDAL,
      secretDAL,
--- a/backend/src/services/secret-import/secret-import-service.ts
+++ b/backend/src/services/secret-import/secret-import-service.ts
@@ -8,6 +8,7 @@ import { TProjectDALFactory } from "../project/project-dal";
 import { TProjectEnvDALFactory } from "../project-env/project-env-dal";
 import { TSecretDALFactory } from "../secret/secret-dal";
 import { TSecretQueueFactory } from "../secret/secret-queue";
+import { SecretOperations } from "../secret/secret-types";
 import { TSecretFolderDALFactory } from "../secret-folder/secret-folder-dal";
 import { TSecretImportDALFactory } from "./secret-import-dal";
 import { fnSecretsFromImports } from "./secret-import-fns";
@@ -26,7 +27,7 @@ type TSecretImportServiceFactoryDep = {
  projectDAL: Pick<TProjectDALFactory, "checkProjectUpgradeStatus">;
  projectEnvDAL: TProjectEnvDALFactory;
  permissionService: Pick<TPermissionServiceFactory, "getProjectPermission">;
-  secretQueueService: Pick<TSecretQueueFactory, "syncSecrets">;
+  secretQueueService: Pick<TSecretQueueFactory, "syncSecrets" | "replicateSecrets">;
 };

 const ERR_SEC_IMP_NOT_FOUND = new BadRequestError({ message: "Secret import not found" });
@@ -53,7 +54,7 @@ export const secretImportServiceFactory = ({
    isReplication,
    path
  }: TCreateSecretImportDTO) => {
-    const { permission } = await permissionService.getProjectPermission(
+    const { permission, membership } = await permissionService.getProjectPermission(
      actor,
      actorId,
      projectId,
@@ -108,12 +109,27 @@ export const secretImportServiceFactory = ({
      );
    });

-    await secretQueueService.syncSecrets({
-      secretPath: secImport.importPath,
-      projectId,
-      environmentSlug: importEnv.slug,
-      excludeReplication: true
-    });
+    if (secImport.isReplication) {
+      const importedSecrets = await secretDAL.find({ folderId: sourceFolder?.id });
+      await secretQueueService.replicateSecrets({
+        secretPath: secImport.importPath,
+        projectId,
+        environmentSlug: importEnv.slug,
+        pickOnlyImportIds: [secImport.id],
+        folderId: sourceFolder?.id as string,
+        secrets: importedSecrets.map(({ id, version }) => ({ operation: SecretOperations.Create, version, id })),
+        // TODO(akhilmhdh): approval based replication this will fail for identity
+        membershipId: membership?.id as string,
+        environmentId: importEnv.id
+      });
+    } else {
+      await secretQueueService.syncSecrets({
+        secretPath: secImport.importPath,
+        projectId,
+        environmentSlug: importEnv.slug,
+        excludeReplication: true
+      });
+    }

    return { ...secImport, importEnv };
  };
@@ -283,7 +299,7 @@ export const secretImportServiceFactory = ({
    if (!folder) return [];
    // this will already order by position
    // so anything based on this order will also be in right position
-    const secretImports = await secretImportDAL.find({ folderId: folder.id });
+    const secretImports = await secretImportDAL.find({ folderId: folder.id, isReplication: false });

    const allowedImports = secretImports.filter(({ importEnv, importPath }) =>
      permission.can(
--- a/backend/src/services/secret-replication/secret-replication-service.ts
+++ b/backend/src/services/secret-replication/secret-replication-service.ts
@@ -64,12 +64,15 @@ export const secretReplicationServiceFactory = ({
 }: TSecretReplicationServiceFactoryDep) => {
  queueService.start(QueueName.SecretReplication, async (job) => {
    logger.info(job.data, "Replication started");
-    const { secrets, folderId, secretPath, environmentId, projectId, membershipId } = job.data;
-    const secretImports = await secretImportDAL.find({
+    const { secrets, folderId, secretPath, environmentId, projectId, membershipId, pickOnlyImportIds } = job.data;
+    let secretImports = await secretImportDAL.find({
      importPath: secretPath,
      importEnv: environmentId,
      isReplication: true
    });
+    secretImports = pickOnlyImportIds
+      ? secretImports.filter(({ id }) => pickOnlyImportIds?.includes(id))
+      : secretImports;
    if (!secretImports.length || !secrets.length) return;

    // unfiltered secrets to be replicated
--- a/backend/src/services/secret/secret-queue.ts
+++ b/backend/src/services/secret/secret-queue.ts
@@ -143,6 +143,18 @@ export const secretQueueFactory = ({
    });
  };

+  const replicateSecrets = async (dto: TSyncSecretsDTO) => {
+    await queueService.queue(QueueName.SecretReplication, QueueJobs.SecretReplication, dto, {
+      attempts: 3,
+      backoff: {
+        type: "exponential",
+        delay: 2000
+      },
+      removeOnComplete: true,
+      removeOnFail: true
+    });
+  };
+
  const removeSecretReminder = async (dto: TRemoveSecretReminderDTO) => {
    const appCfg = getConfig();
    await queueService.stopRepeatableJob(
@@ -361,22 +373,17 @@ export const secretQueueFactory = ({
      }
    );
    await syncIntegrations({ secretPath, projectId, environment });
-    if (!excludeReplication) {
-      await queueService.queue(
-        QueueName.SecretReplication,
-        QueueJobs.SecretReplication,
-        { environmentId, projectId, secretPath, folderId, secrets, membershipId },
-        {
-          attempts: 3,
-          backoff: {
-            type: "exponential",
-            delay: 2000
-          },
-          removeOnComplete: true,
-          removeOnFail: true
-        }
-      );
-    }
+    if (!excludeReplication)
+      await replicateSecrets({
+        environmentId,
+        projectId,
+        secretPath,
+        folderId,
+        secrets,
+        membershipId,
+        excludeReplication,
+        environmentSlug: environment
+      });
  });

  queueService.start(QueueName.IntegrationSync, async (job) => {
@@ -394,7 +401,8 @@ export const secretQueueFactory = ({
      const linkSourceDto = {
        projectId,
        importEnv: folder.environment.id,
-        importPath: secretPath
+        importPath: secretPath,
+        isReplication: false
      };
      const imports = await secretImportDAL.find(linkSourceDto);

@@ -598,6 +606,7 @@ export const secretQueueFactory = ({
    syncIntegrations,
    addSecretReminder,
    removeSecretReminder,
-    handleSecretReminder
+    handleSecretReminder,
+    replicateSecrets
  };
 };
--- a/backend/src/services/secret/secret-service.ts
+++ b/backend/src/services/secret/secret-service.ts
@@ -550,7 +550,8 @@ export const secretServiceFactory = ({

    if (includeImports) {
      const secretImports = await secretImportDAL.findByFolderIds(paths.map((p) => p.folderId));
-      const allowedImports = secretImports.filter(({ importEnv, importPath }) =>
+      const allowedImports = secretImports.filter(({ importEnv, importPath, isReplication }) =>
+        !isReplication &&
        // if its service token allow full access over imported one
        actor === ActorType.SERVICE
          ? true
@@ -655,7 +656,7 @@ export const secretServiceFactory = ({
    // then search for imported secrets
    // here we consider the import order also thus starting from bottom
    if (!secret && includeImports) {
-      const secretImports = await secretImportDAL.find({ folderId });
+      const secretImports = await secretImportDAL.find({ folderId, isReplication: false });
      const allowedImports = secretImports.filter(({ importEnv, importPath }) =>
        // if its service token allow full access over imported one
        actor === ActorType.SERVICE
--- a/backend/src/services/secret/secret-types.ts
+++ b/backend/src/services/secret/secret-types.ts
@@ -389,6 +389,8 @@ export type TSyncSecretsDTO<T extends boolean = false> = {
      environmentId: string;
      folderId: string;
      membershipId: string;
+      // used for import creation to trigger replication
+      pickOnlyImportIds?: string[];
      secrets: {
        operation: SecretOperations;
        id: string;
--- a/frontend/src/hooks/api/secretApprovalRequest/queries.tsx
+++ b/frontend/src/hooks/api/secretApprovalRequest/queries.tsx
@@ -220,6 +220,7 @@ export const useGetSecretApprovalRequestCount = ({
 }) =>
  useQuery({
    queryKey: secretApprovalRequestKeys.count({ workspaceId }),
+    refetchInterval: 5000,
    queryFn: () => fetchSecretApprovalRequestCount({ workspaceId }),
    enabled: Boolean(workspaceId) && (options?.enabled ?? true)
  });
--- a/frontend/src/hooks/api/secretApprovalRequest/types.ts
+++ b/frontend/src/hooks/api/secretApprovalRequest/types.ts
@@ -44,6 +44,7 @@ export type TSecretApprovalSecChange = {

 export type TSecretApprovalRequest<J extends unknown = EncryptedSecret> = {
  id: string;
+  isReplication?: boolean;
  slug: string;
  createdAt: string;
  committerId: string;
--- a/frontend/src/hooks/api/secretImports/types.ts
+++ b/frontend/src/hooks/api/secretImports/types.ts
@@ -10,6 +10,7 @@ export type TSecretImport = {
  position: string;
  createdAt: string;
  updatedAt: string;
+  isReplication?: boolean;
 };

 export type TGetImportedFoldersByEnvDTO = {
--- a/frontend/src/hooks/api/secrets/queries.tsx
+++ b/frontend/src/hooks/api/secrets/queries.tsx
@@ -67,6 +67,7 @@ export const decryptSecrets = (
      env: encSecret.environment,
      key: secretKey,
      value: secretValue,
+      isReplicated: encSecret.isReplicated,
      tags: encSecret.tags,
      comment: secretComment,
      reminderRepeatDays: encSecret.secretReminderRepeatDays,
--- a/frontend/src/hooks/api/secrets/types.ts
+++ b/frontend/src/hooks/api/secrets/types.ts
@@ -14,6 +14,7 @@ export type EncryptedSecret = {
  secretValueIV: string;
  secretValueTag: string;
  __v: number;
+  isReplicated?: boolean;
  createdAt: string;
  updatedAt: string;
  skipMultilineEncoding?: boolean;
@@ -31,6 +32,7 @@ export type DecryptedSecret = {
  key: string;
  value: string;
  comment: string;
+  isReplicated?: boolean;
  reminderRepeatDays?: number | null;
  reminderNote?: string | null;
  tags: WsTag[];
--- a/frontend/src/views/SecretApprovalPage/components/SecretApprovalRequest/SecretApprovalRequest.tsx
+++ b/frontend/src/views/SecretApprovalPage/components/SecretApprovalRequest/SecretApprovalRequest.tsx
@@ -212,7 +212,8 @@ export const SecretApprovalRequest = () => {
                    createdAt,
                    policy,
                    reviewers,
-                    status
+                    status,
+                    isReplication
                  } = secretApproval;
                  const isApprover = policy?.approvers?.indexOf(myMembershipId || "") !== -1;
                  const isReviewed =
@@ -240,8 +241,9 @@ export const SecretApprovalRequest = () => {
                        Opened {formatDistance(new Date(createdAt), new Date())} ago by{" "}
                        {membersGroupById?.[committerId]?.user?.firstName}{" "}
                        {membersGroupById?.[committerId]?.user?.lastName} (
-                        {membersGroupById?.[committerId]?.user?.email}){" "}
-                        {isApprover && !isReviewed && status === "open" && "- Review required"}
+                        {membersGroupById?.[committerId]?.user?.email})
+                        {isReplication && "via replication"}
+                        {isApprover && !isReviewed && status === "open" && " - Review required"}
                      </span>
                    </div>
                  );
--- a/frontend/src/views/SecretApprovalPage/components/SecretApprovalRequest/components/SecretApprovalRequestChanges.tsx
+++ b/frontend/src/views/SecretApprovalPage/components/SecretApprovalRequest/components/SecretApprovalRequestChanges.tsx
@@ -185,6 +185,7 @@ export const SecretApprovalRequestChanges = ({
          <div className="flex flex-grow flex-col">
            <div className="mb-1 text-lg">
              {generateCommitText(secretApprovalRequestDetails.commits)}
+              {secretApprovalRequestDetails.isReplication && <span className="text-sm text-bunker-300"> (replication)</span>}
            </div>
            <div className="flex items-center text-sm text-bunker-300">
              {committer?.user?.firstName}
--- a/frontend/src/views/SecretMainPage/components/SecretImportListView/SecretImportItem.tsx
+++ b/frontend/src/views/SecretMainPage/components/SecretImportListView/SecretImportItem.tsx
@@ -11,7 +11,7 @@ import {
 import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";

 import { ProjectPermissionCan } from "@app/components/permissions";
-import { EmptyState, IconButton, SecretInput, TableContainer } from "@app/components/v2";
+import { EmptyState, IconButton, SecretInput, TableContainer, Tag } from "@app/components/v2";
 import { ProjectPermissionActions, ProjectPermissionSub } from "@app/context";
 import { useToggle } from "@app/hooks";

@@ -19,6 +19,7 @@ type Props = {
  onDelete: () => void;
  environment: string;
  secretPath?: string;
+  isReplication?: boolean;
  importEnvName: string;
  importEnvPath: string;
  importedSecrets: { key: string; value: string; overriden: { env: string; secretPath: string } }[];
@@ -27,11 +28,20 @@ type Props = {
 };

 // to show the environment and folder icon
-export const EnvFolderIcon = ({ env, secretPath }: { env: string; secretPath: string }) => (
+export const EnvFolderIcon = ({
+  env,
+  secretPath,
+  isReplication
+}: {
+  env: string;
+  secretPath: string;
+  isReplication?: boolean;
+}) => (
  <div className="inline-flex items-center space-x-2">
    <div style={{ minWidth: "96px" }}>{env || "-"}</div>
    {secretPath && (
      <div className="inline-flex items-center space-x-2 border-l border-mineshaft-600 pl-2">
+        {isReplication && <Tag size="xs">Replication Mode</Tag>}
        <FontAwesomeIcon icon={faFolder} className="text-md text-green-700" />
        <span>{secretPath}</span>
      </div>
@@ -44,6 +54,7 @@ export const SecretImportItem = ({
  id,
  importEnvName,
  importEnvPath,
+  isReplication,
  importedSecrets = [],
  searchTerm = "",
  secretPath,
@@ -92,7 +103,11 @@ export const SecretImportItem = ({
          <FontAwesomeIcon icon={faFileImport} />
        </div>
        <div className="flex flex-grow items-center px-4 py-2">
-          <EnvFolderIcon env={importEnvName || ""} secretPath={importEnvPath} />
+          <EnvFolderIcon
+            env={importEnvName || ""}
+            secretPath={importEnvPath}
+            isReplication={isReplication}
+          />
        </div>
        <div className="flex items-center space-x-4 border-l border-mineshaft-600 px-4 py-2">
          <ProjectPermissionCan
--- a/frontend/src/views/SecretMainPage/components/SecretImportListView/SecretImportListView.tsx
+++ b/frontend/src/views/SecretMainPage/components/SecretImportListView/SecretImportListView.tsx
@@ -90,7 +90,7 @@ export const SecretImportListView = ({
  const { popUp, handlePopUpOpen, handlePopUpClose, handlePopUpToggle } = usePopUp([
    "deleteSecretImport"
  ] as const);
-  
+
  const sensors = useSensors(
    useSensor(MouseSensor, {}),
    useSensor(TouchSensor, {}),
@@ -159,12 +159,13 @@ export const SecretImportListView = ({
      >
        <SortableContext items={items} strategy={verticalListSortingStrategy}>
          {items?.map((item) => {
-            const { importPath, importEnv, id } = item;
+            const { importPath, importEnv, id, isReplication } = item;
            return (
              <SecretImportItem
                searchTerm={searchTerm}
                key={`imported-env-${id}`}
                id={id}
+                isReplication={isReplication}
                importEnvPath={importPath}
                importEnvName={importEnv.name}
                importedSecrets={computeImportedSecretRows(
@@ -185,9 +186,8 @@ export const SecretImportListView = ({
        isOpen={popUp.deleteSecretImport.isOpen}
        deleteKey="unlink"
        title="Do you want to remove this secret import?"
-        subTitle={`This will unlink secrets from environment ${
-          (popUp.deleteSecretImport?.data as TSecretImport)?.importEnv
-        } of path ${(popUp.deleteSecretImport?.data as TSecretImport)?.importPath}?`}
+        subTitle={`This will unlink secrets from environment ${(popUp.deleteSecretImport?.data as TSecretImport)?.importEnv
+          } of path ${(popUp.deleteSecretImport?.data as TSecretImport)?.importPath}?`}
        onChange={(isOpen) => handlePopUpToggle("deleteSecretImport", isOpen)}
        onDeleteApproved={handleSecretImportDelete}
      />
--- a/frontend/src/views/SecretMainPage/components/SecretListView/SecretItem.tsx
+++ b/frontend/src/views/SecretMainPage/components/SecretListView/SecretItem.tsx
@@ -420,9 +420,8 @@ export const SecretItem = memo(
                      <Tooltip
                        content={
                          secretReminderRepeatDays && secretReminderRepeatDays > 0
-                            ? `Every ${secretReminderRepeatDays} day${
-                                Number(secretReminderRepeatDays) > 1 ? "s" : ""
-                              }
+                            ? `Every ${secretReminderRepeatDays} day${Number(secretReminderRepeatDays) > 1 ? "s" : ""
+                            }
                          `
                            : "Reminder"
                        }