browserchannel 0.0.1

data/LICENSE

@@ -0,0 +1,202 @@
+#!text
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,71 @@
+#BrowserChannel Ruby Server
+Copyright 2011 David Turnbull. Licensed under the Apache License, Version 2.0.
+
+An event-driven server for Google Closure Library's goog.BrowserChannel class.
+
+##Getting Started
+
+### Step 1
+Ensure you have a modern Ruby and RubyGems.
+Version 1.8.6 and higher should work.  Run:
+
+    gem install thin closure json
+    thin start
+
+### Step 2
+Open your web browser and continue from there.
+Check the thin log for the proper port.
+It's most likely:
+
+    http://localhost:3000/
+
+##Getting to Production
+
+The browser is started by attaching a handler to a channel.  The channel
+then connects with a server.  The handler is your implementation.
+
+    var handler = new goog.net.BrowserChannel.Handler();
+    handler.channelOpened = function(channel) {
+      // fire off a message immediately after connect
+      channel.sendMap({message:'data'});
+    };
+    handler.channelHandleArray = function(x, data) {
+      // messages from the server arrive here
+      alert(data[0].message);
+    };
+
+    channel = new goog.net.BrowserChannel();
+    channel.setHandler(handler);
+    channel.connect('demo.test', 'demo.channel');
+
+The server is a Rack application for the `thin` server.  Other Rack servers do
+not support event-driven multi chunk responses.  Thin also enables use of the
+epoll/kqueue interface which allows for tens of thousands of open connections.
+Expect 500-1000 requests per second on a single core of modern hardware.
+
+    # for config.ru
+    require 'browser_channel'
+    require 'browser_test_channel'
+    map '/demo.channel' do
+      run BrowserChannel::Server.new, :handler => MyHandler
+    end
+    map '/demo.test' do
+      run BrowserTestChannel::Server.new
+    end
+
+Just like the browser side, there's a handler for your implementation.
+
+    class MyHandler < BrowserChanner::Handler
+      # this is an echo server
+      def call post_data
+        requests = decode_post_data post_data
+        requests.each { |r| @session << [r] }
+      end
+      # called when channel session is final
+      def terminate
+      end
+    end
+
+Be sure not to deploy the Closure Script build tool or debug tools like
+Rack::Reloader. These will severely affect performance and security.
+Check your middleware if you're not seeing the benchmarks you expect.

data/lib/browser_channel.rb

