jason-rails 0.4.1 → 0.5.0

data/client/lib/createServerActionQueue.d.ts

@@ -0,0 +1,10 @@
+export default function createServerActionQueue(): {
+    addItem: (item: any) => void;
+    getItem: () => any;
+    itemProcessed: () => boolean;
+    fullySynced: () => boolean;
+    getData: () => {
+        queue: any[];
+        inFlight: boolean;
+    };
+};

data/client/lib/createServerActionQueue.js

@@ -0,0 +1,48 @@
+"use strict";
+// A FIFO queue with deduping of actions whose effect will be cancelled by later actions
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = __importDefault(require("lodash"));
+function createServerActionQueue() {
+    const queue = [];
+    let inFlight = false;
+    function addItem(item) {
+        // Check if there are any items ahead in the queue that this item would effectively overwrite.
+        // In that case we can remove them
+        // If this is an upsert && item ID is the same && current item attributes are a superset of the earlier item attributes
+        const { type, payload } = item;
+        if (type.split('/')[1] !== 'upsert') {
+            queue.push(item);
+            return;
+        }
+        lodash_1.default.remove(queue, item => {
+            const { type: itemType, payload: itemPayload } = item;
+            if (type !== itemType)
+                return false;
+            if (itemPayload.id !== payload.id)
+                return false;
+            // Check that all keys of itemPayload are in payload.
+            return lodash_1.default.difference(lodash_1.default.keys(itemPayload), lodash_1.default.keys(payload)).length === 0;
+        });
+        queue.push(item);
+    }
+    return {
+        addItem,
+        getItem: () => {
+            if (inFlight)
+                return false;
+            const item = queue.shift();
+            if (item) {
+                inFlight = true;
+                return item;
+            }
+            return false;
+        },
+        itemProcessed: () => inFlight = false,
+        fullySynced: () => queue.length === 0 && !inFlight,
+        getData: () => ({ queue, inFlight })
+    };
+}
+exports.default = createServerActionQueue;

data/client/lib/createServerActionQueue.test.d.ts

@@ -0,0 +1 @@
+export {};

data/client/lib/createServerActionQueue.test.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const createServerActionQueue_1 = __importDefault(require("./createServerActionQueue"));
+test('Adding items', () => {
+    const serverActionQueue = createServerActionQueue_1.default();
+    serverActionQueue.addItem({ type: 'entity/add', payload: { id: 'abc', attribute: 1 } });
+    const item = serverActionQueue.getItem();
+    expect(item).toStrictEqual({ type: 'entity/add', payload: { id: 'abc', attribute: 1 } });
+});
+test('Deduping of items that will overwrite each other', () => {
+    const serverActionQueue = createServerActionQueue_1.default();
+    serverActionQueue.addItem({ type: 'entity/upsert', payload: { id: 'abc', attribute: 1 } });
+    serverActionQueue.addItem({ type: 'entity/upsert', payload: { id: 'abc', attribute: 2 } });
+    serverActionQueue.addItem({ type: 'entity/upsert', payload: { id: 'abc', attribute: 3 } });
+    const item = serverActionQueue.getItem();
+    expect(item).toStrictEqual({ type: 'entity/upsert', payload: { id: 'abc', attribute: 3 } });
+});
+test('Deduping of items with a superset', () => {
+    const serverActionQueue = createServerActionQueue_1.default();
+    serverActionQueue.addItem({ type: 'entity/upsert', payload: { id: 'abc', attribute: 1 } });
+    serverActionQueue.addItem({ type: 'entity/upsert', payload: { id: 'abc', attribute: 2, attribute2: 'test' } });
+    const item = serverActionQueue.getItem();
+    expect(item).toStrictEqual({ type: 'entity/upsert', payload: { id: 'abc', attribute: 2, attribute2: 'test' } });
+});
+test("doesn't dedupe items with some attributes missing", () => {
+    const serverActionQueue = createServerActionQueue_1.default();
+    serverActionQueue.addItem({ type: 'entity/upsert', payload: { id: 'abc', attribute: 1 } });
+    serverActionQueue.addItem({ type: 'entity/upsert', payload: { id: 'abc', attribute2: 'test' } });
+    const item = serverActionQueue.getItem();
+    serverActionQueue.itemProcessed();
+    const item2 = serverActionQueue.getItem();
+    expect(item).toStrictEqual({ type: 'entity/upsert', payload: { id: 'abc', attribute: 1 } });
+    expect(item2).toStrictEqual({ type: 'entity/upsert', payload: { id: 'abc', attribute2: 'test' } });
+});

