disco_app 0.16.0 → 0.16.1.pre.sidekiq.pre.6.pre.release

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ece31304441ed10f09b9391cd7dd60e4f2ee042b8f1fb782d4a3a57508e0018
-  data.tar.gz: 4795ce5f7be894f915acf1b22342902495de3cff322c4c881634ff26458d6457
+  metadata.gz: dc31c69faa480b4a03ebeda1fede57d6c5dbc6f4447dd292de82dfec19f1f178
+  data.tar.gz: cdb8079cf7052deb770d7654823d34fd02858ac0ad2c6c0cbb7b0f78853cc0f2
 SHA512:
-  metadata.gz: 67ddc280601b0dd494535991a9e217d7eeb94732e0113dffbf973a88096c81f9c31771aa4d2b260a5e586ec3ed90b8d088fe60f697034f07682c0d6f451691a9
-  data.tar.gz: 69f2f10799bdc2b57f904b81734af3252b1497aa64963e87b2f2201fe68e8cc9028b6127b9d99d613a9bb8b0a80f1d2e848eacd572faba9ffbd9c9d66cf517b8
+  metadata.gz: 1f59584cd75e4fca892210ee1c140d86fe2dc34fb840a4520e3b91e2efc78a6aae10825acb19bd809df6ae7376e073219cbb91b631a6f18d282fb3aef364b06b
+  data.tar.gz: e912f48e0bb236cd6753692db5c4c61e05973c0e09939e88ca6b86f88631800bafa303672632b962de12abd296a3a9a5b7c31995a676dac710f4aa1838036d1b

data/app/clients/disco_app/graphql_client.rb

@@ -0,0 +1,85 @@
+require 'rest-client'
+
+##
+# This file defines a very simple GraphQL API client to support a single type
+# of GraphQL API call for a Shopify store - sending a Shopify Flow trigger.
+#
+# We use this simple approach rather than using an existing GraphQL client
+# library such as https://github.com/github/graphql-client (either standalone
+# or as bundled with the Shopify API gem) for a couple of reasons:
+#
+#   - These libraries tend to presume that a single client instance is
+#     instantiated once and then reused across the application, which isn't the
+#     case when we're making API calls once per trigger for each background
+#     job.
+#   - These libraries make an API call to fetch the Shopify GraphQL schema on
+#     initialisation. The schema is very large, so the API call takes a number
+#     of seconds to complete and when parsed consumes a large amount of memory.
+#   - These libraries do not natively work well with the idea of a dynamic API
+#     endpoint (ie, changing the request URL frequently), which is required
+#     when making many requests to different Shopify stores.
+#
+module DiscoApp
+  class GraphqlClient
+
+    def initialize(shop)
+      @shop = shop
+    end
+
+    ##
+    # Fire a Shopify Flow Trigger.
+    # Returns a tuple {Boolean, Array} representing {success, errors}.
+    def create_flow_trigger(title, resource_name, resource_url, properties)
+      body = {
+        trigger_title: title,
+        resources: [
+          {
+            name: resource_name,
+            url: resource_url
+          }
+        ],
+        properties: properties
+      }
+
+      # The double .to_json.to_json below looks odd but is required to properly escape the JSON hash
+      # when inserting it into the GraphQL mutation call.
+      response = execute(%Q(
+        mutation {
+          flowTriggerReceive(body: #{body.to_json.to_json}) {
+            userErrors {
+              field,
+              message
+            }
+          }
+        }
+      ))
+
+      errors = response.dig(:data, :flowTriggerReceive, :userErrors)
+      [errors.empty?, errors]
+    end
+
+    private
+
+      def execute(query)
+        response = RestClient::Request.execute(
+          method: :post,
+          headers: headers,
+          url: url,
+          payload: { query: query }.to_json
+        )
+        JSON.parse(response.body).with_indifferent_access
+      end
+
+      def headers
+        {
+          'Content-Type' => 'application/json',
+          'X-Shopify-Access-Token' => @shop.shopify_token
+        }
+      end
+
+      def url
+        "https://#{@shop.shopify_domain}/admin/api/graphql.json"
+      end
+
+  end
+end

data/app/controllers/disco_app/flow/actions_controller.rb

@@ -0,0 +1,7 @@
+module DiscoApp
+  module Flow
+    class ActionsController < ActionController::Base
+      include DiscoApp::Flow::Concerns::ActionsController
+    end
+  end
+end

data/app/controllers/disco_app/flow/concerns/actions_controller.rb

