rails_twirp 0.2.0 → 0.7.0

data/lib/rails_twirp/route_set.rb

@@ -1,6 +1,10 @@
 # Most of this logic is stolen from Rails ActionDispatch::Routing::RouteSet
 
+require "rails_twirp/mapper"
+
 module RailsTwirp
+  class UnknownRpcError < StandardError; end
+
   class RouteSet
     attr_reader :services
 
@@ -42,15 +46,16 @@ module RailsTwirp
         handler = Class.new
         @rpcs.each do |name, mapping|
           rpc_info = @service_class.rpcs[name]
+          raise UnknownRpcError, "Unknown RPC #{name} on #{@service_class.service_name} service" unless rpc_info
           method_name = rpc_info[:ruby_method]
 
           # Stolen from Rails in ActionDispatch::Request#controller_class_for
-          controller_name = mapping.controller.underscore
-          const_name = controller_name.camelize << "Controller"
           action_name = mapping.action
           response_class = rpc_info[:output_class]
 
           handler.define_method(method_name) do |req, env|
+            controller_name = mapping.controller.underscore
+            const_name = controller_name.camelize << "Controller"
             controller_class = ::ActiveSupport::Dependencies.constantize(const_name)
             controller_class.dispatch(action_name, req, response_class, env)
           end
@@ -63,51 +68,5 @@ module RailsTwirp
         service
       end
     end
-
-    class Mapping
-      attr_reader :controller, :action
-
-      def initialize(to:)
-        @controller, @action = split_to(to)
-      end
-
-      def to_s
-        "#{controller}##{action}"
-      end
-
-      private
-
-      # copied from Rails
-      def split_to(to)
-        if /#/.match?(to)
-          to.split("#").map!(&:-@)
-        else
-          []
-        end
-      end
-    end
-
-    class ServiceMapper
-      def initialize(service_route_set)
-        @service_route_set = service_route_set
-      end
-
-      def rpc(name, to:)
-        mapping = Mapping.new(to: to)
-        @service_route_set.add_route(name, mapping)
-      end
-    end
-
-    class Mapper
-      def initialize(route_set)
-        @route_set = route_set
-      end
-
-      def service(service_definition, &block)
-        service_route_set = @route_set.services[service_definition]
-        service_mapper = ServiceMapper.new(service_route_set)
-        service_mapper.instance_exec(&block)
-      end
-    end
   end
 end

data/lib/rails_twirp/testing/integration_test.rb

@@ -1,6 +1,13 @@
+require "twirp/encoding"
+
 module RailsTwirp
   class IntegrationTest < ActiveSupport::TestCase
+    DEFAULT_HOST = "www.example.com"
+    Response = Struct.new(:status, :body, :headers)
+
     attr_reader :response, :request, :controller
+    attr_writer :mount_path
+    alias :mount_path! :mount_path=
 
     def initialize(name)
       super
@@ -8,9 +15,27 @@ module RailsTwirp
       @before_rpc = []
     end
 
+    def host
+      @host || DEFAULT_HOST
+    end
+    attr_writer :host
+    alias :host! :host=
+
+    def https?
+      @https
+    end
+
+    def https!(value = true)
+      @https = value
+    end
+
     def reset!
       @request = nil
       @response = nil
+      @host = nil
+      @host = nil
+      @https = false
+      @mount_path = "/twirp"
     end
 
     def before_rpc(&block)
@@ -19,25 +44,63 @@ module RailsTwirp
 
     def rpc(service, rpc, request, headers: nil)
       @request = request
-      service = app.twirp.routes.services[service].to_service
-
-      rack_env = {}
-      http_request = ActionDispatch::Request.new(rack_env)
-      http_request.headers.merge! headers if headers.present?
-      env = {rack_env: rack_env}
 
+      env = build_rack_env(service, rpc, request, headers)
       @before_rpc.each do |hook|
         hook.call(env)
       end
 
-      response = service.call_rpc rpc, request, env
-      @response = response
-      @controller = http_request.controller_instance
-      response
+      status, headers, body = app.call(env)
+      @response = decode_rack_response(service, rpc, status, headers, body)
+      set_controller_from_rack_env(env)
+
+      @response
     end
 
     def app
       RailsTwirp.test_app
     end
