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

clujo

v1.1.2

Published

Schedule interdependent tasks on a cron-like schedule with parallel task execution. Built in distributed locking to prevent overlapping executions in a clustered environment.

Downloads

723

Readme

Table of Contents

clujo

Clujo is a flexible solution for managing scheduled tasks in your distributed Node.js applications. It would not be possible without the amazing work of the following projects:

  • Croner: used for running task graphs on a cron schedule
  • ioredis - (not a dependency, but the supported redis client) used to ensure single execution in a distributed environment
  • redis-semaphore (only used if an ioredis instance is provided to start method) - used to ensure single execution in a distributed environment

Coming soon: bun and deno support.

Features

  • Clujo provides an intuitive interface for setting up cron-like schedules, making it easy to create and manage recurring tasks.
  • Clujo's task orchestration allows you to define and execute a set of interdependent tasks, running independent tasks in parallel when possible while ensuring dependent tasks wait for their prerequisites.
  • Clujo's context system allows you to pass and modify state between tasks, enabling sophisticated data flow and making it easier to build complex, stateful workflows.
  • Clujo includes a configurable retry policy, enabling your tasks to automatically recover from transient failures without manual intervention.
  • When used with Redis, Clujo provides out-of-the-box distributed locking, preventing overlapping executions in a distributed environment.
  • Clujo offers type-safe task definitions and context management.
  • With the runOnStartup feature, Clujo allows you to run tasks immediately when needed, in addition to their scheduled times.
  • Clujo provides a graceful way to stop scheduled tasks, ensuring that your application can shut down without leaving tasks in an inconsistent state.
  • Each task can have its own error handler, allowing for fine-grained control over how failures are managed and reported.

Installation

Install Clujo using npm, pnpm, yarn, or your favorite package manager:

pnpm install clujo

or

npm install clujo

or

yarn add clujo

Quick Start

Here's a simple example to get you started with Clujo:

import { TaskGraph, Clujo } from 'clujo';

// Define your tasks
const tasks = new TaskGraph()
  .finalize()
  .addTask({
    id: "task1",
    execute: async ({ deps, ctx }) => {
      console.log("Task 1 executing");
      return "Task 1 result";
    },
  })
  .addTask({
    id: "task2",
    execute: async ({ deps, ctx }) => {
      console.log("Task 2 executing");
      return "Task 2 result";
    },
    // will only execute after task 1 completes
    dependencies: ["task1"],
  })
  .addTask({
    id: "task3",
    execute: async ({ deps, ctx }) => {
      console.log("Task 3 executing");
      return "Task 3 result";
    },
    // since task3 has no dependencies, it will run in parallel with task1 at the start of execution
  })
  .build();

// Create a Clujo instance
const clujo = new Clujo({
  id: "myClujoJob",
  cron: {
    pattern: "*/5 * * * * *",
  },
  taskGraphRunner: tasks,
});

// Start the job
clujo.start({
  // Optional: provide an ioredis client for distributed locking
  redis: { client: new Redis() },
  // Optional: run the job immediately on startup
  runOnStartup: true,
  // Optional: provide a callback to run when the job completes that takes in the completed context object
  onTaskCompletion: (ctx) => console.log(ctx),
});

// Trigger the job manually to get a complete context object
clujo.trigger().then((result) => {
  console.log(result);
});

// Gracefully stop the job by waiting until the current execution completes
// Will force stop after timeout milliseconds
await clujo.stop(timeoutMs);

In the event a Javascript Date object is provided instead of a cron pattern, the task graph will be executed precisely once at the specific date/time specified. Time is in ISO 8601 local time.

Advanced Usage

Understanding Dependency Execution

Context object

The context object contains the appropriate context for the task.

  • All tasks have access to a context object which allows sharing values between tasks
  • If task i depends on tasks j_1,...,j_n, then it can be guaranteed the context object will have the result of tasks j_1,...,j_n under the keys j_1,...,j_n. The value at these keys is the return of task j_i, i = 1,...,n.
  • If a task has no dependencies it has access to the initial context object only (if it was set).

Task execution

  • case: N tasks each with no dependencies. All tasks run concurrently
  • case: N tasks where task i depends on task i-1, i=1,...,N. All tasks run sequentially
  • case: Fix 1 <= i != j <= N. N tasks where task i depends on task j. N\{i} tasks run concurrently, task i runs after task j.
  • case: Task i depends on task j, task j depends on task i. Cyclic dependencies will result in an error pre-execution.

In the event a task execution fails, all further dependent tasks will not be executed. Other independent tasks will continue to run.

Can build up more complex cases from these simple cases

Setting Context and Dependencies

const tasks = new TaskGraph()
  .setContext(async () => {
    const users = await fetchUsers();
    return { users };
  })
  .setDependencies({ logger: console })
  .finalize()
  // ... add tasks
  .build();

Using Redis for Distributed Locking

When an ioredis client is provided, Clujo will use it to acquire a lock for each task execution. This ensures that tasks are not executed concurrently in a distributed environment.

import Redis from 'ioredis';

const redis = new Redis();

clujo.start({
  redis: {
    client: redis,
    lockOptions: { /* optional lock options */ }
  }
});

Running Tasks on Startup

You can run tasks immediately when the job starts by setting the runOnStartup option to true. The triggered execution will prevent a scheduled execution from running at the same time in the event the scheduled execution overlaps with the triggered execution.

clujo.start({
  runOnStartup: true
});

Error Handling

Tasks can have their own error handlers, allowing you to define custom logic for handling failures. The function can be synchronous or asynchronous, and has access to the same context as the execute function.

.addTask({
  id: "taskWithErrorHandler",
  execute: async ({ deps, ctx }) => {
    // Task logic
  },
  errorHandler: async (error, { deps, ctx }) => {
    console.error("Task failed:", error);
  }
})

Retry Policy

Specify a retry policy for a task to automatically retry failed executions. The task will be retried up to maxRetries times, with a delay of retryDelayMs between each retry.

.addTask({
  id: "taskWithRetry",
  execute: async ({ deps, ctx }) => {
    // Task logic
  },
  retryPolicy: { maxRetries: 3, retryDelayMs: 1000 }
})

Using the Scheduler

The Scheduler class provides a convenient way to manage multiple Clujo jobs together. It allows you to add, start, and stop groups of jobs in a centralized manner.

Adding Jobs to the Scheduler

import { Scheduler } from 'clujo';
import { Redis } from 'ioredis';

const scheduler = new Scheduler();

// Add jobs to the scheduler
scheduler.addJob({
  job: myFirstClujoJob,
  // Optional completion handler for this clujo
  completionHandler: async (ctx) => {
    console.log('First job completed with context:', ctx);
  }
});

scheduler.addJob({
  job: mySecondClujoJob
});

// Add more jobs as needed

Starting All Jobs

You can start all added jobs at once, optionally providing a Redis instance for distributed locking:

const redis = new Redis(); // Your Redis configuration

// Start all jobs without distributed locking
scheduler.start();

// Or, start all jobs with distributed locking
scheduler.start(redis);

Stopping All Jobs

To stop all running jobs:

// Stop all jobs with a default timeout of 5000ms
await scheduler.stop();

// Or, specify a custom timeout in milliseconds
await scheduler.stop(10000);