Add presence

README.md

@@ -49,3 +49,24 @@ room.onUpdate(newDoc => {
   console.log(newDoc);
 });
 ```
+
+## Server Side Rendering
+
+To render on the server, you must include any headers that should be passed along to your
+auth endpoint. In most cases, this is just your session cookie.
+
+For example, in Next.js:
+
+```ts
+const room = client.room("my-room");
+
+MyComponent.getInitialProps = async ctx => {
+  const { doc } = await room.init({
+    headers: {
+      cookie: ctx.req.headers
+    }
+  });
+
+  return { doc };
+};
+```

errors/cant-access-auth-endpoint.md

@@ -0,0 +1,20 @@
+# Failing network on the server
+
+Example text:
+
+```
+Room Service can't access the auth endpoint.
+```
+
+## Why this error is happening
+
+Your auth endpoint isn't setup correctly.
+
+## How to fix this
+
+Please confirm that:
+
+1. You've made an [auth endpoint](https://www.roomservice.dev/docs/auth).
+2. Your auth endpoint has a valid API key.
+3. Your auth endpoint itself isn't logging any errors.
+4. Your auth endpoint is pointed to the correct domain, for example, ensure it's not pointing to `localhost:3000` while running in production.

errors/server-side-no-network.md

@@ -0,0 +1,19 @@
+# Failing network on the server
+
+Example text:
+
+```
+Room Service can't access the auth endpoint on the server.
+```
+
+## Why this error is happening
+
+Room Service can't access your auth endpoint when attempting to render on the server (SSR).
+
+## How to fix this
+
+The **most likely case** is that your auth endpoint isn't setup correctly. Please confirm that:
+
+1. You've made an [auth endpoint](https://www.roomservice.dev/docs/auth).
+2. Your auth endpoint has a valid API key.
+3. Your auth endpoint itself isn't logging any errors.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roomservice/browser",
-  "version": "0.3.2-0",
+  "version": "0.4.0-10",
   "main": "dist/index",
   "types": "dist/index",
   "files": [

src/authorize.ts

@@ -9,7 +9,8 @@ interface RoomValue {
 
 export default async function authorize(
   authorizationUrl: string,
-  roomReference: string
+  roomReference: string,
+  headers?: Headers
 ) {
   // Generates and then records a session token
   const result = await ky.post(authorizationUrl, {
@@ -19,6 +20,8 @@ export default async function authorize(
       }
     },
 
+    headers: headers || undefined,
+
     // This only works on sites that have setup DNS,
     // or the debugger on roomservice.dev/app, which
     // uses this SDK.

src/client.test.ts

@@ -4,6 +4,7 @@ import RoomServiceClient from "./client";
 import Offline from "./offline";
 import Sockets from "./socket";
 import { injectFakeSocket } from "./test-socket";
+import { uniq } from "lodash";
 
 const URL = "https://coolsite.com";
 jest.mock("idb-keyval");
@@ -50,12 +51,19 @@ test("room gets called with bearer token", async () => {
   });
   const room = client.room("my-room");
   await room.init();
-  const [url, args] = mock.calls[0];
 
-  expect(url).toBe("https://api.roomservice.dev");
+  const urls = mock.calls.map(([url]) => url);
+  const args = mock.calls.map(([_, args]) => args);
+
+  expect(uniq(urls.sort())).toStrictEqual(
+    [
+      "https://api.roomservice.dev/v1/doc",
+      "https://api.roomservice.dev/v1/presence"
+    ].sort()
+  );
 
   // @ts-ignore because bad typings make me sad
-  expect(args.transportOptions!.polling.extraHeaders.authorization).toBe(
+  expect(args[0].transportOptions.polling.extraHeaders.authorization).toBe(
     "Bearer short-lived-token"
   );
 });
@@ -72,7 +80,7 @@ test("room.publish() can change a document", async () => {
   await room.init();
   sockets.emit("connect");
 
-  const newState = await room.publishDoc(prevState => {
+  const newState = await room.setDoc((prevState: any) => {
     prevState.someOption = "hello!";
   });
 
@@ -85,6 +93,12 @@ test("room.restore() attempts to restore from offline", async () => {
   });
   const room = client.room("my-room");
 
+  // @ts-ignore because trust me typescript, I am very wise and have
+  // been on this earth longer than thee, and I, the great programmer,
+  // know for certain that window.indexDB is, in fact, equal to
+  // wiggly-woggle-pop.
+  window.indexedDB = "wiggly-woggle-pop";
+
   jest.spyOn(Offline, "getDoc").mockImplementation(async (ref, doc) => {
     return save(from({ name: "offlinedoc" }));
   });
@@ -122,10 +136,10 @@ test("room.onUpdateDoc callback tries to save the document to offline", async do
   const room = client.room("my-room");
 
   const cb = jest.fn();
-  room.onUpdateDoc(cb);
+  room.onSetDoc(cb);
 
   // @ts-ignore private
-  const onUpdateSocket = room._onUpdateSocketCallback;
+  const onUpdateSocket = room._docClient._onUpdateSocketCallback;
   expect(onUpdateSocket).toBeTruthy();
 
   await room.init();

src/client.ts

@@ -1,18 +1,30 @@
 import RoomClient from "./room-client";
-import { KeyValueObject } from "./types";
+import { Obj } from "./types";
 
 export default class RoomServiceClient {
   private readonly _authorizationUrl: string;
+  private readonly _headers?: Headers;
 
-  constructor(parameters: { authUrl: string }) {
+  private readonly _roomPool: { [key: string]: RoomClient } = {};
+
+  constructor(parameters: { authUrl: string; headers?: Headers }) {
     this._authorizationUrl = parameters.authUrl;
+    this._headers = parameters.headers;
   }
 
-  room<T extends KeyValueObject>(roomReference: string, state?: T) {
-    return new RoomClient<T>({
+  room<T extends Obj>(roomReference: string, defaultDoc?: T) {
+    if (this._roomPool[roomReference]) {
+      return this._roomPool[roomReference];
+    }
+
+    const room = new RoomClient({
       authUrl: this._authorizationUrl,
-      reference: roomReference,
-      state
+      roomReference,
+      defaultDoc,
+      headers: this._headers
     });
+
+    this._roomPool[roomReference] = room;
+    return room;
   }
 }