{"id":20170196,"url":"https://github.com/fabrix-app/spool-tasks","last_synced_at":"2026-06-08T17:31:30.351Z","repository":{"id":95882867,"uuid":"147563499","full_name":"fabrix-app/spool-tasks","owner":"fabrix-app","description":"Spool: Task Handler for Fabrix","archived":false,"fork":false,"pushed_at":"2018-12-19T16:58:31.000Z","size":80,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-04T01:16:25.105Z","etag":null,"topics":["cqrs","event-sourcing","fabrix","nodejs","rabbitmq","spools","tasks","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fabrix-app.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","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}},"created_at":"2018-09-05T18:39:44.000Z","updated_at":"2018-12-19T16:58:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"c4ba8949-c8fb-4f71-b998-a5ec64afffc6","html_url":"https://github.com/fabrix-app/spool-tasks","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"112104656edb1feab0729a9bdba20dbfb169e2f8"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/fabrix-app/spool-tasks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabrix-app%2Fspool-tasks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabrix-app%2Fspool-tasks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabrix-app%2Fspool-tasks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabrix-app%2Fspool-tasks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fabrix-app","download_url":"https://codeload.github.com/fabrix-app/spool-tasks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabrix-app%2Fspool-tasks/sbom","scorecard":{"id":390624,"data":{"date":"2025-08-11","repo":{"name":"github.com/fabrix-app/spool-tasks","commit":"112104656edb1feab0729a9bdba20dbfb169e2f8"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/8 approved changesets -- score normalized to 0","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":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","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":-1,"reason":"No tokens found","details":null,"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":"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: 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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 13 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":"68 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-h452-7996-h45h","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-4gxf-g5gf-22h4","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-c3m8-x3cg-qm2c","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-56x4-j7p9-fcf9","Warn: Project is vulnerable to: GHSA-v78c-4p63-2j6c","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-j9xp-92vc-559j","Warn: Project is vulnerable to: GHSA-m9jw-237r-gvfv","Warn: Project is vulnerable to: GHSA-fw4p-36j9-rrj3","Warn: Project is vulnerable to: GHSA-wrh9-cjv3-2hpw","Warn: Project is vulnerable to: GHSA-8c25-f3mj-v6h8","Warn: Project is vulnerable to: GHSA-vqfx-gj96-3w95","Warn: Project is vulnerable to: GHSA-f598-mfpv-gmfx","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-qgmg-gppg-76g5","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"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-18T17:42:50.853Z","repository_id":95882867,"created_at":"2025-08-18T17:42:50.853Z","updated_at":"2025-08-18T17:42:50.853Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34073675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["cqrs","event-sourcing","fabrix","nodejs","rabbitmq","spools","tasks","typescript"],"created_at":"2024-11-14T01:17:38.947Z","updated_at":"2026-06-08T17:31:30.335Z","avatar_url":"https://github.com/fabrix-app.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spool-tasks\n\n[![Gitter][gitter-image]][gitter-url]\n[![NPM version][npm-image]][npm-url]\n[![Build Status][ci-image]][ci-url]\n[![Test Coverage][coverage-image]][coverage-url]\n[![Dependency Status][daviddm-image]][daviddm-url]\n[![Follow @FabrixApp on Twitter][twitter-image]][twitter-url]\n\nTask Handler for Fabrix\n - RabbitMQ\n\n## Install\n```sh\n$ npm install @fabrix/spool-tasks --save\n```\n\n### Configure Task Settings\n\n```js\n// config/tasks.ts\nexport const tasks = {\n\n  /**\n   * Define worker profiles. Each worker of a given type listens for the\n   * \"tasks\" defined in its profile below. The task names represent a Task\n   * defined in api.services.tasks. Note that 'memoryBound' and 'cpuBound' are\n   * arbitrary names.\n   */\n  profiles: {\n    memoryBound: [ 'hiMemoryTask1' ],\n    cpuBound: [ 'VideoEncoder', 'hiCpuTask2' ]\n  },\n\n  /**\n   * Set RabbitMQ connection info\n   */\n  connection: {\n    exchange: process.env.TASKER_EXCHANGE, // optional, defaults to `tasker-work-x`\n    workQueueName: process.env.TASKER_WORK_QUEUE, // optional, defaults to `tasker-work-q`\n    interruptQueueName: process.env.TASKER_INTERRUPT_QUEUE, // optional, defaults to `tasker-interrupt-q`\n\n    /**\n     * The RabbitMQ connection information.\n     * See: https://www.rabbitmq.com/uri-spec.html\n     */\n     host: process.env.TASKER_RMQ_HOST,\n     user: process.env.TASKER_RMQ_USER,\n     pass: process.env.TASKER_RMQ_PASS,\n     port: process.env.TASKER_RMQ_PORT,\n     vhost: process.env.TASKER_RMQ_VHOST\n\n     /**\n     * Connection information could also be passed via uri\n     */\n     uri: process.env.TASKER_RMQ_URI\n\n     /**\n      * Additional, optional connection options (default values shown)\n      */\n      heartbeat: 30,\n      timeout:, // this is the connection timeout (in milliseconds, per connection attempt), and there is no default\n      failAFter: 60, // limits how long rabbot will attempt to connect (in seconds, across all connection attempts). Defaults to 60\n      retryLimit: 3, // limits number of consecutive failed attempts\n\n  },\n\n  /**\n   * Set worker to subscribe to tasks in the matching profile (tasks.profiles).\n   * If process.env.WORKER does not match a profile, the application will not subscribe to any tasks\n   */\n  profile: process.env.WORKER\n}\n```\n\n### Configure `worker` Environment\n\n```js\n// config/env/worker.ts\nimport { TasksSpool } from '@fabrix/spool-tasks'\nexport const worker = {\n  main: {\n\n    /**\n     * Only load the spools needed by the workers\n     */\n    spools: [\n     TasksSpool\n    ]\n  }\n}\n```\n\nIf the worker profiles each require more granular environment configurations,\ncreate `worker-cpuBound`, `worker-memoryBound`, etc. environments.\n\n### Include tasks in the app object\nCreate a directory `api/tasks`.  Any task definitions will be created as classes in this directory.\nCreate  `api/tasks/index.ts` to export all of the tasks.\nInclude this directory in `api/index.ts`.  Here is an example:\n```js\n// api/index.ts\n\nimport * as tasks from './tasks'\nexport { tasks }\n```\n\n## Usage\n\nDefine tasks in `api.tasks`.  Tasks are run by a worker processes.\n\n```js\n// api/tasks/VideoEncoder.ts\n\nimport { Task } from '@fabrix/spool-tasks'\nexport class VideoEncoder extends Task {\n\n  /**\n   * \"message\" is the message from RabbitMQ, and contains all the information\n   * the worker needs to do its job. By default, sets this.message and this.app.\n   *\n   * @param message.body.videoFormat\n   * @param message.body.videoBuffer\n   */\n  constructor (app, message) {\n    super(app, message)\n  }\n\n  /**\n   * Do work here. When the work is finished (the Promise is resolved), send\n   * \"ack\" to the worker queue. You must override this method.\n   *\n   * @return Promise\n   */\n  run () {\n    return doWork(this.message)\n  }\n\n  /**\n   * This is a listener which is invoked when the worker is interrupted (specifically,\n   * an interrupt is a particular type of message that instructs this worker to\n   * stop).\n   */\n  interrupt () {\n    this.log.warn('only encoded', this.currentIndex, 'out of', this.totalItems, 'frames')\n  }\n\n  /**\n   * Perform any necessary cleanup, close connections, etc. This method will be\n   * invoked regardless of whether the worker completed successfully or not.\n   * @return Promise\n   */\n  finalize () {\n    return doCleanup(this.message)\n  }\n}\n```\n\n\nTo start a task, publish a message via the `app.tasker` interface: \n```\nconst taskId = app.tasker.publish('VideoEncoder', { vidoeUrl: 'http://...' }\n```\n\nTo interrupt a task in progress, use the `taskId` that is returned from app.tasker.publish(..):\n```\napp.tasker.cancel('VideoEncoder', taskId)\n```\n\n\n\n## Deployment\n\nAn example [Procfile](https://devcenter.heroku.com/articles/procfile) may look like:\n\n```\nweb: npm start\nmemoryBound: NODE_ENV=worker WORKER=memoryBound npm start\ncpuBound: NODE_ENV=worker WORKER=cpuBound npm start\n```\n\n\n\n[npm-image]: https://img.shields.io/npm/v/@fabrix/spool-tasks.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/@fabrix/spool-tasks\n[ci-image]: https://img.shields.io/circleci/project/github/fabrix-app/spool-tasks/master.svg\n[ci-url]: https://circleci.com/gh/fabrix-app/spool-tasks/tree/master\n[daviddm-image]: http://img.shields.io/david/fabrix-app/spool-tasks.svg?style=flat-square\n[daviddm-url]: https://david-dm.org/fabrix-app/spool-tasks\n[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square\n[gitter-url]: https://gitter.im/fabrix-app/fabrix\n[twitter-image]: https://img.shields.io/twitter/follow/FabrixApp.svg?style=social\n[twitter-url]: https://twitter.com/FabrixApp\n[coverage-image]: https://img.shields.io/codeclimate/coverage/github/fabrix-app/spool-tasks.svg?style=flat-square\n[coverage-url]: https://codeclimate.com/github/fabrix-app/spool-tasks/coverage\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffabrix-app%2Fspool-tasks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffabrix-app%2Fspool-tasks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffabrix-app%2Fspool-tasks/lists"}