Cloudflare Workers

pluv.io supports building real-time APIs with Cloudflare Workers through their Durable Objects API. You can define your handler and your DurableObject manually if you need more control, but if you'd like to get started quickly, check out createPluvHandler.

Using with Cloudflare Workers (manual)

Let's step through how we'd put together a real-time API for Cloudflare Workers. The examples below assumes a basic understanding of Cloudflare Workers and Durable Objects.

Install dependencies

1# For the server
2npm install @pluv/io @pluv/platform-cloudflare
3# Server peer-dependencies
4npm install yjs zod

Create PluvIO instance

Define an io (websocket client) instance on the server codebase:

1// backend/io.ts
2
3import { createIO } from "@pluv/io";
4import { platformCloudflare } from "@pluv/platform-cloudflare";
5
6export const io = createIO({ platform: platformCloudflare() });
7
8// Export the websocket client io type, instead of the client itself
9export type AppPluvIO = typeof io;

Attach to a RoomDurableObject

Next, create a RoomDurableObject and attach our new pluv.io instance to the room:

1// server/RoomDurableObject.ts
2
3import { type InferIORoom } from "@pluv/io";
4import { AppPluvIO, io } from "./io";
5
6export class RoomDurableObject implements DurableObject {
7    private _io: InferIORoom<AppPluvIO>;
8
9    constructor(state: DurableObjectState) {
10        this._io = io.getRoom(state.id.toString());
11    }
12
13    async fetch(request: Request) {
14        if (request.headers.get("Upgrade") !== "WebSocket") {
15            return new Response("Expected WebSocket", { status: 400 });
16        }
17
18        const { 0: client, 1: server } = new WebSocketPair();
19
20        await this._io.register(server);
21
22        return new Response(null, { status: 101, webSocket: client });
23    }
24}

Forward request to RoomDurableObject

Lastly, integrate your RoomDurableObject with your Cloudflare Worker's default handler:

1// server/index.ts
2
3const parseRoomId = (url: string): string => {
4    /* get room from req.url */
5};
6
7const handler = {
8    async fetch(req: Request, env: Env): Promise<Response> {
9        const roomId = parseRoomId(req.url);
10        // In wrangler.toml:
11        // [durable_objects]
12        // bindings = [{ name = "rooms", class_name = "RoomDurableObject" }]
13        const durableObjectId = env.rooms.idFromString(roomId);
14
15        const room = env.rooms.get(durableObjectId);
16
17        return room.fetch(request);
18    },
19};
20
21export default handler;

createPluvHandler

If you don't need to modify your DurableObject or Cloudflare Worker handler too specifically, @pluv/platform-cloudflare also provides a function createPluvHandler to create a DurableObject and handler for you automatically.

1import { createIO } from "@pluv/io";
2import { createPluvHandler, platformCloudflare } from "@pluv/platform-cloudflare";
3
4const io = createIO({ platform: platformCloudflare() });
5
6const Pluv = createPluvHandler({
7    // Your PluvIO instance
8    io,
9    // Your durable object binding, defined in wrangler.toml
10    binding: "rooms",
11    // Optional: Specify the base path from which endpoints are defined
12    endpoint: "/api/pluv", // default
13    // If your PluvIO instance defines authorization, add your authorization
14    // logic here. Return a user if authorized, return null or throw an error
15    // if not authorized.
16    authorize(request: Request, roomId: string): Promise<User> {
17        return {
18            id: "abc123",
19            name: "leedavidcs"
20        };
21    },
22    // Optional: If you want to modify your response before it is returned
23    modify: (request, response) => {
24        if (request.headers.get("Upgrade") === "websocket") return response;
25
26        // Add custom headers if you want
27        response.headers.append("access-control-allow-origin", "*");
28
29        return response;
30    },
31});
32
33// Export your Cloudflare Worker DurableObject with your own custom name
34// Then in wrangler.toml:
35// [durable_objects]
36// bindings = [{ name = "rooms", class_name = "RoomDurableObject" }]
37export const RoomDurableObject = Pluv.DurableObject;
38
39// Export your Cloudflare Worker handler
40export default Pluv.handler;
41
42// Alternatively, define your own custom handler
43export default {
44    async fetch(request: Request, env: Env): Promise<Response> {
45        const response = await Pluv.fetch(request, env);
46
47        // matched with the Pluv handler, return response
48        if (response) return response;
49
50        // didn't match with Pluv handler, add your own worker logic
51        // ...
52
53        return new Response("Not found", { status: 404 });
54    }
55};