@@ -0,0 +1,47 @@
+module DiscoApp
+  module Flow
+    module Concerns
+      module ActionsController
+
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :verify_flow_action
+          before_action :find_shop
+          protect_from_forgery with: :null_session
+        end
+
+        def create_flow_action
+          DiscoApp::Flow::CreateAction.call(
+            shop: @shop,
+            action_id: params[:id],
+            action_run_id: params[:action_run_id],
+            properties: params[:properties]
+          )
+
+          head :ok
+        end
+
+        private
+
+          def verify_flow_action
+            unless flow_action_is_valid?
+              head :unauthorized
+            end
+            request.body.rewind
+          end
+
+          # Shopify Flow action endpoints use the same verification method as webhooks, which is why we reuse this
+          # service method here.
+          def flow_action_is_valid?
+            DiscoApp::WebhookService.is_valid_hmac?(request.body.read.to_s, ShopifyApp.configuration.secret, request.headers['HTTP_X_SHOPIFY_HMAC_SHA256'])
+          end
+
+          def find_shop
+            @shop = DiscoApp::Shop.find_by_shopify_domain!(params[:shopify_domain])
+          end
+
+      end
+    end
+  end
+end

data/app/jobs/disco_app/flow/process_action_job.rb

@@ -0,0 +1,11 @@
+module DiscoApp
+  module Flow
+    class ProcessActionJob < DiscoApp::ShopJob
+
+      def perform(_shop, action)
+        ProcessAction.call(action: action)
+      end
+
+    end
+  end
+end

data/app/jobs/disco_app/flow/process_trigger_job.rb

@@ -0,0 +1,11 @@
+module DiscoApp
+  module Flow
+    class ProcessTriggerJob < DiscoApp::ShopJob
+
+      def perform(_shop, trigger)
+        ProcessTrigger.call(trigger: trigger)
+      end
+
+    end
+  end
+end

data/app/jobs/disco_app/shop_job.rb

@@ -1,10 +1,10 @@
+require 'appsignal'
+
 # The base class for all jobs that should be performed in the context of a
 # particular Shop's API session. The first argument to any job inheriting from
 # this class must be the domain of the relevant store, so that the appropriate
 # Shop model can be fetched and the temporary API session created.
 
-require 'rollbar'
-
 class DiscoApp::ShopJob < ApplicationJob
 
   queue_as :default
@@ -22,13 +22,12 @@ class DiscoApp::ShopJob < ApplicationJob
     end
 
     def shop_context(job, block)
-      Rollbar.scoped(rollbar_scope) do
-        @shop.with_api_context { block.call(job.arguments) }
-      end
-    end
-
-    def rollbar_scope
-      { person: { id: @shop.id, username: @shop.shopify_domain } }
+      Appsignal.tag_request(
+        shop_id: @shop.id,
+        shopify_domain: @shop.shopify_domain
+      )
+      
+      @shop.with_api_context { block.call(job.arguments) }
     end
 
 end

data/app/models/disco_app/concerns/shop.rb

@@ -15,6 +15,10 @@ module DiscoApp::Concerns::Shop
     # Define relationship to sessions.
     has_many :sessions, class_name: 'DiscoApp::Session', dependent: :destroy
 