data/client/lib/index.d.ts

@@ -1,10 +1,11 @@
+/// <reference types="react" />
 import _useAct from './useAct';
 import _useSub from './useSub';
 export declare const JasonProvider: ({ reducers, middleware, extraActions, children }: {
     reducers?: any;
     middleware?: any;
     extraActions?: any;
-    children?: any;
-}) => any;
+    children?: import("react").FC<{}> | undefined;
+}) => JSX.Element;
 export declare const useAct: typeof _useAct;
 export declare const useSub: typeof _useSub;

data/client/lib/pruneIdsMiddleware.d.ts

@@ -0,0 +1,2 @@
+declare const pruneIdsMiddleware: (schema: any) => (store: any) => (next: any) => (action: any) => any;
+export default pruneIdsMiddleware;

data/client/lib/pruneIdsMiddleware.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = __importDefault(require("lodash"));
+const pluralize_1 = __importDefault(require("pluralize"));
+const pruneIdsMiddleware = schema => store => next => action => {
+    const { type } = action;
+    const result = next(action);
+    const state = store.getState();
+    if (type === 'jasonModels/setSubscriptionIds') {
+        // Check every model
+        lodash_1.default.map(lodash_1.default.keys(schema), model => {
+            let ids = [];
+            lodash_1.default.map(state.jasonModels[model], (subscribedIds, k) => {
+                ids = lodash_1.default.union(ids, subscribedIds);
+            });
+            // Find IDs currently in Redux that aren't in any subscription
+            const idsToRemove = lodash_1.default.difference(state[pluralize_1.default(model)].ids, ids);
+            store.dispatch({ type: `${pluralize_1.default(model)}/removeMany`, payload: idsToRemove });
+        });
+    }
+    return result;
+};
+exports.default = pruneIdsMiddleware;

data/client/lib/restClient.d.ts

@@ -0,0 +1,2 @@
+declare const restClient: import("axios").AxiosInstance;
+export default restClient;

data/client/lib/restClient.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const axios_case_converter_1 = __importDefault(require("axios-case-converter"));
+const uuid_1 = require("uuid");
+const csrfToken = (_a = document === null || document === void 0 ? void 0 : document.querySelector("meta[name=csrf-token]")) === null || _a === void 0 ? void 0 : _a.content;
+axios_1.default.defaults.headers.common['X-CSRF-Token'] = csrfToken;
+const restClient = axios_case_converter_1.default(axios_1.default.create(), {
+    preservedKeys: (key) => {
+        return uuid_1.validate(key);
+    }
+});
+exports.default = restClient;

data/client/lib/useJason.d.ts

@@ -0,0 +1,5 @@
+export default function useJason({ reducers, middleware, extraActions }: {
+    reducers?: any;
+    middleware?: any[];
+    extraActions?: any;
+}): any[];

