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 · app/routes/edit_together.py · 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.
@router.websocket("/ws/forms/{form_id}")
async def edit_together(websocket: WebSocket, form_id: FormId, user: CurrentUser, rooms: Rooms,
room_key: EditRoomKey, db: Db, name: str = "") -> None:
if not can(user, "edit-forms") or room_key is None: # like saving, editing together is for editors
await websocket.close(code=1008) # before accept(): the browser sees a refused handshake
return
await websocket.accept()
room = rooms.join(room_key, lambda: saved_definition(db, form_id)) # seed = the saved definition
client = room.add(websocket, display_name(name, user.name))
client.send({"type": "init", "clientId": client.id, "colorIndex": client.slot, "color": room.color(client),
"seed": room.seed, "log": room.log}) # init first
if peers := room.roster(client):
client.send({"type": "presence-sync", "peers": peers})
try:
async for raw in websocket.iter_text():
message = parse(raw) # records stay opaque: {} is relayed as {}
if not isinstance(message, dict):
continue
if message.get("type") == "append" and message.get("payload") is not None: # append, then fan out
room.log.append(message["payload"])
room.broadcast(client, {"type": "record", "from": client.id, "payload": message["payload"]})
elif message.get("type") == "presence" and message.get("state") is not None and len(raw) <= 4096:
client.state = message["state"]
room.broadcast(client, {"type": "presence", "peer": room.peer(client)})
# unknown types: ignore
except WebSocketDisconnect:
pass
finally:
rooms.leave(room_key, client) # presence-leave to the others; the log lives until the room empties