added support for manual syncing of integrations

2026-09-22 13:39:35 +00:00 · 2024-05-21 13:56:44 +08:00
parent 9253c69325
commit 629bd9b7c6
7 changed files with 229 additions and 41 deletions
--- a/backend/src/ee/services/audit-log/audit-log-types.ts
+++ b/backend/src/ee/services/audit-log/audit-log-types.ts
@@ -51,6 +51,7 @@ export enum EventType {
  UNAUTHORIZE_INTEGRATION = "unauthorize-integration",
  CREATE_INTEGRATION = "create-integration",
  DELETE_INTEGRATION = "delete-integration",
+  MANUAL_SYNC_INTEGRATION = "manual-sync-integration",
  ADD_TRUSTED_IP = "add-trusted-ip",
  UPDATE_TRUSTED_IP = "update-trusted-ip",
  DELETE_TRUSTED_IP = "delete-trusted-ip",
@@ -281,6 +282,25 @@ interface DeleteIntegrationEvent {
  };
 }

+interface ManualSyncIntegrationEvent {
+  type: EventType.MANUAL_SYNC_INTEGRATION;
+  metadata: {
+    integrationId: string;
+    integration: string;
+    environment: string;
+    secretPath: string;
+    url?: string;
+    app?: string;
+    appId?: string;
+    targetEnvironment?: string;
+    targetEnvironmentId?: string;
+    targetService?: string;
+    targetServiceId?: string;
+    path?: string;
+    region?: string;
+  };
+}
+
 interface AddTrustedIPEvent {
  type: EventType.ADD_TRUSTED_IP;
  metadata: {
@@ -791,6 +811,7 @@ export type Event =
  | UnauthorizeIntegrationEvent
  | CreateIntegrationEvent
  | DeleteIntegrationEvent
+  | ManualSyncIntegrationEvent
  | AddTrustedIPEvent
  | UpdateTrustedIPEvent
  | DeleteTrustedIPEvent
--- a/backend/src/lib/api-docs/constants.ts
+++ b/backend/src/lib/api-docs/constants.ts
@@ -649,6 +649,9 @@ export const INTEGRATION = {
  },
  DELETE: {
    integrationId: "The ID of the integration object."
+  },
+  SYNC: {
+    integrationId: "The ID of the integration object to manually sync"
  }
 };

--- a/backend/src/server/routes/v1/integration-router.ts
+++ b/backend/src/server/routes/v1/integration-router.ts
@@ -262,5 +262,64 @@ export const registerIntegrationRouter = async (server: FastifyZodProvider) => {
    }
  });

-  // TODO(akhilmhdh-pg): manual sync
+  server.route({
+    method: "POST",
+    url: "/:integrationId/sync",
+    config: {
+      rateLimit: writeLimit
+    },
+    schema: {
+      description: "Manually trigger sync of an integration by integration id",
+      security: [
+        {
+          bearerAuth: []
+        }
+      ],
+      params: z.object({
+        integrationId: z.string().trim().describe(INTEGRATION.SYNC.integrationId)
+      }),
+      response: {
+        200: z.object({
+          integration: IntegrationsSchema
+        })
+      }
+    },
+    onRequest: verifyAuth([AuthMode.JWT, AuthMode.IDENTITY_ACCESS_TOKEN]),
+    handler: async (req) => {
+      const integration = await server.services.integration.syncIntegration({
+        actorId: req.permission.id,
+        actor: req.permission.type,
+        actorAuthMethod: req.permission.authMethod,
+        actorOrgId: req.permission.orgId,
+        id: req.params.integrationId
+      });
+
+      await server.services.auditLog.createAuditLog({
+        ...req.auditLogInfo,
+        projectId: integration.projectId,
+        event: {
+          type: EventType.MANUAL_SYNC_INTEGRATION,
+          // eslint-disable-next-line
+          metadata: shake({
+            integrationId: integration.id,
+            integration: integration.integration,
+            environment: integration.environment.slug,
+            secretPath: integration.secretPath,
+            url: integration.url,
+            app: integration.app,
+            appId: integration.appId,
+            targetEnvironment: integration.targetEnvironment,
+            targetEnvironmentId: integration.targetEnvironmentId,
+            targetService: integration.targetService,
+            targetServiceId: integration.targetServiceId,
+            path: integration.path,
+            region: integration.region
+            // eslint-disable-next-line
+          }) as any
+        }
+      });
+
+      return { integration };
+    }
+  });
 };
--- a/backend/src/services/integration/integration-service.ts
+++ b/backend/src/services/integration/integration-service.ts
@@ -9,7 +9,12 @@ import { TIntegrationAuthDALFactory } from "../integration-auth/integration-auth
 import { TSecretQueueFactory } from "../secret/secret-queue";
 import { TSecretFolderDALFactory } from "../secret-folder/secret-folder-dal";
 import { TIntegrationDALFactory } from "./integration-dal";
