p5.Party Demos + Examples!!
- p5.party is a library for easily prototyping online multi-user sketches with p5.js. With p5.party you can quickly test ideas for multiplayer games, realtime multi-user
- apps, and multi-computer art projects.
+ p5.party is a library for easily prototyping online multi-user sketches with p5.js. With p5.party you can quickly test ideas for multiplayer games, realtime multi-user apps, and multi-computer
+ art projects.
Github |
@@ -48,7 +48,7 @@
Level 2
Level 3
- Participants
+ Guests
- idle_clicker
@@ -59,7 +59,7 @@ Level 3
Level 4
- Events
+ Messaging
diff --git a/src/Record.ts b/src/Record.ts
index 75132f9..ee358a9 100644
--- a/src/Record.ts
+++ b/src/Record.ts
@@ -1,32 +1,33 @@
-import { DeepstreamClient } from "@deepstream/client";
-import {
- Record as DSRecord,
- SubscriptionCallback,
-} from "@deepstream/client/dist/src/record/record";
-
import onChange from "on-change";
+import { DeepstreamClient } from "@deepstream/client";
+import { Record as DSRecord } from "@deepstream/client/dist/src/record/record";
+
import * as log from "./log";
+import { SubscriptionCallback } from "./validate";
import { UserData, JSONValue, JSONObject, RecordData } from "./validate";
import { isJSONValue, isJSONObject, isEmpty } from "./validate";
+
import { patchInPlace } from "./patch";
-const sharedRecordLookup = new WeakMap();
+type SharedObject = JSONObject;
+
+const sharedRecordLookup = new WeakMap();
export class Record {
readonly #ds: DeepstreamClient;
readonly #name: string;
#dsRecord: DSRecord | null;
- #shared: JSONObject;
- #watchedShared: JSONObject;
+ #shared: SharedObject;
+ #watchedShared: SharedObject;
+ #whenLoaded: Promise | null;
constructor(ds: DeepstreamClient, name: string) {
this.#ds = ds;
this.#name = name;
this.#dsRecord = null;
this.#shared = {};
- sharedRecordLookup.set(this.#shared, this);
this.#watchedShared = onChange(
this.#shared,
this.#onClientChangeData.bind(this),
@@ -34,43 +35,77 @@ export class Record {
onValidate: this.#onClientValidateData.bind(this),
}
);
+ this.#whenLoaded = null;
+
+ sharedRecordLookup.set(this.#shared, this);
}
async load(initObject?: UserData): Promise {
+ if (this.#whenLoaded) {
+ log.warn("Record.load() called twice!", this.#name);
+ return this.#whenLoaded;
+ }
+
if (this.#ds.getConnectionState() !== "OPEN") {
- log.error("Record.load() called before room is connected.");
+ log.error("Record.load() called before room is connected.", this.#name);
return;
}
- this.#dsRecord = this.#ds.record.getRecord(this.#name);
- this.#dsRecord.subscribe(this.#onServerChangeData.bind(this), true);
- await this.#dsRecord.whenReady();
- if (!initObject) return;
- if (!isEmpty(this.#dsRecord.get())) return; // don't overwrite existing data
- if (!isJSONObject(initObject, "init-data")) return; // validate user data
- await this.#dsRecord.setWithAck(initObject);
+
+ const innerLoad = async () => {
+ this.#dsRecord = this.#ds.record.getRecord(this.#name);
+ this.#dsRecord.subscribe(this.#onServerChangeData.bind(this), true);
+ await this.#dsRecord.whenReady();
+ if (!initObject) return;
+ await this.initData(initObject);
+ };
+
+ this.#whenLoaded = innerLoad();
+ return this.#whenLoaded;
}
- async whenReady() {
- if (this.#dsRecord === null) {
- log.error(`Record '${this.#name}' loading hasn't begun.`);
- return;
+ get whenLoaded(): Promise {
+ if (this.#whenLoaded === null) {
+ log.error("Record.whenLoaded called before load().", this.#name);
+ return Promise.reject(
+ new Error("Record.whenLoaded called before load().")
+ );
}
- await this.#dsRecord.whenReady();
- // when ready returns a Promise
- // we don't want to return the dsRecord
- return;
+ return this.#whenLoaded;
}
- setShared(data: UserData): void {
- if (!isJSONObject(data, "data")) return;
+ /**
+ * sets initial data on the record only if the record is empty
+ *
+ * @param data initial data to set on the record
+ */
+
+ async initData(data: UserData): Promise {
+ if (!this.#dsRecord?.isReady) {
+ log.error("Record.initData() called before record ready.", this.#name);
+ return;
+ }
+
+ // if (!data) return;
+ if (!isEmpty(this.#dsRecord.get())) return; // don't overwrite existing data
+ if (!isJSONObject(data, "init-data")) return; // don't try to write bad data
+
+ // todo: allow but warn non-owner writes
+ await this.#dsRecord.setWithAck(data);
+ }
+ setData(data: UserData): void {
if (!this.#dsRecord?.isReady) {
// prettier-ignore
- log.warn(`setShared() called on '${this.#name}' before ready.\n Ignored: ${JSON.stringify(data)}`);
+ log.error(
+ `Record.setData() called before record ready. ${
+ this.#name
+ }\n Ignored: ${JSON.stringify(data)}`
+ );
return;
}
+ if (!isJSONObject(data, "set-data")) return; // don't try to write bad data
- // todo: warn and allow non-owner writes
+ // todo: allow but warn non-owner writes
this.#dsRecord.set(data);
}
@@ -88,26 +123,12 @@ export class Record {
triggerNow?: boolean
): void {
if (!this.#dsRecord?.isReady) {
- log.warn(`watchShared() called on '${this.#name}' before fully ready.`);
+ log.warn(`watchShared() called on '${this.#name}' before ready.`);
return;
}
- this.whenReady().then(
- () => {
- // @ts-expect-error subscribe overload signatures match watchShared
- this.#dsRecord.subscribe(path, cb, triggerNow);
- },
- () => {
- /**/
- }
- );
-
- // if (typeof path === "string" && typeof cb === "function") {
- // this.#dsRecord.subscribe(path, cb, triggerNow);
- // }
- // if (typeof path === "function" && typeof cb !== "function") {
- // this.#dsRecord.subscribe(path, cb)
- // }
+ // @ts-expect-error subscribe overload signatures DO match watchShared
+ this.#dsRecord.subscribe(path, cb, triggerNow);
}
get shared(): JSONObject {
@@ -118,10 +139,6 @@ export class Record {
return this.#name;
}
- // discard() {
- // this.#dsRecord?.discard();
- // }
-
async delete() {
if (!this.#dsRecord?.isReady) {
log.error(`delete() called on ${this.#name} before ready.`);
@@ -148,8 +165,7 @@ export class Record {
newValue: UserData,
oldValue: UserData
): boolean {
- const valid = isJSONValue(newValue, `${this.#name}/${path}`);
- return valid;
+ return isJSONValue(newValue, `${this.#name}/${path}`);
}
#onClientChangeData(
@@ -159,7 +175,11 @@ export class Record {
): void {
if (!this.#dsRecord?.isReady) {
// prettier-ignore
- log.warn(`Shared object '${this.#name}' written to before ready.\n Ignored: ${path} = ${JSON.stringify(newValue)}`);
+ log.warn(
+ `Shared object written to before ready. ${
+ this.#name
+ }\n Ignored: ${path} = ${JSON.stringify(newValue)}`
+ );
return;
}
// todo: warn and allow non-owner writes
diff --git a/src/Room.ts b/src/Room.ts
index b76f90b..af7a4c4 100644
--- a/src/Room.ts
+++ b/src/Room.ts
@@ -1,31 +1,22 @@
import { DeepstreamClient } from "@deepstream/client";
-// import { List as DSList } from "@deepstream/client/dist/src/record/list";
-
import * as log from "./log";
-import { UserData, JSONValue, JSONObject, isEmpty } from "./validate";
-import { isJSONValue } from "./validate";
+import { SubscriptionCallback } from "./validate";
+import { UserData, JSONValue, JSONObject } from "./validate";
+import { isJSONValue, isEmpty } from "./validate";
import { Record } from "./Record";
-// TODO: alias this through validate
-import { SubscriptionCallback } from "@deepstream/client/dist/src/record/record";
-
-// interface subscribeCallback {
-// (data: JSONValue): void;
-// }
-
-// export type subscribeCallback = (data: JSONValue) => void;
-
export class Room {
readonly #ds: DeepstreamClient;
readonly #roomId: string; // e.g. "app-room"
readonly #guestName: string; // e.g. "app-room/client-uid"
readonly #guestRecords: Map;
- readonly #guestShareds: JSONObject[];
+ readonly #guestShareds: JSONObject[]; // all guest shareds in this room
+ readonly #publishedGuestShareds: JSONObject[]; // just the non-empty ones
+ readonly #myGuestRecord: Record; // record for this guest's shared object
+ readonly #whenConnected: Promise;
- #myGuestRecord: Record; // record for this guest's shared object
- // #dsGuestRecordList: DSList | null; // names of guest records on the server
- #guestNames: string[];
- #hostName: string | undefined;
+ #guestNames: string[]; // names of guests in the room
+ #hostName: string | undefined; // name of designated host
constructor(host: string, appName: string, roomName: string) {
this.#ds = new DeepstreamClient(host);
@@ -33,81 +24,50 @@ export class Room {
this.#guestName = `${this.#roomId}/${this.#ds.getUid()}`;
this.#guestRecords = new Map();
this.#guestShareds = [];
-
+ this.#publishedGuestShareds = [];
this.#myGuestRecord = new Record(this.#ds, this.#guestName);
- // this.#dsGuestRecordList = null;
this.#guestNames = [];
this.#hostName = undefined;
-
- // log.log("I am", this.#guestName);
+ this.#whenConnected = this.#connect();
}
- async connect(): Promise {
- if (this._isConnected()) return;
-
- // log in to deepstream server
- /* istanbul ignore next */ // error reporting
- this.#ds.on("error", (error: string, event: string, topic: string) =>
- log.error("ds error", error, event, topic)
- );
-
- this.#ds.presence.subscribe(this.#onPresence.bind(this));
-
- await this.#ds.login({ username: this.#guestName });
+ #connect(): Promise {
+ const innerConnect = async () => {
+ // subscribe to errors
+ /* istanbul ignore next */ // error reporting
+ this.#ds.on("error", (error: string, event: string, topic: string) =>
+ log.error("ds error", error, event, topic)
+ );
- // get room list and determine host
- await this.#updateGuestNames();
+ // subscribe to ANY/ALL clients connect/disconnect on SERVER
+ this.#ds.presence.subscribe(this.#onPresence.bind(this));
- // load guest record list
- // this.#dsGuestRecordList = this.#ds.record.getList(`${this.#roomId}/guests`);
- // this.#dsGuestRecordList.subscribe(this.#onDSGuestListChanged.bind(this));
- // await this.#dsGuestRecordList.whenReady();
+ // log in to deepstream server
+ await this.#ds.login({ username: this.#guestName });
- // add my guest record to list
- // this.#dsGuestRecordList.addEntry(this.#guestName);
+ // load my guest record
+ void this.#myGuestRecord.load();
- // get the guest records and update guestShareds
- this.#updateGuestShareds();
+ // get room list and determine host
+ await this.#updateGuestNames();
- // if host, do housekeeping
- // if (this.#hostName === this.#guestName) {
- // await this.#deleteStaleGuestRecords();
- // }
+ // get the guest records and update guestShareds
+ this.#updateGuestShareds();
+ };
+ return innerConnect();
}
_isConnected(): boolean {
return this.#ds.getConnectionState() === "OPEN";
}
- whenConnected(): Promise {
- return new Promise((resolve) => {
- if (this._isConnected()) {
- resolve();
- } else {
- this.#ds.on("connectionStateChanged", () => {
- if (this._isConnected()) resolve();
- });
- }
- });
- }
-
- // at any given time any occupied room has exactly one host
- get hostName(): string | undefined {
- return this.#hostName;
+ get whenConnected(): Promise {
+ return this.#whenConnected;
}
- // sorted list of connected guests in this room
- get _guestNames(): string[] {
- // return copy so that it can't be modified
- return [...this.#guestNames];
- }
-
- // get guestName(): string {
- // return this.#guestName;
- // }
-
- isHost(): boolean {
- return this.#hostName === this.#guestName;
+ disconnect() {
+ if (!this._isConnected()) return;
+ this.#ds.close();
}
getRecord(name: string): Record {
@@ -115,22 +75,6 @@ export class Room {
return r;
}
- get myGuestRecord(): Record {
- return this.#myGuestRecord;
- }
-
- get guestShareds(): JSONObject[] {
- // return read only proxy of array
- // caller can still modify properties of the items
- return new Proxy(this.#guestShareds, {
- set() {
- log.error("The guestShared array is read-only.");
- // eat the value
- return true;
- },
- });
- }
-
subscribe(event: string, cb: SubscriptionCallback): void {
this.#ds.event.subscribe(`${this.#roomId}/${event}`, cb);
}
@@ -150,106 +94,45 @@ export class Room {
}
}
- // note: disconnecting twice quickly throws.
- // i could keep a flag to see if disconnect has been called and only
- // allow it to be called once, but thats a little over defensive?
- disconnect() {
- // try {
- if (!this._isConnected()) return;
- this.#ds.close();
- // } catch (e) {
- // log.error("disconnect error", e);
- // }
+ // at any given time any occupied room has exactly one host
+ get hostName(): string | undefined {
+ return this.#hostName;
}
- // async #deleteStaleGuestRecords() {
- // // deletes any guest records for any guests not currently in the room
- // // even if called by host upon entering room, another guest
- // // might have connected _immediately_ after host so we can't clear them
- // // all without checking
- // if (!this.#dsGuestRecordList) return;
- // await this.#dsGuestRecordList.whenReady();
-
- // const deleteRecord = async (name: string) => {
- // // try {
- // const r = this.#ds.record.getRecord(name);
- // await r.whenReady();
- // await r.delete();
- // // } catch (e) {
- // // log.error("deleteStaleGuestRecords error", e);
- // // }
- // };
-
- // const getRecordNames = this.#dsGuestRecordList.getEntries();
- // for (const guestRecordName of getRecordNames) {
- // if (!this.#guestNames.includes(guestRecordName)) {
- // // delete THEN remove from list
- // console.log("deleting stale guest record", guestRecordName);
- // await deleteRecord(guestRecordName);
- // console.log("unlisting stale guest record", guestRecordName);
- // this.#dsGuestRecordList.removeEntry(guestRecordName);
- // }
- // }
- // }
+ // sorted list of connected guests in this room
+ // semi-private for test suite
+ get _guestNames(): string[] {
+ // return copy so that it can't be modified
+ return [...this.#guestNames];
+ }
- // #onDSGuestListChanged(guestNames: string[]): void {
- // void this.#updateGuestShareds();
- // }
+ get myGuestRecord(): Record {
+ return this.#myGuestRecord;
+ }
- /**
- * clears #guestShares, adds shareds for current guests, install
- * watchers to remove/add shareds if they are empty/non-empty
- *
- */
- // ?: this code is pretty hard to read (and full of hacks now), maybe it woudl be clearer to keep an array of guest shareds including empty ones, and use on change to watch it and create a filtered version?
- #updateGuestShareds() {
- function installWatcher(this: Room, r: Record) {
- r.watchShared((data) => {
- // hack: if this Record is for the same server record, use the myGuestRecord shared instead, so identity checks on the client work. guests[0] === me
- let shared = r.shared;
- if (r.name === this.#myGuestRecord.name) {
- shared = this.#myGuestRecord.shared;
- }
- // remove shared if object is empty or record name not in guest shared
- if (isEmpty(data) || !this.#guestNames.includes(r.name)) {
- if (this.#guestShareds.includes(shared)) {
- this.#guestShareds.splice(this.#guestShareds.indexOf(shared), 1);
- }
- }
- // add if object is not empty and record name is in guest shared
- if (!isEmpty(data) && this.#guestNames.includes(r.name)) {
- if (!this.#guestShareds.includes(shared)) {
- this.#guestShareds.push(shared);
- }
- }
- }, true);
- }
+ get guestShareds(): JSONObject[] {
+ // return read only proxy of array
+ // caller can still modify properties of the items
+ return new Proxy(this.#publishedGuestShareds, {
+ set() {
+ log.error("The guestShared array is read-only.");
+ // eat the value
+ return true;
+ },
+ });
+ }
- // add any missing records to guestRecords, start loading them
- for (const name of this.#guestNames) {
- if (this.#guestRecords.has(name)) continue;
- const r = new Record(this.#ds, name);
- this.#guestRecords.set(name, r);
- void r.load().then(installWatcher.bind(this, r));
- }
+ isHost(): boolean {
+ return this.#hostName === this.#guestName;
+ }
- // repopulate guestShareds
- this.#guestShareds.length = 0; // empty it
- for (const name of this.#guestNames) {
- const r = this.#guestRecords.get(name);
- r?.whenReady().then(() => {
- // hack: if this Record is for the same server record, use the myGuestRecord shared instead, so identity checks on the client work. guests[0] === me
- let shared = r.shared;
- if (r.name === this.#myGuestRecord.name) {
- shared = this.#myGuestRecord.shared;
- }
- if (!isEmpty(shared)) {
- if (!this.#guestShareds.includes(shared)) {
- this.#guestShareds.push(shared);
- }
- }
- }, undefined);
- }
+ async #updateGuestNames(): Promise {
+ const everyone = await this.#ds.presence.getAll();
+ this.#guestNames = everyone
+ .filter((guestName) => guestName.startsWith(`${this.#roomId}/`))
+ .concat(this.#guestName)
+ .sort();
+ this.#hostName = this.#guestNames[0];
}
#onPresence(username: string, isLoggedIn: boolean): void {
@@ -268,15 +151,54 @@ export class Room {
// update host
this.#hostName = this.#guestNames[0];
+ // update guest shareds
this.#updateGuestShareds();
}
- async #updateGuestNames(): Promise {
- const everyone = await this.#ds.presence.getAll();
- this.#guestNames = everyone
- .filter((guestName) => guestName.startsWith(`${this.#roomId}/`))
- .concat(this.#guestName)
- .sort();
- this.#hostName = this.#guestNames[0];
+ #updateGuestShareds() {
+ const updatePublishedGuestShareds = () => {
+ this.#publishedGuestShareds.length = 0;
+ const nonemptyShareds = this.#guestShareds.filter((s) => !isEmpty(s));
+ this.#publishedGuestShareds.push(...nonemptyShareds);
+ };
+
+ // add any missing records to guestRecords, start loading them
+ for (const name of this.#guestNames) {
+ if (this.#guestRecords.has(name)) continue;
+ if (name === this.#guestName) {
+ // add my guest record
+ this.#guestRecords.set(name, this.#myGuestRecord);
+ // republish when record changes
+ void this.#myGuestRecord.whenLoaded.then(() => {
+ this.#myGuestRecord.watchShared(
+ updatePublishedGuestShareds.bind(this),
+ true
+ );
+ });
+ } else {
+ // create record for remote guest and add it
+ const r = new Record(this.#ds, name);
+ this.#guestRecords.set(name, r);
+ // republish when record changes
+ void r.load().then(() => {
+ r.watchShared(updatePublishedGuestShareds.bind(this), true);
+ });
+ }
+ }
+
+ // update shareds in guestShareds
+ this.#guestShareds.length = 0; // empty it
+ for (const name of this.#guestNames) {
+ if (name === this.#guestName) {
+ // add `my` guest record
+ this.#guestShareds.push(this.#myGuestRecord.shared);
+ } else {
+ // add remote guest record
+ const r = this.#guestRecords.get(name);
+ if (r) this.#guestShareds.push(r.shared);
+ }
+ }
+
+ updatePublishedGuestShareds();
}
}
diff --git a/src/old/InfoPanel.css b/src/old/InfoPanel.css
deleted file mode 100644
index 895a40e..0000000
--- a/src/old/InfoPanel.css
+++ /dev/null
@@ -1,57 +0,0 @@
-#party-info {
- font-family: monospace;
- font-size: 12px;
-
- background-color: #ffcccc;
- position: absolute;
- right: 0;
- top: 0;
-
- display: none;
-}
-
-#party-info.show {
- display: block;
-}
-
-#party-info div {
- padding: 10px;
-}
-#party-info .app {
- background-color: #ffffcc;
-}
-#party-info .room {
- background-color: #ffffcc;
-}
-#party-info .id {
- background-color: #ffffcc;
-}
-
-#party-info .participant {
- background-color: #ccccff;
-}
-#party-info .host::after {
- content: " « host";
-}
-#party-info .me::after {
- content: " « me";
-}
-#party-info .host.me::after {
- content: " « host+me";
-}
-#party-info .missing {
- color: rgba(0, 0, 0, 0.3);
-}
-
-#party-info .label {
- background-color: #ccffcc;
-}
-#party-info .record {
- background-color: #ccffff;
-}
-
-#party-info a {
- text-decoration: underline;
- cursor: pointer;
- user-select: none;
-}
diff --git a/src/old/InfoPanel.js b/src/old/InfoPanel.js
deleted file mode 100644
index cfea61d..0000000
--- a/src/old/InfoPanel.js
+++ /dev/null
@@ -1,104 +0,0 @@
-import Reef from "reefjs";
-import * as log from "./log";
-
-// eslint-disable-next-line
-import css from "./InfoPanel.css";
-
-const UPDATE_MS = 100;
-
-export class InfoPanel {
- #client; // currently connected client
- #room; // current room
- #el; // the element used to display the info
- #reef; // reef component https://reefjs.com/
- constructor(client, room) {
- this.#client = client;
- this.#room = room;
- this.#el = createInfoPanelElement();
-
- this.#reef = new Reef(this.#el, {
- data: {},
- template,
- listeners: {
- logParticipant: (e) => {
- const participantShareds = this.#room._getParticipantSharedsObject();
- const shared = participantShareds[e.target.dataset.uid];
- log.debug(shared);
- },
- logShared: async (e) => {
- const name = e.target.dataset.name.split("/")[1];
- const record = this.#room.getRecord(name);
- const shared = record.getShared();
- await record.whenReady();
- log.debug(shared);
- },
- },
- });
-
- this.#room.whenReady(this.#startUpdates.bind(this));
- }
-
- toggle(show) {
- this.#el.classList.toggle("show", show);
- }
-
- #startUpdates() {
- setInterval(this.#update.bind(this), UPDATE_MS);
- }
-
- #update() {
- this.#reef.data = {
- onlineClientUids: this.#client.getOnlineClientUids(),
- myUid: this.#client.getUid(),
- ...this.#room._panelData(),
- };
- }
-}
-
-function createInfoPanelElement() {
- let el = document.getElementById("party-info");
- if (!el) {
- el = document.createElement("div");
- el.id = "party-info";
- document.body.appendChild(el);
- }
- return el;
-}
-
-function template(data) {
- const participantDivs = [];
- for (const uid of data.participantUids ?? []) {
- const shortName = uid.substr(-4);
- const me = data.myUid === uid ? "me" : "";
- const host = data.hostUid === uid ? "host" : "";
- const missing = data.onlineClientUids.includes(uid) ? "" : "missing";
- participantDivs.push(
- ``
- );
- }
-
- const sharedRecordDivs = [];
- for (const sharedRecordName of data.sharedRecordNames ?? []) {
- const shortName = sharedRecordName.split("/")[1];
- sharedRecordDivs.push(
- ``
- );
- }
-
- const isHost = data.myUid === data.hostUid ? "host" : "";
- const myShortname = data.myUid.substr(-4);
- return `
- p5.party info
- ${data.appName}
- ${data.roomName}
-
- Participants
- ${participantDivs.join("")}
- Shared Objects
- ${sharedRecordDivs.join("")}
- `;
-}
diff --git a/src/old/emitter.js b/src/old/emitter.js
deleted file mode 100644
index d5fe9e1..0000000
--- a/src/old/emitter.js
+++ /dev/null
@@ -1,30 +0,0 @@
-// tiny emitter based on nanoevents
-// with added once()
-
-// https://github.com/ai/nanoevents
-
-export const createEmitter = () => ({
- events: {},
- // send message to subscribers
- emit(event, ...args) {
- for (const i of this.events[event] || []) {
- i(...args);
- }
- },
-
- // subscribe to future messages
- on(event, cb) {
- (this.events[event] = this.events[event] || []).push(cb);
- return () =>
- (this.events[event] = this.events[event].filter((i) => i !== cb));
- },
-
- // subscribe for first future message only
- once(event, cb) {
- const unbind = this.on(event, (...args) => {
- unbind();
- cb(...args);
- });
- return unbind;
- },
-});
diff --git a/src/old/emitter.te!st.js b/src/old/emitter.te!st.js
deleted file mode 100644
index 613307d..0000000
--- a/src/old/emitter.te!st.js
+++ /dev/null
@@ -1,26 +0,0 @@
-/* global test describe*/
-
-import { createEmitter } from "./emitter";
-
-describe("emitter", () => {
- test("on", (done) => {
- const e = createEmitter();
- e.on("test", () => {
- done();
- });
- e.emit("test");
- });
-
- test("once", (done) => {
- const e = createEmitter();
- e.once("test", () => {
- done();
- });
- e.emit("test");
- });
-
- test("no listener", () => {
- const e = createEmitter();
- e.emit("test");
- });
-});
diff --git a/src/p5.party.ts b/src/p5.party.ts
index 88b8175..f0f6efa 100644
--- a/src/p5.party.ts
+++ b/src/p5.party.ts
@@ -20,13 +20,12 @@ function init() {
? `p5.js v${p5.prototype.VERSION}`
: "p5.js is older than 1.3.1";
log.styled("font-weight: bold", version_string);
- log.styled("font-weight: bold", `p5.party v${version}-ts`);
+ log.styled("font-weight: bold", `p5.party v${version}`);
let room: Room | null = null;
// ! partyConnect (preload)
- p5.prototype.registerPreloadMethod("partyConnect", p5.prototype);
p5.prototype.partyConnect = function (
host: string,
appName: string,
@@ -37,9 +36,9 @@ function init() {
log.warn("You should call partyConnect() only one time");
return;
}
- room = new Room(host, appName, roomName);
const load = async () => {
- await room?.connect(); // room defined above
+ room = new Room(host, appName, roomName);
+ await room.whenConnected;
window.addEventListener("beforeunload", () => {
room?.disconnect();
});
@@ -50,6 +49,7 @@ function init() {
};
void load();
};
+ p5.prototype.registerPreloadMethod("partyConnect", p5.prototype);
// ! partyLoadShared (preload)
@@ -66,7 +66,7 @@ function init() {
const record = room.getRecord(name);
const load = async () => {
- await room?.whenConnected(); // room null checked above
+ await room?.whenConnected; // room null checked above
await record.load(initObject);
log.log(`partyLoadShared "${name}" done!`);
cb?.(record.shared);
@@ -80,8 +80,6 @@ function init() {
// ! partyLoadMyShared
- // note: guest record not created until partyLoadMyShared() is called so it won't be in the guest array
-
p5.prototype.registerPreloadMethod("partyLoadMyShared", p5.prototype);
p5.prototype.partyLoadMyShared = function (
initObject = {},
@@ -95,8 +93,9 @@ function init() {
const record = room.myGuestRecord;
const load = async () => {
- await room?.whenConnected(); // room null checked above
- await record.load(initObject);
+ await room?.whenConnected; // room null checked above
+ await record.whenLoaded;
+ await record.initData(initObject);
log.log(`partyLoadMyShared done!`);
cb?.(record.shared);
this._decrementPreload();
@@ -151,7 +150,7 @@ function init() {
);
return;
}
- Record.recordForShared(shared)?.setShared(object);
+ Record.recordForShared(shared)?.setData(object);
};
// ! partyWatchShared
@@ -204,4 +203,10 @@ function init() {
}
room.emit(event, data);
};
+
+ p5.prototype.partyToggleInfo = function () {
+ log.warn(
+ "partyToggleInfo is no longer available in this version of p5.party."
+ );
+ };
}
diff --git a/src/ts.ts b/src/ts.ts
deleted file mode 100644
index b7c99a9..0000000
--- a/src/ts.ts
+++ /dev/null
@@ -1,3 +0,0 @@
-export function sum(a: number, b: number): number {
- return a + b ;
-}
\ No newline at end of file
diff --git a/src/validate.ts b/src/validate.ts
index f8dd09e..3300714 100644
--- a/src/validate.ts
+++ b/src/validate.ts
@@ -1,15 +1,18 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+
+import dedent from "ts-dedent";
+
import {
JSONValue,
JSONObject,
RecordData,
} from "@deepstream/client/dist/src/constants";
-export { JSONValue, JSONObject, RecordData };
+import { SubscriptionCallback } from "@deepstream/client/dist/src/record/record";
-import dedent from "ts-dedent";
import * as log from "./log";
+export { JSONValue, JSONObject, RecordData, SubscriptionCallback };
export type UserData = unknown;
/**
@@ -43,6 +46,7 @@ export function isJSONValue(
* @param value value to check
* @returns if the value is JSONObject
*/
+
export function isJSONObject(
value: UserData,
name?: string
@@ -78,8 +82,9 @@ interface ValidationError {
message: string;
}
-// validationError is a module global and can be checked if validateJSONValue returns false for info on the error.
-// note: is there a better pattern for this?
+// validationError is a module global and can be checked if/after validateJSONValue returns false for info on the error.
+// note: is there a better pattern for providing error details here?
+
let validationError: ValidationError | null;
function validateJSONValue(value: UserData, path = ""): boolean {
@@ -193,25 +198,3 @@ function validateJSONValue(value: UserData, path = ""): boolean {
* .log((value as JSONObject).test); // okay
* .log(value.test); // not okay
*/
-
-/**
- * export declare type JSONPrimitive = string | number | boolean | null;
- * export interface JSONObject {
- * [member: string]: JSONValue;
- * }
- * export interface JSONArray extends Array {
- * }
- * export declare type JSONValue = JSONPrimitive | JSONObject | JSONArray;
- * export declare type RecordPathData = JSONValue;
- * export declare type RecordData = JSONObject | Array | null | undefined;
- */
-
-/**
- * example
- *
- * export function test(value: UserData): JSONValue {
- * if (!isJSONValue(value)) return null;
- * return value;
- * }
- *
- */
diff --git a/test/Record.test.ts b/test/Record.test.ts
index ac811dd..8b2a9ed 100644
--- a/test/Record.test.ts
+++ b/test/Record.test.ts
@@ -57,7 +57,9 @@ describe("Record - Early Use", () => {
it("Errors if whenReady checked before load begins", async () => {
const ds1 = new DeepstreamClient(HOST);
const r1 = new Record(ds1, "test");
- await r1.whenReady();
+
+ await expect(r1.whenLoaded).rejects.toThrow();
+
expect(errorSpy).toHaveBeenCalled();
errorSpy.mockClear();
ds1.close();
@@ -71,7 +73,7 @@ describe("Record — Creating", () => {
it("ignores init object if not object and warns", async () => {
const r1 = new Record(ds1, "test");
await r1.load("string");
- await r1.whenReady();
+ await r1.whenLoaded;
const shared = r1.shared;
expect(shared).toStrictEqual({});
@@ -227,7 +229,7 @@ describe("Record — Shared Object", () => {
await r2.load();
const shared2 = r2.shared;
- r1.setShared({ a: "a", b: "b" });
+ r1.setData({ a: "a", b: "b" });
await millis(DELAY);
expect(shared2).toStrictEqual({ a: "a", b: "b" });
@@ -239,6 +241,30 @@ describe("Record — Shared Object", () => {
expect(shared2).toStrictEqual({ b: "b" });
});
+ it("removes deleted properties", async () => {
+ const r1 = new Record(ds1, "test");
+ await r1.load();
+ const shared1 = r1.shared;
+
+ const r2 = new Record(ds2, "test");
+ await r2.load();
+ const shared2 = r2.shared;
+
+ r1.setData({ a: "a", b: "b" });
+ await millis(DELAY);
+
+ expect(shared2).toStrictEqual({ a: "a", b: "b" });
+
+ // shared1.a = undefined as unknown as JSONValue;
+
+ delete shared1.a;
+
+ await millis(DELAY);
+
+ expect(shared1).toStrictEqual({ b: "b" });
+ expect(shared2).toStrictEqual({ b: "b" });
+ });
+
it("shares supported types", async () => {
const r1 = new Record(ds1, "test");
await r1.load();
@@ -291,7 +317,7 @@ describe("Record — Shared Object", () => {
await r2.load();
const shared2 = r2.shared;
- r1.setShared({});
+ r1.setData({});
// cast as any to force bad types
shared1.function = (() => {}) as any; // 1
@@ -353,9 +379,9 @@ describe("Record — setShared()", () => {
it("warns and ignores if called early", () => {
const r1 = new Record(ds1, "test");
- r1.setShared({ test: "test" });
- expect(warnSpy).toHaveBeenCalledTimes(1);
- warnSpy.mockClear();
+ r1.setData({ test: "test" });
+ expect(errorSpy).toHaveBeenCalledTimes(1);
+ errorSpy.mockClear();
});
it("should add and remove properties", async () => {
@@ -371,7 +397,7 @@ describe("Record — setShared()", () => {
object: { a: 1 },
emptyIt: [],
};
- r1.setShared(newObject);
+ r1.setData(newObject);
await millis(DELAY);
expect(r1.shared).toStrictEqual(newObject);
@@ -380,11 +406,11 @@ describe("Record — setShared()", () => {
it("warns and ignores if not given JSONObject", async () => {
const r1 = new Record(ds1, "test");
await r1.load({});
- r1.setShared({});
+ r1.setData({});
expect(r1.shared).toStrictEqual({});
- r1.setShared("string");
- r1.setShared({ test: BigInt(1) });
+ r1.setData("string");
+ r1.setData({ test: BigInt(1) });
expect(r1.shared).toStrictEqual({});
@@ -406,7 +432,7 @@ describe("Record — watchShared()", () => {
const r1 = new Record(ds1, "test");
await r1.load();
- r1.setShared({});
+ r1.setData({});
r1.watchShared((data) => {
calledCount++;
expect(data).toBeInstanceOf(Object);
@@ -427,7 +453,7 @@ describe("Record — watchShared()", () => {
const r1 = new Record(ds1, "test");
await r1.load();
- r1.setShared({});
+ r1.setData({});
r1.watchShared("test", (data) => {
calledCount++;
expect(data).toBe("test");
diff --git a/test/Room.test.ts b/test/Room.test.ts
index 324ec4c..8715631 100644
--- a/test/Room.test.ts
+++ b/test/Room.test.ts
@@ -1,5 +1,6 @@
/* eslint-disable @typescript-eslint/no-unsafe-argument */
import { JSONObject } from "@deepstream/client/dist/src/constants";
+import onChange from "on-change";
import { Room } from "../src/Room";
@@ -10,13 +11,13 @@ describe("Room", () => {
it("connects", async () => {
r = new Room(HOST, "test", "test");
- await r.connect();
+ await r.whenConnected;
expect(r._isConnected()).toBe(true);
});
it("double connects", async () => {
- await r.connect();
- await r.connect(); // tripple even
+ await r.whenConnected;
+ await r.whenConnected; // tripple even
expect(r._isConnected()).toBe(true);
});
@@ -32,9 +33,9 @@ describe("Room", () => {
it("waits for whenConnected", async () => {
const r2 = new Room(HOST, "test", "test");
- void r2.connect();
- await r2.whenConnected(); // should wait
- await r2.whenConnected(); // should be instant
+ void r2.whenConnected;
+ await r2.whenConnected; // should wait
+ await r2.whenConnected; // should be instant
expect(r2._isConnected()).toBe(true);
r2.disconnect();
});
@@ -45,7 +46,7 @@ describe("getRecord", () => {
beforeAll(async () => {
r1 = new Room(HOST, "test", "test");
- await Promise.all([r1.connect()]);
+ await Promise.all([r1.whenConnected]);
expect(r1._isConnected()).toBe(true);
});
@@ -70,7 +71,7 @@ describe("Subscribe + Emit", () => {
r1 = new Room(HOST, "test", "test");
r2 = new Room(HOST, "test", "test");
r3 = new Room(HOST, "test", "test2");
- await Promise.all([r1.connect(), r2.connect(), r3.connect()]);
+ await Promise.all([r1.whenConnected, r2.whenConnected, r3.whenConnected]);
expect(r1._isConnected()).toBe(true);
expect(r2._isConnected()).toBe(true);
expect(r3._isConnected()).toBe(true);
@@ -172,7 +173,7 @@ describe("Guests", () => {
r1 = new Room(HOST, "test", "test");
r2 = new Room(HOST, "test", "test");
r3 = new Room(HOST, "test", "test2");
- await Promise.all([r1.connect(), r2.connect(), r3.connect()]);
+ await Promise.all([r1.whenConnected, r2.whenConnected, r3.whenConnected]);
expect(r1._isConnected()).toBe(true);
expect(r2._isConnected()).toBe(true);
@@ -200,13 +201,14 @@ describe("Guests", () => {
});
describe("Guest Shareds", () => {
- it("contains a shared created immediately", async () => {
+ it("local guestShareds contains my (immediate)", async () => {
const r1 = new Room(HOST, "test", "test");
- const c = r1.connect();
+ void r1.whenConnected;
const rec1 = r1.myGuestRecord;
- await r1.whenConnected();
- await rec1.load({ a: Math.random() });
- await c;
+
+ await r1.whenConnected;
+ await rec1.whenLoaded;
+ await rec1.initData({ a: Math.random() });
const my = rec1.shared;
const guests = r1.guestShareds;
@@ -217,17 +219,18 @@ describe("Guest Shareds", () => {
r1.disconnect();
});
- it("remote contains a shared created immediately", async () => {
+ it("remote guestShares contains my (immediate)", async () => {
const r1 = new Room(HOST, "test", "test");
- const c = r1.connect();
+ void r1.whenConnected;
const rec1 = r1.myGuestRecord;
- await r1.whenConnected();
- await rec1.load({ a: 1 });
- await c;
+ await r1.whenConnected;
+ await rec1.whenLoaded;
+ await rec1.initData({ a: 1 });
+
const my = rec1.shared;
const r2 = new Room(HOST, "test", "test");
- await r2.connect();
+ await r2.whenConnected;
const guestShareds = r2.guestShareds;
await millis(500);
@@ -239,12 +242,12 @@ describe("Guest Shareds", () => {
r2.disconnect();
});
- it("contains a shared created after a delay", async () => {
+ it("local guestShares contains my (delayed)", async () => {
const r1 = new Room(HOST, "test", "test");
- await r1.connect();
+ await r1.whenConnected;
const rec1 = r1.myGuestRecord;
await millis(500);
- await rec1.load({ a: 1 });
+ await rec1.initData({ a: 1 });
const my = rec1.shared;
const guests = r1.guestShareds;
@@ -254,16 +257,16 @@ describe("Guest Shareds", () => {
r1.disconnect();
});
- it("remote contains a shared created after a delay", async () => {
+ it("remote guestShares contains my (delayed)", async () => {
const r1 = new Room(HOST, "test", "test");
- await r1.connect();
+ await r1.whenConnected;
const rec1 = r1.myGuestRecord;
await millis(500);
- await rec1.load({ a: 1 });
+ await rec1.initData({ a: 1 });
const my = rec1.shared;
const r2 = new Room(HOST, "test", "test");
- await r2.connect();
+ await r2.whenConnected;
const guestShareds = r2.guestShareds;
await millis(500);
@@ -276,7 +279,7 @@ describe("Guest Shareds", () => {
it("warns on changes to guestShareds", async () => {
const r1 = new Room(HOST, "test", "test");
- await r1.connect();
+ await r1.whenConnected;
const guestShareds = r1.guestShareds;
const l1 = guestShareds.length;
@@ -300,7 +303,7 @@ describe("Host", () => {
r1 = new Room(HOST, "test", "test");
r2 = new Room(HOST, "test", "test");
r3 = new Room(HOST, "test", "test2");
- await Promise.all([r1.connect(), r2.connect(), r3.connect()]);
+ await Promise.all([r1.whenConnected, r2.whenConnected, r3.whenConnected]);
expect(r1._isConnected()).toBe(true);
expect(r2._isConnected()).toBe(true);
expect(r3._isConnected()).toBe(true);
@@ -325,3 +328,22 @@ describe("Host", () => {
expect(r1.hostName).not.toBe(r3.hostName);
});
});
+
+describe("watch watch", () => {
+ test("?", () => {
+ const myArr: any[] = [];
+ const myWatchedArr: any[] = onChange(myArr, (a, b, c) => {
+ /**/
+ });
+
+ const myObj: Record = {};
+
+ myWatchedArr.push(myObj);
+ // myArr changed
+
+ myObj.a = 1;
+
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+ myWatchedArr[0].a = 2;
+ });
+});
diff --git a/test/common.ts b/test/common.ts
index b003379..ef12468 100644
--- a/test/common.ts
+++ b/test/common.ts
@@ -1,4 +1,5 @@
-/* istanbul ignore file */
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+// /* istanbul ignore file */
import * as log from "../src/log";
@@ -11,19 +12,20 @@ export const DELAY = 200;
// export const HOST = "wss://deepstream-server-1.herokuapp.com";
// export const DELAY = 500;
-export const errorSpy = jest
- .spyOn(log, "error")
- .mockImplementation((...args) => {
- // console.log(...args);
+export const errorSpy = //
+ jest.spyOn(log, "error").mockImplementation((...args) => {
+ //console.log(...args);
});
-export const warnSpy = jest.spyOn(log, "warn").mockImplementation((...args) => {
- // console.log(...args);
-});
+export const warnSpy = //
+ jest.spyOn(log, "warn").mockImplementation((...args) => {
+ // console.log(...args);
+ });
-export const logSpy = jest.spyOn(log, "log").mockImplementation((...args) => {
- // console.log(...args);
-});
+export const logSpy = //
+ jest.spyOn(log, "log").mockImplementation((...args) => {
+ // console.log(...args);
+ });
beforeEach(() => {
errorSpy.mockClear();