Farmbot-Web-App/frontend/connectivity/auto_sync.ts

89 lines
3.5 KiB
TypeScript

import { GetState } from "../redux/interfaces";
import { maybeDetermineUuid } from "../resources/selectors";
import { TaggedResource, SpecialStatus } from "farmbot";
import { overwrite, init } from "../api/crud";
import { handleInbound } from "./auto_sync_handle_inbound";
import {
SyncPayload, MqttDataResult, Reason, UpdateMqttData,
} from "./interfaces";
import { outstandingRequests } from "./data_consistency";
import { newTaggedResource } from "../sync/actions";
export function decodeBinary(payload: Buffer): SyncPayload {
return JSON.parse((payload).toString());
}
const SKIP_THESE = ["DeviceSerialNumber"]; // Only FBOS Cares about this one.
export function routeMqttData(chan: string, payload: Buffer):
MqttDataResult<TaggedResource> {
/** Skip irrelevant messages: only resource auto-sync messages are desired.
* eg, `bot/device_#/sync/Resource/#` */
if (!(chan.split("/")[2] == "sync")) { return { status: "SKIP" }; }
/** Extract, Validate and scrub the data as it enters the frontend. */
const parts = chan.split("/");
if (parts.length !== 5) { return { status: "ERR", reason: Reason.BAD_CHAN }; }
const id = parseInt(parts.pop() || "0", 10);
const kind = parts.pop() as TaggedResource["kind"];
if (SKIP_THESE.includes(kind)) { return { status: "SKIP" }; }
const { body, args } = decodeBinary(payload);
if (body) {
return { status: "UPDATE", body, kind: kind, id, sessionId: args.label };
} else {
return { status: "DELETE", kind: kind, id }; // 'null' body means delete.
}
}
export function asTaggedResource(data: UpdateMqttData<TaggedResource>):
TaggedResource {
return newTaggedResource(data.kind, data.body)[0];
}
export const handleCreate =
(data: UpdateMqttData<TaggedResource>) => init(data.kind, data.body, true);
export const handleUpdate =
(d: UpdateMqttData<TaggedResource>, uuid: string) => {
const tr = asTaggedResource(d);
tr.uuid = uuid;
return overwrite(tr, tr.body, SpecialStatus.SAVED);
};
export function handleCreateOrUpdate(dispatch: Function,
getState: GetState,
data: UpdateMqttData<TaggedResource>) {
const state = getState();
const { index } = state.resources;
const hasCopy = maybeDetermineUuid(index, data.kind, data.id);
const isEcho = outstandingRequests.all.has(data.sessionId);
// Here be dragons. 🐲 🐉 ⚔ ️🛡️
// PROBLEM: You see incoming `UPDATE` messages.
// How do you know if it is a new record or an update to
// an existing?
//
// SOLUTION: Every inbound message has a `sessionId` that matches an entry in
// the `outstandingRequests` dictionary. If we have a copy of the
// `sessionId` in the `outstandingRequests` object, then you can
// disregard the sync message- you probably already got the data
// when your AJAX request finished. We call this an "echo"- a
// repetition of a data update we already knew about.
//
// The ultimate problem: We need to know if the incoming data update was
// created by us or some other user. That information lets us know if we are
// UPDATE-ing data or INSERTing data. It also prevents us from double updating
// data when an update comes in twice.
const action = hasCopy ? handleUpdate(data, hasCopy) : handleCreate(data);
return isEcho || dispatch(action);
}
export const autoSync =
(dispatch: Function, getState: GetState) => {
return (chan: string, payload: Buffer) => {
handleInbound(dispatch, getState, routeMqttData(chan, payload));
};
};