jason-rails 0.5.0 → 0.6.3

data/client/lib/index.js

@@ -3,10 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useSub = exports.useAct = exports.JasonProvider = void 0;
+exports.useEager = exports.useSub = exports.useAct = exports.JasonProvider = void 0;
 const JasonProvider_1 = __importDefault(require("./JasonProvider"));
 const useAct_1 = __importDefault(require("./useAct"));
 const useSub_1 = __importDefault(require("./useSub"));
+const useEager_1 = __importDefault(require("./useEager"));
 exports.JasonProvider = JasonProvider_1.default;
 exports.useAct = useAct_1.default;
 exports.useSub = useSub_1.default;
+exports.useEager = useEager_1.default;

data/client/lib/makeEager.js

@@ -40,10 +40,10 @@ function default_1(schema) {
     }
     function useEager(entity, id = null, relations = []) {
         if (id) {
-            return react_redux_1.useSelector(s => addRelations(s, Object.assign({}, s[entity].entities[String(id)]), entity, relations));
+            return react_redux_1.useSelector(s => addRelations(s, Object.assign({}, s[entity].entities[String(id)]), entity, relations), lodash_1.default.isEqual);
         }
         else {
-            return react_redux_1.useSelector(s => addRelations(s, lodash_1.default.values(s[entity].entities), entity, relations));
+            return react_redux_1.useSelector(s => addRelations(s, lodash_1.default.values(s[entity].entities), entity, relations), lodash_1.default.isEqual);
         }
     }
     return useEager;

data/client/lib/pruneIdsMiddleware.js

@@ -6,20 +6,18 @@ 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 { type, payload } = 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 });
+    if (type === 'jasonModels/setSubscriptionIds' || type === 'jasonModels/removeSubscriptionIds') {
+        const { model, ids } = payload;
+        let idsInSubs = [];
+        lodash_1.default.map(state.jasonModels[model], (subscribedIds, k) => {
+            idsInSubs = lodash_1.default.union(idsInSubs, subscribedIds);
         });
+        // Find IDs currently in Redux that aren't in any subscription
+        const idsToRemove = lodash_1.default.difference(state[pluralize_1.default(model)].ids, idsInSubs);
+        store.dispatch({ type: `${pluralize_1.default(model)}/removeMany`, payload: idsToRemove });
     }
     return result;
 };

data/client/lib/restClient.d.ts

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

data/client/lib/transportAdapters/actionCableAdapter.d.ts

@@ -0,0 +1,5 @@
+export default function actionCableAdapter(jasonConfig: any, handlePayload: any, dispatch: any, onConnected: any): {
+    getPayload: (config: any, options: any) => void;
+    createSubscription: (config: any) => void;
+    removeSubscription: (config: any) => void;
+};

data/client/lib/transportAdapters/actionCableAdapter.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const actioncable_1 = require("@rails/actioncable");
+function actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnected) {
+    const consumer = actioncable_1.createConsumer();
+    const subscription = (consumer.subscriptions.create({
+        channel: 'Jason::Channel'
+    }, {
+        connected: () => {
+            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
+            onConnected();
+        },
+        received: payload => {
+            handlePayload(payload);
+            console.debug("ActionCable Payload received: ", payload);
+        },
+        disconnected: () => {
+            dispatch({ type: 'jason/upsert', payload: { connected: false } });
+            console.warn('Disconnected from ActionCable');
+        }
+    }));
+    function getPayload(config, options) {
+        subscription.send(Object.assign({ getPayload: config }, options));
+    }
+    function createSubscription(config) {
+        subscription.send({ createSubscription: config });
+    }
+    function removeSubscription(config) {
+        subscription.send({ removeSubscription: config });
+    }
+    return { getPayload, createSubscription, removeSubscription };
+}
+exports.default = actionCableAdapter;

data/client/lib/transportAdapters/pusherAdapter.d.ts

