jason-rails 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25daf144fbb017120604c8a458e6eaeeffc705752ae046f9df03aa7b9e0e1f77
-  data.tar.gz: 741129a4872a9d384018f88049ded591989bbfa23f87c6915be317008c278051
+  metadata.gz: 453e1a0d649445d973de2e3adf27f88f91c5bf983e65b3c2d993f090816db72b
+  data.tar.gz: ec2600988c60bcb6f661b8835cd3bcb7d3a4b740749ab0f21109e9b6a513b4ca
 SHA512:
-  metadata.gz: f09a2f2f7003f4a259dcdbea1edc702f7e21a5797ed8e8bb73684997a8eccc227349d87b3db27d53a9815407408e9051fa7749002b4ab476000b4cded468dda2
-  data.tar.gz: 28a93aa98358bc098921442af5c583eff00b610b2be196365a47233468706dc5e42e4a96ec18aa87bfa339cd12d25c39942708b62ef05a821aa6b9a59898dd4d
+  metadata.gz: cc2ba8529669a1fe4c48d2ee2ba595a7e3ae907a0d10234f12d68d797de63177143187c5c3767cf32ab35bd053c3c9f3bfa14461f8b6be71d8df437e3e997c7d
+  data.tar.gz: c93e0002f3a7e2379ed29483b6a8323b4b492a319ccc4f9948f0638c47e62a9eeb8b416fad2bbe2cc6b5c13f11a103eab462b7a35f5a36145037981e49c99cc6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jason-rails (0.4.1)
+    jason-rails (0.5.1)
       connection_pool (>= 2.2.3)
       jsondiff
       rails (>= 5)

data/README.md

@@ -54,7 +54,7 @@ end
 
 First you need to wrap your root component in a `JasonProvider`.
 
-```
+```jsx
 import { JasonProvider } from '@jamesr2323/jason'
 
 return <JasonProvider>
@@ -67,7 +67,8 @@ This is a wrapper around `react-redux` Provider component. This accepts the foll
 - `reducers` - An object of reducers that will be included in `configureStore`. Make sure these do not conflict with the names of any of the models you are configuring for use with Jason
 - `extraActions` - Extra actions you want to be available via the `useAct` hook. (See below)
 This must be a function which returns an object which will be merged with the main Jason actions. The function will be passed a dispatch function, store, axios instance and the Jason actions. For example you can add actions for one of your custom slices:
