# Copyright 2017 Google LLC
#
# 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
#
#     https://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 "google/cloud/debugger"

module Google
  module Cloud
    module Debugger
      ##
      # # Railtie
      #
      # Google::Cloud::Debugger::Railtie automatically adds the
      # Google::Cloud::Debugger::Middleware to Rack in a Rails environment.
      #
      # The Middleware is only added when the
      # `Google::Cloud.configure.use_debugger` setting is true or Rails is
      # in the production environment.
      #
      # When loaded, the Google::Cloud::Debugger::Middleware will be inserted
      # after the Rack::ETag Middleware, which is top of the Rack stack, closest
      # to the application code.
      #
      # The Railtie should also initialize a debugger to be used by the
      # Middleware. See the [Configuration
      # Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)
      # on how to configure the Railtie and Middleware.
      #
      class Railtie < ::Rails::Railtie
        ##
        # Inform the Railtie that it is safe to start debugger agents.
        # This simply calls {Google::Cloud::Debugger::Middleware.start_agents}.
        # See its documentation for more information.
        #
        def self.start_agents
          Google::Cloud::Debugger::Middleware.start_agents
        end

        config.google_cloud = ::ActiveSupport::OrderedOptions.new unless
          config.respond_to? :google_cloud
        config.google_cloud[:debugger] = ::ActiveSupport::OrderedOptions.new
        config.google_cloud.define_singleton_method :debugger do
          self[:debugger]
        end

        initializer "Stackdriver.Debugger" do |app|
          self.class.consolidate_rails_config app.config

          self.class.init_middleware app if Cloud.configure.use_debugger
        end

        ##
        # @private Init Debugger integration for Rails. Setup configuration and
        # insert the Middleware.
        def self.init_middleware app
          app.middleware.insert_after Rack::ETag,
                                      Google::Cloud::Debugger::Middleware
        end

        ##
        # @private Consolidate Rails configuration into Debugger instrumentation
        # configuration. Also consolidate the `use_debugger` setting by
        # verifying credentials and Rails environment. The `use_debugger`
        # setting will be true if credentials are valid, and the setting is
        # manually set to true or Rails is in the production environment.
        #
        # @param [Rails::Railtie::Configuration] config The
        #   Rails.application.config
        #
        def self.consolidate_rails_config config
          merge_rails_config config

          init_default_config

          # Done if Google::Cloud.configure.use_debugger is explicitly
          # false
          return if Google::Cloud.configure.use_debugger == false

          # Verify credentials and set use_debugger to false if
          # credentials are invalid
          unless valid_credentials? Debugger.configure.project_id,
                                    Debugger.configure.credentials
            Cloud.configure.use_debugger = false
            return
          end

          # Otherwise set use_debugger to true if Rails is running in
          # the production environment
          Google::Cloud.configure.use_debugger ||= ::Rails.env.production?
        end

        # rubocop:disable all

        ##
        # @private Merge Rails configuration into Debugger instrumentation
        # configuration.
        def self.merge_rails_config rails_config
          gcp_config = rails_config.google_cloud
          dbg_config = gcp_config.debugger

          if Cloud.configure.use_debugger.nil?
            Cloud.configure.use_debugger = gcp_config.use_debugger
          end
          Debugger.configure do |config|
            config.project_id ||= begin
              config.project || dbg_config.project_id || dbg_config.project
                gcp_config.project_id || gcp_config.project
            end
            config.credentials ||= begin
              config.keyfile || dbg_config.credentials || dbg_config.keyfile
                gcp_config.credentials || gcp_config.keyfile
            end
            config.service_name ||= \
              (dbg_config.service_name || gcp_config.service_name)
            config.service_version ||= \
              (dbg_config.service_version || gcp_config.service_version)
          end
        end

        # rubocop:enable all

        ##
        # Fallback to default config values if config parameters not provided.
        def self.init_default_config
          config = Debugger.configure
          config.project_id ||= Debugger.default_project_id
          config.service_name ||= Debugger.default_service_name
          config.service_version ||= Debugger.default_service_version
        end

        ##
        # @private Verify credentials
        def self.valid_credentials? project_id, credentials
          begin
            # if credentials is nil, get default
            credentials ||= Debugger::Credentials.default
            # only create a new Credentials object if the val isn't one already
            unless credentials.is_a? Google::Auth::Credentials
              # if credentials is not a Credentials object, create one
              Debugger::Credentials.new credentials
            end
          rescue StandardError => e
            STDOUT.puts "Note: Google::Cloud::Debugger is disabled because " \
              "it failed to authorize with the service. (#{e.message})"
            return false
          end

          if project_id.to_s.empty?
            STDOUT.puts "Note: Google::Cloud::Debugger is disabled because " \
              "the project ID could not be determined."
            return false
          end

          true
        end

        private_class_method :merge_rails_config,
                             :init_default_config,
                             :valid_credentials?
      end
    end
  end
end