data/client/lib/useJason.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const createActions_1 = __importDefault(require("./createActions"));
+const createJasonReducers_1 = __importDefault(require("./createJasonReducers"));
+const createPayloadHandler_1 = __importDefault(require("./createPayloadHandler"));
+const createOptDis_1 = __importDefault(require("./createOptDis"));
+const createServerActionQueue_1 = __importDefault(require("./createServerActionQueue"));
+const restClient_1 = __importDefault(require("./restClient"));
+const pruneIdsMiddleware_1 = __importDefault(require("./pruneIdsMiddleware"));
+const actioncable_1 = require("@rails/actioncable");
+const toolkit_1 = require("@reduxjs/toolkit");
+const makeEager_1 = __importDefault(require("./makeEager"));
+const humps_1 = require("humps");
+const blueimp_md5_1 = __importDefault(require("blueimp-md5"));
+const lodash_1 = __importDefault(require("lodash"));
+const react_1 = require("react");
+function useJason({ reducers, middleware = [], extraActions }) {
+    const [store, setStore] = react_1.useState(null);
+    const [value, setValue] = react_1.useState(null);
+    const [connected, setConnected] = react_1.useState(false);
+    react_1.useEffect(() => {
+        restClient_1.default.get('/jason/api/schema')
+            .then(({ data: snakey_schema }) => {
+            const schema = humps_1.camelizeKeys(snakey_schema);
+            console.debug({ schema });
+            const serverActionQueue = createServerActionQueue_1.default();
+            const consumer = actioncable_1.createConsumer();
+            const allReducers = Object.assign(Object.assign({}, reducers), createJasonReducers_1.default(schema));
+            console.debug({ allReducers });
+            const store = toolkit_1.configureStore({ reducer: allReducers, middleware: [...middleware, pruneIdsMiddleware_1.default(schema)] });
+            const dispatch = store.dispatch;
+            const optDis = createOptDis_1.default(schema, dispatch, restClient_1.default, serverActionQueue);
+            const actions = createActions_1.default(schema, store, restClient_1.default, optDis, extraActions);
+            const eager = makeEager_1.default(schema);
+            let payloadHandlers = {};
+            let configs = {};
+            function handlePayload(payload) {
+                const { md5Hash } = payload;
+                const handler = payloadHandlers[md5Hash];
+                if (handler) {
+                    handler(payload);
+                }
+                else {
+                    console.warn("Payload arrived with no handler", payload, payloadHandlers);
+                }
+            }
+            const subscription = (consumer.subscriptions.create({
+                channel: 'Jason::Channel'
+            }, {
+                connected: () => {
+                    setConnected(true);
+                    dispatch({ type: 'jason/upsert', payload: { connected: true } });
+                    console.debug('Connected to ActionCable');
+                    // When AC loses connection - all state is lost, so we need to re-initialize all subscriptions
+                    lodash_1.default.values(configs).forEach(config => createSubscription(config));
+                },
+                received: payload => {
+                    handlePayload(payload);
+                    console.debug("ActionCable Payload received: ", payload);
+                },
+                disconnected: () => {
+                    setConnected(false);
+                    dispatch({ type: 'jason/upsert', payload: { connected: false } });
+                    console.warn('Disconnected from ActionCable');
+                }
+            }));
+            function createSubscription(config) {
+                // We need the hash to be consistent in Ruby / Javascript
+                const hashableConfig = lodash_1.default(Object.assign({ conditions: {}, includes: {} }, config)).toPairs().sortBy(0).fromPairs().value();
+                const md5Hash = blueimp_md5_1.default(JSON.stringify(hashableConfig));
+                payloadHandlers[md5Hash] = createPayloadHandler_1.default({ dispatch, serverActionQueue, subscription, config });
+                configs[md5Hash] = hashableConfig;
+                setTimeout(() => subscription.send({ createSubscription: hashableConfig }), 500);
+                return {
+                    remove: () => removeSubscription(hashableConfig),
+                    md5Hash
+                };
+            }
+            function removeSubscription(config) {
+                subscription.send({ removeSubscription: config });
+                const md5Hash = blueimp_md5_1.default(JSON.stringify(config));
+                delete payloadHandlers[md5Hash];
+                delete configs[md5Hash];
+            }
+            setValue({
+                actions: actions,
+                subscribe: config => createSubscription(config),
+                eager,
+                handlePayload
+            });
+            setStore(store);
+        });
+    }, []);
+    return [store, value, connected];
+}
+exports.default = useJason;

data/client/lib/useJason.test.d.ts

@@ -0,0 +1 @@
+export {};

data/client/lib/useJason.test.js

