Fix/performance issues (#92)

* Add batch model retrieval and file info classes

Introduces FileEntry and FileInformation classes for batch operations. Adds a new endpoint to ModelController for retrieving multiple aspect models in a single request. Updates ModelService to return filename and model content as a tuple, and refactors related test and service logic for improved error handling and data structure support.

* Refactor model classes to use Java records

Converted model classes (FileEntry, FileInformation, MigrationResult, Model, Version) to Java records for improved immutability and conciseness. Added AspectModelResult record. Updated ModelService and ModelController to use new record types and adjusted method signatures and usages accordingly. Minor dependency update in pom.xml for @usebruno/cli.

* Update ModelServiceTest.java

Author: michelu89

aspect-model-editor-runtime/pom.xml

@@ -446,7 +446,7 @@
                         </goals>
                         <configuration>
                            <workingDirectory>${project.build.directory}</workingDirectory>
-                           <arguments>install . @usebruno/cli</arguments>
+                           <arguments>install --ignore-scripts . @usebruno/cli@2.15.0</arguments>
                         </configuration>
                      </execution>
                   </executions>

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/ModelService.java

@@ -27,6 +27,7 @@
 import org.eclipse.esmf.ame.exceptions.FileNotFoundException;
 import org.eclipse.esmf.ame.exceptions.FileReadException;
 import org.eclipse.esmf.ame.exceptions.InvalidAspectModelException;
+import org.eclipse.esmf.ame.services.models.AspectModelResult;
 import org.eclipse.esmf.ame.services.models.MigrationResult;
 import org.eclipse.esmf.ame.services.models.Version;
 import org.eclipse.esmf.ame.services.utils.ModelGroupingUtils;
@@ -74,15 +75,19 @@ public ModelService( final AspectModelValidator aspectModelValidator, final Aspe
       this.modelPath = modelPath;
    }
 
-   public String getModel( final AspectModelUrn aspectModelUrn, final String filePath ) {
+   public AspectModelResult getModel( final AspectModelUrn aspectModelUrn, final String filePath ) {
       try {
          final AspectModel aspectModel = ( filePath != null ) ?
                ModelUtils.loadModelFromFile( modelPath, filePath, aspectModelLoader ) :
                loadModelFromUrn( aspectModelUrn );
          validateModel( aspectModel );
 
-         return aspectModel.files().stream().filter( a -> a.elements().stream().anyMatch( e -> e.urn().equals( aspectModelUrn ) ) )
-               .findFirst().map( AspectSerializer.INSTANCE::aspectModelFileToString )
+         return aspectModel.files().stream()
+               .filter( a -> a.elements().stream().anyMatch( e -> e.urn().equals( aspectModelUrn ) ) )
+               .findFirst()
+               .map( aspectModelFile -> new AspectModelResult(
+                     aspectModelFile.filename(),
+                     AspectSerializer.INSTANCE.aspectModelFileToString( aspectModelFile ) ) )
                .orElseThrow( () -> new FileNotFoundException( "Aspect Model not found" ) );
       } catch ( final ModelResolutionException e ) {
          throw new FileNotFoundException( e.getMessage(), e );
@@ -191,16 +196,16 @@ public MigrationResult migrateWorkspace( final boolean setNewVersion, final Path
 
    private void processVersion( final String namespace, final Version version, final boolean setNewVersion, final List<String> errors,
          final Path metaModelStoragePath ) {
-      version.getModels().forEach( model -> {
+      version.models().forEach( model -> {
          try {
-            final boolean isNotLatestKnownVersion = KnownVersion.fromVersionString( model.getVersion() )
+            final boolean isNotLatestKnownVersion = KnownVersion.fromVersionString( model.version() )
                   .filter( v -> KnownVersion.getLatest().equals( v ) ).isPresent();
 
             if ( isNotLatestKnownVersion ) {
                return;
             }
 
-            final Path aspectModelPath = ModelUtils.constructModelPath( modelPath, namespace, version.getVersion(), model.getModel() );
+            final Path aspectModelPath = ModelUtils.constructModelPath( modelPath, namespace, version.version(), model.model() );
             final AspectModel aspectModel = aspectModelLoader.load( aspectModelPath.toFile() );
 
             if ( setNewVersion ) {
@@ -210,7 +215,7 @@ private void processVersion( final String namespace, final Version version, fina
 
             AspectSerializer.INSTANCE.write( aspectModel );
          } catch ( final Exception e ) {
-            errors.add( String.format( "Error processing model: %s", model.getModel() ) );
+            errors.add( String.format( "Error processing model: %s", model.model() ) );
          }
       } );
    }

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/PackageService.java

@@ -30,6 +30,7 @@
 import java.util.zip.ZipOutputStream;
 
 import org.eclipse.esmf.ame.exceptions.CreateFileException;
+import org.eclipse.esmf.ame.exceptions.FileHandlingException;
 import org.eclipse.esmf.ame.exceptions.FileNotFoundException;
 import org.eclipse.esmf.ame.services.models.Version;
 import org.eclipse.esmf.ame.services.utils.ModelGroupingUtils;
@@ -43,7 +44,6 @@
 import org.eclipse.esmf.aspectmodel.generator.zip.AspectModelNamespacePackageCreator;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.aspectmodel.resolver.NamespacePackage;
-import org.eclipse.esmf.aspectmodel.resolver.exceptions.ModelResolutionException;
 import org.eclipse.esmf.aspectmodel.resolver.fs.ModelsRoot;
 import org.eclipse.esmf.aspectmodel.resolver.fs.StructuredModelsRoot;
 import org.eclipse.esmf.aspectmodel.resolver.modelfile.RawAspectModelFileBuilder;
@@ -96,11 +96,16 @@ public Map<String, List<Version>> importPackage( final CompletedFileUpload zipFi
 
          return new ModelGroupingUtils( aspectModelLoader ).groupModelsByNamespaceAndVersion( savedUris, false );
       } catch ( final IOException e ) {
-         throw new ModelResolutionException( "Could not read from input", e );
+         throw new FileHandlingException( "Could not read from input", e );
       }
    }
 
    private AddAspectModelFile createAddChange( final AspectModelFile file, final ModelsRoot modelsRoot ) {
+      if ( file.sourceModel().isEmpty() ) {
+         // TODO check why this will not returend ...
+         throw new FileHandlingException( "Source model is empty for file: " + file );
+      }
+
       final URI targetLocation = modelsRoot.directoryForNamespace( file.namespaceUrn() ).resolve( file.filename().orElseThrow() ).toUri();
 
       final RawAspectModelFileBuilder builder = RawAspectModelFileBuilder.builder().sourceModel( file.sourceModel() )

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/AspectModelResult.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for
+ * additional information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.ame.services.models;
+
+import java.util.Optional;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.core.annotation.Introspected;
+import io.micronaut.serde.annotation.Serdeable;
+
+/**
+ * Represents the result of an aspect model operation.
+ *
+ * @param filename the optional name of the file associated with the model result
+ * @param content the content of the model result
+ */
+@Serdeable
+@Introspected
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record AspectModelResult( Optional<String> filename, String content ) {}

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/FileEntry.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for
+ * additional information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.ame.services.models;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.core.annotation.Introspected;
+import io.micronaut.serde.annotation.Serdeable;
+
+/**
+ * Represents a file entry with aspect model information.
+ *
+ * @param absoluteName the absolute path of the file
+ * @param fileName the name of the file
+ * @param aspectModelUrn the URN of the aspect model
+ * @param modelVersion the version of the model
+ */
+@Serdeable
+@Introspected
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record FileEntry( String absoluteName, String fileName, String aspectModelUrn, String modelVersion ) {
+   /**
+    * Creates a FileEntry with only the aspect model URN.
+    *
+    * @param aspectModelUrn the URN of the aspect model
+    */
+   public FileEntry( final String aspectModelUrn ) {
+      this( null, null, aspectModelUrn, null );
+   }
+}

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/FileInformation.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for
+ * additional information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.ame.services.models;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.core.annotation.Introspected;
+import io.micronaut.serde.annotation.Serdeable;
+
+/**
+ * Represents information about an Aspect Model file.
+ *
+ * @param absoluteName the absolute path of the file
+ * @param aspectModelUrn the URN of the aspect model
+ * @param modelVersion the version of the model
+ * @param aspectModel the aspect model content
+ * @param fileName the name of the file
+ */
+@Serdeable
+@Introspected
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record FileInformation(
+      String absoluteName,
+      String aspectModelUrn,
+      String modelVersion,
+      String aspectModel,
+      String fileName
+) {}

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/MigrationResult.java

@@ -15,39 +15,20 @@
 
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import io.micronaut.core.annotation.Introspected;
 import io.micronaut.serde.annotation.Serdeable;
 
 /**
- * Represents a single migration result with success and erros.
+ * Represents the result of a migration operation.
+ *
+ * @param success indicates whether the migration was successful
+ * @param errors list of error messages encountered during migration, empty if successful
  */
 @Serdeable
 @Introspected
-public class MigrationResult {
-   private boolean success;
-   private List<String> errors;
-
-   public MigrationResult() {
-   }
-
-   public MigrationResult( final boolean success, final List<String> errors ) {
-      this.success = success;
-      this.errors = errors;
-   }
-
-   public boolean isSuccess() {
-      return success;
-   }
-
-   public void setSuccess( final boolean success ) {
-      this.success = success;
-   }
-
-   public List<String> getErrors() {
-      return errors;
-   }
-
-   public void setErrors( final List<String> errors ) {
-      this.errors = errors;
-   }
-}
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record MigrationResult(
+      boolean success,
+      List<String> errors
+) {}

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/Model.java

@@ -15,59 +15,24 @@
 
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import io.micronaut.core.annotation.Introspected;
 import io.micronaut.serde.annotation.Serdeable;
 
 /**
  * Represents a single model with its name or properties.
+ *
+ * @param model the model name or content
+ * @param aspectModelUrn the URN of the aspect model
+ * @param version the version of the model
+ * @param existing indicates whether the model already exists
  */
 @Serdeable
 @Introspected
-public class Model {
-   private String model;
-   private AspectModelUrn aspectModelUrn;
-   private String version;
-   private boolean existing;
-
-   public Model() {
-   }
-
-   public Model( final String model, final AspectModelUrn aspectModelUrn, final String version, final boolean existing ) {
-      this.model = model;
-      this.aspectModelUrn = aspectModelUrn;
-      this.version = version;
-      this.existing = existing;
-   }
-
-   public String getModel() {
-      return model;
-   }
-
-   public void setModel( final String model ) {
-      this.model = model;
-   }
-
-   public AspectModelUrn getAspectModelUrn() {
-      return aspectModelUrn;
-   }
-
-   public void setAspectModelUrn( final AspectModelUrn aspectModelUrn ) {
-      this.aspectModelUrn = aspectModelUrn;
-   }
-
-   public String getVersion() {
-      return version;
-   }
-
-   public void setVersion( final String version ) {
-      this.version = version;
-   }
-
-   public boolean isExisting() {
-      return existing;
-   }
-
-   public void setExisting( final boolean existing ) {
-      this.existing = existing;
-   }
-}
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record Model(
+      String model,
+      AspectModelUrn aspectModelUrn,
+      String version,
+      boolean existing
+) {}

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/Version.java

@@ -15,39 +15,20 @@
 
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import io.micronaut.core.annotation.Introspected;
 import io.micronaut.serde.annotation.Serdeable;
 
 /**
  * Represents a version containing a list of models.
+ *
+ * @param version the version identifier
+ * @param models list of models associated with this version
  */
 @Serdeable
 @Introspected
-public class Version {
-   private String version;
-   private List<Model> models;
-
-   public Version() {
-   }
-
-   public Version( final String version, final List<Model> models ) {
-      this.version = version;
-      this.models = models;
-   }
-
-   public String getVersion() {
-      return version;
-   }
-
-   public void setVersion( final String version ) {
-      this.version = version;
-   }
-
-   public List<Model> getModels() {
-      return models;
-   }
-
-   public void setModels( final List<Model> models ) {
-      this.models = models;
-   }
-}
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record Version(
+      String version,
+      List<Model> models
+) {}