flok 0.0.65 → 0.0.66

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58af4b75f2c646d66f7249cab77f1a550b393f00
-  data.tar.gz: 88ec49b2a0e62a185956debdf4b39e3be76c8f6f
+  metadata.gz: a14b04d730ef3b9aacd8c74e5e4d4aaefe985fa0
+  data.tar.gz: 9b938591a91b898de270c24a5cbea1b7f83ffd3a
 SHA512:
-  metadata.gz: db62e8d340aeae8645db9210d6bbefaef8120c45580dd973967951509abad2c2701c5ef3c662e434866f341355d6f9ace279fd72b064050c385960b00ea87de1
-  data.tar.gz: 631469402017511a3d0fc1df7985b577ac965973f94718635f6e021cab426a7650b4c22951f9cfb2036e17ce4c562454fa656549449c4873ff9b957f24e7fee0
+  metadata.gz: aeaa0959cfa1e56fff2003ce9e0925c6c5384886a0f82da48269bc9e71b14b3684199b5c72e75bfb5793d2edf33860dd3484749307070b4287574ae413dafee9
+  data.tar.gz: 229329809c8dc148b1a01223d8e3a340ada05bb4d169736aba82578c06614f6f1446c3900a2bf9101ea65410642357698ac89f7f71ac732cd6cfbeaff5881428

data/app/kern/pagers/pg_sockio.js

@@ -0,0 +1,50 @@
+//Configure pg_sockio
+<% [0].each do |i| %>
+  function pg_sockio<%= i %>_init(ns, options) {
+    pg_sockio<%= i %>_ns = ns;
+
+    if (options.url === undefined) {
+      throw "pg_sockio<%= i %> was not given a url in options";
+    }
+
+    <% if @debug %>
+      pg_sockio<%= i %>_spec_did_init = true;
+    <% end %>
+
+    //Destination for events sent from the sockio driver
+    function pg_sockio<%= i %>_xevent_handler(ep, ename, einfo) {
+      if (ename === "update") {
+        vm_transaction_begin();
+        vm_cache_write(pg_sockio<%= i %>_ns, einfo.page);
+        vm_transaction_end();
+      } else {
+        <% if @debug %>
+        throw "pg_sockio<%= i %>_xevent_handler received an event called: " + ename + "that it does not know how to handle. This event should never have even been forwarded, but you may have missed adding the handler code if you did request a forward"
+        <% end %>
+      }
+    } 
+
+    //Register the base address for the socket and the destination for events
+    pg_sockio<%= i %>_bp = tels(1);
+    reg_evt(pg_sockio<%= i %>_bp, pg_sockio<%= i %>_xevent_handler);
+
+    SEND("net", "if_sockio_init", options.url, pg_sockio<%= i %>_bp);
+
+    //Signal that the socket.io driver should forward all events to the socket defined by pg_sockio{N}_bp
+    //to the endpoint (with the same reference)
+    SEND("net", "if_sockio_fwd", pg_sockio<%= i %>_bp, "update", pg_sockio<%= i %>_bp);
+  }
+
+  function pg_sockio<%= i %>_watch(id, page) {
+    var info = {
+      page_id: id
+    };
+    SEND("net", "if_sockio_send", pg_sockio<%= i %>_bp, "watch", info);
+  }
+
+  function pg_sockio<%= i %>_unwatch(id) {
+  }
+
+  function pg_sockio<%= i %>_write(page) {
+  }
+<% end %>

data/docs/services/vm/pagers.md

@@ -57,3 +57,29 @@ This pager provides you with local memory that will be automatically cached to d
 
 ####Dummy pager | `pg_dummy0`
 This pager doesn't do anything. Used by some specs which manually write to the vm_cache in leu of the pager
+
+####Sockio pager | `pg_sockio0`
+This pager connects to a socket.io server via the `sockio` module.
+  * **Options**
+    * `url (required)` - The url of the socket.io server you are connecting to. Includes endpoint if that's required for your socket.io server. E.g.
+        `http://myapp.com/socket`
+  * **Globals**
+    * `pg_sockio{N}_bp` - The base address that the socket exists at (`sp`) and the endpoint that events are sent to that are destined for forwarding.
+    * `pg_sockio{N}_xevent_handler` - Events received by the sockio driver are forwarded to the kernel at a certain event endpoint if they are
+        configured via `if_sockio_fwd`. This `xevent_handler`  is the destination for all forwarding requests for the `pg_sockio#{N}` socket. Note
+        that the endpoint shares the same value as the socket's base pointer.
+  * **Functions**
+    * `init` - Will begin trying to establish a connection to the server. When pages are written, 
+    * `watch` - Signals to the socket.io server that a page is being watched via `watch` event with parameters `{page_id:}`
+    * `unwatch` - Signals to the socket.io server that a page is no longer being watched via `unwatch` event with parameters `{page_id:}` 
+    * `write` - 
+      * If the page already exists:
+        * Commits unsynced changes to `vm_cache` and notifies the server of the changes if the page already existed via `/update` with `page_id:,
+            changes:`
+      * If the page does not exist:
+        * writes directly to `vm_cache` and notifies the server of the creation via `/create` with `page:`
+  * **Socket.IO Event Handlers **
+    * `update` - A page has been updated. This may either indicate an update or write. The page will be integrated into `vm_cache` via a rebased if it
+        already exists or a direct write if it dosen't already exist. Contains one field `page:` that contains the page.
+  * **Spec**
+    * If `@debug`, then `sockio{N}_spec_did_init` will be true

data/lib/flok/version.rb

@@ -1,3 +1,3 @@
 module Flok
-  VERSION = "0.0.65"
+  VERSION = "0.0.66"
 end

data/spec/kern/assets/vm/pg_sockio/config.rb

@@ -0,0 +1,12 @@
+#Simple service config that uses built-in spec service to create a instance called 'spec'
+service_instance :vm, :vm, {
+  :pagers => [
+    {
+      :name => "pg_sockio0",
+      :namespace => "sockio",
+      :options => {
+        :url => "http://localhost"
+      }
+    }
+  ]
+}

data/spec/kern/assets/vm/pg_sockio/config_no_url.rb

@@ -0,0 +1,11 @@
+#Simple service config that uses built-in spec service to create a instance called 'spec'
+service_instance :vm, :vm, {
+  :pagers => [
+    {
+      :name => "pg_sockio0",
+      :namespace => "sockio",
+      :options => {
+      }
+    }
+  ]
+}

data/spec/kern/assets/vm/pg_sockio/nothing.rb

@@ -0,0 +1,12 @@
+controller :my_controller do
+  services :vm
+
+  action :my_action do
+    on_entry %{
+    }
+
+    on "read_res", %{
+      read_res_params = params;
+    }
+  end
+end

data/spec/kern/assets/vm/pg_sockio/watch.rb

@@ -0,0 +1,18 @@
+controller :my_controller do
+  services :vm
+
+  action :my_action do
+    on_entry %{
+      var watch_info = {
+        ns: "sockio",
+        id: "test", 
+      };
+
+      Request("vm", "watch", watch_info);
+    }
+
+    on "read_res", %{
+      read_res_params = params;
+    }
+  end
+end

data/spec/kern/vm_sockio_pager_spec.rb

@@ -0,0 +1,117 @@
+#The pg_sockio pager
+
+Dir.chdir File.join File.dirname(__FILE__), '../../'
+require './spec/env/kern.rb'
+require './spec/lib/helpers.rb'
+require './spec/lib/io_extensions.rb'
+require './spec/lib/rspec_extensions.rb'
+require 'zlib'
+
+RSpec.describe "kern:sockio_pager" do
+  include Zlib
+  include_context "kern"
+
+  it "Can initialize the pg_sockio0 pager" do
+    ctx = flok_new_user File.read('./spec/kern/assets/vm/pg_sockio/nothing.rb'), File.read("./spec/kern/assets/vm/pg_sockio/config.rb") 
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    res = ctx.eval("pg_sockio0_spec_did_init")
+    expect(res).to eq(true)
+  end
+
+  it "Does throw an exception if not given a url" do
+    ctx = flok_new_user File.read('./spec/kern/assets/vm/pg_sockio/nothing.rb'), File.read("./spec/kern/assets/vm/pg_sockio/config_no_url.rb") 
+
+    expect {
+      ctx.eval %{
+        //Call embed on main root view
+        base = _embed("my_controller", 0, {}, null);
+
+        //Drain queue
+        int_dispatch([]);
+      }
+    }.to raise_error(/url/)
+  end
+
+  it "Does initialize a socketio connection" do
+    ctx = flok_new_user File.read('./spec/kern/assets/vm/pg_sockio/nothing.rb'), File.read("./spec/kern/assets/vm/pg_sockio/config.rb") 
+    ctx.evald %{
+      //Call embed on main root view
+      dump.base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+
+      dump.pg_sockio0_bp = pg_sockio0_bp;
+    }
+
+    #URL is specified in the config
+    @driver.ignore_up_to "if_sockio_init", 1
+    @driver.mexpect "if_sockio_init", ["http://localhost", Integer], 1
+
+    #Forward the update event
+    @driver.ignore_up_to "if_sockio_fwd", 1
+    @driver.mexpect "if_sockio_fwd", [Integer, "update", dump["pg_sockio0_bp"]], 1
+  end
+
+  it "Does send a watch request via socket.io when a page is watched" do
+    ctx = flok_new_user File.read('./spec/kern/assets/vm/pg_sockio/watch.rb'), File.read("./spec/kern/assets/vm/pg_sockio/config.rb") 
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    #We are sending a watch request for a page named 'test'
+    @driver.ignore_up_to "if_sockio_send", 1
+    @driver.mexpect "if_sockio_send", [Integer, "watch", {
+      "page_id" => "test"
+    }], 1
+  end
+
+  it "Does write a page to vm_cache that dosen't already exist when the page receives an 'update' response from the external socket.io" do
+    ctx = flok_new_user File.read('./spec/kern/assets/vm/pg_sockio/watch.rb'), File.read("./spec/kern/assets/vm/pg_sockio/config.rb") 
+    dump = ctx.evald %{
+      //Call embed on main root view
+      dump.base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+
+      //pg_sockio0 socket address & the endpoint for the event callback
+      dump.pg_sockio0_bp = pg_sockio0_bp;
+    }
+
+    #We received a watch request for a page with the id 'test'
+    #Now we are imagining that the socket.io driver received back some
+    #data and is now signaling to the kernel that data is available
+    @driver.int "int_event", [dump["pg_sockio0_bp"], "update", {page: {
+      _id: "test",
+      _next: nil,
+      _head: nil,
+      entries: [
+        {"_id" => "foo", "_sig" => "foo", "value" => "bar"}
+      ],
+    }}]
+
+    post_read_res_dump = ctx.evald %{
+      //Drain queue (vm_cache_write defers to controller)
+      int_dispatch([]);
+
+      dump.read_res_params = read_res_params;
+    }
+
+    #The controller should have received a notification that a page was updated
+    expect(post_read_res_dump["read_res_params"]["entries"]).to eq([
+      {"_id" => "foo", "_sig" => "foo", "value" => "bar"}
+    ])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flok
 version: !ruby/object:Gem::Version