-import { TCreateIntegrationDTO, TDeleteIntegrationDTO, TUpdateIntegrationDTO } from "./integration-types";
+import {
+  TCreateIntegrationDTO,
+  TDeleteIntegrationDTO,
+  TSyncIntegrationDTO,
+  TUpdateIntegrationDTO
+} from "./integration-types";

 type TIntegrationServiceFactoryDep = {
  integrationDAL: TIntegrationDALFactory;
@@ -201,10 +206,35 @@ export const integrationServiceFactory = ({
    return integrations;
  };

+  const syncIntegration = async ({ id, actorId, actor, actorOrgId, actorAuthMethod }: TSyncIntegrationDTO) => {
+    const integration = await integrationDAL.findById(id);
+    if (!integration) {
+      throw new BadRequestError({ message: "Integration not found" });
+    }
+
+    const { permission } = await permissionService.getProjectPermission(
+      actor,
+      actorId,
+      integration.projectId,
+      actorAuthMethod,
+      actorOrgId
+    );
+    ForbiddenError.from(permission).throwUnlessCan(ProjectPermissionActions.Read, ProjectPermissionSub.Integrations);
+
+    await secretQueueService.syncIntegrations({
+      environment: integration.environment.slug,
+      secretPath: integration.secretPath,
+      projectId: integration.projectId
+    });
+
+    return { ...integration, envId: integration.environment.id };
+  };
+
  return {
    createIntegration,
    updateIntegration,
    deleteIntegration,
-    listIntegrationByProject
+    listIntegrationByProject,
+    syncIntegration
  };
 };
--- a/backend/src/services/integration/integration-types.ts
+++ b/backend/src/services/integration/integration-types.ts
@@ -59,3 +59,7 @@ export type TUpdateIntegrationDTO = {
 export type TDeleteIntegrationDTO = {
  id: string;
 } & Omit<TProjectPermission, "projectId">;
+
+export type TSyncIntegrationDTO = {
+  id: string;
+} & Omit<TProjectPermission, "projectId">;
--- a/frontend/src/hooks/api/integrations/queries.tsx
+++ b/frontend/src/hooks/api/integrations/queries.tsx
@@ -1,9 +1,11 @@
+import { MutableRefObject } from "react";
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";

+import { createNotification } from "@app/components/notifications";
 import { apiRequest } from "@app/config/request";

 import { workspaceKeys } from "../workspace/queries";
-import { TCloudIntegration } from "./types";
+import { TCloudIntegration, TIntegration } from "./types";

 export const integrationQueryKeys = {
  getIntegrations: () => ["integrations"] as const
@@ -110,3 +112,32 @@ export const useDeleteIntegration = () => {
    }
  });
 };
+
+export const useSyncIntegration = (pollingRef: MutableRefObject<NodeJS.Timeout | null>) => {
+  const queryClient = useQueryClient();
+
+  return useMutation<{}, {}, { id: string; workspaceId: string; lastUsed: string }>({
+    mutationFn: ({ id }) => apiRequest.post(`/api/v1/integration/${id}/sync`),
+    onSuccess: (_, { id, workspaceId, lastUsed }) => {
+      // eslint-disable-next-line no-param-reassign
+      pollingRef.current = setInterval(() => {
+        const integrations: TIntegration[] | undefined = queryClient.getQueryData(
+          workspaceKeys.getWorkspaceIntegrations(workspaceId)
+        );
+
+        const integration = integrations?.find((entry) => entry.id === id);
+        if (!integration || integration.lastUsed !== lastUsed) {
+          createNotification({
+            text: "Integration successfully synced",
+            type: "success"
+          });
+          clearInterval(pollingRef.current as NodeJS.Timeout);
+          // eslint-disable-next-line no-param-reassign
+          pollingRef.current = null;
+          return;
+        }
+        queryClient.invalidateQueries(workspaceKeys.getWorkspaceIntegrations(workspaceId));
+      }, 3500);
+    }
+  });
+};
--- a/frontend/src/views/IntegrationsPage/components/IntegrationsSection/IntegrationsSection.tsx
+++ b/frontend/src/views/IntegrationsPage/components/IntegrationsSection/IntegrationsSection.tsx
@@ -1,6 +1,7 @@
+import { useEffect, useRef } from "react";
 import Link from "next/link";
 import { faCalendarCheck } from "@fortawesome/free-regular-svg-icons";
-import { faArrowRight, faXmark } from "@fortawesome/free-solid-svg-icons";
+import { faArrowRight, faRefresh, faXmark } from "@fortawesome/free-solid-svg-icons";
 import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
 import { format } from "date-fns";
 import { integrationSlugNameMapping } from "public/data/frequentConstants";