+    # Define relationship to Flow actions and triggers.
+    has_many :flow_actions, class_name: 'DiscoApp::Flow::Action', dependent: :destroy
+    has_many :flow_triggers, class_name: 'DiscoApp::Flow::Trigger', dependent: :destroy
+
     # Define possible installation statuses as an enum.
     enum status: {
       never_installed: 0,
@@ -73,11 +77,6 @@ module DiscoApp::Concerns::Shop
       "https://#{shopify_domain}/admin"
     end
 
-    # Convenience method to get the email of the shop's admin, to display in Rollbar.
-    def email
-      data[:email]
-    end
-
     def installed_duration
       distance_of_time_in_words_to_now(created_at.time)
     end

data/app/models/disco_app/flow/action.rb

@@ -0,0 +1,7 @@
+module DiscoApp
+  module Flow
+    class Action < ApplicationRecord
+      include DiscoApp::Flow::Concerns::Action
+    end
+  end
+end

data/app/models/disco_app/flow/concerns/action.rb

@@ -0,0 +1,24 @@
+module DiscoApp
+  module Flow
+    module Concerns
+      module Action
+        extend ActiveSupport::Concern
+
+        included do
+
+          belongs_to :shop
+
+          self.table_name = :disco_app_flow_actions
+
+          enum status: {
+            pending: 0,
+            succeeded: 1,
+            failed: 2
+          }
+
+        end
+
+      end
+    end
+  end
+end

data/app/models/disco_app/flow/concerns/trigger.rb

@@ -0,0 +1,24 @@
+module DiscoApp
+  module Flow
+    module Concerns
+      module Trigger
+        extend ActiveSupport::Concern
+
+        included do
+
+          belongs_to :shop
+
+          self.table_name = :disco_app_flow_triggers
+
+          enum status: {
+            pending: 0,
+            succeeded: 1,
+            failed: 2
+          }
+
+        end
+
+      end
+    end
+  end
+end

data/app/models/disco_app/flow/trigger.rb

@@ -0,0 +1,7 @@
+module DiscoApp
+  module Flow
+    class Trigger < ApplicationRecord
+      include DiscoApp::Flow::Concerns::Trigger
+    end
+  end
+end

data/app/services/disco_app/flow/create_action.rb

@@ -0,0 +1,35 @@
+require 'interactor'
+
+module DiscoApp
+  module Flow
+    class CreateAction
+
+      include Interactor
+
+      delegate :shop, :action_id, :action_run_id, :properties, to: :context
+      delegate :action, to: :context
+
+      def call
+        create_action
+        enqueue_process_action_job
+      end
+
+      private
+
+        def create_action
+          context.action = shop.flow_actions.create!(
+            action_id: action_id,
+            action_run_id: action_run_id,
+            properties: properties
+          )
+        rescue ActiveRecord::RecordNotUnique, PG::UniqueViolation
+          context.fail!
+        end
+
+        def enqueue_process_action_job
+          ProcessActionJob.perform_later(shop, action)
+        end
+
+    end
+  end
+end

data/app/services/disco_app/flow/create_trigger.rb

@@ -0,0 +1,34 @@
+require 'interactor'
+
+module DiscoApp
+  module Flow
+    class CreateTrigger
+
+      include Interactor
+
+      delegate :shop, :title, :resource_name, :resource_url, :properties, to: :context
+      delegate :trigger, to: :context
+
+      def call
+        create_trigger
+        enqueue_process_trigger_job
+      end
+
+      private
+
+        def create_trigger
+          context.trigger = shop.flow_triggers.create!(
+            title: title,
+            resource_name: resource_name,
+            resource_url: resource_url,
+            properties: properties
+          )
+        end
+
+        def enqueue_process_trigger_job
+          ProcessTriggerJob.perform_later(shop, trigger)
+        end
+
+    end
+  end
+end

data/app/services/disco_app/flow/process_action.rb

@@ -0,0 +1,50 @@
+require 'interactor'
+
+module DiscoApp
+  module Flow
+    class ProcessAction
+
+      include Interactor
+
+      delegate :action, to: :context
+      delegate :action_service_class, to: :context
+
+      def call
+        validate_action
+        find_action_service_class
+        execute_action_service_class
+      end
+
+      private
+
+        def validate_action
+          context.fail! unless action.pending?
+        end
+
+        def find_action_service_class
+          context.action_service_class =
+            action.action_id.classify.safe_constantize ||
+            %Q(Flow::Actions::#{("#{action.action_id}".classify)}).safe_constantize
+
+          if action_service_class.nil?
+            update_action(false, ["Could not find service class for #{action.action_id}"])
+            context.fail!
+          end
+        end
+
+        def execute_action_service_class
+          result = action_service_class.call(shop: action.shop, properties: action.properties)
+          update_action(result.success?, result.errors)
+        end
+
+        def update_action(success, errors)
+          action.update!(
+            status: success ? Action.statuses[:succeeded] : Action.statuses[:failed],
+            processing_errors: success ? [] : errors,
+            processed_at: Time.current
+          )
+        end
+
+    end
+  end
+end

data/app/services/disco_app/flow/process_trigger.rb

@@ -0,0 +1,52 @@
+require 'interactor'
+
+module DiscoApp
+  module Flow
+    class ProcessTrigger
+
+      include Interactor
+
+      delegate :trigger, to: :context
+      delegate :api_success, :api_errors, to: :context
+
+      def call
+        validate_trigger
+        make_api_request
+        update_trigger
+        fail_if_errors_present
+      end
+
+      private
+
+        def validate_trigger
+          context.fail! unless trigger.pending?
+        end
+
+        def make_api_request
+          context.api_success, context.api_errors = api_client.create_flow_trigger(
+            trigger.title,
+            trigger.resource_name,
+            trigger.resource_url,
+            trigger.properties
+          )
+        end
+
+        def update_trigger
+          trigger.update!(
+            status: api_success ? Trigger.statuses[:succeeded] : Trigger.statuses[:failed],
+            processing_errors: api_success ? [] : api_errors,
+            processed_at: Time.current
+          )
+        end
+
+        def fail_if_errors_present
+          context.fail! unless api_success
+        end
+
+        def api_client
+          @api_client ||= DiscoApp::GraphqlClient.new(trigger.shop)
+        end
+
+    end
+  end
+end

data/config/routes.rb

@@ -9,6 +9,12 @@ DiscoApp::Engine.routes.draw do
     post 'webhooks' => :process_webhook, as: :webhooks
   end
 
+  namespace :flow do
+    controller :actions do
+      post 'actions/:id' => :create_flow_action, as: :flow_actions
+    end
+  end
+
   resources :user_sessions, only: [:new, :create, :destroy]
   get 'auth/shopify_user/callback' => 'user_sessions#callback'
 
@@ -46,7 +52,7 @@ DiscoApp::Engine.routes.draw do
   end
 
   # Make the Sidekiq Web UI accessible using the same credentials as the admin.
-  if Rails.env.production? || Rails.env.staging? 
+  if Rails.env.production? || Rails.env.staging?
     Sidekiq::Web.use Rack::Auth::Basic do |username, password|
       [
         ENV['ADMIN_APP_USERNAME'].present?,

data/db/migrate/20181229100327_create_flow_actions_and_triggers.rb

@@ -0,0 +1,32 @@
+class CreateFlowActionsAndTriggers < ActiveRecord::Migration[5.2]
+
+  def change
+    create_table :disco_app_flow_actions do |t|
+      t.integer :shop_id, limit: 8
+      t.string :action_id
+      t.string :action_run_id
+      t.jsonb :properties, default: {}
+      t.integer :status, default: 0
+      t.datetime :processed_at, null: true
+      t.jsonb :processing_errors, default: []
+      t.timestamps null: false
+    end
+
+    create_table :disco_app_flow_triggers do |t|
+      t.integer :shop_id, limit: 8
+      t.string :title
+      t.string :resource_name
+      t.string :resource_url
+      t.jsonb :properties, default: {}
+      t.integer :status, default: 0
+      t.datetime :processed_at, null: true
+      t.jsonb :processing_errors, default: []
+      t.timestamps null: false
+    end
+
+    add_foreign_key :disco_app_flow_actions, :disco_app_shops, column: :shop_id, on_delete: :cascade
+    add_foreign_key :disco_app_flow_triggers, :disco_app_shops, column: :shop_id, on_delete: :cascade
+    add_index :disco_app_flow_actions, :action_run_id, unique: true
+  end
+
+end

data/lib/disco_app/configuration.rb

@@ -8,6 +8,10 @@ module DiscoApp
     # Set the list of Shopify webhook topics to register.
     attr_accessor :webhook_topics
 
+    # Set Flow configuration
+    attr_accessor :flow_actions
+    attr_accessor :flow_triggers
+
     # Set the below if using an application proxy.
     attr_accessor :app_proxy_prefix
 

data/lib/disco_app/version.rb

@@ -1,3 +1,3 @@
 module DiscoApp
-  VERSION = '0.16.0'
+  VERSION = '0.16.1-sidekiq-6-release'
 end

data/lib/generators/disco_app/disco_app_generator.rb

@@ -41,7 +41,7 @@ class DiscoAppGenerator < Rails::Generators::Base
     gem 'premailer-rails'
     gem 'react-rails'
     gem 'render_anywhere'
-    gem 'rollbar'
+    gem 'appsignal'
     gem 'shopify_app'
     gem 'sidekiq'
 
@@ -156,7 +156,7 @@ class DiscoAppGenerator < Rails::Generators::Base
     application configuration, env: :staging
 
     # Monitoring configuration
-    copy_file 'initializers/rollbar.rb', 'config/initializers/rollbar.rb'
+    copy_file 'config/appsignal.yml', 'config/appsignal.yml'
     copy_file 'config/newrelic.yml', 'config/newrelic.yml'
   end
 

data/lib/generators/disco_app/templates/config/appsignal.yml

@@ -0,0 +1,12 @@
+default: &defaults
+  name: <%= ENV['SHOPIFY_APP_NAME'] || 'Unknown App' %>
+  push_api_key: <%= ENV['APPSIGNAL_PUSH_API_KEY'] %>
+  development:
+    <<: *defaults
+    active: false
+  staging:
+    <<: *defaults
+    active: true
+  production:
+    <<: *defaults
+    active: true

data/lib/generators/disco_app/templates/root/.env

@@ -18,3 +18,6 @@ REDIS_PROVIDER=
 DISCO_API_URL=
 
 WHITELISTED_DOMAINS=
+
+# You can find this listed in 1Password
+APPSIGNAL_PUSH_API_KEY=