Merge branch 'main' into main

neuroglia-io · May 17, 2024 · 993915b · 993915b
2 parents 2d9cc48 + ca10bc3
commit 993915b
Show file tree

Hide file tree

Showing 42 changed files with 502 additions and 466 deletions.
diff --git a/.ci/examples-readme-hydration/index.js b/.ci/examples-readme-hydration/index.js
@@ -32,6 +32,7 @@ const disclaimer = `<!--
         console.error('Enable to parse JSON or convert it to YAML, output as it is.', ex);
       }
     }
+    fileContent = fileContent.trim() + '\n';
     readMe = readMe.replace(include[0], fileContent);
   };
   await fs.promises.writeFile(readMeOutputPath, disclaimer + readMe, { encoding: 'utf8', flag: 'w' });

diff --git a/.ci/validation/package-lock.json b/.ci/validation/package-lock.json
diff --git a/.ci/validation/package.json b/.ci/validation/package.json
@@ -11,7 +11,7 @@
   "author": "CNCF Serverless Workflow Specification",
   "license": "ISC",
   "devDependencies": {
-    "@types/jest": "^29.5.10",
+    "@types/jest": "^29.5.12",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
     "typescript": "^5.3.2"

diff --git a/.ci/validation/src/index.ts b/.ci/validation/src/index.ts
@@ -25,7 +25,7 @@ export module SWSchemaValidator {
     addFormats(ajv)
 
 
-    const workflowSchemaId = 'https://serverlessworkflow.io/schemas/0.8/workflow.json'
+    const workflowSchemaId = 'https://serverlessworkflow.io/schemas/0.9/workflow.json'
     const schemaPath = '../../../schema'
     export const defaultEncoding = 'utf-8'
 

diff --git a/.github/workflows/schema-check.yaml b/.github/workflows/schema-check.yaml
@@ -44,9 +44,9 @@ jobs:
         node-version: [21.x]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'

diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -13,48 +13,38 @@ You can contact the project maintainers at any time by sending an email to the
 
 Main responsibilities of maintainers include:
 
-1) They share responsibility in the project's success.
-2) They have made a long-term, recurring time investment to improve the project.
-3) They spend that time doing whatever needs to be done, not necessarily what
-is the most interesting or fun.
+1) Sharing responsibility for the project's success.
+2) Making a long-term, recurring time investment to improve the project.
+3) Performing necessary tasks, even if they are not the most interesting or fun.
 
 ## Reviewers
 
-A reviewer is a core role within the project.
-They share in reviewing issues and pull requests. Their pull request approvals
-are needed to merge a large code change into the project.
+A reviewer is a core role within the project. They share in reviewing issues and pull requests.
+Their pull request approvals are needed to merge code changes into the project.
+
+## Emeritus Maintainers
+
+Emeritus maintainers are retired maintainers who have provided valuable contributions to the project in the past but are not able to dedicate the time necessary to be fully active maintainers going forward. While their efforts will be focused elsewhere, it is hoped that they will try to find the time to continue to be active participants in the community by:
+
+1) Providing guidance and mentorship to current maintainers and contributors.
+2) Offering historical context and insights based on their past experiences.
+3) Participating in discussions and reviews on an advisory basis, without the obligations of active maintainers.
 
 ## Adding maintainers
 
-Maintainers are first and foremost contributors that have shown they are
-committed to the long term success of a project. Contributors wanting to become
-maintainers are expected to be deeply involved in contributing code, pull
-request review, and triage of issues in the project for more than three months.
-
-Just contributing does not make you a maintainer, it is about building trust
-with the current maintainers of the project and being a person that they can
-depend on and trust to make decisions in the best interest of the project.
-
-Periodically, the existing maintainers curate a list of contributors that have
-shown regular activity on the project over the prior months. From this list,
-maintainer candidates are selected and proposed on the project mailing list.
-Only one maintainer per organization is allowed to avoid taking over votes in case of conflicts.
-
-After a candidate has been announced on the project mailing list, the
-existing maintainers are given fourteen business days to discuss the candidate,
-raise objections and cast their vote. Votes may take place on the mailing list
-or via pull request comment. Candidates must be approved by at least 66% of the
-current maintainers by adding their vote on the mailing list. The reviewer role
-has the same process but only requires 33% of current maintainers. Only
-maintainers of the repository that the candidate is proposed for are allowed to
-vote.
-
-If a candidate is approved, a maintainer will contact the candidate to invite
-the candidate to open a pull request that adds the contributor to the
-MAINTAINERS file. The voting process may take place inside a pull request if a
-maintainer has already discussed the candidacy with the candidate and a
-maintainer is willing to be a sponsor by opening the pull request. The candidate
-becomes a maintainer once the pull request is merged.
+Maintainers are primarily contributors who have shown a strong commitment to the long-term success of the project. Contributors aspiring to become maintainers are expected to be actively involved in coding, reviewing pull requests, and managing issues for over three months.
+
+Becoming a maintainer is not just about contributing; it involves building trust with the current maintainers and proving to be a reliable decision-maker for the project.
+
+Periodically, the existing maintainers compile a list of contributors who have been consistently active in recent months. From this list, maintainer candidates are selected and proposed via a pull request. To avoid conflicts of interest, only one maintainer per organization is allowed.
+
+Once a candidate is proposed by adding them to the MAINTAINERS file via a pull request, the existing maintainers have fourteen business days to discuss, raise objections, and vote. Votes are cast through pull request comments, and candidates must receive at least 66% approval from the current maintainers.
+
+The process for the reviewer role is similar but requires only 33% approval from current maintainers. Voting is restricted to maintainers of the repository for which the candidate is proposed.
+
+## Adding Emeritus Maintainers
+
+To transition a maintainer to an emeritus role, the process follows the same voting and approval procedures as adding new maintainers, a new PR is created that requires a 66% approval vote from the current maintainers. Once approved, the emeritus maintainer is added to the EMERITUS file and announced to the community.
 
 ## Subprojects
 
@@ -140,9 +130,8 @@ document for more information about opening pull requests.
 
 ## Conflict Resolution
 
-At least 66% approval from the project's maintainers is necessary to merge changes
-in the specification. [Lazy consensus](http://communitymgt.wikia.com/wiki/Lazy_consensus)
-is considered by maintainers that do not directly express their opinions in the pull request.
+To merge changes into the specification, approval from at least one maintainer, other than the pull request's author, is required.
+Maintainers who do not explicitly voice their opinions on the pull request within the two-day approval period are assumed to agree through [lazy consensus](http://communitymgt.wikia.com/wiki/Lazy_consensus).
 
 Discussions and voting can be posponed in case one of the maintainers expressed that
 they won't be available for personal reasons, e.g. parental leave, vacations, sick leave, etc.

diff --git a/examples/README_TEMPLATE.md b/examples/README_TEMPLATE.md
@@ -1091,7 +1091,6 @@ events:
   - contextAttributeName: accountId
 - name: ConfirmationCompletedEvent
   type: payment.confirmation
-  kind: produced
 
 ```
 