+
+    private
+
+    def build_rack_env(service, rpc, request, headers)
+      env = {
+        "CONTENT_TYPE" => request_content_type,
+        "HTTPS" => https? ? "on" : "off",
+        "HTTP_HOST" => host,
+        "PATH_INFO" => "#{@mount_path}/#{service.service_full_name}/#{rpc}",
+        "REQUEST_METHOD" => "POST",
+        "SERVER_NAME" => host,
+        "SERVER_PORT" => https? ? "443" : "80",
+        "rack.url_scheme" => https? ? "https" : "http"
+      }
+      if headers.present?
+        http_request = ActionDispatch::Request.new(env)
+        http_request.headers.merge! headers
+      end
+
+      input_class = service.rpcs[rpc][:input_class]
+      env["rack.input"] = StringIO.new(Twirp::Encoding.encode(request, input_class, request_content_type))
+      env
+    end
+
+    def request_content_type
+      Twirp::Encoding::PROTO
+    end
+
+    def decode_rack_response(service, rpc, status, headers, body)
+      body = body.join # body is an Enumerable
+
+      if status === 200
+        output_class = service.rpcs[rpc][:output_class]
+        Twirp::Encoding.decode(body, output_class, headers["Content-Type"])
+      else
+        Twirp::Client.error_from_response(Response.new(status, body, headers))
+      end
+    end
+
+    def set_controller_from_rack_env(env)
+      @controller = ActionDispatch::Request.new(env).controller_class
+    end
   end
 end

data/lib/rails_twirp/url_for.rb

@@ -0,0 +1,17 @@
+require "abstract_controller/url_for"
+
+module RailsTwirp
+  module UrlFor
+    extend ActiveSupport::Concern
+
+    include AbstractController::UrlFor
+
+    def url_options
+      @_url_options ||= {
+        host: http_request.host,
+        port: http_request.optional_port,
+        protocol: http_request.protocol
+      }.merge!(super).freeze
+    end
+  end
+end

data/lib/rails_twirp/version.rb

@@ -1,3 +1,3 @@
 module RailsTwirp
-  VERSION = "0.2.0"
+  VERSION = "0.7.0"
 end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/dummy/app/controllers/application_twirp_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationTwirpController < RailsTwirp::Base
+  rescue_from ActiveRecord::RecordNotFound, with: :handle_not_found
+
+  def handle_not_found
+    error :not_found, "Not found"
+  end
+end

data/test/dummy/app/controllers/pings_controller.rb

@@ -0,0 +1,40 @@
+class PingsController < ApplicationTwirpController
+  before_action :respond_error, only: :before_error
+
+  def ping
+    response = RPC::DummyAPI::PingResponse.new(double_name: request.name * 2)
+    self.response_body = response
+  end
+
+  def ping_render
+    url = rails_twirp_engine_url
+    response = RPC::DummyAPI::PingResponse.new(double_name: "#{url} #{helpers.does_this_work(request.name)}")
+    render pb: response
+  end
+
+  def ping_template
+    @double_name = request.name * 2
+  end
+
+  def error_response
+    error :unauthenticated, "You are not authenticated!!"
+  end
+
+  def raise_error
+    # This error is rescued in ApplicationTwirpController
+    raise ActiveRecord::RecordNotFound, "Not found"
+  end
+
+  def uncaught_raise
+    raise StandardError, "Uncaught"
+  end
+
+  def before_error
+    # This error won't be reached because of the before_action
+    raise NotImplementedError
+  end
+
+  def respond_error
+    error :malformed, "yOuR ReQuEsT Is mAlFoRmEd"
+  end
+end

data/test/dummy/app/controllers/testmod/nested/other_controller.rb

@@ -0,0 +1,10 @@
+module Testmod
+  module Nested
+    class OtherController < ApplicationTwirpController
+      def ping
+        response = RPC::DummyAPI::PingResponse.new(double_name: request.name * 2)
+        self.response_body = response
+      end
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/random_helper.rb

@@ -0,0 +1,5 @@
+module RandomHelper
+  def does_this_work(n)
+    n * 2
+  end
+end

data/test/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/app/views/pings/ping_template.pb.pbbuilder

@@ -0,0 +1 @@
+pb.double_name @double_name

data/test/dummy/bin/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+protoc --twirp_ruby_out=proto/ --ruby_out=proto/ -I proto/ proto/api.proto

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end