ciorent 0.1.1 → 0.1.3

package/README.md

@@ -1,63 +1,31 @@
 A lightweight, low-overhead concurrency library.
-## Fibers
-Virtual threads with more controlled execution.
+## Semaphore
+Semaphore is a concurrency primitive used to control access to a common resource by multiple processes.
 
 ```ts
+import * as semaphore from 'ciorent/semaphore';
 import * as cio from 'ciorent';
-import * as fiber from 'ciorent/fiber';
-
-const thread1 = fiber.fn(function* () {
-  console.log('Fiber 1 started');
-
-  // Thread1 will be interrupted by thread2
-  // As thread2 will end first
-  yield cio.sleep(1000);
-
-  console.log('Fiber 1 done');
-});
-
-const thread2 = fiber.fn(function* (thread) {
-  console.log('Fiber 2 started');
-
-  yield;
-  console.log('Fiber 2 resumed');
-
-  // Start thread 1 and make thread1
-  // lifetime depends on thread2
-  fiber.mount(fiber.spawn(thread1), thread);
-
-  console.log('Fiber 2 done');
-});
-
-// Start running the thread
-fiber.spawn(thread2);
-```
 
-## Latch
-Latch is a synchronization primitive that allows one process to wait until another completes an operation before continuing execution.
+// Only allow 2 task to run concurrently
+const sem = semaphore.init(2);
 
-```ts
-import * as latch from 'ciorent/latch';
+const task = async (id: number) => {
+  // Acquire the semaphore or wait for the semaphore to be available
+  await semaphore.pause(sem);
 
-const startFetch = latch.init();
+  console.log('Task', id, 'started');
 
-const task = async () => {
-  // Blocks until the latch is open
-  await latch.pause(startFetch);
+  // Let the main thread schedules other tasks
+  for (let i = 1; i <= 5; i++) await cio.pause;
 
-  console.log('Start fetching...');
-  const res = await fetch('http://example.com');
-  console.log('Fetch status:', res.status);
-}
+  console.log('Task', id, 'end');
 
-const prepare = () => {
-  // This always run first
-  console.log('Run before fetch:', performance.now().toFixed(2));
-  latch.open(startFetch);
+  // Release the semaphore
+  semaphore.signal(sem);
 }
 
-task();
-prepare();
+// Try to run 5 tasks concurrently
+cio.concurrent(5, task);
 ```
 
 ## Pubsub
@@ -134,33 +102,63 @@ run();
 console.log('Starting...');
 ```
 
-## Semaphore
-Semaphore is a concurrency primitive used to control access to a common resource by multiple processes.
+## Latch
+Latch is a synchronization primitive that allows one process to wait until another completes an operation before continuing execution.
+
+```ts
+import * as latch from 'ciorent/latch';
+
+const startFetch = latch.init();
+
+const task = async () => {
+  // Blocks until the latch is open
+  await latch.pause(startFetch);
+
+  console.log('Start fetching...');
+  const res = await fetch('http://example.com');
+  console.log('Fetch status:', res.status);
+}
+
+const prepare = () => {
+  // This always run first
+  console.log('Run before fetch:', performance.now().toFixed(2));
+  latch.open(startFetch);
+}
+
+task();
+prepare();
+```
+
+## Fibers
+Virtual threads with more controlled execution.
 
 ```ts
-import * as semaphore from 'ciorent/semaphore';
 import * as cio from 'ciorent';
+import * as fiber from 'ciorent/fiber';
 
-// Only allow 2 task to run concurrently
-const sem = semaphore.init(2);
+const f1 = fiber.fn(function* () {
+  console.log('Fiber 1 started');
 
-const task = async (id: number) => {
-  // Acquire the semaphore or wait for the semaphore to be available
-  await semaphore.pause(sem);
+  // Wait for a promise
+  yield cio.sleep(1000);
 
-  console.log('Task', id, 'started');
+  console.log('Fiber 1 done');
+  return Math.random();
+});
 
-  // Let the main thread schedules other tasks
-  for (let i = 1; i <= 5; i++) await cio.pause;
+fiber.spawn(function* (proc) {
+  console.log('Fiber 2 started');
 
-  console.log('Task', id, 'end');
+  // Start f1, wait for it to finish and get the result
+  const res = yield* fiber.join(fiber.spawn(f1));
+  console.log('Fiber 1 result:', res);
 
-  // Release the semaphore
-  semaphore.signal(sem);
-}
+  // Start f1 and make its lifetime depends on current fiber
+  fiber.mount(fiber.spawn(f1), proc);
 
-// Try to run 5 tasks concurrently
-cio.concurrent(5, task);
+  // The runtime will interrupt f1
+  console.log('Fiber 2 done');
+});
 ```
 
 ## Utilities
@@ -253,16 +251,16 @@ Limits the number of calls within a time window.
 ```ts
 import * as cio from 'ciorent';
 