@@ -9,6 +10,7 @@ import { ProjectPermissionCan } from "@app/components/permissions";
 import {
  Alert,
  AlertDescription,
+  Button,
  DeleteActionModal,
  EmptyState,
  FormLabel,
@@ -19,6 +21,7 @@ import {
 } from "@app/components/v2";
 import { ProjectPermissionActions, ProjectPermissionSub } from "@app/context";
 import { usePopUp } from "@app/hooks";
+import { useSyncIntegration } from "@app/hooks/api/integrations/queries";
 import { TIntegration } from "@app/hooks/api/types";

 type Props = {
@@ -42,6 +45,17 @@ export const IntegrationsSection = ({
    "deleteConfirmation"
  ] as const);

+  const syncPollingRef = useRef<NodeJS.Timeout | null>(null);
+  const { mutate: syncIntegration } = useSyncIntegration(syncPollingRef);
+
+  useEffect(() => {
+    return () => {
+      if (syncPollingRef.current) {
+        clearInterval(syncPollingRef.current);
+      }
+    };
+  }, []);
+
  return (
    <div className="mb-8">
      <div className="mx-4 mb-4 mt-6 flex flex-col items-start justify-between px-2 text-xl">
@@ -193,49 +207,75 @@ export const IntegrationsSection = ({
              </div>
              <div className="mt-[1.5rem] flex cursor-default">
                {integration.isSynced != null && integration.lastUsed != null && (
-                  <Tag
-                    key={integration.id}
-                    className={integration.isSynced ? "bg-green/50" : "bg-red/80"}
-                  >
-                    <Tooltip
-                      center
-                      className="max-w-xs whitespace-normal break-words"
-                      content={
-                        <div className="flex max-h-[10rem] flex-col overflow-auto ">
-                          <div className="flex self-start">
-                            <FontAwesomeIcon
-                              icon={faCalendarCheck}
-                              className="pt-0.5 pr-2 text-sm"
-                            />
-                            <div className="text-sm">Last sync</div>
-                          </div>
-                          <div className="pl-5 text-left text-xs">
-                            {format(new Date(integration.lastUsed), "yyyy-MM-dd, hh:mm aaa")}
-                          </div>
-                          {!integration.isSynced && (
-                            <>
-                              <div className="mt-2 flex self-start">
-                                <FontAwesomeIcon icon={faXmark} className="pt-1 pr-2 text-sm" />
-                                <div className="text-sm">Fail reason</div>
-                              </div>
-                              <div className="pl-5 text-left text-xs">
-                                {integration.syncMessage}
-                              </div>
-                            </>
-                          )}
-                        </div>
-                      }
+                  <>
+                    <Tag
+                      key={integration.id}
+                      className={integration.isSynced ? "bg-green/50" : "bg-red/80"}
                    >
-                      <div className="px-2 text-white">Sync Status</div>
-                    </Tooltip>
-                  </Tag>
+                      <Tooltip
+                        center
+                        className="max-w-xs whitespace-normal break-words"
+                        content={
+                          <div className="flex max-h-[10rem] flex-col overflow-auto ">
+                            <div className="flex self-start">
+                              <FontAwesomeIcon
+                                icon={faCalendarCheck}
+                                className="pt-0.5 pr-2 text-sm"
+                              />
+                              <div className="text-sm">Last sync</div>
+                            </div>
+                            <div className="pl-5 text-left text-xs">
+                              {format(new Date(integration.lastUsed), "yyyy-MM-dd, hh:mm aaa")}
+                            </div>
+                            {!integration.isSynced && (
+                              <>
+                                <div className="mt-2 flex self-start">
+                                  <FontAwesomeIcon icon={faXmark} className="pt-1 pr-2 text-sm" />
+                                  <div className="text-sm">Fail reason</div>
+                                </div>
+                                <div className="pl-5 text-left text-xs">
+                                  {integration.syncMessage}
+                                </div>
+                              </>
+                            )}
+                          </div>
+                        }
+                      >
+                        <div className="px-2 text-white">Sync Status</div>
+                      </Tooltip>
+                    </Tag>
+                    {!integration.isSynced && integration.lastUsed != null && (
+                      <div className="mr-1 flex items-end opacity-80 duration-200 hover:opacity-100">
+                        <Tooltip
+                          className="text-center"
+                          content="Manually sync integration secrets"
+                        >
+                          <Button
+                            onClick={() =>
+                              syncIntegration({
+                                workspaceId,
+                                id: integration.id,
+                                lastUsed: integration.lastUsed as string
+                              })
+                            }
+                            isLoading={!!syncPollingRef.current}
+                            className="max-w-[2.5rem]"
+                            isDisabled={!!syncPollingRef.current}
+                            colorSchema="primary"
+                          >
+                            <FontAwesomeIcon icon={faRefresh} className="px-1" />
+                          </Button>
+                        </Tooltip>
+                      </div>
+                    )}
+                  </>
                )}
                <ProjectPermissionCan
                  I={ProjectPermissionActions.Delete}
                  a={ProjectPermissionSub.Integrations}
                >
                  {(isAllowed: boolean) => (
-                    <div className="ml-2 flex items-end opacity-80 duration-200 hover:opacity-100">
+                    <div className="flex items-end opacity-80 duration-200 hover:opacity-100">
                      <Tooltip content="Remove Integration">
                        <IconButton
                          onClick={() => handlePopUpOpen("deleteConfirmation", integration)}