JSON definition · shared/definitions/creator-load-save.json
View on GitHub
{
"title": "Support request",
"elements": [
{
"type": "dropdown",
"name": "product",
"title": "Product",
"choices": [
"Form Library",
"Survey Creator",
"Dashboard",
"PDF Generator"
]
},
{
"type": "comment",
"name": "issue",
"title": "Describe the issue",
"isRequired": true
},
{
"type": "radiogroup",
"name": "urgency",
"title": "How urgent is it?",
"choices": [
"Low",
"Normal",
"Blocking"
]
},
{
"type": "boolean",
"name": "callback",
"title": "Call me back"
}
]
}
Client · shared/client/edit-together.js · sjs:edit-together.save
View on GitHub
// Save the synchronized schema separately from the room's temporary edit log
function configureSaving() {
saver = createSchemaSaver(() => creator.JSON, async json => {
if (!connected()) throw new Error("Reconnect before saving the shared form.");
const response = await fetch(`/api/forms/${formId}`, {
method: "PUT", headers: { "Content-Type": "application/json" }, body: json
});
if (!response.ok) throw await responseError(response, "Couldn't save the form schema. Please try again.");
}, ({ state, error }) => {
showError(state === "error" ? error : "");
retrySave.hidden = state !== "error";
formSelector.disabled = state === "saving";
});
creator.saveSurveyFunc = async (saveNo, callback) => {
const saved = await saver.save();
callback(saveNo, saved);
// Creator says "not saved" in the callback; show the server's reason after it
if (!saved) creator.notify(saver.error, "error");
};
creator.onModified.add(() => { if (ready && !collab.isApplying) saver.changed(); });
}
Client · shared/client/edit-together.js · sjs:edit-together.client
View on GitHub
// Rebuild the shared form from its saved schema and ordered edit log
function initialize(message) {
creator?.dispose();
creator = new SurveyCreator({ showTranslationTab: true });
creator.JSON = message.seed;
collab = new CollaborationPlugin(creator, { roomId: formId, getInviteLink: sharedFormLink });
creator.addPlugin("collaboration", collab);
collab.setClientId(message.clientId);
configureSaving();
saver.markSaved();
if (message.log.length) collab.apply(message.log);
const append = (_, { record }) => send({ type: "append", payload: record });
collab.onRecordAdded.add(append);
collab.onRecordChanged.add(append);
collab.onStateChanged.add(() => send({ type: "presence", state: collab.getState() }));
}
Server · relay/edit-relay.js · sjs:edit-together.server
View on GitHub
// The same kind of relay as Fill Forms Together, keeping an append-only log instead of a value map:
// Creator records must be replayed in order. It runs in this app's process, on its port.
const rooms = new Map(); // room key => EditRoom { seed, log, clients }
function connect(ws, { formId, roomKey, user, database, name }) { // relay/index.js checked that the user may edit
let room = rooms.get(roomKey);
if (!room) rooms.set(roomKey, (room = new EditRoom(savedDefinition(database, formId)))); // seed = saved definition
room.cancelDrop(); // back within 2 s: keep the room
const client = { id: randomBytes(8).toString("hex"), name: displayName(name, user.name), slot: room.freeSlot() };
ws.client = { ...client, state: null, roomKey };
room.clients.add(ws);
const { id, slot } = client;
send(ws, { type: "init", clientId: id, colorIndex: slot, color: PALETTE[slot], seed: room.seed, log: room.log }); // first
const peers = room.roster(ws);
if (peers.length > 0) send(ws, { type: "presence-sync", peers });
}
function message(ws, raw) {
const msg = parse(raw);
const room = rooms.get(ws.client.roomKey);
if (!room || !isObject(msg)) return;
if (msg.type === "append" && msg.payload !== undefined && msg.payload !== null) { // append, then fan out
room.log.push(msg.payload);
room.broadcast(ws, { type: "record", from: ws.client.id, payload: msg.payload });
} else if (msg.type === "presence" && msg.state != null && raw.length <= 4096) {
ws.client.state = msg.state;
room.broadcast(ws, { type: "presence", peer: EditRoom.peer(ws) });
} // unknown types: ignore
}
function close(ws) {
const room = rooms.get(ws.client?.roomKey);
if (!room) return;
room.clients.delete(ws);
room.broadcast(ws, { type: "presence-leave", clientId: ws.client.id });
if (room.clients.size === 0) room.dropAfter(2000, () => rooms.delete(ws.client.roomKey)); // the log lives until then
}