-// Allow 1 call in 500ms
+// Allow 2 calls in 500ms, other calls are dropped
 const fn = cio.rateLimit((id: number) => {
   console.log('Call ' + id + ':', Math.floor(performance.now()) + 'ms');
-}, 500, 1);
+}, 500, 2);
 
-fn(1); // fn(1) gets executed
-await cio.sleep(100);
-fn(2); // fn(2) gets skipped
-await cio.sleep(500);
-fn(3); // fn(3) gets executed
+// Some calls will be dropped
+for (let i = 0; i < 8; i++) {
+  fn(i);
+  await cio.sleep(400);
+}
 ```
 
 ### Throttle
@@ -275,6 +273,6 @@ const fn = cio.throttle((id: number) => {
   console.log(id + ': ' + Math.floor(performance.now()) + 'ms');
 }, 500, 2);
 
-cio.concurrent(8, (id) => fn(id));
+cio.concurrent(8, fn);
 ```
 

package/fiber.d.ts

@@ -2,47 +2,51 @@
  * @module Fibers
  */
 /**
- * Check whether the fiber is paused
+ * Describe a fiber process
  */
-export declare const paused: (t: Thread) => boolean;
-/**
- * Check whether the fiber is running
- */
-export declare const running: (t: Thread) => boolean;
-/**
- * Check whether the fiber is done
- */
-export declare const done: (t: Thread) => boolean;
-/**
- * Describe a fiber
- */
-export interface Thread<T = unknown, TReturn = unknown> {
+export interface Process<TReturn = unknown> {
     /**
      * The waiting promise
      */
-    0: Promise<T | TReturn>;
+    0: Promise<TReturn | undefined>;
     /**
      * Fiber status
      */
-    1: 0 | 1 | 2;
+    1: 0 | 1 | 2 | 3;
     /**
      * Callback to continue running the fiber
      */
     2: null | (() => void);
     /**
-     * Bounded threads
+     * Bounded fibers
      */
-    3: Thread[];
+    3: Process[];
 }
 /**
  * Describe a fiber runtime
  */
-export type Runtime = <const T, const TReturn, const Args extends any[]>(gen: (thread: Thread<T, TReturn>, ...args: Args) => Generator<T, TReturn>, ...args: Args) => Thread<T, TReturn>;
+export type Runtime = <const TReturn, const Args extends any[]>(gen: (proc: Process<TReturn>, ...args: Args) => Generator<any, TReturn>, ...args: Args) => Process<TReturn>;
+/**
+ * Check whether the fiber is paused
+ */
+export declare const paused: (t: Process) => boolean;
+/**
+ * Check whether the fiber is running
+ */
+export declare const running: (t: Process) => boolean;
+/**
+ * Check whether the fiber is finished
+ */
+export declare const done: (t: Process) => boolean;
+/**
+ * Check whether the fiber is interrupted
+ */
+export declare const stopped: (t: Process) => boolean;
 /**
  * Create a fiber function
  * @param f
  */
-export declare const fn: <const Fn extends (thread: Thread, ...args: any[]) => Generator>(f: Fn) => Fn;
+export declare const fn: <const Fn extends (thread: Process, ...args: any[]) => Generator>(f: Fn) => Fn;
 /**
  * A basic fiber runtime
  * @param g
@@ -52,39 +56,39 @@ export declare const spawn: Runtime;
  * Pause the execution of a fiber
  * @param t
  */
-export declare const pause: (t: Thread) => void;
+export declare const pause: (t: Process) => void;
 /**
  * Resume the execution of a fiber
  * @param t
  */
-export declare const resume: (t: Thread) => void;
+export declare const resume: (t: Process) => void;
 /**
  * Stop the execution of a fiber
  * @param t
  */
-export declare const stop: (t: Thread) => void;
+export declare const stop: (t: Process) => void;
 /**
  * Wait for a fiber and retrieve its result
  * @param t
  */
-export declare function join<T extends Thread>(t: T): Generator<Awaited<T[1]>, Awaited<T[1]>>;
+export declare function join<T extends Process>(t: T): Generator<Awaited<T[0]>, Awaited<T[0]>>;
 /**
  * Wait for a fiber to finish and retrieve its result
  * @param t
  */
-export declare const finish: <T extends Thread>(t: T) => T[1];
+export declare const finish: <T extends Process>(t: T) => T[3];
 /**
  * Mount child fiber lifetime to parent lifetime
  * @param child
  * @param parent
  */
-export declare const mount: (child: Thread, parent: Thread) => void;
+export declare const mount: (child: Process, parent: Process) => void;
 /**
  * Control the fiber with an abort signal
  * @param t
  * @param signal
  */
-export declare const control: (t: Thread, signal: AbortSignal) => void;
+export declare const control: (t: Process, signal: AbortSignal) => void;
 /**
  * Unwrap a promise result
  */

package/fiber.js

@@ -1 +1 @@
-export let paused=(t)=>t[1]===0;export let running=(t)=>t[1]===1;export let done=(t)=>t[1]===2;let invoke=async(g,thread)=>{try{let t=g.next();while(!t.done){let v=await t.value;if(thread[1]===0){let r;let p=new Promise((res)=>{r=res});thread[2]=r;await p}if(thread[1]===2){thread[3].forEach(stop);return v}t=g.next(v)}thread[1]=2;return t.value}finally{thread[3].forEach(stop)}};export let fn=(f)=>f;export let spawn=(f,...args)=>{let thread=[null,1,null,[]];thread[0]=invoke(f(thread,...args),thread);return thread};export let pause=(t)=>{if(t[1]===1)t[1]=0};export let resume=(t)=>{if(t[1]===0){t[1]=1;t[2]?.()}};export let stop=(t)=>{if(t[1]===0){t[1]=2;t[2]?.()}else t[1]=2};export function*join(t){return yield t[1]}export let finish=(t)=>t[1];export let mount=(child,parent)=>{parent[3].push(child)};export let control=(t,signal)=>{signal.addEventListener("abort",()=>{stop(t)})};export function*unwrap(t){return yield t}
+export let paused=(t)=>t[1]===0;export let running=(t)=>t[1]===1;export let done=(t)=>t[1]===2;export let stopped=(t)=>t[1]===3;let invoke=async(g,thread)=>{try{let t=g.next();while(!t.done){let v=await t.value;if(thread[1]===0){let r;let p=new Promise((res)=>{r=res});thread[2]=r;await p}if(thread[1]===3)return;t=g.next(v)}thread[1]=2;return t.value}finally{thread[3].forEach(stop)}};export let fn=(f)=>f;export let spawn=(f,...args)=>{let thread=[null,1,null,[]];thread[0]=invoke(f(thread,...args),thread);return thread};export let pause=(t)=>{if(t[1]===1)t[1]=0};export let resume=(t)=>{if(t[1]===0){t[1]=1;t[2]?.()}};export let stop=(t)=>{if(t[1]===0)t[2]?.();t[1]=3};export function*join(t){return yield t[0]}export let finish=(t)=>t[3];export let mount=(child,parent)=>{parent[3].push(child)};export let control=(t,signal)=>{signal.addEventListener("abort",()=>{stop(t)})};export function*unwrap(t){return yield t}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ciorent",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A lightweight, low-overhead concurrency library",
   "homepage": "https://ciorent.netlify.app",
   "repository": {
@@ -19,13 +19,13 @@
   "types": "./index.d.ts",
   "exports": {
     "./sliding-queue": "./sliding-queue.js",
+    "./fixed-queue": "./fixed-queue.js",
+    "./fiber": "./fiber.js",
+    ".": "./index.js",
     "./semaphore": "./semaphore.js",
+    "./dropping-queue": "./dropping-queue.js",
     "./topic": "./topic.js",
-    ".": "./index.js",
-    "./latch": "./latch.js",
     "./channel": "./channel.js",
-    "./fixed-queue": "./fixed-queue.js",
-    "./dropping-queue": "./dropping-queue.js",
-    "./fiber": "./fiber.js"
+    "./latch": "./latch.js"
   }
 }

package/semaphore.d.ts

@@ -32,6 +32,6 @@ export declare const pause: (s: Semaphore) => Promise<void>;
  */
 export declare const signal: (s: Semaphore) => void;
 /**
- * Wrap a task to bind to a custom semaphore later
+ * Bind a task to a semaphore
  */
-export declare const wrap: <Args extends any[], Return extends Promise<any>>(f: (...args: Args) => Return) => ((s: Semaphore, ...a: Args) => Return);
+export declare const bind: <T extends (...args: any[]) => Promise<any>>(f: T, s: Semaphore) => T;

package/semaphore.js

@@ -1 +1 @@
-import{pause as resolvedPromise}from"./index.js";export let init=(n)=>{let root=[null];return[n,root,root]};export let pause=(s)=>{s[0]--;if(s[0]<0){let r;let p=new Promise((res)=>{r=res});s[1]=s[1][0]=[null,r];return p}return resolvedPromise};export let signal=(s)=>{if(s[0]<0)(s[2]=s[2][0])[1]();s[0]++};export let wrap=(f)=>async(s,...a)=>{s[0]--;if(s[0]<0){let r;let p=new Promise((res)=>{r=res});s[1]=s[1][0]=[null,r];await p}try{return await f(...a)}finally{signal(s)}};
+import{pause as resolvedPromise}from"./index.js";export let init=(n)=>{let root=[null];return[n,root,root]};export let pause=(s)=>{s[0]--;if(s[0]<0){let r;let p=new Promise((res)=>{r=res});s[1]=s[1][0]=[null,r];return p}return resolvedPromise};export let signal=(s)=>{if(s[0]<0)(s[2]=s[2][0])[1]();s[0]++};export let bind=(f,s)=>async(...a)=>{s[0]--;if(s[0]<0){let r;let p=new Promise((res)=>{r=res});s[1]=s[1][0]=[null,r];await p}try{return await f(...a)}finally{if(s[0]<0)(s[2]=s[2][0])[1]();s[0]++}};