Move updateLayout analytics event to ContextLayoutRefactoringService

Author: subrata71

app/server/appsmith-server/src/main/java/com/appsmith/server/layouts/UpdateLayoutServiceCEImpl.java

@@ -10,8 +10,6 @@
 import com.appsmith.server.constants.FieldName;
 import com.appsmith.server.domains.ExecutableDependencyEdge;
 import com.appsmith.server.domains.Layout;
-import com.appsmith.server.domains.NewPage;
-import com.appsmith.server.domains.User;
 import com.appsmith.server.dtos.LayoutDTO;
 import com.appsmith.server.dtos.UpdateMultiplePageLayoutDTO;
 import com.appsmith.server.exceptions.AppsmithError;
@@ -87,29 +85,22 @@ private Mono<Boolean> sendUpdateLayoutAnalyticsEvent(
             boolean isSuccess,
             Throwable error,
             CreatorContextType creatorType) {
-        return Mono.zip(sessionUserService.getCurrentUser(), newPageService.getByIdWithoutPermissionCheck(creatorId))
-                .flatMap(tuple -> {
-                    User t1 = tuple.getT1();
-                    NewPage t2 = tuple.getT2();
-
-                    final Map<String, Object> data = Map.of(
-                            "username",
-                            t1.getUsername(),
-                            "appId",
-                            t2.getApplicationId(),
-                            "creatorId",
-                            creatorId,
-                            "creatorType",
-                            creatorType,
-                            "layoutId",
-                            layoutId,
-                            "isSuccessfulExecution",
-                            isSuccess,
-                            "error",
-                            error == null ? "" : error.getMessage());
+        return contextLayoutRefactorResolver
+                .getContextLayoutRefactorHelper(creatorType)
+                .getContextForAnalytics(creatorId)
+                .flatMap(contextInfo -> {
+                    final Map<String, Object> data = Map.ofEntries(
+                            Map.entry("username", contextInfo.getUsername()),
+                            Map.entry("artifactType", contextInfo.getArtifactType()),
+                            Map.entry("artifactId", contextInfo.getArtifactId()),
+                            Map.entry("creatorId", creatorId),
+                            Map.entry("creatorType", creatorType),
+                            Map.entry("layoutId", layoutId),
+                            Map.entry("isSuccessfulExecution", isSuccess),
+                            Map.entry("error", error == null ? "" : error.getMessage()));
 
                     return analyticsService
-                            .sendObjectEvent(AnalyticsEvents.UPDATE_LAYOUT, t2, data)
+                            .sendObjectEvent(AnalyticsEvents.UPDATE_LAYOUT, contextInfo.getDomain(), data)
                             .thenReturn(isSuccess);
                 })
                 .onErrorResume(e -> {

app/server/appsmith-server/src/main/java/com/appsmith/server/newpages/refactors/PageLayoutRefactoringServiceImpl.java

@@ -1,6 +1,7 @@
 package com.appsmith.server.newpages.refactors;
 
 import com.appsmith.server.applications.base.ApplicationService;
+import com.appsmith.server.constants.ArtifactType;
 import com.appsmith.server.constants.FieldName;
 import com.appsmith.server.domains.Layout;
 import com.appsmith.server.domains.NewPage;
@@ -11,7 +12,9 @@
 import com.appsmith.server.exceptions.AppsmithError;
 import com.appsmith.server.exceptions.AppsmithException;
 import com.appsmith.server.newpages.base.NewPageService;
+import com.appsmith.server.refactors.AnalyticsContextDTO;
 import com.appsmith.server.refactors.ContextLayoutRefactoringService;
+import com.appsmith.server.services.SessionUserService;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
@@ -27,6 +30,7 @@
 public class PageLayoutRefactoringServiceImpl implements ContextLayoutRefactoringService<NewPage, PageDTO> {
     private final NewPageService newPageService;
     private final ApplicationService applicationService;
+    private final SessionUserService sessionUserService;
 
     @Override
     public Mono<PageDTO> updateContext(String contextId, LayoutContainer dto) {
@@ -106,4 +110,17 @@ public String getArtifactId(RefactoringMetaDTO refactoringMetaDTO) {
     public void setUpdatedContext(RefactoringMetaDTO refactoringMetaDTO, LayoutContainer updatedContext) {
         refactoringMetaDTO.setUpdatedPage((PageDTO) updatedContext);
     }
+
+    @Override
+    public Mono<AnalyticsContextDTO> getContextForAnalytics(String contextId) {
+        return Mono.zip(sessionUserService.getCurrentUser(), newPageService.getByIdWithoutPermissionCheck(contextId))
+                .map(tuple -> {
+                    return AnalyticsContextDTO.builder()
+                            .username(tuple.getT1().getUsername())
+                            .artifactType(ArtifactType.APPLICATION)
+                            .artifactId(tuple.getT2().getApplicationId())
+                            .domain(tuple.getT2())
+                            .build();
+                });
+    }
 }

app/server/appsmith-server/src/main/java/com/appsmith/server/refactors/AnalyticsContextDTO.java

@@ -0,0 +1,18 @@
+package com.appsmith.server.refactors;
+
+import com.appsmith.external.models.BaseDomain;
+import com.appsmith.server.constants.ArtifactType;
+import lombok.Builder;
+import lombok.Data;
+
+/**
+ * DTO class that holds context information used for analytics
+ */
+@Data
+@Builder
+public class AnalyticsContextDTO {
+    private String username;
+    private ArtifactType artifactType;
+    private String artifactId;
+    private BaseDomain domain;
+}

app/server/appsmith-server/src/main/java/com/appsmith/server/refactors/ContextLayoutRefactoringService.java

@@ -104,4 +104,13 @@ Mono<Integer> getEvaluationVersionMono(
      * @param updatedContext The updated layout container to persist in metadata
      */
     void setUpdatedContext(RefactoringMetaDTO refactoringMetaDTO, LayoutContainer updatedContext);
+
+    /**
+     * Retrieves context information needed for analytics based on the context ID.
+     * This includes the username of the current user, the artifact ID, and the domain object.
+     *
+     * @param contextId The unique identifier of the context
+     * @return A Mono emitting the analytics context information
+     */
+    Mono<AnalyticsContextDTO> getContextForAnalytics(String contextId);
 }