Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish to JSR #29

Merged
merged 3 commits into from
May 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/jsr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: jsr

env:
DENO_VERSION: 1.x

on:
push:
tags:
- "v*"

permissions:
contents: read
id-token: write

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: denoland/setup-deno@v1
with:
deno-version: ${{ env.DENO_VERSION }}
- name: Publish
run: |
deno run -A jsr:@david/[email protected]
11 changes: 11 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,14 @@ jobs:
- name: Benchmark
run: |
deno task bench | aha --no-header >> $GITHUB_STEP_SUMMARY

jsr-publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: denoland/setup-deno@v1
with:
deno-version: ${{ env.DENO_VERSION }}
- name: Publish (dry-run)
run: |
deno publish --dry-run
68 changes: 4 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,26 @@
# workerio

[![deno land](http://img.shields.io/badge/available%20on-deno.land/x-lightgrey.svg?logo=deno)](https://deno.land/x/workerio)
[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/workerio/mod.ts)
[![JSR](https://jsr.io/badges/@lambdalisue/workerio)](https://jsr.io/@lambdalisue/workerio)
[![Test](https://github.com/lambdalisue/deno-workerio/actions/workflows/test.yml/badge.svg)](https://github.com/lambdalisue/deno-workerio/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/lambdalisue/deno-workerio/graph/badge.svg?token=6Q1iOBg2Ka)](https://codecov.io/gh/lambdalisue/deno-workerio)

[Deno][deno] module to translate Worker's system of messages into
[`ReadableStream<Uint8Array>`][readablestream] and
[`WritableStream<Uint8Array>`][writablestream] or [`Deno.Reader`][reader] and
[`Deno.Writer`][writer].
[`WritableStream<Uint8Array>`][writablestream].

[deno]: https://deno.land/
[reader]: https://doc.deno.land/builtin/stable#Deno.Reader
[writer]: https://doc.deno.land/builtin/stable#Deno.Writer
[ReadableStream]: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream
[WritableStream]: https://developer.mozilla.org/en-US/docs/Web/API/WritableStream

## Example

### ReadableStream/WritableStream

#### Server

```typescript
import {
readableStreamFromWorker,
writableStreamFromWorker,
} from "https://deno.land/x/workerio@$MODULE_VERSION/mod.ts";
} from "@lambdalisue/workerio";

const decoder = new TextDecoder();
const encoder = new TextEncoder();
Expand Down Expand Up @@ -55,7 +49,7 @@ for await (const data of reader) {
import {
readableStreamFromWorker,
writableStreamFromWorker,
} from "https://deno.land/x/workerio@$MODULE_VERSION/mod.ts";
} from "@lambdalisue/workerio";

const decoder = new TextDecoder();
const encoder = new TextEncoder();
Expand All @@ -76,60 +70,6 @@ async function main(): Promise<void> {
main().catch((e) => console.error(e));
```

### Deno.Reader/Deno.Writer

#### Server

```typescript
import {
WorkerReader,
WorkerWriter,
} from "https://deno.land/x/workerio@$MODULE_VERSION/mod.ts";

const decoder = new TextDecoder();
const encoder = new TextEncoder();

const worker = new Worker(new URL("./worker.ts", import.meta.url).href, {
type: "module",
});

const reader = new WorkerReader(worker);
const writer = new WorkerWriter(worker);

await writer.write(encoder.encode("Hello"));
await writer.write(encoder.encode("World"));

for await (const data of Deno.iter(reader)) {
const text = decoder.decode(data);
console.log(text);
}
```

#### Worker

```typescript
import {
WorkerReader,
WorkerWriter,
} from "https://deno.land/x/workerio@$MODULE_VERSION/mod.ts";

const decoder = new TextDecoder();
const encoder = new TextEncoder();

async function main(): Promise<void> {
const worker = self as unknown as Worker;
const reader = new WorkerReader(worker);
const writer = new WorkerWriter(worker);

for await (const data of Deno.iter(reader)) {
const text = decoder.decode(data);
await writer.write(encoder.encode(`!!! ${text} !!!`));
}
}

main().catch((e) => console.error(e));
```

## License

The code follows MIT license written in [LICENSE](./LICENSE). Contributors need
Expand Down
23 changes: 22 additions & 1 deletion deno.jsonc
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
{
"name": "@lambdalisue/workerio",
"version": "0.0.0",
"exports": {
".": "./mod.ts",
"./readable_stream": "./readable_stream.ts",
"./writable_stream": "./writable_stream.ts"
},
"publish": {
"include": ["LICENSE", "README.md", "**/*.ts"],
"exclude": [
"./readable_stream_bench.ts",
"./readable_stream_test.ts",
"./test_bench.ts",
"./test_echo_server.ts",
"./test_util.ts",
"./writable_stream_bench.ts",
"./writable_stream_test.ts"
]
},
"tasks": {
"check": "deno check **/*.ts",
"test": "deno test -A --doc --parallel --shuffle",
Expand All @@ -9,6 +28,8 @@
"update:commit": "deno task -q update --commit --pre-commit=fmt,lint"
},
"imports": {
"https://deno.land/x/workerio@$MODULE_VERSION/": "./"
"@std/assert": "jsr:@std/assert@^0.225.1",
"@std/bytes": "jsr:@std/bytes@^0.224.0",
"@lambdalisue/workerio": "./mod.ts"
}
}
23 changes: 0 additions & 23 deletions example/server.ts

This file was deleted.

19 changes: 0 additions & 19 deletions example/worker.ts

This file was deleted.

67 changes: 3 additions & 64 deletions mod.ts
Original file line number Diff line number Diff line change
@@ -1,26 +1,21 @@
/**
* [Deno] module to translate Worker's system of messages into
* [`ReadableStream<Uint8Array>`][readablestream] and
* [`WritableStream<Uint8Array>`][writablestream] or [`Deno.Reader`][reader] and
* [`Deno.Writer`][writer].
* [`WritableStream<Uint8Array>`][writablestream].
*
* [Deno]: https://deno.land/
* [reader]: https://doc.deno.land/builtin/stable#Deno.Reader
* [writer]: https://doc.deno.land/builtin/stable#Deno.Writer
* [ReadableStream]: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream
* [WritableStream]: https://developer.mozilla.org/en-US/docs/Web/API/WritableStream
*
* ## Example
*
* ### ReadableStream/WritableStream
*
* #### Server
*
* ```typescript
* import {
* readableStreamFromWorker,
* writableStreamFromWorker,
* } from "https://deno.land/x/workerio@$MODULE_VERSION/mod.ts";
* } from "@lambdalisue/workerio";
*
* const decoder = new TextDecoder();
* const encoder = new TextEncoder();
Expand Down Expand Up @@ -49,7 +44,7 @@
* import {
* readableStreamFromWorker,
* writableStreamFromWorker,
* } from "https://deno.land/x/workerio@$MODULE_VERSION/mod.ts";
* } from "@lambdalisue/workerio";
*
* const decoder = new TextDecoder();
* const encoder = new TextEncoder();
Expand All @@ -70,63 +65,7 @@
* main().catch((e) => console.error(e));
* ```
*
* ### Deno.Reader/Deno.Writer
*
* #### Server
*
* ```typescript
* import {
* WorkerReader,
* WorkerWriter,
* } from "https://deno.land/x/workerio@$MODULE_VERSION/mod.ts";
*
* const decoder = new TextDecoder();
* const encoder = new TextEncoder();
*
* const worker = new Worker(new URL("./worker.ts", import.meta.url).href, {
* type: "module",
* });
*
* const reader = new WorkerReader(worker);
* const writer = new WorkerWriter(worker);
*
* await writer.write(encoder.encode("Hello"));
* await writer.write(encoder.encode("World"));
*
* for await (const data of Deno.iter(reader)) {
* const text = decoder.decode(data);
* console.log(text);
* }
* ```
*
* #### Worker
*
* ```typescript
* import {
* WorkerReader,
* WorkerWriter,
* } from "https://deno.land/x/workerio@$MODULE_VERSION/mod.ts";
*
* const decoder = new TextDecoder();
* const encoder = new TextEncoder();
*
* async function main(): Promise<void> {
* const worker = self as unknown as Worker;
* const reader = new WorkerReader(worker);
* const writer = new WorkerWriter(worker);
*
* for await (const data of Deno.iter(reader)) {
* const text = decoder.decode(data);
* await writer.write(encoder.encode(`!!! ${text} !!!`));
* }
* }
*
* main().catch((e) => console.error(e));
* ```
*
* @module
*/
export * from "./readable_stream.ts";
export * from "./reader.ts";
export * from "./writable_stream.ts";
export * from "./writer.ts";
28 changes: 2 additions & 26 deletions readable_stream_bench.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { assertEquals } from "https://deno.land/[email protected]/testing/asserts.ts";
import { readableStreamFromWorker, WorkerReader } from "./mod.ts";
import { assertEquals } from "@std/assert";
import { readableStreamFromWorker } from "./mod.ts";
import { MockWorker } from "./test_util.ts";

const count = 100;
Expand Down Expand Up @@ -35,28 +35,4 @@ for (const size of sizes) {
assertEquals(total, size * count);
},
);

Deno.bench(
`WorkerReader (${size.toString().padStart(2)} Bytes x ${count})`,
{
group: size.toString(),
},
async () => {
const worker = new MockWorker() as Worker;
const reader = new WorkerReader(worker);
for (let i = 0; i < count; i++) {
const data = new Uint8Array(size);
worker.postMessage(data);
}
worker.postMessage(null);
let total = 0;
while (true) {
const p = new Uint8Array(1024);
const n = await reader.read(p);
if (n === null) break;
total += n;
}
assertEquals(total, size * count);
},
);
}
8 changes: 4 additions & 4 deletions readable_stream_test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { assertEquals } from "https://deno.land/[email protected]/testing/asserts.ts";
import { concat } from "https://deno.land/[email protected]/bytes/mod.ts";
import { assertEquals } from "@std/assert";
import { concat } from "@std/bytes";
import { readableStreamFromWorker } from "./mod.ts";
import { MockWorker } from "./test_util.ts";

Expand All @@ -15,7 +15,7 @@ Deno.test(
for await (const chunk of rstream) {
chunks.push(chunk);
}
const content = concat(...chunks);
const content = concat(chunks);
assertEquals(content, new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]));
},
);
Expand All @@ -32,7 +32,7 @@ Deno.test(
for await (const chunk of rstream) {
chunks.push(chunk);
}
const content = concat(...chunks);
const content = concat(chunks);
assertEquals(content, new Uint8Array([0, 1, 2, 3, 4]));
},
);
Loading