Engage persist compiler plugin with persist multi-model support

ballerina/Ballerina.toml

@@ -1,7 +1,7 @@
 [package]
 org = "ballerina"
 name = "persist"
-version = "1.6.1"
+version = "1.7.0"
 authors = ["Ballerina"]
 keywords = ["persist"]
 repository = "https://github.com/ballerina-platform/module-ballerina-persist"
@@ -15,5 +15,5 @@ graalvmCompatible = true
 [[platform.java21.dependency]]
 groupId = "io.ballerina.stdlib"
 artifactId = "persist-native"
-version = "1.6.1"
-path = "../native/build/libs/persist-native-1.6.1-SNAPSHOT.jar"
+version = "1.7.0"
+path = "../native/build/libs/persist-native-1.7.0-SNAPSHOT.jar"

ballerina/CompilerPlugin.toml

@@ -3,4 +3,4 @@ id = "persist-compiler-plugin"
 class = "io.ballerina.stdlib.persist.compiler.PersistCompilerPlugin"
 
 [[dependency]]
-path = "../compiler-plugin/build/libs/persist-compiler-plugin-1.6.1-SNAPSHOT.jar"
+path = "../compiler-plugin/build/libs/persist-compiler-plugin-1.7.0-SNAPSHOT.jar"

ballerina/Dependencies.toml

