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

steps-track

v1.1.13

Published

A simple JS implementation for tracking the time-used and data of the intermediate steps in a long function. Useful for enhancing performance of a pipeline-like functions that consists of parallel async functions.

Downloads

694

Readme

StepsTrack

StepsTrack is a simple library for tracking the time and data of the intermediate steps in a function for further debugging / enchancements. Useful for enhancing performance of a pipeline-like function that consists of multiple steps and/or conccurent async functions.

Features

  • Track intermediates data, results and execution time of all sub-steps.
  • Generate Gantt chart for visual representation of step durations.

Installation

npm install --save steps-track

Note: If you encounter error installing chart.js / node-canvas, see https://github.com/Automattic/node-canvas/wiki#installation-guides

Example

Sample Code

import { StepTracker } from 'steps-track';

async function main() {
        
    const mainTracker = new StepTracker('main', {
        logResult: true,    // Default false. If true, the result of each step will be logged.
                            // Note: Setting to true may incur memory usage increase.
        listeners: {
            'foo': (data) => {
                console.log(`tracker.on(foo) receiving ${data}`)
            },
            'someData': (data) => {
                console.log(`tracker.on(someData) receiving ${data}`)
            }
        }
    });

    await mainTracker.track(async (st: StepTracker) => {
       
        await st.step('demo', async (st: StepTracker) => {
        
            // Your logic here
            st.record('foo', 'bar');
            await new Promise(resolve => setTimeout(resolve, 200));
        });
        
        await st.step('fetch', async (st: StepTracker) => {
                
            const urls = await st.step('preprocess', async (st: StepTracker) => {
                
                // Some preprocess logic
                st.record('someData', 12345);
                await new Promise(resolve => setTimeout(resolve, 1000));
                return ['https://url1.com', 'https://url2.com', 'https://url3.com'];
            });
        
            await new Promise(resolve => setTimeout(resolve, 500));
        
            // Concurrent sub steps
            await Promise.all(urls.map(async (url) => {
                return st.step(`${url}`, async (st: StepTracker) => {
                    return await fetch(url);
                });
            }));
        });
    });
    
    console.log(JSON.stringify(mainTracker.output(), null, 2));

    // output gantt chart

    const ganttArgs = {
        unit: 'ms',                 // 's' | 'ms'. Default 'ms'
        minWidth: 100,              // Default 500
        minHeight: 100,             // Default 300
        includeSteps: /main.fetch/  // string[] | RegExp. if not provided, all steps will be included
    }
    // Gantt chart generated via quickchart.io
    const ganttUrl = mainTracker.ganttUrl(ganttArgs);     

    // Gantt chart buffer generated locally using chart.js, in png format
    const ganttBuffer = mainTracker.ganttLocal(ganttArgs);
}

Gantt Chart Output

To Do

  • Generate speed analysis based on multiple runs of the same function

License

MIT License