jason-rails 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e6d1d960c2bb555ccaa555a17de7730ce90c35aa57594256bcb73bc96dade09
-  data.tar.gz: b096c733bd15195ac383097a8138507915caa5fba29d9099325755972a64fe2a
+  metadata.gz: 25daf144fbb017120604c8a458e6eaeeffc705752ae046f9df03aa7b9e0e1f77
+  data.tar.gz: 741129a4872a9d384018f88049ded591989bbfa23f87c6915be317008c278051
 SHA512:
-  metadata.gz: 4ce914a0e658fe97051ff6a64a48a29bccde202ad3fa60bc3aadc287f4a50a4f169d647b66f456e3147da8551b5b321185caa05c9790c964202d5275b20a8732
-  data.tar.gz: ebde6f3323cb516915e3ddea2f747595a864df2cac9f52e05c67b1320c46f20693c479d7b39b11f391638dc9e5027b92e86ad65089282c6c190b6ba4982b3de3
+  metadata.gz: f09a2f2f7003f4a259dcdbea1edc702f7e21a5797ed8e8bb73684997a8eccc227349d87b3db27d53a9815407408e9051fa7749002b4ab476000b4cded468dda2
+  data.tar.gz: 28a93aa98358bc098921442af5c583eff00b610b2be196365a47233468706dc5e42e4a96ec18aa87bfa339cd12d25c39942708b62ef05a821aa6b9a59898dd4d

data/.gitignore

@@ -11,4 +11,7 @@
 .rspec_status
 client/node_modules/
 
-client/yarn-error.log
+client/yarn-error.log
+*.log
+*.gem
+.DS_Store

data/README.md

@@ -1,10 +1,12 @@
 # Jason
 
+Jason is still in a highly experimental phase with a rapidly changing API. Production use not recommended - but please give it a try!
+
 ## The goal
 
 I wanted:
  - Automatic updates to client state based on database state
- - Automatic persistence to database
+ - Persistence to the database without many layers of passing parameters
  - Redux for awesome state management
  - Optimistic updates
 
@@ -24,22 +26,122 @@ gem 'jason-rails'
   yarn add @jamesr2323/jason
 ```
 
+You will also need have peer dependencies of `redux`, `react-redux` and `@reduxjs/toolkit`.
+
+### In Rails
+
+Include the module `Jason::Publisher` in all models you want to publish via Jason.
+
+Create a new initializer e.g. `jason.rb` which defines your schema
+
+```ruby
+Jason.setup do |config|
+  config.schema = {
+    post: {
+      subscribed_fields: [:id, :name]
+    },
+    comment: {
+      subscribed_fields: [:id]
+    },
+    user: {
+      subscribed_fields: [:id]
+    }
+  }
+end
+```
+
+### In your frontend code
+
+First you need to wrap your root component in a `JasonProvider`.
+
+```
+import { JasonProvider } from '@jamesr2323/jason'
+
+return <JasonProvider>
+  <YourApp />
+</JasonProvider>
+```
+
+This is a wrapper around `react-redux` Provider component. This accepts the following props (all optional):
+
+- `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:
+```
+function extraActions(dispatch, store, restClient, act) {
+  return {
+    local: {
+      upsert: payload => dis({ type: 'local/upsert', payload })
+    }
+  }
+}
+```
+
+- `middleware` - Passed directly to `configureStore` with additional Jason middleware
+
 ## Usage
+Jason provides two custom hooks to access functionality.
+
+### useAct
+This returns an object which allows you to access actions which both update models on the server, and perform an optimistic update to the Redux store.
 
-### Define your schema
+Example
+```jsx
+import React, { useState } from 'react'
+import { useAct } from '@jamesr2323/jason'
+
+export default function PostCreator() {
+  const act = useAct()
+  const [name, setName] = useState('')
+
+  function handleClick() {
+    act.posts.add({ name })
+  }
+
+  return <div>
+    <input value={name} onChange={e => setName(e.target.value)} />
+    <button onClick={handleClick}>Add</button>
+  </div>
+}
+```
 
+### useSub
+This subscribes your Redux store to a model or set of models. It will automatically unsubscribe when the component unmounts.
+
+Example
+```
+import React from 'react'
+import { useSelector } from 'react-redux'
+import { useSub } from '@jamesr2323/jason'
+import _ from 'lodash'
+
+export default function PostsList() {
+  useSub({ model: 'post', includes: ['comments'] })
+  const posts = useSelector(s => _.values(s.posts.entities))
+
+  return <div>
+    { posts.map(({ id, name }) => <div key={id}>{ name }</div>) }
+  </div>
+}
+```
+
+
+## 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
+- 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
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jason. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jason/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/useJason.js

@@ -37,6 +37,7 @@ 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];
@@ -55,7 +56,7 @@ function useJason({ reducers, middleware = [], extraActions }) {
                     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));
+                    lodash_1.default.keys(configs).forEach(md5Hash => createSubscription(configs[md5Hash], subOptions[md5Hash]));
                 },
                 received: payload => {
                     handlePayload(payload);
@@ -67,15 +68,28 @@ function useJason({ reducers, middleware = [], extraActions }) {
                     console.warn('Disconnected from ActionCable');
                 }
             }));
-            function createSubscription(config) {
+            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 });
                 configs[md5Hash] = hashableConfig;
+                subOptions[md5Hash] = options;
                 setTimeout(() => subscription.send({ 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);
+                }
                 return {
-                    remove: () => removeSubscription(hashableConfig),
+                    remove() {
+                        removeSubscription(hashableConfig);
+                        if (pollInterval)
+                            clearInterval(pollInterval);
+                    },
                     md5Hash
                 };
             }
