From b32b669dafc96f825a75962863505773ae5d75e1 Mon Sep 17 00:00:00 2001
From: Rajat Agrawal <rajat@appsmith.com>
Date: Tue, 9 Jan 2024 09:54:16 +0530
Subject: [PATCH] chore: Add migration for adding indexes to actionCollection
 collection (#30087)

Fixes #30088

This PR adds an index to actionCollection collection on
unpublished.defaultResources.pageId keypath.

This is the most used keypath in the mongo db queries that can use an
index.

Relevant slack thread here.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Refactor**
- Improved database query performance by adding an index to enhance the
search efficiency on collections.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---
 ...tion043AddIndexActionCollectionPageID.java | 48 +++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration043AddIndexActionCollectionPageID.java

diff --git a/app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration043AddIndexActionCollectionPageID.java b/app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration043AddIndexActionCollectionPageID.java
new file mode 100644
index 0000000000..4067f1b919
--- /dev/null
+++ b/app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration043AddIndexActionCollectionPageID.java
@@ -0,0 +1,48 @@
+package com.appsmith.server.migrations.db.ce;
+
+import com.appsmith.server.domains.ActionCollection;
+import io.mongock.api.annotations.ChangeUnit;
+import io.mongock.api.annotations.Execution;
+import io.mongock.api.annotations.RollbackExecution;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.data.mongodb.UncategorizedMongoDbException;
+import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.data.mongodb.core.index.Index;
+
+import static com.appsmith.server.migrations.DatabaseChangelog1.dropIndexIfExists;
+import static com.appsmith.server.migrations.DatabaseChangelog1.ensureIndexes;
+import static com.appsmith.server.migrations.DatabaseChangelog1.makeIndex;
+
+@Slf4j
+@ChangeUnit(order = "043", id = "add-index-to-action-collection-default-resources-pageid", author = "")
+public class Migration043AddIndexActionCollectionPageID {
+    private final MongoTemplate mongoTemplate;
+    private static final String INDEX_KEYPATH = "unpublishedCollection.defaultResources.pageId";
+    private static final String PREVIOUS_INDEX_NAME = "unpublishedCollection.defaultResources.pageId_1";
+
+    public Migration043AddIndexActionCollectionPageID(MongoTemplate mongoTemplate) {
+        this.mongoTemplate = mongoTemplate;
+    }
+
+    @RollbackExecution
+    public void rollbackExecution() {}
+
+    @Execution
+    public void addIndexToActionCollectionCollection() {
+        Index index = makeIndex(INDEX_KEYPATH);
+
+        try {
+            dropIndexIfExists(mongoTemplate, ActionCollection.class, PREVIOUS_INDEX_NAME);
+            dropIndexIfExists(mongoTemplate, ActionCollection.class, INDEX_KEYPATH);
+
+            ensureIndexes(mongoTemplate, ActionCollection.class, index);
+        } catch (UncategorizedMongoDbException exception) {
+            log.error(
+                    "An error occurred while creating the index : {}, skipping the additon of index because of {}.",
+                    INDEX_KEYPATH,
+                    exception.getMessage());
+        } catch (Exception e) {
+            log.error("An error occurred while creating the index : {}", INDEX_KEYPATH, e);
+        }
+    }
+}