jason-rails 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0d37099f467ff5bd4ab868732ce57c53bf055e6ecb8d0f0506bb14ee723d77
-  data.tar.gz: 6912d141317dbc95edb96bc11ed29235a90fc6dd8575a4dcba18017b81a9964f
+  metadata.gz: 592a7eab8028ae28815abbf0d401d98b2ceabc0009f30713f68795da21adb165
+  data.tar.gz: 315f5088e258dcab9755dc92f4de03f3f2f016cf6698d3619f022c1e7d601e9d
 SHA512:
-  metadata.gz: 3cce0310a94bba9c73237d3d18bcd7aa949fb35905b7dd76c69c05b6d8259f1fc6d0b79da2a01b3db34b372cf438ea96777c14d2bd3bdbfacf9ba27578e81f19
-  data.tar.gz: f2460fea5f459d24966741cce29855b97b9361a900a848e8655ccdfb4cbaa03aa4d47135b2fa661961f7c8d46d37f5e9bc821ff97a6f5cdd22265f7a8d755758
+  metadata.gz: a33fdc1d57462a97b7dd571222ff314cc77338e5172fcfc662f3e1fd5f008deed299abcd870900d0b50805944af822b462f6adee46953895499ce49f69df6680
+  data.tar.gz: 8ec1a59761856754f09bb7b6431d3d45d319daf9d4c7f030b8c7c2301c28ab2d0393952c4d7339a4d6310da2689c3cba8c71048deed931e0d3c4b0cf5c2fc2f1

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v0.8.0
+- Cold cache handling:
+ - Expiry is now set on all cached models of one week
+ - Code now handles case where cached model is missing and repopulates the cache
+
+## v0.7.5
+- Fixed JS errors when payloads arrive on websockets after the subscription has been unmounted
+- Fixed errors during initialization due to calling `cache_all` on a Rails model before it had fully initialized.
+
+## v0.7.3
+- Added: Add JasonContext to exports, for use in scenarios where you need to forward the context into some other React reconciler (e.g. `react-three-fiber`)
+- Fixed: Unneeded `reload` in Publisher resulting in extra database calls
+
 ## v0.7.1
 - Added: Authorization for REST endpoints. Previously these just inherited logic from ApplicationController. Pass a `update_authorization_service` option to the Jason initializer to use this.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jason-rails (0.7.0)
+    jason-rails (0.7.5)
       connection_pool (>= 2.2.3)
       jsondiff
       rails (>= 5)
@@ -89,9 +89,10 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
-    mimemagic (0.3.8)
+    mimemagic (0.3.10)
       nokogiri (~> 1)
-    mini_mime (1.0.2)
+      rake
+    mini_mime (1.1.0)
     mini_portile2 (2.5.0)
     minitest (5.14.3)
     nio4r (2.5.7)

data/README.md

@@ -21,7 +21,7 @@ An alternative way of thinking about Jason is "what if we applied the Flux/Redux
 Add the gem and the NPM package
 
 ```ruby
-gem 'jason-rails'
+gem 'jason-rails', require: 'jason'
 ```
 
 ```bash
@@ -52,6 +52,11 @@ Jason.setup do |config|
 end
 ```
 
+Mount the Jason engine in `routes.rb`
+```ruby
+mount Jason::Engine => "/jason"
+```
+
 ### In your frontend code
 
 First you need to wrap your root component in a `JasonProvider`.
@@ -173,6 +178,15 @@ Development is primarily driven by the needs of projects we're using Jason in. I
 - Assess using RedisGraph for the graph diffing functionality, to see if this would provide a performance boost
 - Improve the Typescript definitions (ie remove the abundant `any` typing currently used)
 
+## Publishing a new version
+- Update `version.rb`
+- Update CHANGELOG
+- `gem build`
+- `gem push`
+- `npm version [major/minor/patch]`
+- `npm publish`
+- Push new version to Github
+
 ## License
 
 The gem, npm package and source code in the git repository are available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/client/lib/JasonProvider.d.ts

@@ -1,8 +1,10 @@
 import React from 'react';
