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

webtask-hacks

v2.2.1

Published

A collection of webtask-related hacks and ideas

Downloads

21

Readme

Webtask hacks

A collection of experiments and hacks for getting the most (and sometimes too much) out of the Webtask platform.

Compilers

Middleware

The middleware compiler provides a mechanism to run any number of middleware prior to invoking a webtask.

A middleware is a function exported by a node module having the signature function(req, res, next), where:

  • req is the instance of http.IncomingRequest for the current request. It has a req.webtaskContext property:

  • res is the instance of http.ServerResponse for the current request

  • next is a function with the signature function next(error). A middleware function may be designed to complete the response, in which case it can omit calling next. A middleware may also implement authentication logic, such as the authentication middleware. In this case, the middleware might invoke next with an Error. If the error has a statusCode property, this will be used as the response status code. Otherwise, to allow control to go to the next middleware, or to the default middleware (which compiles and invokes the webtask code), the middleware can call next() with no arguments.

Usage:

  1. Set the wt-compiler metadata property on your webtask to webtask-hacks/middleware.

  2. Set the wt-node-dependencies metadata property to the stringified JSON of an object having a webtask-hacks property whose value is the latest version of this module.

    {"webtask-hacks":"1.4.1"}
  3. Set the wt-middleware metadata property to a comma-separated list of middleware references. These references can be the name of an npm module, in which case the module's default export is used. These can also be references like module_name/name_of_export_function, which would be equivalent to require('module_name').name_of_export_function. These middleware will be invoked sequentially and the next middleware will only be invoked if the previous middleware calls next() without argument.

  4. Optionally, set the wt-debug metadata property to a comma-separated list of debug references that contains wt-middleware. This will result in additional debug information being sent to real-time logs.

Workflow

The workflow compiler allows you to build compound webtasks that have one of two composition models:

  1. fanout - Run a set of child webtasks in parallel, collecting response status codes.
  2. sequence - Run one child webtask after the other, piping the output of one into the input of the next.

Usage:

  1. Create a webtask with code using the following structure:

    {
        "type": "fanout | sequence",
        "nodes": [
            {
                "name": "name_of_webtask_0"
            },
            {
                "name": "name_of_webtask_1"
            },
            {
                "name": "name_of_webtask_N"
            }
        ]
    }
  2. Set the wt-compiler metadata property on your webtask to webtask-hacks/workflow.

  3. Set the wt-node-dependencies metadata property to the stringified JSON of an object having a webtask-hacks property whose value is the latest version of this module.

    {"webtask-hacks":"1.4.1"}
  4. Optionally, set the wt-workflow-debug metadata property to a number corresponding to the minimum level of logs that will be output to your webtask logs.

    Supported levels are as follows:

    20: debug
    30: info
    40: warn
    50: error

Middleware

Using middleware requires configuring the webtask-hacks/middleware compiler. Please see above.

Cron authentication

The webtask-hacks/authenticateCron middleware provides cron job authentication based on the assumption that only trusted agents know the webtask token that underpins a webtask cron job. The Webtask daemon will automatically invoke cron jobs with an Authorization header having a bearer token corresponding to the cron job's underlying webtask token. This middleware will reject requests where this does not hold true.

Authentication

The webtask-hacks/authenticate middleware provides a generic authentication solution that assumes that only trusted agents can inspect the metadata of the webtask. Requests subject to this middleware will be rejected if they have a wt-auth-secret secret and the value of that secre does not match the bearer token in the Authorization header.

JSON logging

The webtask-hacks/jsonLogger middleware augments the console object in Webtask so that all logic running later in the synchronous or asynchronous continuation will result in newline-delimited json having the format { chunk, requestId, webtaskId } being emitted to the real-time logs. This may be useful for other middleware that might want to ship augmented logs to 3rd party services or to facilitate per-request logging by consumers of real-time logs.