Durable Objects REST Message Queue Example

Note: You must use wrangler 1.19.3 or newer to deploy this project.

An edge message queue service that runs on Cloudflare Workers using Durable Objects and KV. It is implemented as a simple REST API.

This demo uses:

• Cloudflare Workers
• Durable Objects
• KV
• Miniflare v2
• TypeScript
• Jest
• ES Modules
• esbuild
• Wrangler

Running the Demo

• git clone https://github.com/ryan-mars/workers-queue-demo.git
• Install wrangler
• cd workers-queue-demo
• npm install
• wrangler login
• wrangler kv:namespace create QUEUES_KV You should see something like:

🌀  Creating namespace with title "workers-queue-demo-QUEUES_KV"
✨  Success!
Add the following to your configuration file in your kv_namespaces array:
{ binding = "QUEUES_KV", id = "baf085c23c..." }

• Add the KV config to wrangler.toml
• wrangler publish will build, run tests, and deploy to Cloudflare

You should see something like:

✨  Build completed successfully!`
✨  Successfully published your script to
 https://workers-queue-demo.you1234.workers.dev

Note the URL 👆🏻

Copy/paste the contents of schema.yaml into Swagger Editor. Change the servers key to match your deployed URL.

Have fun!

Where to find things

• REST API spec is in schema.yaml.
• Worker code is in src/. The Durable Object Queue class is in src/queue.ts, and the Worker script is in src/index.ts.
• esbuild is configured to output a bundled ES Module to dist/index.mjs.
• Unit tests in src/index.spec.ts, which will run as part of wrangler build. To run tests on their own use npm test.