@@ -0,0 +1,5 @@
+export default function pusherAdapter(jasonConfig: any, handlePayload: any, dispatch: any): {
+    getPayload: (config: any, options: any) => void;
+    createSubscription: (config: any) => void;
+    removeSubscription: (config: any) => void;
+};

data/client/lib/transportAdapters/pusherAdapter.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const pusher_js_1 = __importDefault(require("pusher-js"));
+const restClient_1 = __importDefault(require("../restClient"));
+const uuid_1 = require("uuid");
+const lodash_1 = __importDefault(require("lodash"));
+function pusherAdapter(jasonConfig, handlePayload, dispatch) {
+    let consumerId = uuid_1.v4();
+    const { pusherKey, pusherRegion, pusherChannelPrefix } = jasonConfig;
+    const pusher = new pusher_js_1.default(pusherKey, {
+        cluster: 'eu',
+        forceTLS: true,
+        authEndpoint: '/jason/api/pusher/auth'
+    });
+    pusher.connection.bind('state_change', ({ current }) => {
+        if (current === 'connected') {
+            dispatch({ type: 'jason/upsert', payload: { connected: true } });
+        }
+        else {
+            dispatch({ type: 'jason/upsert', payload: { connected: false } });
+        }
+    });
+    pusher.connection.bind('error', error => {
+        dispatch({ type: 'jason/upsert', payload: { connected: false } });
+    });
+    const configToChannel = {};
+    function createSubscription(config) {
+        restClient_1.default.post('/jason/api/create_subscription', { config, consumerId })
+            .then(({ data: { channelName } }) => {
+            configToChannel[JSON.stringify(config)] = channelName;
+            subscribeToChannel(channelName);
+        })
+            .catch(e => console.error(e));
+    }
+    function removeSubscription(config) {
+        const channelName = configToChannel[JSON.stringify(config)];
+        unsubscribeFromChannel(fullChannelName(channelName));
+        restClient_1.default.post('/jason/api/remove_subscription', { config, consumerId })
+            .catch(e => console.error(e));
+    }
+    function getPayload(config, options) {
+        restClient_1.default.post('/jason/api/get_payload', {
+            config,
+            options
+        })
+            .then(({ data }) => {
+            lodash_1.default.map(data, (payload, modelName) => {
+                handlePayload(payload);
+            });
+        })
+            .catch(e => console.error(e));
+    }
+    function subscribeToChannel(channelName) {
+        const channel = pusher.subscribe(fullChannelName(channelName));
+        channel.bind('changed', message => handlePayload(message));
+    }
+    function unsubscribeFromChannel(channelName) {
+        const channel = pusher.unsubscribe(fullChannelName(channelName));
+    }
+    function fullChannelName(channelName) {
+        return `private-${pusherChannelPrefix}-${channelName}`;
+    }
+    return { getPayload, createSubscription, removeSubscription };
+}
+exports.default = pusherAdapter;

data/client/lib/useEager.d.ts

@@ -0,0 +1 @@
+export default function useEager(entity: any, id?: null, relations?: never[]): void;

data/client/lib/useEager.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const JasonContext_1 = __importDefault(require("./JasonContext"));
+const react_1 = require("react");
+function useEager(entity, id = null, relations = []) {
+    const { eager } = react_1.useContext(JasonContext_1.default);
+    return eager(entity, id, relations);
+}
+exports.default = useEager;

data/client/lib/useJason.js

@@ -10,7 +10,7 @@ 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 createTransportAdapter_1 = __importDefault(require("./createTransportAdapter"));
 const toolkit_1 = require("@reduxjs/toolkit");
 const makeEager_1 = __importDefault(require("./makeEager"));
 const humps_1 = require("humps");
@@ -20,14 +20,13 @@ 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 }) => {
+        restClient_1.default.get('/jason/api/config')
+            .then(({ data: jasonConfig }) => {
+            const { schema: snakey_schema } = jasonConfig;
             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)] });