-```
+
+```js
 function extraActions(dispatch, store, restClient, act) {
   return {
     local: {
@@ -109,7 +110,7 @@ export default function PostCreator() {
 This subscribes your Redux store to a model or set of models. It will automatically unsubscribe when the component unmounts.
 
 Example
-```
+```jsx
 import React from 'react'
 import { useSelector } from 'react-redux'
 import { useSub } from '@jamesr2323/jason'
@@ -125,14 +126,22 @@ export default function PostsList() {
 }
 ```
 
+## Authorization
+
+By default all models can be subscribed to and updated without authentication or authorization. Probably you want to lock down access.
+
+### Authorizing subscriptions
+You can do this by providing an class to Jason in the initializer under the `subscription_authorization_service` key. This must be a class receiving a message `call` with the parameters `user`, `model`, `conditions`, `sub_models` and return true or false for whether the user is allowed to access a subscription with those parameters. You can decide the implementation details of this to be as simple or complex as your app requires.
+
+### Authorizing updates
+Similarly to authorizing subscriptions, you can do this by providing an class to Jason in the initializer under the `update_authorization_service` key. This must be a class receiving a message `call` with the parameters `user`, `model`, `instance`, `update`, `remove` and return true or false for whether the user is allowed to access a subscription with those parameters.
 
 ## Roadmap
 
 Development is primarily driven by the needs of projects we're using Jason in. In no particular order, being considered is:
 - Failure handling - rolling back local state in case of an error on the server
-- Authorization - integrating with a library like Pundit to determine who can subscribe to given state updates and perform updates on models
+- Authorization - more thorough authorization integration, with utility functions for common authorizations. Allowing authorization of access to particular fields such as restricting the fields of a user that are publicly broadcast.
 - Utilities for "Draft editing" - both storing client-side copies of model trees which can be committed or discarded, as well as persisting a shadow copy to the database (to allow resumable editing, or possibly collaborative editing features)
-- Integration with pub/sub-as-a-service tools, such as Pusher
 
 ## Development
 

data/app/controllers/jason/api/pusher_controller.rb

@@ -0,0 +1,15 @@
+ class Jason::Api::PusherController < ApplicationController
+  skip_before_action :verify_authenticity_token
+
+  def auth
+    channel_main_name = params[:channel_name].remove("private-#{Jason.pusher_channel_prefix}-")
+    subscription_id = channel_main_name.remove('jason-')
+
+    if Jason::Subscription.find_by_id(subscription_id).user_can_access?(current_user)
+      response = Pusher.authenticate(params[:channel_name], params[:socket_id])
+      return render json: response
+    else
+      return head :forbidden
+    end
+  end
+end

data/app/controllers/jason/api_controller.rb

@@ -1,6 +1,21 @@
 class Jason::ApiController < ::ApplicationController
-  def schema
-    render json: Jason.schema
+  before_action :load_and_authorize_subscription, only: [:create_subscription, :remove_subscription, :get_payload]
+  # config seems to be a reserved name, resulting in infinite loop
+  def configuration
+    payload = {
+      schema: Jason.schema,
+      transportService: Jason.transport_service,
+    }
+
+    if Jason.transport_service == :pusher
+      payload.merge!({
+        pusherKey: Jason.pusher_key,
+        pusherRegion: Jason.pusher_region,
+        pusherChannelPrefix: Jason.pusher_channel_prefix
+      })
+    end
+
+    render json: payload
   end
 
   def action
@@ -33,4 +48,31 @@ class Jason::ApiController < ::ApplicationController
 
     return head :ok
   end
+
+  def create_subscription
+    @subscription.add_consumer(params[:consumer_id])
+    render json: { channelName: @subscription.channel }
+  end
+
+  def remove_subscription
+    @subscription.remove_consumer(params[:consumer_id])
+  end
+
+  def get_payload
+    if params[:options].try(:[], :force_refresh)
+      @subscription.set_ids_for_sub_models
+    end
+
+    render json: @subscription.get
+  end
+
+  private
+
+  def load_and_authorize_subscription
+    config = params[:config].to_unsafe_h
+    @subscription = Jason::Subscription.upsert_by_config(config['model'], conditions: config['conditions'], includes: config['includes'])
+    if !@subscription.user_can_access?(current_user)
+      return head :forbidden
+    end
+  end
 end

data/client/lib/JasonProvider.js

@@ -8,7 +8,7 @@ const useJason_1 = __importDefault(require("./useJason"));
 const react_redux_1 = require("react-redux");
 const JasonContext_1 = __importDefault(require("./JasonContext"));
 const JasonProvider = ({ reducers, middleware, extraActions, children }) => {
-    const [store, value, connected] = useJason_1.default({ reducers, middleware, extraActions });
+    const [store, value] = useJason_1.default({ reducers, middleware, extraActions });
     if (!(store && value))
         return react_1.default.createElement("div", null); // Wait for async fetch of schema to complete
     return react_1.default.createElement(react_redux_1.Provider, { store: store },

data/client/lib/createJasonReducers.js

@@ -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] = lodash_1.default.remove(s[model][subscriptionId] || [], id);
+            },
+            removeSubscription(s, a) {
+                const { payload: { subscriptionId } } = a;
+                lodash_1.default.map(models, model => {
+                    delete s[model][subscriptionId];
+                });
             }
         }
     }).reducer;

data/client/lib/createPayloadHandler.d.ts

@@ -1,6 +1,9 @@
-export default function createPayloadHandler({ dispatch, serverActionQueue, subscription, config }: {
+export default function createPayloadHandler({ dispatch, serverActionQueue, transportAdapter, config }: {
     dispatch: any;
     serverActionQueue: any;
-    subscription: any;
+    transportAdapter: any;
     config: any;
-}): (data: any) => void;
+}): {
+    handlePayload: (data: any) => void;
+    tearDown: () => void;
+};

data/client/lib/createPayloadHandler.js

@@ -11,7 +11,7 @@ function diffSeconds(dt2, dt1) {
     var diff = (dt2.getTime() - dt1.getTime()) / 1000;
     return Math.abs(Math.round(diff));
 }
-function createPayloadHandler({ dispatch, serverActionQueue, subscription, config }) {
+function createPayloadHandler({ dispatch, serverActionQueue, transportAdapter, config }) {
     const subscriptionId = uuid_1.v4();
     let idx = {};
     let patchQueue = {};
@@ -19,7 +19,7 @@ function createPayloadHandler({ dispatch, serverActionQueue, subscription, confi
     let updateDeadline = null;
     let checkInterval;
     function getPayload() {
-        setTimeout(() => subscription.send({ getPayload: config }), 1000);
+        setTimeout(() => transportAdapter.getPayload(config), 1000);
     }
     function camelizeKeys(item) {
         return deepCamelizeKeys_1.default(item, key => uuid_1.validate(key));
@@ -41,7 +41,7 @@ function createPayloadHandler({ dispatch, serverActionQueue, subscription, confi
                 dispatch({ type: `jasonModels/setSubscriptionIds`, payload: { model, subscriptionId, ids } });
             }
             else if (destroy) {
-                dispatch({ type: `${pluralize_1.default(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 {
@@ -87,6 +87,10 @@ function createPayloadHandler({ dispatch, serverActionQueue, subscription, confi
         }
     }
     tGetPayload();
-    return handlePayload;
+    // Clean up after ourselves
+    function tearDown() {
+        dispatch({ type: `jasonModels/removeSubscription`, payload: { subscriptionId } });
+    }
+    return { handlePayload, tearDown };
 }
 exports.default = createPayloadHandler;

data/client/lib/createTransportAdapter.d.ts

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

data/client/lib/createTransportAdapter.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const actionCableAdapter_1 = __importDefault(require("./transportAdapters/actionCableAdapter"));
+const pusherAdapter_1 = __importDefault(require("./transportAdapters/pusherAdapter"));
+function createTransportAdapter(jasonConfig, handlePayload, dispatch, onConnect) {
+    const { transportService } = jasonConfig;
+    if (transportService === 'action_cable') {
+        return actionCableAdapter_1.default(jasonConfig, handlePayload, dispatch, onConnect);
+    }
+    else if (transportService === 'pusher') {
+        return pusherAdapter_1.default(jasonConfig, handlePayload, dispatch);
+    }
+    else {
+        throw (`Transport adapter does not exist for ${transportService}`);
+    }
+}
+exports.default = createTransportAdapter;

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/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/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;