@@ -84,10 +98,11 @@ function useJason({ reducers, middleware = [], extraActions }) {
                 const md5Hash = blueimp_md5_1.default(JSON.stringify(config));
                 delete payloadHandlers[md5Hash];
                 delete configs[md5Hash];
+                delete subOptions[md5Hash];
             }
             setValue({
                 actions: actions,
-                subscribe: config => createSubscription(config),
+                subscribe: createSubscription,
                 eager,
                 handlePayload
             });

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/src/restClient.ts

@@ -8,6 +8,6 @@ const restClient = applyCaseMiddleware(axios.create() as any, {
   preservedKeys: (key) => {
     return isUuid(key)
   }
-})
+}) as any
 
 export default restClient

data/client/src/useJason.ts

@@ -45,6 +45,7 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
 
       let payloadHandlers = {}
       let configs = {}
+      let subOptions = {}
 
       function handlePayload(payload) {
         const { md5Hash } = payload
@@ -66,7 +67,7 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
           console.debug('Connected to ActionCable')
 
           // When AC loses connection - all state is lost, so we need to re-initialize all subscriptions
-          _.values(configs).forEach(config => createSubscription(config))
+          _.keys(configs).forEach(md5Hash => createSubscription(configs[md5Hash], subOptions[md5Hash]))
         },
         received: payload => {
           handlePayload(payload)
@@ -79,17 +80,31 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
         }
       }));
 
-      function createSubscription(config) {
+      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 })
         configs[md5Hash] = hashableConfig
+        subOptions[md5Hash] = options
 
         setTimeout(() => subscription.send({ 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)
+        }
 
         return {
-          remove: () => removeSubscription(hashableConfig),
+          remove() {
+            removeSubscription(hashableConfig)
+            if (pollInterval) clearInterval(pollInterval)
+          },
           md5Hash
         }
       }
@@ -99,11 +114,12 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
         const md5Hash = md5(JSON.stringify(config))
         delete payloadHandlers[md5Hash]
         delete configs[md5Hash]
+        delete subOptions[md5Hash]
       }
 
       setValue({
         actions: actions,
-        subscribe: config => createSubscription(config),
+        subscribe: createSubscription,
         eager,
         handlePayload
       })

data/client/src/useSub.ts

@@ -1,11 +1,13 @@
 import JasonContext from './JasonContext'
 import { useContext, useEffect } from 'react'
 
-export default function useSub(config) {
+export default function useSub(config, options = {}) {
+  // useEffect uses strict equality
+  const configJson = JSON.stringify(config)
   const subscribe = useContext(JasonContext).subscribe
 
   useEffect(() => {
     // @ts-ignore
-    return subscribe(config)
-  }, [])
+    return subscribe(config, options).remove
+  }, [configJson])
 }

data/lib/jason/channel.rb

@@ -21,7 +21,7 @@ class Jason::Channel < ActionCable::Channel::Base
       elsif (config = message['removeSubscription'])
         remove_subscription(config)
       elsif (config = message['getPayload'])
-        get_payload(config)
+        get_payload(config, message['forceRefresh'])
       end
     rescue => e
       puts e.message
@@ -50,8 +50,11 @@ class Jason::Channel < ActionCable::Channel::Base
     # TODO Stop streams
   end
 
-  def get_payload(config)
+  def get_payload(config, force_refresh = false)
     subscription = Jason::Subscription.upsert_by_config(config['model'], conditions: config['conditions'], includes: config['includes'])
+    if force_refresh
+      subscription.set_ids(enforce: true)
+    end
     subscription.get.each do |payload|
       transmit(payload) if payload.present?
     end

data/lib/jason/publisher.rb

@@ -35,7 +35,7 @@ module Jason::Publisher
     # - TODO: The value of an instance changes so that it enters/leaves a subscription
 
     # TODO: Optimize this, by caching associations rather than checking each time instance is saved
-    jason_assocs = self.class.reflect_on_all_associations(:belongs_to).select { |assoc| assoc.klass.has_jason? }
+    jason_assocs = self.class.reflect_on_all_associations(:belongs_to).select { |assoc| assoc.klass.respond_to?(:has_jason?) }
     jason_assocs.each do |assoc|
       if self.previous_changes[assoc.foreign_key].present?
 

data/lib/jason/subscription.rb

@@ -149,16 +149,22 @@ class Jason::Subscription
     old_ids = $redis_jason.smembers("jason:subscriptions:#{id}:ids:#{model_name}")
 
     # Remove
-    $redis_jason.srem("jason:subscriptions:#{id}:ids:#{model_name}", (old_ids - ids))
+    ids_to_remove = old_ids - ids
+    if ids_to_remove.present?
+      $redis_jason.srem("jason:subscriptions:#{id}:ids:#{model_name}", ids_to_remove)
+    end
 
-    (old_ids - ids).each do |instance_id|
+    ids_to_remove.each do |instance_id|
       $redis_jason.srem("jason:models:#{model_name}:#{instance_id}:subscriptions", id)
     end
 
     # Add
-    $redis_jason.sadd("jason:subscriptions:#{id}:ids:#{model_name}", (ids - old_ids))
+    ids_to_add = ids - old_ids
+    if ids_to_add.present?
+      $redis_jason.sadd("jason:subscriptions:#{id}:ids:#{model_name}", ids_to_add)
+    end
 
-    (ids - old_ids).each do |instance_id|
+    ids_to_add.each do |instance_id|
       $redis_jason.sadd("jason:models:#{model_name}:#{instance_id}:subscriptions", id)
     end
   end

data/lib/jason/version.rb

@@ -1,3 +1,3 @@
 module Jason
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jason-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - James Rees
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails