Add shell persistence methods

Author: johnsonr

.github/workflows/maven.yml

@@ -3,7 +3,7 @@
 
 # This workflow uses actions that are not certified by GitHub.
 # They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
+# separate terms of persistenceService, privacy policy, and support
 # documentation.
 
 name: Build

src/main/java/com/embabel/modernizer/agent/MigrationPointDto.java

@@ -6,12 +6,14 @@
 import com.embabel.agent.api.common.Ai;
 import com.embabel.agent.api.common.OperationContext;
 import com.embabel.coding.tools.bash.BashTools;
-import com.embabel.modernizer.entity.MigrationJob;
-import com.embabel.modernizer.entity.MigrationReport;
-import com.embabel.modernizer.service.MigrationService;
+import com.embabel.modernizer.entity.*;
+import com.embabel.modernizer.service.PersistenceService;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.lang.Nullable;
 
 import java.util.LinkedList;
 import java.util.List;
@@ -21,11 +23,40 @@
 @Agent(description = "Code modernization agent")
 public record ModernizerAgent(
         ModernizerConfig config,
-        MigrationService service
+        PersistenceService persistenceService
 ) {
 
     private final static Logger logger = LoggerFactory.getLogger(ModernizerAgent.class);
 
+    private record MigrationPointDto(
+            String filePath,
+            String description,
+            String recipeId) {
+    }
+
+    private record MigrationPointsDto(
+            List<MigrationPointDto> migrationPoints,
+            @JsonPropertyDescription("High-level overview of the migration points")
+            String overview
+    ) {
+    }
+
+    private record MigrationReportDto(
+            boolean success,
+            String notes,
+            @JsonProperty(access = JsonProperty.Access.READ_ONLY)
+            @Nullable String branch
+    ) {
+        /**
+         * Return a new instance identifying a branch that was used for this migration
+         */
+        public MigrationReportDto withBranch(String branch) {
+            return new MigrationReportDto(success, notes, branch);
+        }
+
+    }
+
+
     @Action
     public MigrationPoints migrationPoints(
             MigrationJob migrationJob,
@@ -37,56 +68,74 @@ public MigrationPoints migrationPoints(
                 .withToolObject(new BashTools(softwareProject.getRoot()))
                 .withTemplate("find_migration_points")
                 .createObject(
-                        MigrationPoints.class,
+                        MigrationPointsDto.class,
                         Map.of(
                                 "notes", migrationJob.getNotes(),
                                 "classifications", migrationJob.getCookbook().getRecipes())
                 );
         logger.info("{} migration points found: \n{}",
-                migrationPoints.migrationPoints().size(),
+                migrationPoints.migrationPoints.size(),
                 new ObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(migrationPoints));
-        return migrationPoints;
+        persistenceService.saveMigrationJob(migrationJob);
+        migrationJob.setMigrationPoints(new MigrationPoints(
+                migrationPoints.migrationPoints.stream().map(
+                        mp -> new MigrationPoint(
+                                mp.filePath(),
+                                mp.description(),
+                                mp.recipeId()
+                        )
+                ).toList(), migrationPoints.overview));
+        return migrationJob.getMigrationPoints();
     }
 
     @AchievesGoal(description = "Modernize codebase")
     @Action
-    public List<MigrationReport> modernize(
+    public MigrationsReport modernize(
             MigrationJob migrationJob,
             MigrationPoints migrationPoints,
             OperationContext context
     ) {
         var softwareProject = migrationJob.softwareProject();
-        var migrations = new LinkedList<MigrationReport>();
+        var migrationReports = new LinkedList<MigrationReport>();
         for (var classification : migrationJob.getCookbook().getRecipes()) {
             logger.info("Processing classification: {} - {}", classification.getRecipeId(), classification.getDescription());
 
             var originalBranch = softwareProject.currentBranch();
             var branchName = context.getAgentProcess().getId() + "_" + classification.getRecipeId().toLowerCase();
             var success = softwareProject.createAndCheckoutBranch(branchName);
             logger.info("Classification branch {} created from branch {} - {}", branchName, originalBranch, success);
-            migrations.addAll(context.parallelMap(
-                    migrationPoints.migrationPoints()
+            var dtos = context.parallelMap(
+                    migrationPoints.getMigrationPoints()
                             .stream()
-                            .filter(mp -> Objects.equals(mp.recipeId(), classification.getRecipeId())).toList(),
+                            .filter(mp -> Objects.equals(mp.getRecipeId(), classification.getRecipeId())).toList(),
                     1,
                     mp -> tryToFixIndividualMigrationPoint(
                             migrationJob,
                             mp, context.ai())
-            ));
+            );
+            migrationReports.addAll(dtos.stream().map(dto ->
+                    new MigrationReport(
+                            dto.success(),
+                            dto.notes(),
+                            dto.branch()
+                    )).toList());
             // Go back to the original branch
             logger.info("Switching back from classification branch {} to original branch {}", branchName, originalBranch);
             softwareProject.checkoutBranch(originalBranch);
         }
-        return migrations;
+        var migrationsReport = new MigrationsReport(migrationReports);
+        migrationJob.setMigrationsReport(migrationsReport);
+        persistenceService.saveMigrationJob(migrationJob);
+        return migrationsReport;
     }
 
     /**
      * Try to fix an individual migration point
      * Commit if successful, otherwise revert
      */
-    private MigrationReport tryToFixIndividualMigrationPoint(
+    private MigrationReportDto tryToFixIndividualMigrationPoint(
             MigrationJob migrationJob,
-            MigrationPointDto migrationPoint,
+            MigrationPoint migrationPoint,
             Ai ai) {
         var softwareProject = migrationJob.softwareProject();
         var migrationReport = ai
@@ -95,21 +144,21 @@ private MigrationReport tryToFixIndividualMigrationPoint(
                 .withToolObject(new BashTools(softwareProject.getRoot()))
                 .withTemplate("fix_migration_point")
                 .createObject(
-                        MigrationReport.class,
+                        MigrationReportDto.class,
                         Map.of(
                                 "migrationPoint", migrationPoint
                         )
                 );
-        if (migrationReport.isSuccess()) {
-            var message = "Fix: " + migrationPoint.description();
+        if (migrationReport.success()) {
+            var message = "Fix: " + migrationPoint.getDescription();
             softwareProject.commit(message, false);
             logger.info("Committing branch {} - {} as migration was successful",
                     softwareProject.currentBranch(), message);
-
+            migrationReport = migrationReport.withBranch(softwareProject.currentBranch());
         } else {
             logger.warn("Reverting branch {} as migration was not successful", softwareProject.currentBranch());
             softwareProject.revert();
         }
-        return migrationReport.withBranch(softwareProject.currentBranch());
+        return migrationReport;
     }
 }

src/main/java/com/embabel/modernizer/agent/MigrationPoints.java

@@ -9,7 +9,6 @@
  * Collection of migration recipes (immutable entity)
  */
 @Entity
-@Table(name = "migration_cookbook")
 public class MigrationCookbook {
 
     @Id
@@ -52,7 +51,6 @@ public List<MigrationRecipe> getRecipes() {
         return recipes;
     }
 
-    // Static cookbook definitions
     public static final MigrationCookbook MODERNIZE_JAVA = new MigrationCookbook(
             "MODERNIZE_JAVA",
             new MigrationRecipe("Legacy", "Code that is outdated and may not follow current best practices."),

src/main/java/com/embabel/modernizer/agent/ModernizerAgent.java

@@ -39,11 +39,11 @@ public class MigrationJob {
     @Column(nullable = false)
     private Instant updatedAt;
 
-    @OneToMany(mappedBy = "migrationJob", cascade = CascadeType.ALL, orphanRemoval = true)
-    private List<MigrationPoint> migrationPoints = new ArrayList<>();
+    @OneToOne(mappedBy = "migrationJob", cascade = CascadeType.ALL, orphanRemoval = true)
+    private MigrationPoints migrationPoints;
 
-    @OneToMany(mappedBy = "migrationJob", cascade = CascadeType.ALL, orphanRemoval = true)
-    private List<MigrationPoints> migrationPointsSets = new ArrayList<>();
+    @OneToOne(mappedBy = "migrationJob", cascade = CascadeType.ALL, orphanRemoval = true)
+    private MigrationsReport migrationsReport;
 
     // Transient field - not persisted
     @Transient
@@ -116,36 +116,26 @@ public void setUpdatedAt(Instant updatedAt) {
         this.updatedAt = updatedAt;
     }
 
-    public List<MigrationPoint> getMigrationPoints() {
+    public MigrationPoints getMigrationPoints() {
         return migrationPoints;
     }
 
-    public void setMigrationPoints(List<MigrationPoint> migrationPoints) {
+    public void setMigrationPoints(MigrationPoints migrationPoints) {
         this.migrationPoints = migrationPoints;
+        if (migrationPoints != null) {
+            migrationPoints.setMigrationJob(this);
+        }
     }
 
-    // Helper methods for bidirectional relationship
-    public void addMigrationPoint(MigrationPoint migrationPoint) {
-        migrationPoints.add(migrationPoint);
-        migrationPoint.setMigrationJob(this);
-    }
-
-    public void removeMigrationPoint(MigrationPoint migrationPoint) {
-        migrationPoints.remove(migrationPoint);
-        migrationPoint.setMigrationJob(null);
-    }
-
-    public List<MigrationPoints> getMigrationPointsSets() {
-        return migrationPointsSets;
-    }
-
-    public void setMigrationPointsSets(List<MigrationPoints> migrationPointsSets) {
-        this.migrationPointsSets = migrationPointsSets;
+    public MigrationsReport getMigrationsReport() {
+        return migrationsReport;
     }
 
-    public void addMigrationPointsSet(MigrationPoints migrationPointsSet) {
-        migrationPointsSets.add(migrationPointsSet);
-        migrationPointsSet.setMigrationJob(this);
+    public void setMigrationsReport(MigrationsReport migrationsReport) {
+        this.migrationsReport = migrationsReport;
+        if (migrationsReport != null) {
+            migrationsReport.setMigrationJob(this);
+        }
     }
 
     // Lazy getter for transient field

src/main/java/com/embabel/modernizer/entity/MigrationCookbook.java

@@ -11,32 +11,30 @@
 
 @Entity
 @EntityListeners(AuditingEntityListener.class)
-@Table(name = "migration_point")
 public class MigrationPoint {
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;
 
     @ManyToOne(fetch = FetchType.LAZY)
-    @JoinColumn(name = "migration_job_id", nullable = false)
-    private MigrationJob migrationJob;
+    @JoinColumn(name = "migration_points_id", nullable = false)
+    private MigrationPoints migrationPoints;
 
-    @Column(name = "file_path", nullable = false, length = 1024)
+    @Column(nullable = false, length = 1024)
     private String filePath;
 
-    @Column(name = "description", columnDefinition = "CLOB")
+    @Column(columnDefinition = "CLOB")
     private String description;
 
-    @Column(name = "recipe_id")
     private String recipeId;
 
     @CreatedDate
-    @Column(name = "created_at", nullable = false, updatable = false)
+    @Column(nullable = false, updatable = false)
     private Instant createdAt;
 
     @LastModifiedDate
-    @Column(name = "updated_at", nullable = false)
+    @Column(nullable = false)
     private Instant updatedAt;
 
     @OneToMany(mappedBy = "migrationPoint", cascade = CascadeType.ALL, orphanRemoval = true)
@@ -60,14 +58,6 @@ public void setId(Long id) {
         this.id = id;
     }
 
-    public MigrationJob getMigrationJob() {
-        return migrationJob;
-    }
-
-    public void setMigrationJob(MigrationJob migrationJob) {
-        this.migrationJob = migrationJob;
-    }
-
     public String getFilePath() {
         return filePath;
     }
@@ -96,18 +86,11 @@ public Instant getCreatedAt() {
         return createdAt;
     }
 
-    public void setCreatedAt(Instant createdAt) {
-        this.createdAt = createdAt;
-    }
 
     public Instant getUpdatedAt() {
         return updatedAt;
     }
-
-    public void setUpdatedAt(Instant updatedAt) {
-        this.updatedAt = updatedAt;
-    }
-
+    
     public List<MigrationReport> getMigrationReports() {
         return migrationReports;
     }
@@ -126,4 +109,12 @@ public void removeMigrationReport(MigrationReport migrationReport) {
         migrationReports.remove(migrationReport);
         migrationReport.setMigrationPoint(null);
     }
+
+    public MigrationPoints getMigrationPoints() {
+        return migrationPoints;
+    }
+
+    public void setMigrationPoints(MigrationPoints migrationPoints) {
+        this.migrationPoints = migrationPoints;
+    }
 }