-declare const JasonProvider: ({ reducers, middleware, extraActions, children }: {
+declare const JasonProvider: ({ reducers, middleware, enhancers, extraActions, transportOptions, children }: {
     reducers?: any;
     middleware?: any;
+    enhancers?: any;
     extraActions?: any;
+    transportOptions?: any;
     children?: React.FC<{}> | undefined;
 }) => JSX.Element;
 export default JasonProvider;

data/client/lib/JasonProvider.js

@@ -7,8 +7,8 @@ const react_1 = __importDefault(require("react"));
 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] = useJason_1.default({ reducers, middleware, extraActions });
+const JasonProvider = ({ reducers, middleware, enhancers, extraActions, transportOptions = {}, children }) => {
+    const [store, value] = useJason_1.default({ reducers, middleware, enhancers, extraActions, transportOptions });
     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/createTransportAdapter.d.ts

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

data/client/lib/createTransportAdapter.js

@@ -5,10 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (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) {
+function createTransportAdapter(jasonConfig, handlePayload, dispatch, onConnect, transportOptions) {
     const { transportService } = jasonConfig;
     if (transportService === 'action_cable') {
-        return actionCableAdapter_1.default(jasonConfig, handlePayload, dispatch, onConnect);
+        return actionCableAdapter_1.default(jasonConfig, handlePayload, dispatch, onConnect, transportOptions);
     }
     else if (transportService === 'pusher') {
         return pusherAdapter_1.default(jasonConfig, handlePayload, dispatch);

data/client/lib/index.d.ts

@@ -2,10 +2,17 @@
 import _useAct from './useAct';
 import _useSub from './useSub';
 import _useEager from './useEager';
-export declare const JasonProvider: ({ reducers, middleware, extraActions, children }: {
+export declare const JasonContext: import("react").Context<{
+    actions: any;
+    subscribe: null;
+    eager: (entity: any, id: any, relations: any) => void;
+}>;
+export declare const JasonProvider: ({ reducers, middleware, enhancers, extraActions, transportOptions, children }: {
     reducers?: any;
     middleware?: any;
+    enhancers?: any;
     extraActions?: any;
+    transportOptions?: any;
     children?: import("react").FC<{}> | undefined;
 }) => JSX.Element;
 export declare const useAct: typeof _useAct;

data/client/lib/index.js

@@ -3,11 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useEager = exports.useSub = exports.useAct = exports.JasonProvider = void 0;
+exports.useEager = exports.useSub = exports.useAct = exports.JasonProvider = exports.JasonContext = void 0;
+const JasonContext_1 = __importDefault(require("./JasonContext"));
 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.JasonContext = JasonContext_1.default;
 exports.JasonProvider = JasonProvider_1.default;
 exports.useAct = useAct_1.default;
 exports.useSub = useSub_1.default;

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

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

data/client/lib/transportAdapters/actionCableAdapter.js

@@ -7,9 +7,10 @@ const actioncable_1 = require("@rails/actioncable");
 const restClient_1 = __importDefault(require("../restClient"));
 const uuid_1 = require("uuid");
 const lodash_1 = __importDefault(require("lodash"));
-function actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnected) {
+function actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnected, transportOptions) {
     const consumerId = uuid_1.v4();
-    const consumer = actioncable_1.createConsumer();
+    const { cableUrl } = transportOptions;
+    const consumer = cableUrl ? actioncable_1.createConsumer(cableUrl) : actioncable_1.createConsumer();
     const subscription = (consumer.subscriptions.create({
         channel: 'Jason::Channel'
     }, {

data/client/lib/useJason.d.ts

@@ -1,5 +1,7 @@
-export default function useJason({ reducers, middleware, extraActions }: {
+export default function useJason({ reducers, middleware, enhancers, transportOptions, extraActions }: {
     reducers?: any;
     middleware?: any[];
+    enhancers?: any[];
     extraActions?: any;
+    transportOptions?: any;
 }): any[];

data/client/lib/useJason.js

@@ -16,7 +16,7 @@ const humps_1 = require("humps");
 const blueimp_md5_1 = __importDefault(require("blueimp-md5"));
 const lodash_1 = __importDefault(require("lodash"));
 const react_1 = require("react");
-function useJason({ reducers, middleware = [], extraActions }) {
+function useJason({ reducers, middleware = [], enhancers = [], transportOptions = {}, extraActions }) {
     const [store, setStore] = react_1.useState(null);
     const [value, setValue] = react_1.useState(null);
     react_1.useEffect(() => {
@@ -28,7 +28,7 @@ function useJason({ reducers, middleware = [], extraActions }) {
             const serverActionQueue = createServerActionQueue_1.default();
             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)] });
+            const store = toolkit_1.configureStore({ reducer: allReducers, middleware: [...middleware, pruneIdsMiddleware_1.default(schema)], enhancers });
             const dispatch = store.dispatch;
             const optDis = createOptDis_1.default(schema, dispatch, restClient_1.default, serverActionQueue);
             const actions = createActions_1.default(schema, store, restClient_1.default, optDis, extraActions);
@@ -37,7 +37,7 @@ function useJason({ reducers, middleware = [], extraActions }) {
             let subOptions = {};
             function handlePayload(payload) {
                 const { md5Hash } = payload;
-                const { handlePayload } = payloadHandlers[md5Hash];
+                const { handlePayload } = payloadHandlers[md5Hash] || {};
                 if (handlePayload) {
                     handlePayload(payload);
                 }
@@ -45,7 +45,7 @@ function useJason({ reducers, middleware = [], extraActions }) {
                     console.warn("Payload arrived with no handler", payload, payloadHandlers);
                 }
             }
-            const transportAdapter = createTransportAdapter_1.default(jasonConfig, handlePayload, dispatch, () => lodash_1.default.keys(configs).forEach(md5Hash => createSubscription(configs[md5Hash], subOptions[md5Hash])));
+            const transportAdapter = createTransportAdapter_1.default(jasonConfig, handlePayload, dispatch, () => lodash_1.default.keys(configs).forEach(md5Hash => createSubscription(configs[md5Hash], subOptions[md5Hash])), transportOptions);
             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();

data/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jamesr2323/jason",
-  "version": "0.7.1",
+  "version": "0.7.5",
   "module": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {

data/client/src/JasonProvider.tsx

@@ -3,8 +3,8 @@ import useJason from './useJason'
 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] = useJason({ reducers, middleware, extraActions })
+const JasonProvider = ({ reducers, middleware, enhancers, extraActions, transportOptions = {}, children }: { reducers?: any, middleware?: any, enhancers?: any, extraActions?: any, transportOptions?: any, children?: React.FC }) => {
+  const [store, value] = useJason({ reducers, middleware, enhancers, extraActions, transportOptions })
 
   if(!(store && value)) return <div /> // Wait for async fetch of schema to complete
 

data/client/src/createTransportAdapter.ts

@@ -1,10 +1,10 @@
 import actionCableAdapter from './transportAdapters/actionCableAdapter'
 import pusherAdapter from './transportAdapters/pusherAdapter'
 
-export default function createTransportAdapter(jasonConfig, handlePayload, dispatch, onConnect) {
+export default function createTransportAdapter(jasonConfig, handlePayload, dispatch, onConnect, transportOptions) {
   const { transportService } = jasonConfig
   if (transportService === 'action_cable') {
-    return actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnect)
+    return actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnect, transportOptions)
   } else if (transportService === 'pusher') {
     return pusherAdapter(jasonConfig, handlePayload, dispatch)
   } else {

data/client/src/index.ts

@@ -1,8 +1,10 @@
+import _JasonContext from './JasonContext'
 import _JasonProvider from './JasonProvider'
 import _useAct from './useAct'
 import _useSub from './useSub'
 import _useEager from './useEager'
 
+export const JasonContext = _JasonContext
 export const JasonProvider = _JasonProvider
 export const useAct = _useAct
 export const useSub = _useSub

data/client/src/transportAdapters/actionCableAdapter.ts

@@ -3,10 +3,12 @@ import restClient from '../restClient'
 import { v4 as uuidv4 } from 'uuid'
 import _ from 'lodash'
 
-export default function actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnected) {
+export default function actionCableAdapter(jasonConfig, handlePayload, dispatch, onConnected, transportOptions) {
   const consumerId = uuidv4()
 
-  const consumer = createConsumer()
+  const { cableUrl } = transportOptions
+  const consumer = cableUrl ? createConsumer(cableUrl) : createConsumer()
+
   const subscription = (consumer.subscriptions.create({
     channel: 'Jason::Channel'
   }, {

data/client/src/useJason.ts

@@ -14,7 +14,7 @@ import md5 from 'blueimp-md5'
 import _ from 'lodash'
 import React, { useState, useEffect } from 'react'
 
-export default function useJason({ reducers, middleware = [], extraActions }: { reducers?: any, middleware?: any[], extraActions?: any }) {
+export default function useJason({ reducers, middleware = [], enhancers = [], transportOptions = {}, extraActions }: { reducers?: any, middleware?: any[], enhancers?: any[], extraActions?: any, transportOptions?: any }) {
   const [store, setStore] = useState(null as any)
   const [value, setValue] = useState(null as any)
 
@@ -35,7 +35,7 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
 
       console.debug({ allReducers })
 
-      const store = configureStore({ reducer: allReducers, middleware: [...middleware, pruneIdsMiddleware(schema)] })
+      const store = configureStore({ reducer: allReducers, middleware: [...middleware, pruneIdsMiddleware(schema)], enhancers })
       const dispatch = store.dispatch
 
       const optDis = createOptDis(schema, dispatch, restClient, serverActionQueue)
@@ -48,7 +48,7 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
       function handlePayload(payload) {
         const { md5Hash } = payload
 
-        const { handlePayload } = payloadHandlers[md5Hash]
+        const { handlePayload } = payloadHandlers[md5Hash] || {}
         if (handlePayload) {
           handlePayload(payload)
         } else {
@@ -56,7 +56,13 @@ export default function useJason({ reducers, middleware = [], extraActions }: {
         }
       }
 
-      const transportAdapter = createTransportAdapater(jasonConfig, handlePayload, dispatch, () => _.keys(configs).forEach(md5Hash => createSubscription(configs[md5Hash], subOptions[md5Hash])))
+      const transportAdapter = createTransportAdapater(
+        jasonConfig,
+        handlePayload,
+        dispatch,
+        () => _.keys(configs).forEach(md5Hash => createSubscription(configs[md5Hash], subOptions[md5Hash])),
+        transportOptions
+      )
 
       function createSubscription(config, options = {}) {
         // We need the hash to be consistent in Ruby / Javascript

data/lib/jason/consistency_checker.rb

@@ -21,6 +21,10 @@ class Jason::ConsistencyChecker
     check_all(fix: true)
   end
 
+  def wipe_all_subs
+
+  end
+
   def initialize(subscription)
     @subscription = subscription
     @inconsistent = false

data/lib/jason/lua_generator.rb

@@ -1,10 +1,13 @@
 class Jason::LuaGenerator
   ## TODO load these scripts and evalsha
   def cache_json(model_name, id, payload)
+    expiry = 7*24*60*60 + rand(6*60*60)
+
+    # ensure the content expires first
     cmd = <<~LUA
       local gidx = redis.call('INCR', 'jason:gidx')
-      redis.call( 'set', 'jason:cache:' .. ARGV[1] .. ':' .. ARGV[2] .. ':gidx', gidx )
-      redis.call( 'hset', 'jason:cache:' .. ARGV[1], ARGV[2], ARGV[3] )
+      redis.call( 'setex', 'jason:cache:' .. ARGV[1] .. ':' .. ARGV[2] .. ':gidx', #{expiry}, gidx )
+      redis.call( 'setex', 'jason:cache:' .. ARGV[1] .. ':' .. ARGV[2], #{expiry - 60}, ARGV[3] )
       return gidx
     LUA
 
@@ -15,15 +18,26 @@ class Jason::LuaGenerator
     # If value has changed, return old value and new idx. Otherwise do nothing.
     cmd = <<~LUA
       local t = {}
-      local models = {}
+      local insts = {}
+      local miss_ids = {}
       local ids = redis.call('smembers', 'jason:subscriptions:' .. ARGV[2] .. ':ids:' .. ARGV[1])
 
       for k,id in pairs(ids) do
-        models[#models+1] = redis.call( 'hget', 'jason:cache:' .. ARGV[1], id)
+        local result = redis.call( 'get', 'jason:cache:' .. ARGV[1] .. ':' .. id)
+        if (result == false) then
+          miss_ids[#miss_ids+1] = id
+        else
+          insts[#insts+1] = result
+        end
       end
 
-      t[#t+1] = models
-      t[#t+1] = redis.call( 'get', 'jason:subscription:' .. ARGV[2] .. ':' .. ARGV[1] .. ':idx' )
+      if next(miss_ids) == nil then
+        t[#t+1] = insts
+        t[#t+1] = redis.call( 'get', 'jason:subscription:' .. ARGV[2] .. ':' .. ARGV[1] .. ':idx' )
+      else
+        t[#t+1] = miss_ids
+        t[#t+1] = 'missing'
+      end
 
       return t
     LUA

data/lib/jason/publisher.rb

@@ -16,7 +16,7 @@ module Jason::Publisher
 
     # Exists
     if self.persisted? && (scope.blank? || self.class.unscoped.send(scope).exists?(self.id))
-      payload = self.reload.as_json(as_json_config)
+      payload = self.as_json(as_json_config)
       gidx = Jason::LuaGenerator.new.cache_json(self.class.name.underscore, self.id, payload)
       return [payload, gidx]
     # Has been destroyed
@@ -124,12 +124,16 @@ module Jason::Publisher
   end
 
   def jason_cached_value
-    JSON.parse($redis_jason.hget("jason:cache:#{self.class.name.underscore}", id) || '{}')
+    JSON.parse($redis_jason.get("jason:cache:#{self.class.name.underscore}:#{id}") || '{}')
   end
 
   class_methods do
     def cache_all
-      all.each(&:cache_json)
+      all.find_each(&:cache_json)
+    end
+
+    def cache_for(ids)
+      where(id: ids).find_each(&:cache_json)
     end
 
     def has_jason?

data/lib/jason/subscription.rb

@@ -399,16 +399,17 @@ class Jason::Subscription
   end
 
   def get_for_model(model_name)
-    if $redis_jason.sismember("jason:models:#{model_name}:all:subscriptions", id)
-      instance_jsons_hash, idx = $redis_jason.multi do |r|
-        r.hgetall("jason:cache:#{model_name}")
-        r.get("jason:subscription:#{id}:#{model_name}:idx")
-      end
-      instance_jsons = instance_jsons_hash.values
-    else
+    instance_jsons, idx = Jason::LuaGenerator.new.get_payload(model_name, id)
+    if idx == 'missing'
+      # warm cache and then retry
+      model_klass(model_name).cache_for(instance_jsons)
       instance_jsons, idx = Jason::LuaGenerator.new.get_payload(model_name, id)
     end
 
+    if instance_jsons.any? { |json| json.blank? }
+      raise Jason::MissingCacheError
+    end
+
     payload = instance_jsons.map do |instance_json|
       instance_json ? JSON.parse(instance_json) : {}
     end
@@ -437,7 +438,7 @@ class Jason::Subscription
 
   def add(model_name, instance_id)
     idx = $redis_jason.incr("jason:subscription:#{id}:#{model_name}:idx")
-    payload = JSON.parse($redis_jason.hget("jason:cache:#{model_name}", instance_id) || '{}')
+    payload = JSON.parse($redis_jason.get("jason:cache:#{model_name}:#{instance_id}") || '{}')
 
     payload = {
       id: instance_id,
@@ -479,3 +480,5 @@ class Jason::Subscription
     broadcaster.broadcast(payload)
   end
 end
+
+class Jason::MissingCacheError < StandardError; end

data/lib/jason/version.rb

@@ -1,3 +1,3 @@
 module Jason
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/lib/jason.rb

@@ -51,7 +51,11 @@ module Jason
         puts "Old config was #{previous_schema[model]}"
         puts "New config is #{config}"
         puts "Rebuilding cache for #{model}"
-        model.classify.constantize.cache_all
+
+        # This is necessary to ensure all Rails methods have been added to model before we attempt to cache.
+        Rails.configuration.after_initialize do
+           model.classify.constantize.cache_all
+        end
         puts "Done"
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jason-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - James Rees
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails