{"id":16039547,"url":"https://github.com/ordermentum/steveo","last_synced_at":"2026-04-01T18:05:45.646Z","repository":{"id":19175470,"uuid":"85769743","full_name":"ordermentum/steveo","owner":"ordermentum","description":"Node.js/Typescript Background Task/Streaming Framework (Kafka, AWS SQS, Redis)","archived":false,"fork":false,"pushed_at":"2026-03-24T11:08:41.000Z","size":4449,"stargazers_count":21,"open_issues_count":12,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-03-25T14:09:47.771Z","etag":null,"topics":["aws","javascript","kafka","node","nodejs","redis","registry","sqs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ordermentum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-03-22T01:05:34.000Z","updated_at":"2026-03-20T18:52:13.000Z","dependencies_parsed_at":"2023-02-19T13:01:32.443Z","dependency_job_id":"8930a62f-38bd-4288-bbc1-5fbb34eaabeb","html_url":"https://github.com/ordermentum/steveo","commit_stats":{"total_commits":755,"total_committers":15,"mean_commits":"50.333333333333336","dds":0.4278145695364238,"last_synced_commit":"249504e16d1b23eb08897f35e00e608abfd6cf82"},"previous_names":[],"tags_count":172,"template":false,"template_full_name":null,"purl":"pkg:github/ordermentum/steveo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ordermentum%2Fsteveo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ordermentum%2Fsteveo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ordermentum%2Fsteveo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ordermentum%2Fsteveo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ordermentum","download_url":"https://codeload.github.com/ordermentum/steveo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ordermentum%2Fsteveo/sbom","scorecard":{"id":711911,"data":{"date":"2025-08-11","repo":{"name":"github.com/ordermentum/steveo","commit":"ba351f7bb12e40601c382d9c74eec04ad56d3cd2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.8,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/ordermentum/steveo/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/ordermentum/steveo/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/ordermentum/steveo/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/ordermentum/steveo/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ordermentum/steveo/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/ordermentum/steveo/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/ordermentum/steveo/release.yml/main?enable=pin","Warn: containerImage not pinned by hash: apps/prisma-example/Dockerfile:1: pin your Docker image by updating node:20 to node:20@sha256:572a90df10a58ebb7d3f223d661d964a6c2383a9c2b5763162b4f631c53dc56a","Warn: containerImage not pinned by hash: apps/tasks-example/Dockerfile:1: pin your Docker image by updating ordermentum/service:16 to ordermentum/service:16@sha256:8d4e3ac7d4395137299e0392e86a08fe4fcc5c433eba3d0bfcbff7e0a9752594","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:64","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"19 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-7v5v-9h63-cj86","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-h755-8qp9-cq85","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T08:23:49.242Z","repository_id":19175470,"created_at":"2025-08-22T08:23:49.242Z","updated_at":"2025-08-22T08:23:49.242Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31290747,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","javascript","kafka","node","nodejs","redis","registry","sqs","typescript"],"created_at":"2024-10-08T23:05:19.361Z","updated_at":"2026-04-01T18:05:45.616Z","avatar_url":"https://github.com/ordermentum.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eWelcome to steveo 👋\u003c/h1\u003e\n\u003cp\u003e\n  \u003ca href=\"https://www.npmjs.com/package/steveo\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Version\" src=\"https://img.shields.io/npm/v/steveo.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"#\" target=\"_blank\"\u003e\n    \u003cimg alt=\"License: Apache--2.0\" src=\"https://img.shields.io/badge/License-Apache--2.0-yellow.svg\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n[![npm version](https://badge.fury.io/js/steveo.svg)](https://badge.fury.io/js/steveo)\n[![CI](https://github.com/ordermentum/steveo/actions/workflows/main.yml/badge.svg?branch=develop)](https://github.com/ordermentum/steveo/actions/workflows/main.yml)\n[![npm](https://img.shields.io/npm/l/steveo.svg)](https://www.npmjs.com/package/steveo)\n[![npm](https://img.shields.io/npm/dt/steveo.svg)](https://www.npmjs.com/package/steveo)\n\nSteveo is a comprehensive framework for handling background job processing in Node.js. It offers support for popular messaging systems such as Kafka, SQS, and Redis.\n\nIn Australian culture, it is common to abbreviate names, like \"John\" becoming \"Johno,\" or add extra vowels, like \"Sarah\" becoming \"Sazza.\" The name \"Steveo\" is a playful play on \"Steve\" inspired by Steve Jobs.\n\nThe primary purpose of Steveo is to handle asynchronous task processing. It allows you to define tasks that involve time-consuming operations without causing a blockage in the main execution flow of an HTTP request. Think of it as [sidekiq](https://github.com/mperham/sidekiq) for node.js with support for multiple backends.\n\nSteveo also bundles a task scheduling framework for Postgresql as an optional addon.\n\nMultiple tasks can be strung together to form workflows that will reliably handle errors and retry patterns.\n\n## Installation\n\nThis is a Node.js module available through the npm registry.\n\nBefore installing, download and install Node.js. Node.js 16  or higher is required.\n\nIf this is a brand new project, make sure to create a package.json first with the npm init command.\n\nInstallation is done using the npm install command:\n\n```bash\n$ npm install steveo\n```\n\n## Author\n\n👤 **engineering@ordermentum.com**\n\n\n### Example\n\n```javascript\n(async () =\u003e {\n  const steveo = Steveo();\n\n  const example = steveo.task('example-task', async ({ name }) =\u003e {\n    console.log(`hello ${name}`);\n  });\n\n  await example.publish({ name: 'tommo' });\n  await example.publish({ name: 'bazza' });\n\n  // or\n  steve.publish('example-task', { name: 'tim' });\n\n  await steveo.runner().process();\n})();\n```\n\nPublish without registering a task\n\n```javascript\nawait steveo.publish('example-task', { name: 'Apple' });\n```\n\nFor more details, see [example](https://github.com/ordermentum/steveo/blob/master/examples/full/README.md)\n\n\n## Contributing\n\n\n### Installing dependencies\n\n```sh\nyarn install\n```\n\n## Running tests\n\n```sh\nyarn run test\n```\n\n\n## Architecture\n\nOn a highlevel, it works as below, Steveo has 3 main components\n\nYou publish a message to a queue for a defined task or workflow.\n\nError Handling: Steveo provides mechanisms to handle errors during task processing. It emits events for task failures and connection failures, allowing you to implement appropriate error handling strategies.\n\n### Task\n\nHolds the information about the type of task. It has below methods,\n\n- publish - send a message onto a queue\n- subscribe - process a message\n\n### Workflow\n\nAllows a sequence of steps to be defined and executed.\n\nThe output of each step will be fed into the arguments of the proceeding step.\n\n### Registry\n\nTask Registry: Steveo maintains a registry that keeps track of tasks + workflows and their associated handlers. When a new task is created, it is added to the registry for dispatch handling.\n\nResponsible for keeping the inventory of tasks + workflows \u0026 event manager. Whenever a new task or workflow is created, an entry will be added in the registry\n\n### Consumer\n\nResponsible for consuming messages,\n\n- `process` method initialize group consumers and start to consume the messages. It will then call the subscribe callback set on the task\n\n\n\n```\n              +-----------+     +-----------+     +-----------+\n              |           |     |           |     |           |\nPUBLISH -----\u003e|   TASK    |     | REGISTRY  |     | CONSUMER  |-----\u003e RECEIVE\n              |           |     |           |     |           |\n              |           |     |           |     |           |\n              +-----------+     +-----------+     +-----------+\n```\n\n## Events\n\nEvent Emission: Steveo emits various events during task processing, allowing you to handle different stages of task execution, such as receiving a message, completing a task, or encountering failures.\n\nEmitting events based on success/failures\n\n\n| Event                     |                      Description                       |\n|---------------------------|:------------------------------------------------------:|\n| runner_receive            |                   Received a message                   |\n| runner_complete           |         Completed running the associated task          |\n| runner_failure            |           Failed running the associated task           |\n| runner_connection_failure |      Error while polling for message (Kafka only)      |\n| task_send                 |                                                        |\n| task_success              |                                                        |\n| task_failure              |                                                        |\n| task_added                |                                                        |\n| task_removed              |                                                        |\n| producer_success          |                                                        |\n| producer_failure          |                                                        |\n| pool_reserve              |  When a consumer reserves a handle in the worker pool  |\n| pool_release              | When a consumer releases a handle from the worker pool |\n\n\n## Packages\n\n| Package             |                                Description                                |\n|---------------------|:-------------------------------------------------------------------------:|\n| steveo              | Core steveo package that provides the async task processing functionality |\n| @steveojs/newrelic  |             New Relic addon for Steveo to provide APM tracing             |\n| @steveojs/sentry    |            Sentry addon to provide tracing and error tracking             |\n| @steveojs/statsd    |            Statsd addon to provide metrics to a statsd server             |\n| @steveojs/prisma    |                      Job Scheduler using Prisma ORM                       |\n| @steveojs/sequelize |                     Job Scheduler using Sequelize ORM                     |\n|                     |                                                                           |\n\n## Scheduler\n\nThis repo also contains two schedulers for scheduling tasks using postgresql (prisma and sequelize).\n\nNeeds a jobs table to be created. See `packages/prisma/migrations` or `packages/sequelize/migrations` in the individual packages\n\n## How?\n\nSee `apps/example/bin/jobs` and `apps/src/index`\n\nFor prisma, you will need take the `prisma/prisma/schema.prisma` add put it into your app `prisma/schema.prisma` file. Prisma has no way to share or import schemas from packages.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fordermentum%2Fsteveo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fordermentum%2Fsteveo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fordermentum%2Fsteveo/lists"}