Merge branch 'main' into feat-listen-any-events-until

Author: cdavernas

.ci/validation/package-lock.json

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023-Present The Serverless Workflow Specification Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { SWSchemaValidator } from "./index";
+import fs from "node:fs";
+import path from "node:path";
+
+SWSchemaValidator.prepareSchemas();
+
+const ctkDir = path.join(__dirname, "..", "..", "..", "ctk", "features");
+
+function extractYamlBlocks(content: string): string[] {
+    const yamlBlockRegex = /"""yaml\s([\s\S]*?)\s"""/gm;  // Match YAML blocks
+    let match;
+    const yamlBlocks: string[] = [];
+
+    while ((match = yamlBlockRegex.exec(content)) !== null) {
+        yamlBlocks.push(match[1]);
+    }
+
+    return yamlBlocks;
+}
+
+const workflows = fs.readdirSync(ctkDir)
+    .filter((file) => file.endsWith(".feature"))
+    .flatMap((file) => {
+        const filePath = path.join(ctkDir, file);
+        const fileContent = fs.readFileSync(filePath, SWSchemaValidator.defaultEncoding);
+
+        const yamlBlocks = extractYamlBlocks(fileContent);
+
+        return yamlBlocks
+            .map((yamlText) => SWSchemaValidator.yamlToJSON(yamlText))
+            .filter((workflow) => typeof workflow === "object")
+            .filter((workflow) => "document" in workflow)
+            .filter((workflow) => "dsl" in workflow.document)
+            .map((workflow) => ({ workflow, file }));
+    });
+
+describe(`Validate workflows from .feature files`, () => {
+    test.each(workflows)('$workflow.document.name (from $file)', ({ workflow, file }) => {
+        const results = SWSchemaValidator.validateSchema(workflow);
+
+        if (results?.errors) {
+            console.warn(
+                `Schema validation failed for workflow "${workflow.document.name}" in file "${file}" with:`,
+                JSON.stringify(results.errors, null, 2)
+            );
+        }
+
+        expect(results?.valid).toBeTruthy();
+    });
+});

.ci/validation/src/ctk.test.ts

@@ -25,7 +25,7 @@ export module SWSchemaValidator {
   addFormats(ajv);
 
   const workflowSchemaId =
-    "https://serverlessworkflow.io/schemas/1.0.0-alpha1/workflow.yaml";
+    "https://serverlessworkflow.io/schemas/1.0.0-alpha5/workflow.yaml";
   const schemaPath = "../../../schema";
   export const defaultEncoding = "utf-8";
 

.ci/validation/src/index.ts

@@ -1,8 +1,8 @@
 document:
-  dsl: 1.0.0-alpha1
+  dsl: '1.0.0-alpha5'
   namespace: examples
   name: two-tasks-in-one-item
-  version: 1.0.0-alpha1
+  version: '0.1.0'
 do:
   - getPet:
       call: http

.ci/validation/test/fixtures/invalid/extra-property-in-call.yaml

@@ -1,8 +1,8 @@
 document:
-  dsl: 1.0.0-alpha1
+  dsl: '1.0.0-alpha5'
   namespace: examples
   name: two-tasks-in-one-item
-  version: 1.0.0-alpha1
+  version: '0.1.0'
 do:
   - getPet:
       call: http

.ci/validation/test/fixtures/invalid/two-tasks-in-one-item.yaml

@@ -0,0 +1,76 @@
+name: Bug Report
+description: Create a bug report
+labels: ["type: bug"]
+body:
+
+- type: markdown
+  attributes:
+    value: |
+       :pray: Thanks for taking the time to fill out this bug report!
+
+- type: markdown
+  attributes:
+    value: |
+       ## Bug Report
+
+- type: textarea
+  id: i-tried-this
+  attributes:
+    label: "I tried this:"
+    placeholder: "What did you try to do? A code snippet or example helps."
+  validations:
+    required: true
+
+- type: textarea
+  id: instead-what-happened
+  attributes:
+    label: "This happened:"
+    placeholder: "What happened instead of what you've expected?"
+  validations:
+    required: true
+
+- type: textarea
+  id: what-did-you-expect
+  attributes:
+    label: "I expected this:"
+    placeholder: "What did you expect to happen? Describe the output or behavior you expected to see (unless it's obvious)."
+
+- type: textarea
+  id: workaround
+  attributes:
+    label: "Is there a workaround?"
+    placeholder: "What's the workaround to avoid this issue?"
+
+- type: textarea
+  attributes:
+    label: Anything else?
+    placeholder: |
+      Links? References? Logs? Anything that will give us more context about the issue you are encountering.
+      Tip: You can attach images or log files by dragging files in.
+
+- type: markdown
+  attributes:
+    value: |
+       ## Environment
+
+- type: dropdown
+  id: areas
+  attributes:
+    label: "Area(s)"
+    multiple: true
+    options:
+      - Documentation
+      - Schema
+      - CTK
+      - Examples
+      - Use Cases
+      - Community
+      - Other
+
+- type: textarea
+  attributes:
+    label: Community Notes
+    value: |
+      <!-- Please keep this note for the community -->
+      * Please vote by adding a 👍 reaction to the issue to help us prioritize.
+      * If you are interested to work on this issue, please leave a comment.name: Bug Report 🐞

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,2 @@
+blank_issues_enabled: false
+contact_links: []

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,48 @@
+name: Feature Request
+description: Create a feature request
+labels: ["type: feature"]
+body:
+
+- type: markdown
+  attributes:
+    value: |
+       :pray: Thanks for taking the time to fill out this feature request!
+
+- type: markdown
+  attributes:
+    value: |
+       ## Feature Request
+
+- type: textarea
+  id: what-would-you-like-to-be-added
+  attributes:
+    label: "What would you like to be added?"
+    placeholder: "Description of the feature you'd like to see."
+  validations:
+    required: true
+
+- type: textarea
+  id: proposals
+  attributes:
+    label: "Proposal(s):"
+    placeholder: "Describe your proposal(s) and any relevant details here."
+
+- type: textarea
+  id: alternatives
+  attributes:
+    label: "Alternative(s):"
+    placeholder: "Describe any alternative approaches, options, or suggestions you’d like to consider."
+
+- type: textarea
+  id: additional-info
+  attributes:
+    label: "Additional info:"
+    placeholder: "Provide any supplementary details, context, or supporting information here."
+
+- type: textarea
+  attributes:
+    label: Community Notes
+    value: |
+      <!-- Please keep this note for the community -->
+      * Please vote by adding a 👍 reaction to the feature to help us prioritize.
+      * If you are interested to work on this feature, please leave a comment.