Git Product home page Git Product logo

semaphore-async-await's Introduction

JavaScript Semaphore

A promise-based semaphore implementation suitable to be used with async/await.

Spare me the details, all I need is a lock.

Just import { Lock } from 'semaphore-async-await', acquire the lock by calling await lock.acquire() and release it when you're done by calling lock.release().

But JavaScript is single-threaded and doesn't need semaphores!

This package can be used to synchronize functions that span multiple iterations of the event loop and prevent other code from being executed while your function is waiting.

Suppose you have a function

async function criticalFunction() {
  const data = await getDataFromDb();
  const modifiedData = await asynchronouslyDoStuffWithData(data);
  return writeDataBackToDb(modifiedData);
}

Calling this function repeatedly could lead to overlapping read/writes. To avoid this problem, a lock can be added like so:

const lock = new Semaphore(1);

async function criticalFunctionSynchronous() {
  await lock.acquire();

  try {
    await criticalFunction();
  } finally {
    lock.release();
  }
}

Asynchronous functions like criticalFunction are executed in multiple chunks of code on the event loop, this package makes it possible to enforce an ordering in these chunks.

Install

yarn add semaphore-async-await

API

Usage

import Semaphore from 'semaphore-async-await';

(async () => {

  // A Semaphore with one permit is a lock
  const lock = new Semaphore(1);

  // Helper function used to wait for the given number of milliseconds
  const wait = (ms) => new Promise(r => setTimeout(r, ms));

  let globalVar = 0;

  (async () => {
    // This waits (without blocking the event loop) until a permit becomes available
    await lock.wait();
    const localCopy = globalVar;
    await wait(500);
    globalVar = localCopy + 1;
    // Signal releases the lock and lets other things run
    lock.signal();
  })();

  // This returns false because the function above has acquired the lock
  // and is scheduled to continue executing once the main function yields or
  // returns
  console.log(lock.tryAcquire() === false);

  // Similar to the function above but using waitFor instead of wait. We
  // give it five seconds to wait which is enough time for it to acquire
  // the lock
  (async () => {
    // This waits for at least five seconds, trying to acquire a permit.
    const didAcquireLock = await lock.waitFor(5000);
    if (didAcquireLock) {
      const localCopy = globalVar;
      await wait(500);
      globalVar = localCopy + 1;
      // Signal releases the lock and lets other things run
      lock.signal();
    }
  })();

  // Alternative to using wait()/signal() directly
  lock.execute(async () => {
    const localCopy = globalVar;
    await wait(500);
    globalVar = localCopy + 1;
  });

  // Wait for everything to finish
  await wait(2000);

  console.log(globalVar === 3);
})();

License

MIT

semaphore-async-await's People

Contributors

felixfbecker avatar jsoendermann avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

semaphore-async-await's Issues

Signature for execute() is wrong

async execute<T>(func: () => T): Promise<T> {

func is awaited, so it should be

async execute<T>(func: () => T | PromiseLike<T>): Promise<T> {

Otherwise TS incorrectly infers the return type as Promise<Promise<T>>

Thanks for this awesome package, it's awesome to see simple concepts like Semaphores properly implemented in TypeScript.

TypeError: Semaphore is not a constructor

Is there a trick to using this module in a Typescript project?

import Semaphore from 'semaphore-async-await';
const lock = new Semaphore(1);

TypeError: Semaphore is not a constructor

I was able to work around the issue by changing the import statement to this, but it seems a bit dodgy:

import SemaphoreModule from 'semaphore-async-await';
// Not sure why we need to do it this way...
const Semaphore = (SemaphoreModule as any)['default'];

const lock = new Semaphore(1); // works now

Am I doing something wrong?

Return value for execute method

It might be useful if you add return value for execute method for something like:

Promise.all(
	jobs.map(
		( name ) =>
			semaphore.execute(
				() => job( name )
			)
	)
)
.then(
	( results ) =>
	{
		console.log( '\nResults:', results );
	}
);

I know, that I can write somethin like this:

Promise.all(
	jobs.map(
		async ( name ) =>
		{
			await semaphore.wait();
			const result = await job( name );
			semaphore.signal();
			return result;
		}
	)
)
.then(
	( results ) =>
	{
		console.log( '\nResults:', results );
	}
);

But first example looks simpler.

The corejs reference in the Type defintion causes a TypeScript error

I am using this in an Ionic 2 TypeScript application. The reference to the corejs at the top of the type definition file causes a TypeScript error . Just deleting it fixes it, but of course it comes back as soon as we do a npm install on the project.

Can this be removed?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.