-  version: 0.0.65
+  version: 0.0.66
 platform: ruby
 authors:
 - seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-17 00:00:00.000000000 Z
+date: 2015-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -297,6 +297,7 @@ files:
 - app/kern/pagers/pg_dummy.js
 - app/kern/pagers/pg_mem.js
 - app/kern/pagers/pg_net_sim.js
+- app/kern/pagers/pg_sockio.js
 - app/kern/pagers/pg_spec.js
 - app/kern/pagers/sockio_pager.js
 - app/kern/pagers/spec0.js
@@ -1253,6 +1254,10 @@ files:
 - spec/kern/assets/vm/pg_net_sim/nothing.rb
 - spec/kern/assets/vm/pg_net_sim/pages.json
 - spec/kern/assets/vm/pg_net_sim/watch.rb
+- spec/kern/assets/vm/pg_sockio/config.rb
+- spec/kern/assets/vm/pg_sockio/config_no_url.rb
+- spec/kern/assets/vm/pg_sockio/nothing.rb
+- spec/kern/assets/vm/pg_sockio/watch.rb
 - spec/kern/assets/vm/service0.rb
 - spec/kern/assets/vm/service_controller0.rb
 - spec/kern/assets/vm/vm_commit_pages.js
@@ -1273,6 +1278,7 @@ files:
 - spec/kern/vm_service_mem_pagers_spec.rb
 - spec/kern/vm_service_net_sim_pager_spec.rb
 - spec/kern/vm_service_spec.rb
+- spec/kern/vm_sockio_pager_spec.rb
 - spec/kern/vm_transaction_spec.rb
 - spec/lib/helpers.rb
 - spec/lib/io_extensions.rb
@@ -2182,6 +2188,10 @@ test_files:
 - spec/kern/assets/vm/pg_net_sim/nothing.rb
 - spec/kern/assets/vm/pg_net_sim/pages.json
 - spec/kern/assets/vm/pg_net_sim/watch.rb
+- spec/kern/assets/vm/pg_sockio/config.rb
+- spec/kern/assets/vm/pg_sockio/config_no_url.rb
+- spec/kern/assets/vm/pg_sockio/nothing.rb
+- spec/kern/assets/vm/pg_sockio/watch.rb
 - spec/kern/assets/vm/service0.rb
 - spec/kern/assets/vm/service_controller0.rb
 - spec/kern/assets/vm/vm_commit_pages.js
@@ -2202,6 +2212,7 @@ test_files:
 - spec/kern/vm_service_mem_pagers_spec.rb
 - spec/kern/vm_service_net_sim_pager_spec.rb
 - spec/kern/vm_service_spec.rb
+- spec/kern/vm_sockio_pager_spec.rb
 - spec/kern/vm_transaction_spec.rb
 - spec/lib/helpers.rb
 - spec/lib/io_extensions.rb