jason-rails 0.5.1 → 0.6.0

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jamesr2323/jason",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "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/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 }
 }

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/pruneIdsMiddleware.ts

@@ -2,20 +2,20 @@ 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/removeSubscriptionIds') {
+    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)

data/client/src/transportAdapters/actionCableAdapter.ts

@@ -0,0 +1,38 @@
+import { createConsumer } from "@rails/actioncable"
+
+export default function actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnected) {
+  const consumer = 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({ getPayload: config, ...options })
+  }
+
+  function createSubscription(config) {
+    subscription.send({ createSubscription: config })
+  }
+
+  function removeSubscription(config) {
+    subscription.send({ removeSubscription: config })
+  }
+
+  return { getPayload, createSubscription, removeSubscription }
+}

data/client/src/transportAdapters/pusherAdapter.ts

@@ -0,0 +1,72 @@
+import Pusher from 'pusher-js'
+import { createConsumer } from "@rails/actioncable"
+import restClient from '../restClient'
+import { v4 as uuidv4 } from 'uuid'
+import _ from 'lodash'
+
+export default function pusherAdapter(jasonConfig, handlePayload, dispatch) {
+  let consumerId = uuidv4()
+
+  const { pusherKey, pusherRegion, pusherChannelPrefix } = jasonConfig
+  const pusher = new Pusher(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.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.post('/jason/api/remove_subscription', { config, consumerId })
+    .catch(e => console.error(e))
+  }
+
+  function getPayload(config, options) {
+    restClient.post('/jason/api/get_payload', {
+      config,
+      options
+    })
+    .then(({ data }) => {
+      _.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 }
+}

data/client/src/useJason.test.ts

@@ -5,7 +5,10 @@ import restClient from './restClient'
 jest.mock('./restClient')
 
 test('it works', async () => {
-  const resp = { data: { post: {} } };
+  const resp = { data: {
+    schema: { post: {} },
+    transportService: 'action_cable'
+  } };
   // @ts-ignore
   restClient.get.mockResolvedValue(resp);
 
@@ -45,7 +48,10 @@ test('it works', async () => {
 })
 
 test('pruning IDs', async () => {
-  const resp = { data: { post: {} } };
+  const resp = { data: {
+    schema: { post: {} },
+    transportService: 'action_cable'
+  } };
 
   // @ts-ignore
   restClient.get.mockResolvedValue(resp);

data/client/src/useJason.ts

@@ -5,8 +5,8 @@ import createOptDis from './createOptDis'
 import createServerActionQueue from './createServerActionQueue'
 import restClient from './restClient'
 import pruneIdsMiddleware from './pruneIdsMiddleware'
+import createTransportAdapater from './createTransportAdapter'
 
-import { createConsumer } from "@rails/actioncable"
 import { createEntityAdapter, createSlice, createReducer, configureStore } from '@reduxjs/toolkit'
 
 import makeEager from './makeEager'
@@ -18,17 +18,17 @@ import React, { useState, useEffect } from 'react'
 export default function useJason({ reducers, middleware = [], extraActions }: { reducers?: any, middleware?: any[], extraActions?: any }) {
   const [store, setStore] = useState(null as any)
   const [value, setValue] = useState(null as any)
-  const [connected, setConnected] = useState(false)
 
   useEffect(() => {
-    restClient.get('/jason/api/schema')
-    .then(({ data: snakey_schema }) => {
+    restClient.get('/jason/api/config')
+    .then(({ data: jasonConfig }) => {
+      const { schema: snakey_schema } = jasonConfig
       const schema = camelizeKeys(snakey_schema)
       console.debug({ schema })
 
       const serverActionQueue = createServerActionQueue()
 
-      const consumer = createConsumer()
+
       const allReducers = {
         ...reducers,
         ...createJasonReducers(schema)
@@ -50,54 +50,32 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
       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
-          _.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 = createTransportAdapater(jasonConfig, handlePayload, dispatch, () => _.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 = _({ conditions: {}, includes: {}, ...config }).toPairs().sortBy(0).fromPairs().value()
         const md5Hash = md5(JSON.stringify(hashableConfig))
-        payloadHandlers[md5Hash] = createPayloadHandler({ dispatch, serverActionQueue, subscription, config })
+        payloadHandlers[md5Hash] = createPayloadHandler({ dispatch, serverActionQueue, transportAdapter, config })
         configs[md5Hash] = hashableConfig
         subOptions[md5Hash] = options
 
-        setTimeout(() => subscription.send({ createSubscription: hashableConfig }), 500)
+        setTimeout(() => transportAdapter.createSubscription(hashableConfig), 500)
         let pollInterval = null as any;
 
-        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 {
@@ -110,8 +88,9 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
       }
 
       function removeSubscription(config) {
-        subscription.send({ removeSubscription: config })
+        transportAdapter.removeSubscription(config)
         const md5Hash = md5(JSON.stringify(config))
+        payloadHandlers[md5Hash].tearDown()
         delete payloadHandlers[md5Hash]
         delete configs[md5Hash]
         delete subOptions[md5Hash]
@@ -127,5 +106,5 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
     })
   }, [])
 
-  return [store, value, connected]
+  return [store, value]
 }

data/client/yarn.lock

@@ -3645,6 +3645,13 @@ punycode@^2.1.0, punycode@^2.1.1:
   resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec"
   integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==
 
+pusher-js@^7.0.3:
+  version "7.0.3"
+  resolved "https://registry.yarnpkg.com/pusher-js/-/pusher-js-7.0.3.tgz#f81c78cdf2ad32f546caa7532ec7f9081ef00b8d"
+  integrity sha512-HIfCvt00CAqgO4W0BrdpPsDcAwy51rB6DN0VMC+JeVRRbo8mn3XTeUeIFjmmlRLZLX8rPhUtLRo7vPag6b8GCw==
+  dependencies:
+    tweetnacl "^1.0.3"
+
 qs@~6.5.2:
   version "6.5.2"
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.2.tgz#cb3ae806e8740444584ef154ce8ee98d403f3e36"
@@ -4358,6 +4365,11 @@ tweetnacl@^0.14.3, tweetnacl@~0.14.0:
   resolved "https://registry.yarnpkg.com/tweetnacl/-/tweetnacl-0.14.5.tgz#5ae68177f192d4456269d108afa93ff8743f4f64"
   integrity sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=
 
+tweetnacl@^1.0.3:
+  version "1.0.3"
+  resolved "https://registry.yarnpkg.com/tweetnacl/-/tweetnacl-1.0.3.tgz#ac0af71680458d8a6378d0d0d050ab1407d35596"
+  integrity sha512-6rt+RN7aOi1nGMyC4Xa5DdYiukl2UWCbcJft7YhxReBGQD7OAM8Pbxw6YMo4r2diNEA8FEmu32YOn9rhaiE5yw==
+
 type-check@~0.3.2:
   version "0.3.2"
   resolved "https://registry.yarnpkg.com/type-check/-/type-check-0.3.2.tgz#5884cab512cf1d355e3fb784f30804b2b520db72"

data/config/routes.rb

@@ -1,4 +1,8 @@
 Jason::Engine.routes.draw do
-  get '/api/schema', to: 'api#schema'
+  get '/api/config', to: 'api#configuration'
   post '/api/action', to: 'api#action'
+  post '/api/create_subscription', to: 'api#create_subscription'
+  post '/api/remove_subscription', to: 'api#remove_subscription'
+  post '/api/get_payload', to: 'api#get_payload'
+  post '/api/pusher/auth', to: 'api/pusher#auth'
 end