npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

plimited

v1.3.0

Published

Limited promise based resource pool

Downloads

17

Readme


Promise? Pool? Promise Pool? Limited Execution? All-in-one

API

eveything is in TypeScript, by the way

  1. PLimited - classic promise based "connection pool"
import {PLimited} from 'plimited';

const pool = PLimited({
  // create pool limited to 10 concurrent connections
  limit: 10,
  // create no more than 2 connection simultaneously
  constructionLimit: 2, 
  // close connection of unused for a minute
  ttl: 60,
  
  // optional life cycle methods
  // called on the first worker allocation
  onInit: (): sharedObject => allocateSomething(),
  // called on the last worker deallocation
  onIdle: (sharedObject) => deallocateSomething();
  
  // optional worker creators. called for each worker  
  constructor: (index, sharedObject) => createSomething(),
  destructor: (oldInstance, sharedObject) => destroy(oldInstance),
  
  // optional lifecycle events, called for each worker allocation
  onAcquire: (instance) => instance.prepare(),
  onFree: (instance) => instance.clean(),
  
  // you may hold something "complex" inside pool, and return a simpler API for the customer
  getter: (instance) => instance.aLittlePartOfIt;
});

const task = async () => { 
  // acquire "worker"
  const worker = await pool.acquire();
  // use instance you `constructor` before
  worker.get().doSomething();
  // release it
  worker.free();
};
  1. limited - concurrent execution controller.
import {limited} from 'plimited'
const taskRunner = limited(10);

// would return N promises you can await for
// but execute no more than 10 tasks in concurrently
Promise.all(
  data.map(item => taskRunner(async () => anything(item)))
);

taskRunner.close();

Handling exceptions

If, by any reason, worker become broken, for example puppetter might broke due to js exceptions on the page, you might dispose it

const worker = await pool.acquire();
//...
//something went wrong
await worker.regenerate(); // dispose the old worker, and create a new one
//...
worker.free();

// or
worker.drop(); // drop worker at once, no need to "free" it

Examples

Simple puppeteer, tab per worker

  • Uses onInit to create browser
  • creates a page on construction.
  • destroys it on destruction
  • Once all resources are freed - destroys the acquired browser.
import puppeteer from 'puppeteer';
import {PLimited} from 'plimited';

const createBrowser = () => puppeteer.launch();

return new PLimited({
    limit: 10,
    ttl: 60000, // keep alive for a minute
    
    // per Pool handlers
    onInit: () => {
      // pool initilization - create a browser
      return createBrowser();
    },
    onIdle: (browser) => {
      // pool idle state(no active workers) - destroy the browser
      browser.close();
    },
    
    // worker contruction handlers
    construct: async (index, browser) => {
      // create a new page
      return await browser.newPage();     
    },
    destruct: async (page) => {
      page.close();
    }
  });

Puppeteer, process per worker

Puppeteer is not 100% concurrent across "tabs", so sometimes it's better to create separated processes.

  • creates a browser and a page on construction.
  • destroys both on destruction
  • returns only page for a customer
import puppeteer from 'puppeteer';
import {PLimited} from 'plimited';

const createBrowser = () => puppeteer.launch();

return new PLimited({
    limit: 10,
    constructionLimit: 1, // allow only one puppeteer to "spin up" in a single point in time
    ttl: 60000, // keep alive for a moment
    construct: async () => {
      // create a browser
      const browser = await createBrowser();
      
      // create a new page
      const page = await browser.newPage();
     
      return { page, browser };
    },
    destruct: async ({ browser }) => {
      await browser.close();
    },
    // client needs only the "page" 
    getter: ({ page }) => page,
    onAcquire: async ({ page }) => {
      // initialization for every round
      await page.goto(`about:blank`, { waitUntil: 'load' })
      
      await page.setViewport({
        width: 1024,
        height: 768
      });
    },
  });

Mysql connection pool

Easy, and reliable

const mysql = require("mysql");
const {PLimited} = require("plimited");

const pool = new PLimited({
  limit: 10,
  ttl: 60 * 10,
  construct() {
    return mysql.createConnection({
      user: 'root',
      password: '',
      connection: ''
    })
  },

  destruct(conn) {
    conn.close();
  }
});

Licence

MIT