@@ -37,63 +36,59 @@ function useJason({ reducers, middleware = [], extraActions }) {
             const eager = makeEager_1.default(schema);
             let payloadHandlers = {};
             let configs = {};
+            let subOptions = {};
             function handlePayload(payload) {
                 const { md5Hash } = payload;
-                const handler = payloadHandlers[md5Hash];
-                if (handler) {
-                    handler(payload);
+                const { handlePayload } = payloadHandlers[md5Hash];
+                if (handlePayload) {
+                    handlePayload(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) {
+            const transportAdapter = createTransportAdapter_1.default(jasonConfig, handlePayload, dispatch, () => lodash_1.default.keys(configs).forEach(md5Hash => createSubscription(configs[md5Hash], subOptions[md5Hash])));
+            function createSubscription(config, options = {}) {
                 // 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 });
+                payloadHandlers[md5Hash] = createPayloadHandler_1.default({ dispatch, serverActionQueue, transportAdapter, config });
                 configs[md5Hash] = hashableConfig;
-                setTimeout(() => subscription.send({ createSubscription: hashableConfig }), 500);
+                subOptions[md5Hash] = options;
+                setTimeout(() => transportAdapter.createSubscription(hashableConfig), 500);
+                let pollInterval = null;
+                // This is only for debugging / dev - not prod!
+                // @ts-ignore
+                if (options.pollInterval) {
+                    // @ts-ignore
+                    pollInterval = setInterval(() => transportAdapter.getPayload(hashableConfig, { forceRefresh: true }), options.pollInterval);
+                }
                 return {
-                    remove: () => removeSubscription(hashableConfig),
+                    remove() {
+                        removeSubscription(hashableConfig);
+                        if (pollInterval)
+                            clearInterval(pollInterval);
+                    },
                     md5Hash
                 };
             }
             function removeSubscription(config) {
-                subscription.send({ removeSubscription: config });
+                transportAdapter.removeSubscription(config);
                 const md5Hash = blueimp_md5_1.default(JSON.stringify(config));
+                payloadHandlers[md5Hash].tearDown();
                 delete payloadHandlers[md5Hash];
                 delete configs[md5Hash];
+                delete subOptions[md5Hash];
             }
             setValue({
                 actions: actions,
-                subscribe: config => createSubscription(config),
+                subscribe: createSubscription,
                 eager,
                 handlePayload
             });
             setStore(store);
         });
     }, []);
-    return [store, value, connected];
+    return [store, value];
 }
 exports.default = useJason;

data/client/lib/useJason.test.js

@@ -17,7 +17,10 @@ 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: {} } };
+    const resp = { data: {
+            schema: { post: {} },
+            transportService: 'action_cable'
+        } };
     // @ts-ignore
     restClient_1.default.get.mockResolvedValue(resp);
     const { result, waitForNextUpdate } = react_hooks_1.renderHook(() => useJason_1.default({ reducers: {
@@ -50,7 +53,10 @@ test('it works', () => __awaiter(void 0, void 0, void 0, function* () {
     });
 }));
 test('pruning IDs', () => __awaiter(void 0, void 0, void 0, function* () {
-    const resp = { data: { post: {} } };
+    const resp = { data: {
+            schema: { post: {} },
+            transportService: 'action_cable'
+        } };
     // @ts-ignore
     restClient_1.default.get.mockResolvedValue(resp);
     const { result, waitForNextUpdate } = react_hooks_1.renderHook(() => useJason_1.default({ reducers: {

data/client/lib/useSub.d.ts

@@ -1 +1 @@
-export default function useSub(config: any): void;
+export default function useSub(config: any, options?: {}): void;

data/client/lib/useSub.js

@@ -5,11 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const JasonContext_1 = __importDefault(require("./JasonContext"));
 const react_1 = require("react");
-function useSub(config) {
+function useSub(config, options = {}) {
+    // useEffect uses strict equality
+    const configJson = JSON.stringify(config);
     const subscribe = react_1.useContext(JasonContext_1.default).subscribe;
     react_1.useEffect(() => {
         // @ts-ignore
-        return subscribe(config);
-    }, []);
+        return subscribe(config, options).remove;
+    }, [configJson]);
 }
 exports.default = useSub;

data/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jamesr2323/jason",
-  "version": "0.5.0",
+  "version": "0.6.2",
   "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
@@ -16,6 +16,7 @@
     "jsonpatch": "^3.0.1",
     "lodash": "^4.17.20",
     "pluralize": "^8.0.0",
+    "pusher-js": "^7.0.3",
     "uuid": "^8.3.1"
   },
   "devDependencies": {

data/client/src/JasonContext.ts

@@ -1,5 +1,8 @@
 import { createContext } from 'react'
+const eager = function(entity, id, relations) {
+  console.error("Eager called but is not implemented")
+}
 
-const context = createContext({ actions: {} as any, subscribe: null, eager: null })
+const context = createContext({ actions: {} as any, subscribe: null, eager })
 
 export default context

data/client/src/JasonProvider.tsx

@@ -4,7 +4,7 @@ import { Provider } from 'react-redux'
 import JasonContext from './JasonContext'
 
 const JasonProvider = ({ reducers, middleware, extraActions, children }: { reducers?: any, middleware?: any, extraActions?: any, children?: React.FC }) => {
-  const [store, value, connected] = useJason({ reducers, middleware, extraActions })
+  const [store, value] = useJason({ reducers, middleware, extraActions })
 
   if(!(store && value)) return <div /> // Wait for async fetch of schema to complete
 

data/client/src/createJasonReducers.ts

@@ -42,6 +42,7 @@ function generateJasonSlices(models) {
       setSubscriptionIds(s,a) {
         const { payload } = a
         const { subscriptionId, model, ids } = payload
+        console.log({ initialState })
         s[model][subscriptionId] = ids
       },
       addSubscriptionId(s,a) {
@@ -53,6 +54,12 @@ function generateJasonSlices(models) {
         const { payload } = a
         const { subscriptionId, model, id } = payload
         s[model][subscriptionId] = _.remove(s[model][subscriptionId] || [], id)
+      },
+      removeSubscription(s, a) {
+        const { payload: { subscriptionId } } = a
+        _.map(models, model => {
+          delete s[model][subscriptionId]
+        })
       }
     }
   }).reducer

data/client/src/createPayloadHandler.ts

@@ -9,7 +9,7 @@ function diffSeconds(dt2, dt1) {
   return Math.abs(Math.round(diff))
 }
 
-export default function createPayloadHandler({ dispatch, serverActionQueue, subscription, config }) {
+export default function createPayloadHandler({ dispatch, serverActionQueue, transportAdapter, config }) {
   const subscriptionId = uuidv4()
 
   let idx = {}
@@ -20,7 +20,7 @@ export default function createPayloadHandler({ dispatch, serverActionQueue, subs
   let checkInterval
 
   function getPayload() {
-    setTimeout(() => subscription.send({ getPayload: config }), 1000)
+    setTimeout(() => transportAdapter.getPayload(config), 1000)
   }
 
   function camelizeKeys(item) {
@@ -46,7 +46,7 @@ export default function createPayloadHandler({ dispatch, serverActionQueue, subs
         const ids = payload.map(instance => instance.id)
         dispatch({ type: `jasonModels/setSubscriptionIds`, payload: { model, subscriptionId, ids }})
       } else if (destroy) {
-        dispatch({ type: `${pluralize(model)}/remove`, payload: id })
+        // Middleware will determine if this model should be removed if it isn't in any other subscriptions
         dispatch({ type: `jasonModels/removeSubscriptionId`, payload: { model, subscriptionId, id }})
       } else {
         dispatch({ type: `${pluralize(model)}/upsert`, payload })
@@ -97,5 +97,10 @@ export default function createPayloadHandler({ dispatch, serverActionQueue, subs
 
   tGetPayload()
 
-  return handlePayload
+  // Clean up after ourselves
+  function tearDown() {
+    dispatch({ type: `jasonModels/removeSubscription`, payload: { subscriptionId }})
+  }
+
+  return { handlePayload, tearDown }
 }