rails_twirp 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aa4bf745efcab88ddcf8cc58f6bf76e482901d37c8736102a5c32a6f20d0892
-  data.tar.gz: 8d6dbf635e44bf444d16d2eeaa7046a53027767745972a7add35e204ae73eaec
+  metadata.gz: 78af7d754c6fbaf90cbf22f5ef83b116c54840ab97fc2daffb09a5a37bcd7c91
+  data.tar.gz: '0078e09678ea09ccda0d2db94c1ff241222cf3074f4febd580197efc9d257cd1'
 SHA512:
-  metadata.gz: b48547bdb5e77c0c508f1e5dcdce7b01a692d94ce79aac38f837b0397adb696a6f68d36f116e02221ed24c04152b8fb3cdb77072bfbda81fe4b5247bcf359c1e
-  data.tar.gz: e4ed631582628257e281c78201177f351a6855f9bb9ebdfe6bb3ca0bc52349a59f56995cbcaa8c781640308bd4f032cd8fee7d5bc18191bb239082874379e2bc
+  metadata.gz: fd943fdaa9b54614c268b6d7471bec3726bffb2125f5afa6992b9b30db2c03bbc2027869e1b23f449addf81cd2140d3abe97677f35d6a5ba924be515b01998b4
+  data.tar.gz: ab7b4e53cdfc9eb84a6f4875674b643c668adc15f103cf60ba367078393e23257477b13a0eb5355e69248eb1250feb73a37eb5e689a7a501cd9236c4630a600a

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Ruby Test
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+          bundler-cache: true
+
+      - name: Run tests
+        run: bin/test
+
+      - name: Run standardrb
+        run: bundle exec standardrb

data/.gitignore

@@ -11,3 +11,4 @@
 .byebug_history
 Gemfile.lock
 *.gem
+/.idea

data/.standard.yml

@@ -0,0 +1,4 @@
+ignore:
+  - 'test/dummy/proto/*'
+  - '**/*':
+    - Lint/RescueException

data/Gemfile

@@ -1,8 +1,8 @@
 source "https://rubygems.org"
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Specify your gem's dependencies in rails_twirp.gemspec.
 gemspec
 
-# To use a debugger
-# gem 'byebug', group: [:development, :test]
+gem "sqlite3"
+gem "pbbuilder", "~> 0.3.0"
+gem "standard"

data/lib/rails_twirp.rb

@@ -1,5 +1,6 @@
 require "rails_twirp/version"
 
+require "rails_twirp/application"
 require "rails_twirp/base"
 require "rails_twirp/route_set"
 require "rails_twirp/testing/integration_test"

data/lib/rails_twirp/base.rb

@@ -1,13 +1,33 @@
+require "abstract_controller/base"
+require "abstract_controller/rendering"
+require "action_view/rendering"
+require "rails_twirp/render_pb"
+require "rails_twirp/errors"
+require "abstract_controller/asset_paths"
+require "abstract_controller/caching"
+require "abstract_controller/logger"
+require "abstract_controller/callbacks"
+require "rails_twirp/rescue"
+
 module RailsTwirp
   class Base < AbstractController::Base
     abstract!
 
-    include AbstractController::Logger
-    include AbstractController::AssetPaths
-    include AbstractController::Callbacks
-    include AbstractController::Caching
+    # The order of these includes matter.
+    # The rendering modules extend each other, so need to be in this order.
     include AbstractController::Rendering
     include ActionView::Rendering
+    include RenderPb
+    include Errors
+
+    # These add helpers for the controller
+    include AbstractController::AssetPaths
+    include AbstractController::Caching
+    include AbstractController::Logger
+
+    # These need to be last so errors can be handled as early as possible.
+    include AbstractController::Callbacks
+    include Rescue
 
     attr_internal :request, :env, :response_class
     def initialize
@@ -35,16 +55,15 @@ module RailsTwirp
       response_body
     end
 
-    def render(*args)
-      options = {formats: :pb, handlers: :pbbuilder, locals: {response_class: response_class}}
-      options.deep_merge! args.extract_options!
-      super(*args, options)
-    end
-
     def self.dispatch(action, request, response_class, env = {})
       new.dispatch(action, request, response_class, env)
     end
 
