jason-rails 0.5.1 → 0.6.4

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)] });
@@ -40,49 +39,29 @@ function useJason({ reducers, middleware = [], extraActions }) {
             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.keys(configs).forEach(md5Hash => createSubscription(configs[md5Hash], subOptions[md5Hash]));
-                },
-                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');
-                }
-            }));
+            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;
                 subOptions[md5Hash] = options;
-                setTimeout(() => subscription.send({ createSubscription: hashableConfig }), 500);
+                setTimeout(() => transportAdapter.createSubscription(hashableConfig), 500);
                 let pollInterval = null;
-                console.log("createSubscription", { config, options });
                 // This is only for debugging / dev - not prod!
                 // @ts-ignore
                 if (options.pollInterval) {
                     // @ts-ignore
-                    pollInterval = setInterval(() => subscription.send({ getPayload: config, forceRefresh: true }), options.pollInterval);
+                    pollInterval = setInterval(() => transportAdapter.getPayload(hashableConfig, { forceRefresh: true }), options.pollInterval);
                 }
                 return {
                     remove() {
@@ -94,8 +73,9 @@ function useJason({ reducers, middleware = [], extraActions }) {
                 };
             }
             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];
@@ -109,6 +89,6 @@ function useJason({ reducers, middleware = [], extraActions }) {
             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: {
@@ -75,5 +81,37 @@ test('pruning IDs', () => __awaiter(void 0, void 0, void 0, function* () {
         idx: 2
     });
     // The ID 4 should have been pruned
-    expect(store.getState().posts.ids).toStrictEqual([5]);
+    expect(store.getState().posts.ids).toStrictEqual(['5']);
+}));
+test('pruning IDs by destroy', () => __awaiter(void 0, void 0, void 0, function* () {
+    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: {
+            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' }, { id: 5, name: 'test it out' }],
+        md5Hash: subscription.md5Hash,
+        idx: 1
+    });
+    expect(store.getState().posts.ids).toStrictEqual(['4', '5']);
+    handlePayload({
+        destroy: true,
+        model: 'post',
+        id: 5,
+        md5Hash: subscription.md5Hash,
+        idx: 2
+    });
+    // The ID 4 should have been pruned
+    expect(store.getState().posts.ids).toStrictEqual(['4']);
 }));

data/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jamesr2323/jason",
-  "version": "0.5.0",
+  "version": "0.6.4",
   "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,17 +42,23 @@ function generateJasonSlices(models) {
       setSubscriptionIds(s,a) {
         const { payload } = a
         const { subscriptionId, model, ids } = payload
-        s[model][subscriptionId] = ids
+        s[model][subscriptionId] = ids.map(id => String(id))
       },
       addSubscriptionId(s,a) {
         const { payload } = a
         const { subscriptionId, model, id } = payload
-        s[model][subscriptionId] = _.union(s[model][subscriptionId] || [], [id])
+        s[model][subscriptionId] = _.union(s[model][subscriptionId] || [], [String(id)])
       },
       removeSubscriptionId(s,a) {
         const { payload } = a
         const { subscriptionId, model, id } = payload
-        s[model][subscriptionId] = _.remove(s[model][subscriptionId] || [], id)
+        s[model][subscriptionId] = _.difference(s[model][subscriptionId] || [], [String(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) {
@@ -42,14 +42,14 @@ export default function createPayloadHandler({ dispatch, serverActionQueue, subs
       const { payload, destroy, id, type } = patchQueue[model][idx[model]]
 
       if (type === 'payload') {
-        dispatch({ type: `${pluralize(model)}/upsertMany`, payload })
+        dispatch({ type: `${pluralize(model)}/upsertMany`, payload: payload.map(m => ({ ...m, id: String(m.id) })) })
         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 })
+        dispatch({ type: `${pluralize(model)}/upsert`, payload: { ...payload, id: String(payload.id) } })
         dispatch({ type: `jasonModels/addSubscriptionId`, payload: { model, subscriptionId, id }})
       }
 
@@ -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 }
 }

data/client/src/createTransportAdapter.ts

@@ -0,0 +1,13 @@
+import actionCableAdapter from './transportAdapters/actionCableAdapter'
+import pusherAdapter from './transportAdapters/pusherAdapter'
+
+export default function createTransportAdapter(jasonConfig, handlePayload, dispatch, onConnect) {
+  const { transportService } = jasonConfig
+  if (transportService === 'action_cable') {
+    return actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnect)
+  } else if (transportService === 'pusher') {
+    return pusherAdapter(jasonConfig, handlePayload, dispatch)
+  } else {
+    throw(`Transport adapter does not exist for ${transportService}`)
+  }
+}

data/client/src/index.ts

@@ -1,7 +1,9 @@
 import _JasonProvider from './JasonProvider'
 import _useAct from './useAct'
 import _useSub from './useSub'
+import _useEager from './useEager'
 
 export const JasonProvider = _JasonProvider
 export const useAct = _useAct
-export const useSub = _useSub
+export const useSub = _useSub
+export const useEager = _useEager

data/client/src/makeEager.ts

@@ -36,9 +36,9 @@ export default function (schema) {
 
   function useEager(entity, id = null, relations = []) {
     if (id) {
-      return useSelector(s => addRelations(s, { ...s[entity].entities[String(id)] }, entity, relations))
+      return useSelector(s => addRelations(s, { ...s[entity].entities[String(id)] }, entity, relations), _.isEqual)
     } else {
-      return useSelector(s => addRelations(s, _.values(s[entity].entities), entity, relations))
+      return useSelector(s => addRelations(s, _.values(s[entity].entities), entity, relations), _.isEqual)
     }
   }
 

data/client/src/pruneIdsMiddleware.ts

@@ -2,20 +2,21 @@ import _ from 'lodash'
 import pluralize from '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
-    _.map(_.keys(schema), model => {
-      let ids = []
-      _.map(state.jasonModels[model], (subscribedIds, k) => {
-        ids = _.union(ids, subscribedIds)
-      })
-      // Find IDs currently in Redux that aren't in any subscription
-      const idsToRemove = _.difference(state[pluralize(model)].ids, ids)
-      store.dispatch({ type: `${pluralize(model)}/removeMany`, payload: idsToRemove })
+  if (type === 'jasonModels/setSubscriptionIds' || type === 'jasonModels/removeSubscriptionId') {
+    const { model, ids } = payload
+
+    let idsInSubs = []
+    _.map(state.jasonModels[model], (subscribedIds, k) => {
+      idsInSubs = _.union(idsInSubs, subscribedIds)
     })
+
+    // Find IDs currently in Redux that aren't in any subscription
+    const idsToRemove = _.difference(state[pluralize(model)].ids, idsInSubs)
+    store.dispatch({ type: `${pluralize(model)}/removeMany`, payload: idsToRemove })
   }
 
   return result

data/client/src/restClient.ts

@@ -4,6 +4,7 @@ import { validate as isUuid } from 'uuid'
 
 const csrfToken = (document?.querySelector("meta[name=csrf-token]") as any)?.content
 axios.defaults.headers.common['X-CSRF-Token'] = csrfToken
+
 const restClient = applyCaseMiddleware(axios.create() as any, {
   preservedKeys: (key) => {
     return isUuid(key)