@@ -0,0 +1,79 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_hooks_1 = require("@testing-library/react-hooks");
+const useJason_1 = __importDefault(require("./useJason"));
+const restClient_1 = __importDefault(require("./restClient"));
+jest.mock('./restClient');
+test('it works', () => __awaiter(void 0, void 0, void 0, function* () {
+    const resp = { data: { post: {} } };
+    // @ts-ignore
+    restClient_1.default.get.mockResolvedValue(resp);
+    const { result, waitForNextUpdate } = react_hooks_1.renderHook(() => useJason_1.default({ reducers: {
+            test: (s, a) => s || {}
+        } }));
+    yield waitForNextUpdate();
+    const [store, value, connected] = result.current;
+    const { handlePayload, subscribe } = value;
+    const subscription = subscribe({ post: {} });
+    handlePayload({
+        type: 'payload',
+        model: 'post',
+        payload: [{ id: 4, name: 'test' }],
+        md5Hash: subscription.md5Hash,
+        idx: 1
+    });
+    handlePayload({
+        id: 4,
+        model: 'post',
+        destroy: true,
+        md5Hash: subscription.md5Hash,
+        idx: 2
+    });
+    handlePayload({
+        id: 5,
+        model: 'post',
+        payload: { id: 5, name: 'test2' },
+        md5Hash: subscription.md5Hash,
+        idx: 3
+    });
+}));
+test('pruning IDs', () => __awaiter(void 0, void 0, void 0, function* () {
+    const resp = { data: { post: {} } };
+    // @ts-ignore
+    restClient_1.default.get.mockResolvedValue(resp);
+    const { result, waitForNextUpdate } = react_hooks_1.renderHook(() => useJason_1.default({ reducers: {
+            test: (s, a) => s || {}
+        } }));
+    yield waitForNextUpdate();
+    const [store, value, connected] = result.current;
+    const { handlePayload, subscribe } = value;
+    const subscription = subscribe({ post: {} });
+    handlePayload({
+        type: 'payload',
+        model: 'post',
+        payload: [{ id: 4, name: 'test' }],
+        md5Hash: subscription.md5Hash,
+        idx: 1
+    });
+    handlePayload({
+        type: 'payload',
+        model: 'post',
+        payload: [{ id: 5, name: 'test it out' }],
+        md5Hash: subscription.md5Hash,
+        idx: 2
+    });
+    // The ID 4 should have been pruned
+    expect(store.getState().posts.ids).toStrictEqual([5]);
+}));

data/client/lib/useSub.js

@@ -8,6 +8,7 @@ const react_1 = require("react");
 function useSub(config) {
     const subscribe = react_1.useContext(JasonContext_1.default).subscribe;
     react_1.useEffect(() => {
+        // @ts-ignore
         return subscribe(config);
     }, []);
 }

data/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jamesr2323/jason",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
@@ -23,11 +23,12 @@
     "@babel/preset-env": "^7.12.11",
     "@babel/preset-typescript": "^7.12.7",
     "@reduxjs/toolkit": "^1.5.0",
+    "@testing-library/react-hooks": "^5.0.3",
     "@types/jest": "^26.0.19",
     "babel-jest": "^26.6.3",
     "jest": "^26.6.3",
-    "react": "^16.8.3",
-    "react-dom": "^16.8.3",
+    "react": "^16.9.x",
+    "react-dom": "^16.9.x",
     "react-redux": "^7.2.2",
     "typescript": "^4.1.2"
   },

data/client/src/JasonProvider.tsx

@@ -1,130 +1,12 @@
-import createActions from './createActions'
-import { createConsumer } from "@rails/actioncable"
-import JasonContext from './JasonContext'
-import axios from 'axios'
-import applyCaseMiddleware from 'axios-case-converter'
+import React from 'react'
+import useJason from './useJason'
 import { Provider } from 'react-redux'
