Skip to content

correcly apply client-side JSON patch #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 36 additions & 17 deletions src/client/packages/idom-client-react/src/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,50 @@ import React from "react";
import jsonpatch from "fast-json-patch";

export function useJsonPatchCallback(initial) {
const model = React.useRef(initial);
const doc = React.useRef(initial);
const forceUpdate = useForceUpdate();

const applyPatch = React.useCallback(
(pathPrefix, patch) => {
if (pathPrefix) {
patch = patch.map((op) =>
Object.assign({}, op, { path: pathPrefix + op.path })
);
(path, patch) => {
if (!path) {
// We CANNOT mutate the part of the document because React checks some
// attributes of the model (e.g. model.attributes.style is checked for
// identity).
doc.current = applyNonMutativePatch(doc, patch, false, false, true);
} else {
// We CAN mutate the document here though because we know that nothing above
// The patch `path` is changing. Thus, maintaining the identity for that section
// of the model is accurate.
applyMutativePatch(doc.current, [
{
op: "replace",
path: path,
// We CANNOT mutate the part of the document where the actual patch is being
// applied. Instead we create a copy because React checks some attributes of
// the model (e.g. model.attributes.style is checked for identity). The part
// of the document above the `path` can be mutated though because we know it
// has not changed.
value: applyNonMutativePatch(
jsonpatch.getValueByPointer(doc.current, path),
patch
),
},
]);
}
// Always return a newDocument because React checks some attributes of the model
// (e.g. model.attributes.style is checked for identity)
model.current = jsonpatch.applyPatch(
model.current,
patch,
false,
false,
true
).newDocument;
forceUpdate();
},
[model]
[doc]
);

return [model.current, applyPatch];
return [doc.current, applyPatch];
}

function applyNonMutativePatch(doc, patch) {
return jsonpatch.applyPatch(doc, patch, false, false, true).newDocument;
}

function applyMutativePatch(doc, patch) {
jsonpatch.applyPatch(doc, patch, false, true, true).newDocument;
}

function useForceUpdate() {
Expand Down