@rdfc/js-runner 3.0.2 → 3.1.0-alpha.1

package/README.md

@@ -1,5 +1,9 @@
 # JavaScript runner for RDF-Connect
 
+[![Build and tests with Node.js](https://github.com/rdf-connect/js-runner/actions/workflows/build-test.yml/badge.svg)](https://github.com/rdf-connect/js-runner/actions/workflows/build-test.yml) [![npm](https://img.shields.io/npm/v/@rdfc/js-runner.svg?style=popout)](https://npmjs.com/package/@rdfc/js-runner)
+
+This package provides a JavaScript runner implementation for RDF-Connect, which allows you to run JavaScript/TypeScript processors in your [RDF-Connect](https://github.com/rdf-connect/rdf-connect) pipeline.
+
 ## Usage
 
 To use the JavaScript (Node or Bun) runner for RDF-Connect, you need to have a pipeline configuration that includes JavaScript/TypeScript processors.

package/__tests__/channels.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test, vi } from 'vitest'
-import { StreamMsgMock } from '../src/testUtils'
+import { StreamMsgMock, channel, createRunner } from '../src/testUtils'
 import { WriterInstance } from '../src/writer'
 import { FromRunner, StreamIdentify } from '@rdfc/proto'
 import { createLogger, transports } from 'winston'
@@ -109,6 +109,8 @@ describe('Writer', async () => {
 
     await writer.close()
 
+    expect(writer.canceled).toBe(false)
+
     expect(msgs.length).toBe(1)
     expect(msgs.map((x) => x.close!.channel)).toEqual([uri])
 
@@ -150,4 +152,67 @@ describe('Writer', async () => {
       'world',
     ])
   })
+
+  test('is marked canceled when connected reader cancels', async () => {
+    const runner = createRunner()
+    const [writer, reader] = channel(runner, 'cancel-channel')
+
+    await reader.cancel()
+
+    expect(writer.canceled).toBe(true)
+    await expect(writer.string('hello')).rejects.toThrow(/canceled/i)
+  })
+
+  test('emits a cancel event when connected reader cancels', async () => {
+    const runner = createRunner()
+    const [writer, reader] = channel(runner, 'cancel-listener-channel')
+    const onCancel = vi.fn()
+
+    writer.on('cancel', onCancel)
+    await reader.cancel()
+
+    expect(onCancel).toBeCalledTimes(1)
+  })
+
+  test('does not emit a cancel event on a local close', async () => {
+    const uri = 'someUri'
+    const runner = 'myRunner'
+    const client = new StreamMsgMock(() => 1)
+    const write = async (_msg: FromRunner) => undefined
+    const writer = new WriterInstance(uri, client as any, write, runner, logger)
+    const onCancel = vi.fn()
+
+    writer.on('cancel', onCancel)
+    await writer.close()
+
+    expect(onCancel).not.toBeCalled()
+  })
+
+  test('throws when writing to a canceled writer', async () => {
+    const uri = 'someUri'
+    const runner = 'myRunner'
+    const client = new StreamMsgMock(() => 1)
+    const write = async (_msg: FromRunner) => undefined
+    const writer = new WriterInstance(uri, client as any, write, runner, logger)
+
+    await writer.close(true)
+
+    expect(writer.canceled).toBe(true)
+    await expect(writer.buffer(encoder.encode('x'))).rejects.toThrow(
+      /canceled/i,
+    )
+  })
+
+  test('rejects in-flight writes when reader cancels', async () => {
+    const runner = createRunner()
+    const [writer, reader] = channel(runner, 'cancel-in-flight')
+
+    // Register a reader consumer without draining it so the writer waits for processed.
+    reader.strings()
+
+    const pendingWrite = writer.string('hello')
+    await reader.cancel()
+
+    await expect(pendingWrite).rejects.toThrow(/canceled/i)
+  })
 })

package/__tests__/echoProcessor.test.ts

@@ -70,12 +70,11 @@ describe('EchoProcessor', () => {
 
     const msgs: string[] = []
 
-      ; (async () => {
-        for await (const m of outputReader.strings()) {
-          msgs.push(m)
-        }
-      })()
-
+    ;(async () => {
+      for await (const m of outputReader.strings()) {
+        msgs.push(m)
+      }
+    })()
 
     await inputWriter.string('Hello')
     expect(msgs).toEqual(['Hello'])
@@ -107,13 +106,13 @@ describe('EchoProcessor', () => {
 
     const msgs: string[] = []
 
-      ; (async () => {
-        for await (const m of outputReader.strings()) {
-          msgs.push(m)
-        }
-      })()
+    ;(async () => {
+      for await (const m of outputReader.strings()) {
+        msgs.push(m)
+      }
+    })()
 
-    const gen = async function*() {
+    const gen = async function* () {
       yield encoder.encode('Hello')
       yield encoder.encode('World')
     }