[NU-1923] Rename source 'sample-generator' to 'event-generator' and '…

…period' to 'schedule' (#7502) rename source 'sample-generator' to 'event-generator' and 'period' to 'schedule'
TouK · Jan 30, 2025 · b3eaf14 · b3eaf14
1 parent f8960d1
commit b3eaf14
Show file tree

Hide file tree

Showing 34 changed files with 161 additions and 76 deletions.
diff --git a/defaultModel/src/main/scala/pl/touk/nussknacker/defaultmodel/DefaultModelMigrations.scala b/defaultModel/src/main/scala/pl/touk/nussknacker/defaultmodel/DefaultModelMigrations.scala
@@ -14,6 +14,7 @@ class DefaultModelMigrations extends ProcessMigrations {
     // 100 -> NewMigration,
     // Newly added migrations should be in the hundreds: 100, 200, 300 and so on. We do this because
     // many ProcessMigrations can be loaded using SPI, and we want to avoid overlapping numbers when merging.
+    100 -> SampleGeneratorToEventGeneratorAndPeriodToScheduleParameter
   )
 
 }
diff --git a/...defaultmodel/migrations/SampleGeneratorToEventGeneratorAndPeriodToScheduleParameter.scala b/...defaultmodel/migrations/SampleGeneratorToEventGeneratorAndPeriodToScheduleParameter.scala
@@ -0,0 +1,30 @@
+package pl.touk.nussknacker.defaultmodel.migrations
+
+import pl.touk.nussknacker.engine.api.MetaData
+import pl.touk.nussknacker.engine.api.parameter.ParameterName
+import pl.touk.nussknacker.engine.graph.node
+import pl.touk.nussknacker.engine.graph.node.Source
+import pl.touk.nussknacker.engine.graph.source.SourceRef
+import pl.touk.nussknacker.engine.migration.NodeMigration
+
+object SampleGeneratorToEventGeneratorAndPeriodToScheduleParameter extends NodeMigration {
+
+  override val description: String = "Change name of component: sample-generator -> event-generator " +
+    "and its parameter: period -> schedule"
+
+  override def migrateNode(metaData: MetaData): PartialFunction[node.NodeData, node.NodeData] = {
+    case source @ Source(_, ref @ SourceRef("sample-generator", _), _) =>
+      source.copy(ref =
+        ref.copy(
+          typ = "event-generator",
+          parameters = ref.parameters.map { param =>
+            param.name.value match {
+              case "period" => param.copy(name = ParameterName("schedule"))
+              case _        => param
+            }
+          }
+        )
+      )
+  }
+
+}
diff --git a/...er/defaultModel/migrations/SampleGeneratorToEventGeneratorAndPeriodicToScheduleSpec.scala b/...er/defaultModel/migrations/SampleGeneratorToEventGeneratorAndPeriodicToScheduleSpec.scala
@@ -0,0 +1,45 @@
+package pl.touk.nussknacker.defaultModel.migrations
+
+import org.scalatest.freespec.AnyFreeSpecLike
+import org.scalatest.matchers.should.Matchers
+import pl.touk.nussknacker.defaultmodel.migrations.SampleGeneratorToEventGeneratorAndPeriodToScheduleParameter
+import pl.touk.nussknacker.engine.api.parameter.ParameterName
+import pl.touk.nussknacker.engine.api.{MetaData, StreamMetaData}
+import pl.touk.nussknacker.engine.graph.evaluatedparam.Parameter
+import pl.touk.nussknacker.engine.graph.node.Source
+import pl.touk.nussknacker.engine.graph.source.SourceRef
+import pl.touk.nussknacker.engine.spel.SpelExtension._
+
+class SampleGeneratorToEventGeneratorAndPeriodicToScheduleSpec extends AnyFreeSpecLike with Matchers {
+
+  "SampleGeneratorToEventGeneratorAndPeriodicToScheduleSpec should be applied" in {
+    val metaData = MetaData("test", StreamMetaData(Some(1)))
+    val beforeMigration = Source(
+      id = "sample-generator",
+      ref = SourceRef(
+        typ = "sample-generator",
+        parameters = List(
+          Parameter(ParameterName("period"), "T(java.time.Duration).parse('PT1M')".spel),
+          Parameter(ParameterName("count"), "1".spel),
+          Parameter(ParameterName("value"), "1".spel),
+        )
+      )
+    )
+    val expectedAfterMigration = Source(
+      id = "sample-generator",
+      ref = SourceRef(
+        typ = "event-generator",
+        parameters = List(
+          Parameter(ParameterName("schedule"), "T(java.time.Duration).parse('PT1M')".spel),
+          Parameter(ParameterName("count"), "1".spel),
+          Parameter(ParameterName("value"), "1".spel),
+        )
+      )
+    )
+
+    val migrated = SampleGeneratorToEventGeneratorAndPeriodToScheduleParameter.migrateNode(metaData)(beforeMigration)
+
+    migrated shouldBe expectedAfterMigration
+  }
+
+}
diff --git a/...apshots__/electron/Linux/Components list should allow filtering by usage #1.png b/...apshots__/electron/Linux/Components list should allow filtering by usage #1.png
diff --git a/...mage_snapshots__/electron/Linux/Components list should display component #0.png b/...mage_snapshots__/electron/Linux/Components list should display component #0.png
diff --git a/...should display question mark when renaming a node and updating the count #0.png b/...should display question mark when renaming a node and updating the count #0.png
diff --git a/...shots__/electron/Linux/Node window should display event-generator source #0.png b/...shots__/electron/Linux/Node window should display event-generator source #0.png
diff --git a/...ots__/electron/Linux/Process initially clean should import JSON and save #0.png b/...ots__/electron/Linux/Process initially clean should import JSON and save #0.png
diff --git a/...ots__/electron/Linux/Process initially clean should import JSON and save #1.png b/...ots__/electron/Linux/Process initially clean should import JSON and save #1.png
diff --git a/designer/client/cypress/e2e/counts.cy.ts b/designer/client/cypress/e2e/counts.cy.ts
@@ -82,7 +82,7 @@ describe("Counts", () => {
             .click();
         cy.get("[data-testid=window]").contains(/^ok$/i).click();
 
-        cy.getNode("sample-generator")
+        cy.getNode("event-generator")
             .parent()
             .matchImage({ screenshotConfig: { padding: 16 } });
     });

