dynamically generate reload tasks based on debug versions of quickstart configs

Author: chakru-r

docker/build.gradle

@@ -80,11 +80,30 @@ ext {
                     preserveVolumes: true
             ]
     ]
+
+    //  only for debug variants of quickstart to enable <variant>Reload tasks. 
+    // The actual service name needs the profile to be appended,  <container-name>-<profile>
+    moduleToContainer = [
+        ':metadata-service:war': 'datahub-gms',
+        ':datahub-frontend': 'frontend',
+        ':docker:datahub-ingestion': 'datahub-ingestion',
+        ':docker:mysql-setup': 'datahub-mysql-setup',
+        ':docker:kafka-setup': 'datahub-kafka-setup',
+        ':datahub-upgrade': 'system-update',
+        ':docker:elasticsearch-setup': 'datahub-elasticsearch-setup',
+        ':docker:postgres-setup': 'datahub-postgres-setup',
+        ':metadata-jobs:mce-consumer-job': 'datahub-mce-consumer',
+        ':metadata-jobs:mae-consumer-job': 'datahub-mae-consumer',
+
+    ]
 }
 
 // Register all quickstart tasks
 quickstart_configs.each { taskName, config ->
-    tasks.register(taskName)
+    tasks.register(taskName) {
+        group = 'quickstart'
+    }
+    
 }
 
 // Dynamically create all quickstart tasks and configurations
@@ -169,6 +188,7 @@ tasks.register('minDockerCompose2.20', Exec) {
 }
 
 tasks.register('quickstartNuke') {
+    group = 'quickstart'
     doFirst {
         quickstart_configs.each { taskName, config ->
             dockerCompose."${taskName}".removeVolumes = !config.preserveVolumes
@@ -178,6 +198,7 @@ tasks.register('quickstartNuke') {
 }
 
 tasks.register('quickstartDown') {
+    group = 'quickstart'
     finalizedBy(tasks.withType(ComposeDownForced))
 }
 
@@ -186,39 +207,36 @@ tasks.withType(ComposeUp).configureEach {
     dependsOn tasks.named("minDockerCompose2.20")
 }
 
-task debugReload(type: Exec) {
-    //TODO: Generate *reloadTasks for all quickStart configs. Need to move the moduleToContainer to ext and define mappings for all containers.   
-    // Map of module paths to their corresponding container names
-    def moduleToContainer = [
-        ':metadata-service:war': 'datahub-gms-debug',
-        ':datahub-upgrade': 'system-update-debug',
-        ':datahub-frontend': 'frontend-debug'
-    ]
-    
-    doFirst {
-        // Get all tasks that were executed as part of this build
-        def executedTasks = project.gradle.taskGraph.allTasks.findAll { it.state.executed }
-        
-        // Find which modules actually had work done
-        def containersToRestart = []
-        moduleToContainer.each { modulePath, containerName ->
-            def moduleProject = project.project(modulePath)
-            def dockerPrepareTask = moduleProject.tasks.findByName('dockerPrepare')
-            
-            if (dockerPrepareTask && executedTasks.contains(dockerPrepareTask) && !dockerPrepareTask.state.upToDate) {
-                containersToRestart << containerName
+// Register all quickstart Reload tasks. For quickstartDebug, the reload task is DebugReload. (Taskname without quickstart prefix)
+quickstart_configs.each { taskName, config ->
+    if (config.isDebug) {
+        def reloadTaskName = taskName.replaceFirst(/^quickstart/, "")
+        tasks.register("${reloadTaskName}Reload", Exec) {
+            dependsOn tasks.named("${taskName}PrepareAll")
+            group = 'quickstart'
+            description = "Build and reload only changed containers for the ${taskName} task"
+            doFirst {
+                def executedTasks = project.gradle.taskGraph.allTasks.findAll { it.state.executed }
+                def containersToRestart = []
+
+                moduleToContainer.each { modulePath, containerName ->
+                    def moduleProject = project.project(modulePath)
+                    def dockerPrepareTask = moduleProject.tasks.findByName('dockerPrepare')
+                    
+                    if (dockerPrepareTask && executedTasks.contains(dockerPrepareTask) && !dockerPrepareTask.state.upToDate) {
+                        containersToRestart << "${containerName}-${config.profile}"
+                    }
+                }
+                
+                // Only restart containers that had their modules rebuilt
+                if (containersToRestart) {
+                    def cmd = ["docker compose -p datahub --profile ${config.profile}"] + ['-f', compose_base] + ['restart'] + containersToRestart
+                    commandLine 'bash', '-c', cmd.join(" ")
+                } else {
+                    // If no containers need restart, make this a no-op
+                    commandLine 'bash', '-c', 'echo "No containers need restarting - all modules are up to date"'
+                }    
             }
         }
-        
-        // Only restart containers that had their modules rebuilt
-        if (containersToRestart) {
-            def cmd = ['docker compose -p datahub --profile debug'] + ['-f', compose_base] + ['restart'] + containersToRestart
-            commandLine 'bash', '-c', cmd.join(" ")
-        } else {
-            // If no containers need restart, make this a no-op
-            commandLine 'bash', '-c', 'echo "No containers need restarting - all modules are up to date"'
-        }
     }
-    
-    dependsOn tasks.named("quickstartDebugPrepareAll")
-}
+}

docker/profiles/docker-compose.frontend.yml

@@ -96,7 +96,7 @@ services:
     profiles:
       - debug-consumers
     depends_on:
-      system-update-debug:
+      system-update-debug-consumers:
         condition: service_completed_successfully
   frontend-debug-neo4j:
     <<: *datahub-frontend-service-dev

docker/profiles/docker-compose.gms.yml

@@ -248,19 +248,22 @@ services:
         condition: service_completed_successfully
       kafka-setup:
         condition: service_completed_successfully
-  system-update-debug:
+  system-update-debug: &system-update-debug
     <<: *datahub-system-update-service-dev
     profiles:
       - debug
       - debug-backend
-      - debug-consumers
     depends_on:
       mysql-setup-dev:
         condition: service_completed_successfully
       opensearch-setup-dev:
         condition: service_completed_successfully
       kafka-setup-dev:
         condition: service_completed_successfully
+  system-update-debug-consumers: # for consistent naming based on profile
+    <<: *system-update-debug
+    profiles:
+      - debug-consumers
   system-update-debug-elasticsearch:
     <<: *datahub-system-update-service-dev
     profiles:
@@ -386,7 +389,7 @@ services:
       MAE_CONSUMER_ENABLED: false
       MCE_CONSUMER_ENABLED: false
     depends_on:
-      system-update-debug:
+      system-update-debug-consumers:
         condition: service_completed_successfully
   datahub-gms-debug-neo4j:
     <<: *datahub-gms-service-dev
@@ -414,7 +417,7 @@ services:
     depends_on:
       datahub-gms-quickstart-consumers:
         condition: service_healthy
-  datahub-mae-consumer-quickstart-consumers-dev:
+  datahub-mae-consumer-debug-consumers:
     <<: *datahub-mae-consumer-service-dev
     profiles:
       - debug-consumers
@@ -431,7 +434,7 @@ services:
     depends_on:
       datahub-gms-quickstart-consumers:
         condition: service_healthy
-  datahub-mce-consumer-quickstart-consumers-dev:
+  datahub-mce-consumer-debug-consumers:
     <<: *datahub-mce-consumer-service-dev
     profiles:
       - debug-consumers