refactor: updated for readability

src/index.ts

@@ -4,12 +4,14 @@ import { Readable } from "stream";
 import formatsPretty from "@rdfjs/formats/pretty.js";
 import Serializer from "@rdfjs/serializer-turtle";
 import { Validator } from "shacl-engine";
+import { ShaclError } from "./error";
 
 type ValidateArguments = {
     path: string;
     incoming: Stream<string>;
     outgoing: Writer<string>;
     report?: Writer<string>;
+    verbose?: boolean;
 };
 
 export async function validate(
@@ -29,7 +31,13 @@ export async function validate(
 
     // Create shape stream.
     const res = await rdf.fetch(path);
-    const shapes = await res.dataset();
+    if (!res.ok) {
+        throw ShaclError.fileSystemError();
+    }
+
+    const shapes = await res.dataset().catch(() => {
+        throw ShaclError.invalidRdfFormat();
+    });
 
     // Parse input stream using shape stream.
     // @ts-expect-error Factory is valid.
@@ -42,16 +50,21 @@ export async function validate(
             // Parse data into a dataset.
             const rawStream = Readable.from(data);
             const quadStream = parser.import(rawStream);
-            const dataset = await rdf.dataset().import(quadStream);
+            const dataset = await rdf
+                .dataset()
+                .import(quadStream)
+                .catch(() => {
+                    throw ShaclError.invalidRdfFormat();
+                });
 
             // Run through validator.
             const result = await validator.validate({ dataset });
-            const resultRaw = serializer.transform(result.dataset);
 
             // Pass through data if valid.
             if (result.conforms) {
                 await outgoing.push(data);
             } else if (report) {
+                const resultRaw = serializer.transform(result.dataset);
                 await report.push(resultRaw);
             }
         });

tests/data/invalid.report.ttl

@@ -4,14 +4,6 @@
 [ a sh:ValidationReport;
   sh:conforms false;
   sh:result [ a sh:ValidationResult;
-      sh:focusNode ex:ValidPoint;
-      sh:resultMessage "Requires an integer X coordinate";
-      sh:resultPath ex:x;
-      sh:resultSeverity sh:Violation;
-      sh:sourceConstraintComponent sh:DatatypeConstraintComponent;
-      sh:sourceShape [];
-      sh:value "1"
-    ], [ a sh:ValidationResult;
       sh:focusNode ex:ValidPoint;
       sh:resultMessage "Requires an integer Y coordinate";
       sh:resultPath ex:y;
@@ -27,5 +19,13 @@
       sh:sourceConstraintComponent sh:ClosedConstraintComponent;
       sh:sourceShape ex:PointShape;
       sh:value "3"
+    ], [ a sh:ValidationResult;
+      sh:focusNode ex:ValidPoint;
+      sh:resultMessage "Requires an integer X coordinate";
+      sh:resultPath ex:x;
+      sh:resultSeverity sh:Violation;
+      sh:sourceConstraintComponent sh:DatatypeConstraintComponent;
+      sh:sourceShape [];
+      sh:value "1"
     ]
 ].

tests/error.test.ts

@@ -0,0 +1,30 @@
+import { describe, test, expect } from "vitest";
+import { validate } from "../src";
+import { SimpleStream } from "@ajuvercr/js-runner";
+import { ShaclError } from "../src/error";
+
+describe("errors", () => {
+    test("invalid shacl file path", async () => {
+        expect.assertions(1);
+
+        const func = validate({
+            path: "/tmp/shacl-doesnt-exist.ttl",
+            incoming: new SimpleStream<string>(),
+            outgoing: new SimpleStream<string>(),
+        });
+
+        expect(func).rejects.toThrow(ShaclError.fileSystemError());
+    });
+
+    test("invalid shacl rdf format", async () => {
+        expect.assertions(1);
+
+        const func = validate({
+            path: "./tests/shacl/invalid.ttl",
+            incoming: new SimpleStream<string>(),
+            outgoing: new SimpleStream<string>(),
+        });
+
+        expect(func).rejects.toThrow(ShaclError.invalidRdfFormat());
+    });
+});

tests/shacl/invalid.ttl

@@ -0,0 +1,25 @@
+@prefix ex: <http://example.org#> .
+@prefix sh: <http://www.w3.org/ns/shacl#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+ex:PointShape
+    a sh:NodeShape;
+    sh:targetClass ex:Point;
+    sh:closed true;
+    sh:ignoredProperties (rdf:type);
+    sh:property [
+        sh:path ex:x;
+        sh:message "Requires an integer X coordinate";
+        sh:name "X-coordinate";
+        sh:datatype xsd:integer;
+        sh:minCount 1;
+        sh:maxCount 1;
+    ], [
+        sh:path ex:y;
+        sh:message "Requires an integer Y coordinate";
+        sh:name "Y-coordinate";
+        sh:datatype xsd:integer;
+        sh:minCount 1;
+        sh:maxCount 1;
+    ] # NOTE: Intentionally misses a period here!