fix(core): change version property to pluginVersion

kestra-io · Mar 3, 2025 · e36160e · e36160e
1 parent fa07cbd
commit e36160e
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 18 deletions.
diff --git a/core/src/main/java/io/kestra/core/models/PluginVersioning.java b/core/src/main/java/io/kestra/core/models/PluginVersioning.java
@@ -0,0 +1,16 @@
+package io.kestra.core.models;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.Pattern;
+
+/**
+ * Interface that can be implemented by classes supporting plugin versioning.
+ *
+ * @see io.kestra.core.docs.Plugin
+ */
+public interface PluginVersioning {
+
+    @Pattern(regexp="\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9]+)|([a-zA-Z0-9]+)")
+    @Schema(title = "The version of the plugin to use.")
+    String getPluginVersion();
+}
diff --git a/core/src/main/java/io/kestra/core/models/hierarchies/SubflowGraphTask.java b/core/src/main/java/io/kestra/core/models/hierarchies/SubflowGraphTask.java
@@ -92,8 +92,8 @@ public String getType() {
         }
 
         @Override
-        public String getVersion() {
-            return ((TaskInterface) subflowTask).getVersion();
+        public String getPluginVersion() {
+            return ((TaskInterface) subflowTask).getPluginVersion();
         }
     }
 }
diff --git a/core/src/main/java/io/kestra/core/models/tasks/Task.java b/core/src/main/java/io/kestra/core/models/tasks/Task.java
@@ -31,7 +31,7 @@ abstract public class Task implements TaskInterface {
 
     protected String type;
 
-    protected String version;
+    protected String pluginVersion;
 
     private String description;
 

diff --git a/core/src/main/java/io/kestra/core/models/tasks/TaskForExecution.java b/core/src/main/java/io/kestra/core/models/tasks/TaskForExecution.java
@@ -16,7 +16,7 @@ public class TaskForExecution implements TaskInterface {
 
     protected String type;
 
-    protected String version;
+    protected String pluginVersion;
 
     protected List<TaskForExecution> tasks;
 

diff --git a/core/src/main/java/io/kestra/core/models/tasks/TaskInterface.java b/core/src/main/java/io/kestra/core/models/tasks/TaskInterface.java
@@ -2,13 +2,14 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import io.kestra.core.models.Plugin;
+import io.kestra.core.models.PluginVersioning;
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Pattern;
 
 @JsonInclude(JsonInclude.Include.NON_DEFAULT)
-public interface TaskInterface extends Plugin {
+public interface TaskInterface extends Plugin, PluginVersioning {
     @NotNull
     @NotBlank
     @Pattern(regexp="^[a-zA-Z0-9][a-zA-Z0-9_-]*")
@@ -19,8 +20,4 @@ public interface TaskInterface extends Plugin {
     @Pattern(regexp="\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*(\\.\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*)*")
     @Schema(title = "The class name of this task.")
     String getType();
-
-    @Pattern(regexp="\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9]+)?|([a-zA-Z0-9]+)")
-    @Schema(title = "The class version of this task.")
-    String getVersion();
 }
diff --git a/core/src/main/java/io/kestra/core/models/triggers/AbstractTrigger.java b/core/src/main/java/io/kestra/core/models/triggers/AbstractTrigger.java
@@ -34,7 +34,7 @@ abstract public class AbstractTrigger implements TriggerInterface {
 
     protected String type;
 
-    protected String version;
+    protected String pluginVersion;
 
     private String description;
 

diff --git a/core/src/main/java/io/kestra/core/models/triggers/AbstractTriggerForExecution.java b/core/src/main/java/io/kestra/core/models/triggers/AbstractTriggerForExecution.java
@@ -13,7 +13,7 @@ public class AbstractTriggerForExecution implements TriggerInterface {
 
     protected String type;
 
-    protected String version;
+    protected String pluginVersion;
 
     public static AbstractTriggerForExecution of(AbstractTrigger abstractTrigger) {
         return AbstractTriggerForExecution.builder()

diff --git a/core/src/main/java/io/kestra/core/models/triggers/TriggerInterface.java b/core/src/main/java/io/kestra/core/models/triggers/TriggerInterface.java
@@ -1,13 +1,14 @@
 package io.kestra.core.models.triggers;
 
 import io.kestra.core.models.Plugin;
+import io.kestra.core.models.PluginVersioning;
 import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Pattern;
 
 
-public interface TriggerInterface extends Plugin {
+public interface TriggerInterface extends Plugin, PluginVersioning {
     @NotNull
     @NotBlank
     @Pattern(regexp="^[a-zA-Z0-9][a-zA-Z0-9_-]*")
@@ -20,8 +21,4 @@ public interface TriggerInterface extends Plugin {
     @Schema(title = "The class name for this current trigger.")
     String getType();
 
-    @Pattern(regexp="\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9]+)|([a-zA-Z0-9]+)")
-    @Schema(title = "The class version for this trigger.")
-    String getVersion();
-
 }
diff --git a/core/src/main/java/io/kestra/core/plugins/serdes/PluginDeserializer.java b/core/src/main/java/io/kestra/core/plugins/serdes/PluginDeserializer.java
@@ -33,7 +33,7 @@ public final class PluginDeserializer<T extends Plugin> extends JsonDeserializer
     private static final Logger log = LoggerFactory.getLogger(PluginDeserializer.class);
 
     private static final String TYPE = "type";
-    private static final String VERSION = "version";
+    private static final String VERSION = "pluginVersion";
 
     private volatile PluginRegistry pluginRegistry;
 

diff --git a/core/src/test/java/io/kestra/core/serializers/YamlParserTest.java b/core/src/test/java/io/kestra/core/serializers/YamlParserTest.java
@@ -198,7 +198,7 @@ void invalidProperty() {
             () -> this.parse("flows/invalids/invalid-property.yaml")
         );
 
-        assertThat(exception.getMessage(), is("Unrecognized field \"invalid\" (class io.kestra.plugin.core.debug.Return), not marked as ignorable (14 known properties: \"logLevel\", \"timeout\", \"retry\", \"allowWarning\", \"format\", \"version\", \"type\", \"id\", \"description\", \"workerGroup\", \"runIf\", \"logToFile\", \"disabled\", \"allowFailure\"])"));
+        assertThat(exception.getMessage(), is("Unrecognized field \"invalid\" (class io.kestra.plugin.core.debug.Return), not marked as ignorable (14 known properties: \"logLevel\", \"timeout\", \"retry\", \"allowWarning\", \"format\", \"pluginVersion\", \"type\", \"id\", \"description\", \"workerGroup\", \"runIf\", \"logToFile\", \"disabled\", \"allowFailure\"])"));
         assertThat(exception.getConstraintViolations().size(), is(1));
         assertThat(exception.getConstraintViolations().iterator().next().getPropertyPath().toString(), is("io.kestra.core.models.flows.Flow[\"tasks\"]->java.util.ArrayList[0]->io.kestra.plugin.core.debug.Return[\"invalid\"]"));
     }