diff --git a/designer/client/cypress/e2e/nodeWindow.cy.ts b/designer/client/cypress/e2e/nodeWindow.cy.ts
@@ -13,13 +13,13 @@ describe("Node window", () => {
         cy.viewport(1600, 800);
     });
 
-    it("should display sample-generator source", () => {
+    it("should display event-generator source", () => {
         cy.visitNewProcess(NAME).as("processName");
         cy.contains(/^sources$/)
             .should("exist")
             .scrollIntoView();
         cy.layoutScenario();
-        cy.get("[data-testid='component:sample-generator']")
+        cy.get("[data-testid='component:event-generator']")
             .should("be.visible")
             .drag("#nk-graph-main", {
                 target: {
@@ -29,7 +29,7 @@ describe("Node window", () => {
                 force: true,
             });
 
-        cy.getNode("sample-generator").dblclick();
+        cy.getNode("event-generator").dblclick();
 
         // TODO: fix validation display in node windows
         cy.intercept("POST", "/api/nodes/*/validation").as("validation");

diff --git a/designer/client/cypress/fixtures/aggregations.json b/designer/client/cypress/fixtures/aggregations.json
@@ -15,12 +15,12 @@
     },
     "nodes": [
         {
-            "id": "sample-generator",
+            "id": "event-generator",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/counts.json b/designer/client/cypress/fixtures/counts.json
@@ -16,12 +16,12 @@
     },
     "nodes": [
         {
-            "id": "sample-generator",
+            "id": "event-generator",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1S')"

diff --git a/designer/client/cypress/fixtures/docsAggregatesFullOuterJoin#0.json b/designer/client/cypress/fixtures/docsAggregatesFullOuterJoin#0.json
@@ -18,10 +18,10 @@
         {
             "id": "subscriber alerts",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"
@@ -65,10 +65,10 @@
             {
                 "id": "audit - all events",
                 "ref": {
-                    "typ": "sample-generator",
+                    "typ": "event-generator",
                     "parameters": [
                         {
-                            "name": "period",
+                            "name": "schedule",
                             "expression": {
                                 "language": "spel",
                                 "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsAggregatesSingleSideJoin#0.json b/designer/client/cypress/fixtures/docsAggregatesSingleSideJoin#0.json
@@ -114,10 +114,10 @@
             {
                 "id": "subscriber alerts",
                 "ref": {
-                    "typ": "sample-generator",
+                    "typ": "event-generator",
                     "parameters": [
                         {
-                            "name": "period",
+                            "name": "schedule",
                             "expression": {
                                 "language": "spel",
                                 "expression": "T(java.time.Duration).parse('PT1M')"
@@ -160,10 +160,10 @@
             {
                 "id": "audit - all events",
                 "ref": {
-                    "typ": "sample-generator",
+                    "typ": "event-generator",
                     "parameters": [
                         {
-                            "name": "period",
+                            "name": "schedule",
                             "expression": {
                                 "language": "spel",
                                 "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsChoice#0.json b/designer/client/cypress/fixtures/docsBasicComponentsChoice#0.json
@@ -18,10 +18,10 @@
         {
             "id": "source",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsFilter#0.json b/designer/client/cypress/fixtures/docsBasicComponentsFilter#0.json
@@ -18,10 +18,10 @@
         {
             "id": "source",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsFilter#1.json b/designer/client/cypress/fixtures/docsBasicComponentsFilter#1.json
@@ -18,10 +18,10 @@
         {
             "id": "source",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsForEach#0.json b/designer/client/cypress/fixtures/docsBasicComponentsForEach#0.json
@@ -18,10 +18,10 @@
         {
             "id": "source",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsRecordVariable#0.json b/designer/client/cypress/fixtures/docsBasicComponentsRecordVariable#0.json
@@ -16,12 +16,12 @@
     },
     "nodes": [
         {
-            "id": "sample-generator",
+            "id": "event-generator",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsSplit#0.json b/designer/client/cypress/fixtures/docsBasicComponentsSplit#0.json
@@ -16,12 +16,12 @@
     },
     "nodes": [
         {
-            "id": "sample-generator",
+            "id": "event-generator",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsUnion#0.json b/designer/client/cypress/fixtures/docsBasicComponentsUnion#0.json
@@ -18,10 +18,10 @@
         {
             "id": "source",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsVariable#0.json b/designer/client/cypress/fixtures/docsBasicComponentsVariable#0.json
@@ -18,10 +18,10 @@
         {
             "id": "input Kafka topic with json content",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/docsBasicComponentsVariable#1.json b/designer/client/cypress/fixtures/docsBasicComponentsVariable#1.json
@@ -16,12 +16,12 @@
     },
     "nodes": [
         {
-            "id": "sample-generator",
+            "id": "event-generator",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('PT1M')"

diff --git a/designer/client/cypress/fixtures/table.json b/designer/client/cypress/fixtures/table.json
@@ -17,12 +17,12 @@
     },
     "nodes": [
         {
-            "id": "sample-generator",
+            "id": "event-generator",
             "ref": {
-                "typ": "sample-generator",
+                "typ": "event-generator",
                 "parameters": [
                     {
-                        "name": "period",
+                        "name": "schedule",
                         "expression": {
                             "language": "spel",
                             "expression": "T(java.time.Duration).parse('P1D')"

diff --git a/docs/Changelog.md b/docs/Changelog.md
@@ -37,9 +37,10 @@
 * [#7356](https://github.com/TouK/nussknacker/pull/7356) Integers converted to BigDecimals have scale 18,
   this fixes issue with unexpected low scale when performing division on BigDecimals which were created in such conversion.
 * [#7379](https://github.com/TouK/nussknacker/pull/7379) Removed CustomAction mechanism.
-* Changes to `periodic` component (renamed to `sample-generator`):
-  * [#7368](https://github.com/TouK/nussknacker/pull/7368) Component rename: `periodic` to `sample-generator`
-  * [#7373](https://github.com/TouK/nussknacker/pull/7373) Improvements to `period` editor
+* Changes to `periodic` component (renamed to `event-generator`):
+  * [#7502](https://github.com/TouK/nussknacker/pull/7502) Component rename: `periodic` to `event-generator`
+  * [#7502](https://github.com/TouK/nussknacker/pull/7502) Parameter rename: `period` to `schedule`
+  * [#7373](https://github.com/TouK/nussknacker/pull/7373) Improvements to `schedule` editor
   * [#7376](https://github.com/TouK/nussknacker/pull/7376) Previously, when count was > 1, the value was evaluated once
     and emitted times count. For example: if the value was evaluated to be a random UUID and count was 5, one UUID was
     generated and emitted 5 times. Now in one count batch each value is evaluated separately.

diff --git a/docs/MigrationGuide.md b/docs/MigrationGuide.md
@@ -82,7 +82,7 @@ To see the biggest differences please consult the [changelog](Changelog.md).
   was removed to temporarily disable consumer group namespacing.
 
 ### Code API changes
-* [#7368](https://github.com/TouK/nussknacker/pull/7368) Renamed `PeriodicSourceFactory` to `SampleGeneratorSourceFactory`
+* [#7368](https://github.com/TouK/nussknacker/pull/7368) [#7502](https://github.com/TouK/nussknacker/pull/7502) Renamed `PeriodicSourceFactory` to `EventGeneratorSourceFactory`
 * [#7364](https://github.com/TouK/nussknacker/pull/7364) The DeploymentManager must implement `def schedulingSupport: SchedulingSupport`. If support not added, then `NoSchedulingSupport` should be used.
 
 ## In version 1.18.0

diff --git a/docs/developers_guide/FlinkComponents.md b/docs/developers_guide/FlinkComponents.md
@@ -41,7 +41,7 @@ Your Nussknacker source component specification should be a [SourceFactory](http
 returning your source implementation.
 
 ### Examples
-- [Periodic source](../scenarios_authoring/DataSourcesAndSinks.md#sample-generator) and its [implementation](https://github.com/TouK/nussknacker/blob/staging/engine/flink/components/base/src/main/scala/pl/touk/nussknacker/engine/flink/util/transformer/SampleGeneratorSourceFactory.scala)
+- [Event generator source](../scenarios_authoring/DataSourcesAndSinks.md#event-generator) and its [implementation](https://github.com/TouK/nussknacker/blob/staging/engine/flink/components/base/src/main/scala/pl/touk/nussknacker/engine/flink/util/transformer/EventGeneratorSourceFactory.scala)
 - [FlinkKafkaSource](https://github.com/TouK/nussknacker/blob/staging/engine/flink/kafka-components-utils/src/main/scala/pl/touk/nussknacker/engine/kafka/source/flink/FlinkKafkaSource.scala)
   and its factory returning the source implementation along with the fixed specification (e.g. based on a Scala case class) [KafkaSourceFactory](https://github.com/TouK/nussknacker/blob/staging/utils/kafka-components-utils/src/main/scala/pl/touk/nussknacker/engine/kafka/source/KafkaSourceFactory.scala)
   or generic one [UniversalKafkaSourceFactory](https://github.com/TouK/nussknacker/blob/staging/utils/schemed-kafka-components-utils/src/main/scala/pl/touk/nussknacker/engine/schemedkafka/source/UniversalKafkaSourceFactory.scala)