diff --git a/examples/accumulate-room-readings.json b/examples/accumulate-room-readings.json
@@ -1,6 +1,5 @@
 {
-    "id": "roomreadings",
-    "name": "roomreadings",
+    "name": "room-readings",
     "description": "Room Temp and Humidity Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",

diff --git a/examples/applicant-request-decision.json b/examples/applicant-request-decision.json
@@ -1,5 +1,4 @@
 {
-    "id": "applicantrequest",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "applicant-request-decision-workflow",

diff --git a/examples/async-function-invocation.json b/examples/async-function-invocation.json
@@ -1,5 +1,4 @@
 {
-    "id": "sendcustomeremail",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "send-customer-email-workflow",

diff --git a/examples/async-subflow-invocation.json b/examples/async-subflow-invocation.json
@@ -1,5 +1,4 @@
 {
-    "id": "onboardcustomer",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "onboard-customer",

diff --git a/examples/book-lending.json b/examples/book-lending.json
@@ -1,10 +1,10 @@
 {
-    "id": "booklending",
-    "name": "booklending",
+    "name": "book-lending",
     "description": "Book Lending Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",
     "start": "book-lending-request",
+    "constants" : { "WAIT_BEFORE_POLL" : "PT2W"},
     "states": [
         {
             "name": "book-lending-request",
@@ -101,10 +101,13 @@
                             "bookid": "${ .book.id }",
                             "lender": "${ .lender }"
                         }
+                    }, 
+                    "sleep" : {
+                      "after" : "$CONST.WAIT_BEFORE_POLL"
                     }
                 }
             ],
-            "transition": "sleep-two-weeks"
+            "transition": "get-book-status"
         },
         {
             "name": "cancel-request",
@@ -118,15 +121,12 @@
                             "bookid": "${ .book.id }",
                             "lender": "${ .lender }"
                         }
+                    }, 
+                    "sleep" : {
+                      "after" : "$CONST.WAIT_BEFORE_POLL"
                     }
                 }
             ],