@@ -0,0 +1,261 @@
+# Copyright 2011 David Turnbull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+require 'thin'
+
+class BrowserChannel
+
+  class Server
+    def initialize options={}
+      @options = {
+        # Subclass this echo Handler or create your own.
+        :handler => Handler,
+        # Ensure a chunk is sent within these first few seconds because
+        # waiting an entire interval looks too much like a broken server.
+        :keep_alive_first => 10,
+        # Send a noop chunk every so many seconds to prevent timeouts.
+        :keep_alive_interval => 30,
+        # Alternate host prefix for clients with connection pool limits.
+        :host_prefix => nil,
+        # Number of seconds a session must be unbound before freed.
+        :gc_max_age => 120,
+        # Minimum number of seconds to wait between garbage collections.
+        :gc_frequency => 10,
+      }.merge! options
+      errors = []
+      unless @options[:gc_max_age] > (@options[:keep_alive_interval] - @options[:keep_alive_first])
+        # in this condition, connections look expired on creation
+        errors << 'gc_max_age is too small'
+      end
+      if @options[:keep_alive_interval] < @options[:keep_alive_first]
+        errors << 'keep_alive_first must be same or smaller than keep_alive_interval'
+      end
+      raise "Options Fail: #{errors.join(', ')}." unless errors.empty?
+    end
+    def call env
+      BrowserChannel.new @options, env
+      Thin::Connection::AsyncResponse          
+    end
+  end
+  
+  # Example Handler that echos data.
+  class Handler
+    REQ_REGEXP = /^req(\d*)_(.*)$/
+    def initialize session
+      @session = session
+    end
+    def terminate
+    end
+    def call post_data
+      requests = decode_post_data post_data
+      requests.each { |r| @session << [r] }
+    end
+    private 
+    def decode_post_data post_data
+      count = [0,post_data['count'].to_i].max
+      requests = Array.new(count){Hash.new}
+      post_data.each do |key, value|
+        next unless match = REQ_REGEXP.match(key)
+        index = match[1].to_i
+        next if index < 0 or index >= count
+        requests[index][match[2]] = value
+      end
+      requests
+    end
+  end
+
+  # A Session manages two arrays of responses.  One is maintained in case the
+  # connection is dropped so that we don't lose messages.  This gets truncated
+  # as we receive 'AID' information from the client indicating the data was
+  # received.  The other array collects outgoing data for the currently bound
+  # channel so it can be sent in a single chunk with other data in the next tick.
+
+  class Session
+
+    @@sessions ||= {}
+    @@sessions_gc ||= Time.now
+
+    ID_CHARACTERS = (('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a).freeze
+  
+    def self.new options, id, array_id
+      if Time.now > @@sessions_gc
+        to_terminate = []
+        @@sessions.each do |key, session|
+          next unless session.unbound_at
+          next if Time.now - session.unbound_at < options[:gc_max_age]
+          to_terminate << key 
+        end
+        to_terminate.each do |key|
+          @@sessions[key].terminate
+        end
+        @@sessions_gc = Time.now + options[:gc_frequency]
+      end
+      if id
+        session = @@sessions[id]
+        if session and array_id and !array_id.empty?
+          array_id = array_id.to_i
+          messages = session.messages
+          messages.shift until messages.empty? or messages.first[0] > array_id
+        end
+        return session 
+      end
+      while !id or @@sessions.has_key? id
+        id = (0..32).map{ID_CHARACTERS[rand(ID_CHARACTERS.size)]}.join 
+      end
+      allocate.instance_eval do
+        @handler = options[:handler].new self
+        initialize id
+        @@sessions[id] = self
+      end
+    end
+  
+    attr_accessor :id, :array_id, :messages, :unbound_at
+  
+    def initialize id
+      @id = id
+      @array_id = -1
+      @messages = []
+      unbind(@channel = nil) # trick into init
+    end
+    
+    def bind channel
+      @channel = channel
+      @channel_queue = []
+      @unbound_at = nil
+    end
+
+    # A channel will request to unbind itself after the connection completes.
+    # It's possible another connection has taken over so abort if it looks so.
+    def unbind channel
+      return if @channel != channel
+      @channel = channel
+      @unbound_at = Time.now
+    end
+    
+    def terminate
+      @handler.terminate if @handler.respond_to? :terminate
+      @@sessions.delete @id
+    end
+    
+    # Data from the browser arrives here.
+    def call post_data
+      session_bound = @channel ? 1 : 0
+      pending_bytes = @messages.empty? ? 0 : @session.to_json.bytesize
+      response = [session_bound, @array_id, pending_bytes]
+      @handler.call post_data
+      response
+    end
+  
+    # Adds a new message and schedules it to be sent.
+    # Magic ['stop'] will tell the browser server is going down.
+    def push array
+      message = [@array_id += 1, array]
+      @messages << message
+      return unless @channel
+      if @channel_queue.empty?
+        EventMachine.next_tick do
+          if @channel
+            @channel.send_data @channel_queue
+            @channel_queue = []
+          end
+        end
+      end
+      @channel_queue << message
+    end
+    alias :<< :push
+
+  end
+
+  include EventMachine::Deferrable
+
+  LATEST_CHANNEL_VERSION = 8
+  NOOP = ['noop'.freeze].freeze
+
+  def initialize options, env
+    @options = options
+    request = Rack::Request.new env
+    request_GET = request.GET
+    request_GET_SID = request_GET['SID']
+    @session = Session.new @options, request_GET_SID, request_GET['AID']
+    unless @session
+      request.env['async.callback'].call [400, {}, self]
+      succeed
+      return
+    end
+    if @session.array_id == -1
+      @session << ['c', @session.id, @options[:host_prefix], LATEST_CHANNEL_VERSION]
+    end
+    @chunked = request_GET['CI'] == '0'
+    @html_data_type = request_GET['TYPE'] == 'html'
+    headers = {'Cache-Control' => 'no-cache'}
+    headers['Content-Type'] = @html_data_type ? 'text/html' : 'application/javascript'
+    env['async.callback'].call [200, headers, self]
+    if @html_data_type
+      @body_callback.call "<html><body>\n"
+      if domain = request_GET['DOMAIN']
+        @body_callback.call "<script>try{document.domain=#{domain.dump};}catch(e){}</script>\n"
+      end
+    end
+    if request_GET['TYPE'] == 'terminate'
+      @session.terminate
+      succeed
+      return
+    end
+    if request.post? and request_GET_SID
+      send_data @session.call request.POST
+      return
+    elsif request.get?
+      # Thin calls errback when connection closes, even after success
+      if @chunked
+        @last_message = Time.now - ( @options[:keep_alive_interval] - @options[:keep_alive_first] )
+        keep_alive 
+        errback { @timer.cancel }
+      end
+      @session.bind self 
+      errback { @session.unbind self }
+    end
+    send_data @session.messages unless @session.messages.empty?
+  end
+  
+  def keep_alive
+    idle = Time.now - @last_message
+    if idle > @options[:keep_alive_interval]
+      @session << NOOP
+      idle = 0
+    end
+    @timer = EventMachine::Timer.new @options[:keep_alive_interval] - idle, &method(:keep_alive)
+  end
+
+  def each &block
+    @body_callback = block
+  end
+
+  def send_data messages
+    json = messages.to_json
+    if @html_data_type
+      @body_callback.call "<script>try{parent.m(#{json.dump});}catch(e){}</script>\n"
+    else
+      @body_callback.call "#{json.bytesize+1}\n#{json}\n"
+    end
+    @last_message = Time.now
+    unless @chunked
+      if @html_data_type
+        @body_callback.call "<script>try{parent.d();}catch(e){}</script>\n</body></html>\n"
+      end
+      succeed 
+    end
+  end
+
+end

data/lib/browser_test_channel.rb

@@ -0,0 +1,80 @@
+# Copyright 2011 David Turnbull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+require 'thin'
+
+class BrowserTestChannel
+
+  class Server
+    def initialize options={}
+      @options = {
+        # alternate host prefix for clients with connection pool limits
+        :host_prefix => nil,
+        # network admins can block this host to disable streaming
+        # '/mail/images/cleardot.gif' must be found on this host
+        :blocked_prefix => nil,
+      }.merge! options
+    end
+    def call env
+      request = Rack::Request.new env
+      if request.GET['MODE'] == 'init'
+        [
+          200,
+          {'Content-Type' => 'application/javascript'}, 
+          [[@options[:host_prefix], @options[:blocked_prefix]].to_json]
+        ]
+      else
+        BrowserTestChannel.new request
+        Thin::Connection::AsyncResponse
+      end
+    end
+  end
+
+  include EventMachine::Deferrable
+
+  def initialize request
+    @html_data_type = request.GET['TYPE'] == 'html'
+    headers = {'Cache-Control' => 'no-cache'}
+    headers['Content-Type'] = @html_data_type ? 'text/html' : 'application/javascript'
+    request.env['async.callback'].call [200, headers, self]
+    if @html_data_type
+      @body_callback.call "<html><body>\n"
+      if domain = request.GET['DOMAIN']
+        @body_callback.call "<script>try{document.domain=#{domain.dump};}catch(e){}</script>\n"
+      end
+    end
+    call '11111'
+    EventMachine.add_timer(2) do
+      call '2'
+      if @html_data_type
+        @body_callback.call "<script>try{parent.d();}catch(e){}</script>\n</body></html>\n"
+      end
+      succeed
+    end
+  end
+
+  def each &blk
+    @body_callback = blk
+  end
+
+  def call chunk
+    if @html_data_type
+      @body_callback.call "<script>try{parent.m(#{chunk.dump});}catch(e){}</script>\n"
+    else
+      @body_callback.call chunk
+    end
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: browserchannel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Turnbull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-05 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &2152966860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152966860
+description: 
+email:
+- dturnbull@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/browser_channel.rb
+- lib/browser_test_channel.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: https://github.com/dturnbull/browserchannel
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An event-driven server for Google Closure Library's goog.BrowserChannel class
+test_files: []