+    # Used by the template renderer to figure out which template to use
+    def details_for_lookup
+      {formats: [:pb], handlers: [:pbbuilder]}
+    end
+
     ActiveSupport.run_load_hooks(:rails_twirp, self)
   end
 end

data/lib/rails_twirp/engine.rb

@@ -1,5 +1,6 @@
-require "rails/railtie"
 require "rails_twirp/application"
+require "rails_twirp/route_set"
+require "rails/railtie"
 
 module RailsTwirp
   # Even though this is an engine, we don't inherit from Rails::Engine because we don't want anything it provides.
@@ -26,8 +27,11 @@ module RailsTwirp
       app.config.paths.add "app/twirp/views", load_path: true
     end
 
-    initializer :set_controller_view_path do
-      ActiveSupport.on_load(:rails_twirp) { prepend_view_path "app/twirp/views" }
+    initializer :set_controller_view_path do |app|
+      views = app.config.paths["app/twirp/views"].existent
+      unless views.empty?
+        ActiveSupport.on_load(:rails_twirp) { prepend_view_path views }
+      end
     end
 
     initializer :add_twirp do |app|
@@ -37,11 +41,12 @@ module RailsTwirp
 
     initializer :load_twirp_routes do |app|
       # Load route files
-      route_configs = [
+      [
         *app.config.paths["config/twirp/routes.rb"].existent,
         *app.config.paths["config/twirp/routes"].existent
-      ]
-      load(*route_configs)
+      ].each do |path|
+        load path
+      end
 
       # Create a router that knows how to route all the registered services
       services = app.twirp.routes.to_services

data/lib/rails_twirp/errors.rb

@@ -0,0 +1,11 @@
+require "twirp/error"
+
+module RailsTwirp
+  module Errors
+    # Helper that sets the response to a Twirp Error
+    # The valid error codes can be found in Twirp::ERROR_CODES
+    def error(code, message, meta = nil)
+      self.response_body = Twirp::Error.new(code, message, meta)
+    end
+  end
+end

data/lib/rails_twirp/render_pb.rb

@@ -0,0 +1,18 @@
+module RailsTwirp
+  # RenderPb makes it possible to do 'render pb: <proto object>', skipping templates
+  # The way this module is written is inspired by ActionController::Renderers
+  module RenderPb
+    def render_to_body(options)
+      _render_to_body_with_pb(options) || super
+    end
+
+    def _render_to_body_with_pb(options)
+      if options.include? :pb
+        _process_options(options)
+        return options[:pb]
+      end
+
+      nil
+    end
+  end
+end

data/lib/rails_twirp/rescue.rb

@@ -0,0 +1,14 @@
+module RailsTwirp
+  module Rescue
+    extend ActiveSupport::Concern
+    include ActiveSupport::Rescuable
+
+    private
+
+    def process_action(*)
+      super
+    rescue Exception => exception
+      rescue_with_handler(exception) || raise
+    end
+  end
+end

data/lib/rails_twirp/route_set.rb

@@ -1,6 +1,8 @@
 # Most of this logic is stolen from Rails ActionDispatch::Routing::RouteSet
 
 module RailsTwirp
+  class UnknownRpcError < StandardError; end
+
   class RouteSet
     attr_reader :services
 
@@ -42,6 +44,7 @@ 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

data/lib/rails_twirp/testing/integration_test.rb

@@ -30,7 +30,12 @@ module RailsTwirp
         hook.call(env)
       end
 
-      response = service.call_rpc rpc, request, env
+      response = begin
+        service.call_rpc rpc, request, env
+      rescue => e
+        Twirp::Error.internal_with(e)
+      end
+
       @response = response
       @controller = http_request.controller_instance
       response

data/lib/rails_twirp/version.rb

@@ -1,3 +1,3 @@
 module RailsTwirp
-  VERSION = "0.2.0"
+  VERSION = "0.3.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,39 @@
+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
+    response = RPC::DummyAPI::PingResponse.new(double_name: request.name * 2)
+    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/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+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/twirp/views/pings/ping_template.pb.pbbuilder

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

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/bin/generate

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