-            "transition": "sleep-two-weeks"
-        },
-        {
-            "name": "sleep-two-weeks",
-            "type": "sleep",
-            "duration": "PT2W",
             "transition": "get-book-status"
         },
         {

diff --git a/examples/car-vitals-checks-subflow.json b/examples/car-vitals-checks-subflow.json
@@ -1,6 +1,5 @@
 {
-    "id": "vitalscheck",
-    "name": "vitalscheck",
+    "name": "vitals-check",
     "description": "Car Vitals Check",
     "version": "1.0.0",
     "specVersion": "0.8",

diff --git a/examples/car-vitals-checks.json b/examples/car-vitals-checks.json
@@ -1,6 +1,5 @@
 {
-    "id": "checkcarvitals",
-    "name": "checkcarvitals",
+    "name": "check-car-vitals",
     "description": "Check Car Vitals Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",

diff --git a/examples/check-inbox-periodically.json b/examples/check-inbox-periodically.json
@@ -1,5 +1,4 @@
 {
-    "id": "check-inbox",
     "name": "check-inbox",
     "version": "1.0.0",
     "specVersion": "0.8",

diff --git a/examples/continuing-as-a-new-execution.json b/examples/continuing-as-a-new-execution.json
@@ -1,6 +1,5 @@
 {
-    "id": "notifycustomerworkflow",
-    "name": "notifycustomerworkflow",
+    "name": "notify-customer-workflow",
     "description": "Notify Customer",
     "version": "1.0.0",
     "specVersion": "0.8",

diff --git a/examples/curl.json b/examples/curl.json
@@ -0,0 +1,35 @@
+{
+    "name": "curlgoogle",
+    "version": "1.0.0",
+    "specVersion": "0.8",
+    "description": "Curl Google",
+    "start": "curl",
+    "functions": [
+        {
+            "name": "curl-google",
+            "type": "http",
+            "operation": {
+                "method": "GET",
+                "uri": "https://www.google.com/search?q={query}"
+            }
+        }
+    ],
+    "states": [
+        {
+            "name": "curl",
+            "type": "operation",
+            "actions": [
+                {
+                    "name": "do-curl",
+                    "functionRef": {
+                        "refName": "curl-google",
+                        "arguments": {
+                            "query": "${ .query }"
+                        }
+                    }
+                }
+            ],
+            "end": true
+        }
+    ]
+}
diff --git a/examples/event-based-greeting.json b/examples/event-based-greeting.json
@@ -1,8 +1,7 @@
 {
-    "id": "eventbasedgreeting",
     "version": "1.0.0",
     "specVersion": "0.8",
-    "name": "Event Based Greeting Workflow",
+    "name": "event-based-greeting-workflow",
     "description": "Event Based Greeting",
     "start": "greet",
     "events": [

diff --git a/examples/event-based-service-invocation.json b/examples/event-based-service-invocation.json
@@ -1,5 +1,4 @@
 {
-    "id": "vet-appointment-workflow",
     "name": "vet-appointment-workflow",
     "description": "Vet service call via events",
     "version": "1.0.0",
@@ -9,14 +8,12 @@
         {
             "name": "make-vet-appointment",
             "source": "VetServiceSource",
-            "type": "events.vet.appointments",
-            "kind": "produced"
+            "type": "events.vet.appointments"
         },
         {
             "name": "vet-appointment-info",
             "source": "VetServiceSource",
-            "type": "events.vet.appointments",
-            "kind": "consumed"
+            "type": "events.vet.appointments"
         }
     ],
     "states": [
@@ -26,10 +23,15 @@
             "actions": [
                 {
                     "name": "make-appointment-action",
-                    "eventRef": {
-                        "produceEventRef": "make-vet-appointment",
-                        "data": "${ .patientInfo }",
-                        "consumeEventRef": "vet-appointment-info"
+                    "publish": {
+                        "event": "make-vet-appointment",
+                        "data": "${ .patientInfo }"
+                    }
+                },
+                {
+                    "name": "wait-appointement-confirmation",
+                    "subscribe": {
+                        "event": "vet-appointment-info"
                     },
                     "actionDataFilter": {
                         "results": "${ .appointmentInfo }"

diff --git a/examples/event-based-transitions.json b/examples/event-based-transitions.json
@@ -1,5 +1,4 @@
 {
-    "id": "eventbasedswitchstate",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "event-based-switch-transitions",

diff --git a/examples/filling-a-glass-of-water.json b/examples/filling-a-glass-of-water.json
@@ -1,6 +1,5 @@
 {
-    "id": "fillglassofwater",
-    "name": "fillglassofwater",
+    "name": "fill-glass-of-water",
     "description": "Fill glass of water workflow",
     "version": "1.0.0",
     "specVersion": "0.8",

diff --git a/examples/finalize-college-application.json b/examples/finalize-college-application.json
@@ -1,6 +1,5 @@
 {
-    "id": "finalize-college-application",
-    "name": "finalizeCollegeApplication",
+    "name": "finalize-college-application",
     "version": "1.0.0",
     "specVersion": "0.8",
     "start": "finalize-application",

diff --git a/examples/greeting.json b/examples/greeting.json
@@ -1,5 +1,4 @@
 {
-    "id": "greeting",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "greeting-workflow",

diff --git a/examples/handle-car-auction-bids.json b/examples/handle-car-auction-bids.json
@@ -1,5 +1,4 @@
 {
-    "id": "handle-car-auction-bid",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "handle-car-auction-bid",

diff --git a/examples/hello-world.json b/examples/hello-world.json
@@ -1,8 +1,7 @@
 {
-   "id": "helloworld",
    "version": "1.0.0",
    "specVersion": "0.8",
-   "name": "Hello World Workflow",
+   "name": "hello-world-workflow",
    "description": "Inject Hello World",
    "start": "hello-state",
    "states": [