@rdfc/js-runner 2.0.0-alpha.7 → 2.0.0-alpha.9

package/src/testUtils.ts

@@ -1,20 +1,22 @@
-import { DataChunk, OrchestratorMessage, RunnerClient } from '@rdfc/proto'
+import { DataChunk, RunnerClient } from '@rdfc/proto'
 import { ClientReadableStream } from '@grpc/grpc-js'
 import * as grpc from '@grpc/grpc-js'
 import { ClientReadableStreamImpl } from './reexports'
-import { extractShapes } from 'rdf-lens';
-import { Parser } from 'n3';
-import { readFile } from 'fs/promises';
-import winston, { createLogger } from 'winston';
-import { WriterInstance } from './writer';
-import { ReaderInstance } from './reader';
+import { extractShapes } from 'rdf-lens'
+import { Parser } from 'n3'
+import { readFile } from 'fs/promises'
+import winston, { createLogger } from 'winston'
+import { WriterInstance } from './writer'
+import { ReaderInstance } from './reader'
 
-export async function getProcessorShape(baseIRI = process.cwd() + "/node_modules/@rdfc/js-runner/index.ttl") {
-  const configFile = await readFile(baseIRI, { encoding: "utf8" });
-  const configQuads = new Parser().parse(configFile);
-  const shapes = extractShapes(configQuads);
+export async function getProcessorShape(
+  baseIRI = process.cwd() + '/node_modules/@rdfc/js-runner/index.ttl',
+) {
+  const configFile = await readFile(baseIRI, { encoding: 'utf8' })
+  const configQuads = new Parser().parse(configFile)
+  const shapes = extractShapes(configQuads)
 
-  return shapes;
+  return shapes
 }
 
 export class TestClient extends RunnerClient {
@@ -46,23 +48,30 @@ export async function one<T>(iter: AsyncIterable<T>): Promise<T | undefined> {
 export const client = new TestClient()
 export const uri = 'someUri'
 export const logger = createLogger({
-  transports: new winston.transports.Console({ level: process.env['DEBUG'] || 'info' }),
+  transports: new winston.transports.Console({
+    level: process.env['DEBUG'] || 'info',
+  }),
 })
 
 export function createWriter(iri = uri): [WriterInstance, ReaderInstance] {
-  const reader = createReader(iri);
-  const writeStream = new WriterInstance(iri, client, async (msg) => {
-    if (msg.msg) {
-      reader.handleMsg(msg.msg);
-    }
-    if(msg.close) {
-      reader.close()
-    }
-  }, logger)
-  return [writeStream, reader];
+  const reader = createReader(iri)
+  const writeStream = new WriterInstance(
+    iri,
+    client,
+    async (msg) => {
+      if (msg.msg) {
+        reader.handleMsg(msg.msg)
+      }
+      if (msg.close) {
+        reader.close()
+      }
+    },
+    logger,
+  )
+  return [writeStream, reader]
 }
 
 export function createReader(iri = uri): ReaderInstance {
-  const reader = new ReaderInstance(iri, client, logger);
-  return reader;
+  const reader = new ReaderInstance(iri, client, logger)
+  return reader
 }

package/src/util_processors.ts

@@ -16,5 +16,5 @@ export class LogProcessor extends Processor<LogArgs> {
     }
   }
 
-  async produce() { }
+  async produce() {}
 }

package/src/writer.ts

@@ -5,86 +5,86 @@ import { Any } from './reader'
 
 type Writable = (msg: OrchestratorMessage) => Promise<unknown>
 export interface Writer {
-    readonly uri: string;
-    buffer(buffer: Uint8Array): Promise<void>
+  readonly uri: string
+  buffer(buffer: Uint8Array): Promise<void>
 
-    stream(buffer: AsyncIterable<Uint8Array>): Promise<void>
-    stream<T>(
-        buffer: AsyncIterable<T>,
-        tranform: (x: T) => Uint8Array,
-    ): Promise<void>
+  stream(buffer: AsyncIterable<Uint8Array>): Promise<void>
+  stream<T>(
+    buffer: AsyncIterable<T>,
+    tranform: (x: T) => Uint8Array,
+  ): Promise<void>
 
-    string(buffer: string): Promise<void>
-    any(any: Any): Promise<void>
-    close(): Promise<void>
+  string(buffer: string): Promise<void>
+  any(any: Any): Promise<void>
+  close(): Promise<void>
 }
 const encoder = new TextEncoder()
 export class WriterInstance implements Writer {
-    readonly uri: string
-    private readonly client: RunnerClient
-    private readonly write: Writable
-    private readonly logger: Logger
+  readonly uri: string
+  private readonly client: RunnerClient
+  private readonly write: Writable
+  private readonly logger: Logger
 
-    constructor(
-        uri: string,
-        client: RunnerClient,
-        write: Writable,
-        logger: Logger,
-    ) {
-        this.client = client
-        this.write = write
-        this.uri = uri
-        this.logger = logger
+  constructor(
+    uri: string,
+    client: RunnerClient,
+    write: Writable,
+    logger: Logger,
+  ) {
+    this.client = client
+    this.write = write
+    this.uri = uri
+    this.logger = logger
+  }
+  async any(any: Any): Promise<void> {
+    if ('stream' in any) {
+      await this.stream(any.stream)
     }
-    async any(any: Any): Promise<void> {
-        if ('stream' in any) {
-            await this.stream(any.stream)
-        }
-        if ('buffer' in any) {
-            await this.buffer(any.buffer)
-        }
-        if ('string' in any) {
-            await this.string(any.string)
-        }
+    if ('buffer' in any) {
+      await this.buffer(any.buffer)
     }
-
-    async buffer(buffer: Uint8Array): Promise<void> {
-        this.logger.debug(`${this.uri} sends buffer ${buffer.length} bytes`)
-        await this.write({ msg: { data: buffer, channel: this.uri } })
+    if ('string' in any) {
+      await this.string(any.string)
     }
+  }
 
-    async stream<T = Uint8Array>(
-        buffer: AsyncIterable<T>,
-        transform?: (x: T) => Uint8Array,
-    ) {
-        const t = transform || ((x: unknown) => <Uint8Array>x)
-        const stream = this.client.sendStreamMessage()
-        const id: Id = await new Promise((res) => stream.once('data', res))
-        this.logger.debug(`${this.uri} streams message with id ${id.id}`)
-        await this.write({ streamMsg: { id, channel: this.uri } })
+  async buffer(buffer: Uint8Array): Promise<void> {
+    this.logger.debug(`${this.uri} sends buffer ${buffer.length} bytes`)
+    await this.write({ msg: { data: buffer, channel: this.uri } })
+  }
 
-        const write = promisify(stream.write.bind(stream))
-        for await (const msg of buffer) {
-            await write({ data: t(msg) })
-        }
+  async stream<T = Uint8Array>(
+    buffer: AsyncIterable<T>,
+    transform?: (x: T) => Uint8Array,
+  ) {
+    const t = transform || ((x: unknown) => <Uint8Array>x)
+    const stream = this.client.sendStreamMessage()
+    const id: Id = await new Promise((res) => stream.once('data', res))
+    this.logger.debug(`${this.uri} streams message with id ${id.id}`)
+    await this.write({ streamMsg: { id, channel: this.uri } })
 
-        this.logger.debug(`${this.uri} is done streaming message with id ${id.id}`)
-        stream.end()
+    const write = promisify(stream.write.bind(stream))
+    for await (const msg of buffer) {
+      await write({ data: t(msg) })
     }
 
-    async string(msg: string): Promise<void> {
-        this.logger.debug(`${this.uri} sends string ${msg.length} characters`)
-        await this.write({
-            msg: { data: encoder.encode(msg), channel: this.uri },
-        })
-    }
+    this.logger.debug(`${this.uri} is done streaming message with id ${id.id}`)
+    stream.end()
+  }
+
+  async string(msg: string): Promise<void> {
+    this.logger.debug(`${this.uri} sends string ${msg.length} characters`)
+    await this.write({
+      msg: { data: encoder.encode(msg), channel: this.uri },
+    })
+  }
 
-    async close(issued = false): Promise<void> {
-        this.logger.debug(`${this.uri} closes stream`)
-        if (!issued) {
-            await this.write({
-                close: { channel: this.uri },
-            })
-        }
+  async close(issued = false): Promise<void> {
+    this.logger.debug(`${this.uri} closes stream`)
+    if (!issued) {
+      await this.write({
+        close: { channel: this.uri },
+      })
     }
+  }
 }

package/examples/echo/.idea/echo.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/examples/echo/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_23" project-jdk-name="24" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

package/examples/echo/.idea/vcs.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$/../.." vcs="Git" />
-    <mapping directory="$PROJECT_DIR$/node_modules/@rdfc/js-runner" vcs="Git" />
-  </component>
-</project>

package/examples/echo/.swls/config.json

@@ -1 +0,0 @@
-{ "disabled": ["shapes"] }

package/examples/echo/index.ttl

@@ -1,3 +0,0 @@
-@prefix foaf: <http://xmlns.com/foaf/0.1/>.
-<#me> a foaf:Person;
-    foaf:name "".

package/examples/echo/minimal.ttl

@@ -1,90 +0,0 @@
-@prefix rdfc: <https://w3id.org/rdf-connect#>.
-@prefix prov: <http://www.w3.org/ns/prov#>.
-@prefix sds: <https://w3id.org/sds#>.
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
-@prefix owl: <http://www.w3.org/2002/07/owl#>.
-@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
-@prefix sh: <http://www.w3.org/ns/shacl#>.
-
-############################################################
-#                    General statements                    #
-############################################################
-# sds:Activity is a prov:Activity
-sds:Activity rdfs:subClassOf prov:Activity.
-
-# rdfc:Processor too
-rdfc:Processor rdfs:subClassOf sds:Activity.
-
-# sds:implementationOf is subClassOf
-sds:implementationOf rdfs:subPropertyOf rdfs:subClassOf.
-
-############################################################
-#                   Javascript statements                  #
-############################################################
-# specialized for js too
-rdfc:jsImplementationOf rdfs:subPropertyOf sds:implementationOf.
-
-# A node runner, runs things that are rdfc:jsImplementationOf rdfc:Processor  (aka, rdfs:subClassOf prov:Activity)
-rdfc:NodeRunner a rdfc:Runner;
-  rdfc:handlesSubjectsOf rdfc:jsImplementationOf;
-  rdfc:command "npx js-runner".
-
-# Shape that a Js Processor should fulfil;
-[ ] a sh:NodeShape;
-  # We target it with jsImplementationOf
-  sh:targetSubjectsOf rdfc:jsImplementationOf;
-  sh:property [
-    sh:path rdfc:entrypoint;
-    sh:name "location";
-    sh:minCount 1;
-    sh:maxCount 1;
-    sh:datatype xsd:string;
-  ], [
-    sh:path rdfc:file;
-    sh:name "file";
-    sh:minCount 1;
-    sh:maxCount 1;
-    sh:datatype xsd:string;
-  ], [
-    sh:path rdfc:class;
-    sh:name "clazz";
-    sh:maxCount 1;
-    sh:datatype xsd:string;
-  ].
-
-############################################################
-#                   Processor statements                   #
-############################################################
-rdfc:FooBarProcessor a owl:Class, rdfs:Class;
-  rdfc:jsImplementationOf rdfc:Processor;
-  rdfs:label "My Epic FooBar Processor";
-  rdfs:description "FooBars everything!";
-  rdfc:entrypoint <./>;
-  rdfc:file <./lib/processors.js>;
-  rdfc:class "FooBarProcessor".
-
-[ ] a sh:NodeShape;
-  sh:targetClass rdfc:FooBarProcessor;
-  sh:property [
-    sh:path rdfc:reader;
-    sh:name "reader";
-    sh:minCount 1;
-    sh:maxCount 1;
-    sh:class rdfc:Reader;
-  ].
-
-############################################################
-#                    Pipeline statements                   #
-############################################################
-<> a rdfc:Pipeline;
-  rdfc:consistsOf [
-    rdfc:instantiates rdfc:NodeRunner;
-    rdfc:processor <foobar>;
-  ].
-
-# <incomingMessages> a rdfc:Reader.
-<incomingMessages> a rdfc:Reader.
-
-<fooBar> a rdfc:FooBarProcessor;
-  rdfc:reader <incomingMessages>.
-

package/examples/echo/shacl.ttl

@@ -1,9 +0,0 @@
-
-@prefix foaf: <http://xmlns.com/foaf/0.1/>.
-@prefix sh: <http://www.w3.org/ns/shacl#>.
-[] a sh:NodeShape;
-  sh:targetClass foaf:Person;
-  sh:property [
-    sh:path foaf:name;
-    sh:minCount 1;
-  ].