graphql-live-query-patch-json-patch

@n1ru4l/graphql-live-query-patch-json-patch

Smaller live query payloads with JSON patches (RFC6902).

When having big query results JSON patches might be able to drastically reduce the payload sent to clients. Every time a new execution result is published a JSON patch is generated by diffing the previous and the next execution result. The patch operations are then sent to the client where they are applied to the initial execution result.

Query

query post($id: ID!) @live {
  post(id: $id) {
    id
    title
    totalLikeCount
  }
}

Initial result

{
  "data": {
    "post": {
      "id": "1",
      "title": "foo",
      "totalLikeCount": 10
    }
  },
  "revision": 1
}

Patch result (increase totalLikeCount)

{
  "patch": [
    {
      "op": "replace",
      "path": "post/totalLikeCount",
      "value": 11
    }
  ],
  "revision": 2
}

For a full example usage check out the todo-example client & server code.

Install Instructions

yarn add -E @n1ru4l/graphql-live-query-patch-json-patch

API

applyLiveQueryJSONPatchGenerator

Wrap a execute result and apply a live query patch generator middleware.

import { execute } from "graphql";
import { applyLiveQueryJSONPatchGenerator } from "@n1ru4l/graphql-live-query-patch-json-patch";
import { schema } from "./schema";

const result = applyLiveQueryJSONPatchGenerator(
  execute({
    schema,
    operationDocument: parse(/* GraphQL */ `
      query todosQuery @live {
        todos {
          id
          content
          isComplete
        }
      }
    `),
    rootValue: rootValue,
    contextValue: {},
    variableValues: null,
    operationName: "todosQuery",
  })
);

applyLiveQueryJSONPatch

Inflate the execution patch results on the client side.

import { applyLiveQueryJSONPatch } from "@n1ru4l/graphql-live-query-patch-json-patch";

const asyncIterable = applyLiveQueryJSONPatch(
  // networkLayer.execute returns an AsyncIterable
  networkLayer.execute({
    operation: /* GraphQL */ `
      query todosQuery @live {
        todos {
          id
          content
          isComplete
        }
      }
    `,
  })
);

AsyncIterators make composing async logic super easy. In case your GraphQL transport does not return a AsyncIterator you can use the @n1ru4l/push-pull-async-iterable-iterator package for wrapping the result as a AsyncIterator.

import { applyLiveQueryJSONPatch } from "@n1ru4l/graphql-live-query-patch-json-patch";
import { makeAsyncIterableIteratorFromSink } from "@n1ru4l/push-pull-async-iterable-iterator";
import { createClient } from "graphql-ws/lib/use/ws";

const client = createClient({
  url: "ws://localhost:3000/graphql",
});

const asyncIterableIterator = makeAsyncIterableIteratorFromSink((sink) => {
  const dispose = client.subscribe(
    {
      query: "query @live { hello }",
    },
    {
      next: sink.next,
      error: sink.error,
      complete: sink.complete,
    }
  );
  return () => dispose();
});

const wrappedAsyncIterableIterator = applyLiveQueryJSONPatch(
  asyncIterableIterator
);

for await (const value of asyncIterableIterator) {
  console.log(value);
}

applyLiveQueryJSONPatch

In most cases using createApplyLiveQueryPatchGenerator is the best solution. However, some special implementations might need a more flexible and direct way of applying the patch middleware.

import { execute } from "graphql";
import { applyLiveQueryJSONPatch } from "@n1ru4l/graphql-live-query-patch-json-patch";
import { schema } from "./schema";

execute({
  schema,
  operationDocument: parse(/* GraphQL */ `
    query todosQuery @live {
      todos {
        id
        content
        isComplete
      }
    }
  `),
  rootValue: rootValue,
  contextValue: {},
  variableValues: null,
  operationName: "todosQuery",
}).then(async (result) => {
  if (isAsyncIterable(result)) {
    for (const value of applyLiveQueryJSONPatch(result)) {
      console.log(value);
    }
  }
});