-import { createEntityAdapter, createSlice, createReducer, configureStore } from '@reduxjs/toolkit'
-import createJasonReducers from './createJasonReducers'
-import createPayloadHandler from './createPayloadHandler'
-import createOptDis from './createOptDis'
-import makeEager from './makeEager'
-import { camelizeKeys } from 'humps'
-import md5 from 'blueimp-md5'
-import _ from 'lodash'
-import React, { useState, useEffect } from 'react'
-import { validate as isUuid } from 'uuid'
+import JasonContext from './JasonContext'
 
 const JasonProvider = ({ reducers, middleware, extraActions, children }: { reducers?: any, middleware?: any, extraActions?: any, children?: React.FC }) => {
-  const [store, setStore] = useState(null)
-  const [value, setValue] = useState(null)
-  const [connected, setConnected] = useState(false)
-
-  const csrfToken = (document.querySelector("meta[name=csrf-token]") as any).content
-  axios.defaults.headers.common['X-CSRF-Token'] = csrfToken
-  const restClient = applyCaseMiddleware(axios.create(), {
-    preservedKeys: (key) => {
-      return isUuid(key)
-    }
-  })
-
-  useEffect(() => {
-    restClient.get('/jason/api/schema')
-    .then(({ data: snakey_schema }) => {
-      const schema = camelizeKeys(snakey_schema)
-
-      const serverActionQueue = function() {
-        const queue: any[] = []
-        let inFlight = false
-
-        return {
-          addItem: (item) => queue.push(item),
-          getItem: () => {
-            if (inFlight) return false
-
-            const item = queue.shift()
-            if (item) {
-              inFlight = true
-              return item
-            }
-            return false
-          },
-          itemProcessed: () => inFlight = false,
-          fullySynced: () => queue.length === 0 && !inFlight,
-          getData: () => ({ queue, inFlight })
-        }
-      }()
-
-      const consumer = createConsumer()
-      const allReducers = {
-        ...reducers,
-        ...createJasonReducers(schema)
-      }
-
-      console.log({ schema, allReducers })
-      const store = configureStore({ reducer: allReducers, middleware })
-
-      let payloadHandlers = {}
-      function handlePayload(payload) {
-        const { model, md5Hash } = payload
-        console.log({ md5Hash, fn: `${model}:${md5Hash}`, payloadHandlers, model: _.camelCase(model), payload })
-        const handler = payloadHandlers[`${_.camelCase(model)}:${md5Hash}`]
-        if (handler) {
-          handler({ ...payload, model: _.camelCase(model) })
-        }
-      }
-
-      const subscription = (consumer.subscriptions.create({
-        channel: 'Jason::Channel'
-      }, {
-        connected: () => {
-          setConnected(true)
-        },
-        received: payload => {
-          console.log("Payload received", payload)
-          handlePayload(payload)
-        },
-        disconnected: () => console.warn('Disconnected from ActionCable')
-      }));
-
-      console.log('sending message')
-      subscription.send({ message: 'test' })
-
-      function createSubscription(config) {
-        const md5Hash = md5(JSON.stringify(config))
-        console.log('Subscribe with', config, md5Hash)
-
-        _.map(config, (v, model) => {
-          payloadHandlers[`${model}:${md5Hash}`] = createPayloadHandler(store.dispatch, serverActionQueue, subscription, model, schema[model])
-        })
-        subscription.send({ createSubscription: config })
-
-        return () => removeSubscription(config)
-      }
-
-      function removeSubscription(config) {
-        subscription.send({ removeSubscription: config })
-        const md5Hash = md5(JSON.stringify(config))
-        _.map(config, (v, model) => {
-          delete payloadHandlers[`${model}:${md5Hash}`]
-        })
-      }
-      const optDis = createOptDis(schema, store.dispatch, restClient, serverActionQueue)
-      const actions = createActions(schema, store, restClient, optDis, extraActions)
-      const eager = makeEager(schema)
-
-      console.log({ actions })
-
-      setValue({
-        actions: actions,
-        subscribe: (config) => createSubscription(config),
-        eager
-      })
-      setStore(store)
-    })
-  }, [])
+  const [store, value, connected] = useJason({ reducers, middleware, extraActions })
 
-  if(!(store && value && connected)) return <div /> // Wait for async fetch of schema to complete
+  if(!(store && value)) return <div /> // Wait for async fetch of schema to complete
 
   return <Provider store={store}>
     <JasonContext.Provider value={value}>{ children }</JasonContext.Provider>