@@ -18,7 +18,7 @@ modules = [
 [[package]]
 org = "ballerina"
 name = "persist"
-version = "1.6.1"
+version = "1.7.0"
 dependencies = [
 	{org = "ballerina", name = "jballerina.java"}
 ]

changelog.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- [Enable persist compiler plugin validations for the new persist multi-model support](https://github.com/ballerina-platform/ballerina-library/issues/8503)
+
+## [1.4.0] - 2024-08-20
+
 ### Added
 - [Added compiler plugin validations for H2 as a datasource](https://github.com/ballerina-platform/ballerina-library/issues/5715)
 

compiler-plugin-test/src/test/java/io/ballerina/stdlib/persist/compiler/CompilerPluginTest.java

@@ -790,6 +790,236 @@ public void validateFieldTypesForRedisDB() {
         );
     }
 
+    // --- Multi-model support tests ---
+
+    private Package loadMultiModelPersistFile(String directory, String modelName, String name) {
+        Path projectDirPath = Paths.get("src", "test", "resources", directory, "persist", modelName)
+                .toAbsolutePath().resolve(name);
+        SingleFileProject project = SingleFileProject.load(getEnvironmentBuilder(), projectDirPath);
+        return project.currentPackage();
+    }
+
+    @Test
+    public void identifyMultiModelFileSuccess() {
+        List<Diagnostic> diagnostics = getMultiModelErrorDiagnostics("project_12", "medical",
+                "valid-persist-model-path.bal", 1);
+        testDiagnostic(
+                diagnostics,
+                new String[]{
+                        PERSIST_101.getCode()
+                },
+                new String[]{
+                        "persist model definition only supports record and enum definitions"
+                },
+                new String[]{
+                        "(2:0,3:1)"
+                });
+    }
+
+    @Test
+    public void identifyMultiModelFileFailure() {
+        // A file in a non-persist subdirectory should not be identified as a model file
+        Path projectDirPath = Paths.get("src", "test", "resources", "project_1", "resources").toAbsolutePath()
+                .resolve("single-bal.bal");
+        SingleFileProject project = SingleFileProject.load(getEnvironmentBuilder(), projectDirPath);
+        DiagnosticResult diagnosticResult = project.currentPackage().getCompilation().diagnosticResult();
+        Assert.assertEquals(diagnosticResult.diagnosticCount(), 0);
+    }
+
+    @Test
+    public void validateEntityFieldTypeForMysqlMultiModel() {
+        List<Diagnostic> diagnostics = getMultiModelErrorDiagnostics("project_12", "medical",
+                "field-types.bal", 10);
+        testDiagnostic(
+                diagnostics,
+                new String[]{
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_306.getCode(),
+                },
+                new String[]{
+                        "an entity does not support boolean array field type",
+                        "an entity does not support json-typed field",
+                        "an entity does not support json array field type",
+                        "an entity does not support time:Civil array field type",
+                        "an entity does not support union-typed field",
+                        "an entity does not support error-typed field",
+                        "an entity does not support error array field type",
+                        "an entity does not support mysql:Client-typed field",
+                        "an entity does not support mysql:Client array field type",
+                        "an entity does not support enum array field type"
+                },
+                new String[]{
+                        "(18:4,18:13)",
+                        "(20:4,20:8)",
+                        "(21:4,21:10)",
+                        "(24:4,24:16)",
+                        "(25:4,25:21)",
+                        "(27:4,27:9)",
+                        "(28:4,28:11)",
+                        "(30:4,30:16)",
+                        "(31:4,31:18)",
+                        "(34:4,34:12)"
+                });
+    }
+
+    @Test
+    public void validateEntityRecordPropertiesMultiModel() {
+        List<Diagnostic> diagnostics = getMultiModelErrorDiagnostics("project_12", "medical",
+                "record-properties.bal", 1);
+        testDiagnostic(
+                diagnostics,
+                new String[]{
+                        PERSIST_201.getCode()
+                },
+                new String[]{
+                        "an entity should be a closed record"
+                },
+                new String[]{
+                        "(17:25,23:1)"
+                });
+    }
+
+    @Test
+    public void validateEntityFieldTypeForPostgresqlMultiModelByFilePath() {
+        List<Diagnostic> diagnostics = getMultiModelErrorDiagnostics("project_13", "inventory",
+                "field-types.bal", 10);
+        testDiagnostic(
+                diagnostics,
+                new String[]{
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_306.getCode(),
+                },
+                new String[]{
+                        "an entity does not support boolean array field type",
+                        "an entity does not support json-typed field",
+                        "an entity does not support json array field type",
+                        "an entity does not support time:Civil array field type",
+                        "an entity does not support union-typed field",
+                        "an entity does not support error-typed field",
+                        "an entity does not support error array field type",
+                        "an entity does not support mysql:Client-typed field",
+                        "an entity does not support mysql:Client array field type",
+                        "an entity does not support enum array field type"
+                },
+                new String[]{
+                        "(18:4,18:13)",
+                        "(20:4,20:8)",
+                        "(21:4,21:10)",
+                        "(24:4,24:16)",
+                        "(25:4,25:21)",
+                        "(27:4,27:9)",
+                        "(28:4,28:11)",
+                        "(30:4,30:16)",
+                        "(31:4,31:18)",
+                        "(34:4,34:12)"
+                });
+    }
+
+    @Test
+    public void validateMultiModelIsolationDefaultModel() {
+        List<Diagnostic> diagnostics = getErrorDiagnostics("project_14", "field-types.bal", 10);
+        testDiagnostic(
+                diagnostics,
+                new String[]{
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_306.getCode(),
+                },
+                new String[]{
+                        "an entity does not support boolean array field type",
+                        "an entity does not support json-typed field",
+                        "an entity does not support json array field type",
+                        "an entity does not support time:Civil array field type",
+                        "an entity does not support union-typed field",
+                        "an entity does not support error-typed field",
+                        "an entity does not support error array field type",
+                        "an entity does not support mysql:Client-typed field",
+                        "an entity does not support mysql:Client array field type",
+                        "an entity does not support enum array field type"
+                },
+                new String[]{
+                        "(18:4,18:13)",
+                        "(20:4,20:8)",
+                        "(21:4,21:10)",
+                        "(24:4,24:16)",
+                        "(25:4,25:21)",
+                        "(27:4,27:9)",
+                        "(28:4,28:11)",
+                        "(30:4,30:16)",
+                        "(31:4,31:18)",
+                        "(34:4,34:12)"
+                });
+    }
+
+    @Test
+    public void validateMultiModelIsolationNamedModel() {
+        List<Diagnostic> diagnostics = getMultiModelErrorDiagnostics("project_14", "secondary",
+                "field-types.bal", 10);
+        testDiagnostic(
+                diagnostics,
+                new String[]{
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_305.getCode(),
+                        PERSIST_306.getCode(),
+                        PERSIST_306.getCode(),
+                },
+                new String[]{
+                        "an entity does not support boolean array field type",
+                        "an entity does not support json-typed field",
+                        "an entity does not support json array field type",
+                        "an entity does not support time:Civil array field type",
+                        "an entity does not support union-typed field",
+                        "an entity does not support error-typed field",
+                        "an entity does not support error array field type",
+                        "an entity does not support mysql:Client-typed field",
+                        "an entity does not support mysql:Client array field type",
+                        "an entity does not support enum array field type"
+                },
+                new String[]{
+                        "(18:4,18:13)",
+                        "(20:4,20:8)",
+                        "(21:4,21:10)",
+                        "(24:4,24:16)",
+                        "(25:4,25:21)",
+                        "(27:4,27:9)",
+                        "(28:4,28:11)",
+                        "(30:4,30:16)",
+                        "(31:4,31:18)",
+                        "(34:4,34:12)"
+                });
+    }
+
+    // --- Helper methods ---
+
     private List<Diagnostic> getErrorDiagnostics(String modelDirectory, String modelFileName, int count) {
         DiagnosticResult diagnosticResult = loadPersistModelFile(modelDirectory, modelFileName).getCompilation()
                 .diagnosticResult();
@@ -799,6 +1029,18 @@ private List<Diagnostic> getErrorDiagnostics(String modelDirectory, String model
         return errorDiagnosticsList;
     }
 
+    private List<Diagnostic> getMultiModelErrorDiagnostics(String projectDirectory, String modelName,
+                                                           String modelFileName, int count) {
+        DiagnosticResult diagnosticResult = loadMultiModelPersistFile(projectDirectory, modelName,
+                modelFileName)
+                .getCompilation().diagnosticResult();
+        List<Diagnostic> errorDiagnosticsList = diagnosticResult.diagnostics().stream()
+                .filter(r -> r.diagnosticInfo().severity().equals(DiagnosticSeverity.ERROR))
+                .collect(Collectors.toList());
+        Assert.assertEquals(errorDiagnosticsList.size(), count);
+        return errorDiagnosticsList;
+    }
+
 
     private void testDiagnostic(List<Diagnostic> errorDiagnosticsList, String[] codes, String[] messages,
                                 String[] locations) {

compiler-plugin-test/src/test/resources/project_12/Ballerina.toml

@@ -0,0 +1,9 @@
+[package]
+org = "root"
+name = "project_12"
+version = "0.1.0"
+
+[[tool.persist]]
+model = "medical"
+options.datastore = "mysql"
+filePath = "persist/medical/model.bal"

compiler-plugin-test/src/test/resources/project_12/persist/medical/field-types.bal

@@ -0,0 +1,36 @@
+import ballerina/persist as _;
+import ballerina/time;
+import ballerinax/mysql;
+
+public enum Gender {
+    M,
+    F
+}
+
+public type MedicalNeed record {|
+    readonly int needId;
+    boolean booleanTest;
+    int itemId;
+    float floatTest;
+    decimal decimalTest;
+    string beneficiaryId;
+    byte[] beneficiaryIdByteArray;
+
+    boolean[] booleanArray;
+
+    json jsonTest;
+    json[] jsonArray;
+
+    time:Civil period;
+    time:Civil[] periodArray;
+    time:Civil|string unionType;
+
+    error errorType;
+    error[] errorArrayType;
+
+    mysql:Client clientType;
+    mysql:Client[] clientArrayType;
+
+    Gender gender;
+    Gender[] genderArray;
+|};

compiler-plugin-test/src/test/resources/project_12/persist/medical/record-properties.bal

@@ -0,0 +1,24 @@
+import ballerina/persist as _;
+import ballerina/time;
+
+public enum EnumType {
+    TYPE_1,
+    TYPE_2
+}
+
+public type MedicalNeed record {|
+    readonly int needId;
+    int itemId;
+    int beneficiaryId;
+    time:Civil period;
+    int quantity;
+    EnumType enumType;
+|};
+
+public type MedicalNeed2 record {
+    readonly int needId;
+    int itemId;
+    int beneficiaryId;
+    time:Civil period;
+    int quantity;
+};

compiler-plugin-test/src/test/resources/project_12/persist/medical/valid-persist-model-path.bal

@@ -0,0 +1,4 @@
+import ballerina/persist as _;
+
+public function main() {
+}

compiler-plugin-test/src/test/resources/project_13/Ballerina.toml

@@ -0,0 +1,9 @@
+[package]
+org = "root"
+name = "project_13"
+version = "0.1.0"
+
+[[tool.persist]]
+id = "project13"
+options.datastore = "postgresql"
+filePath = "persist/inventory/model.bal"