zuora_connect 3.0.0.pre.m → 3.0.0.pre.r

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa8acf1336b53b9d3407afba6a37d962a74434e087974a5810955c20c7e5e2f1
-  data.tar.gz: e3c8f1a30f247c68e78891244e01fdded4c1c5b76ede6540f1808aed255b987d
+  metadata.gz: 8b3516f74913531168adf62cf95a28fe805018ab49ec723c9083d8f80064c158
+  data.tar.gz: 78e7f843dcfdd421d3dd80eb868afba810c68f6b85783a5efb645f93bf3c6097
 SHA512:
-  metadata.gz: 525866e7f02a4ad82b6d8920ee372f091a6f1216c6ae851149b5e5835f71db237c2d4313039abf0b30279f030f7f6994669a8dc38728fea3c427a1402d40bc44
-  data.tar.gz: fec0a295b4a3493c9b15320e4cd4578396795f63af4e9ad58fbcd88627b16ba7e7ab72bf7826efc85efe3501c26ba65cab47a88c8bf06a8f8fce7df7417eb7ce
+  metadata.gz: e6760f6ae414ea0362a93f4ed28d6345d3cf2247e9bac4bcb4e927159da124507fb342ba3a8237176885aa9a8d1fd389a8c629c1cedf97914d6d48757e9d95b0
+  data.tar.gz: 7b92aebfc8426957e86dec98a6f8251e124094deee5b55776e65c6e5bd2d3d6615bc08740d9658766d7164d10d4193f8591d096702a2c605c4426d2c07cf4f53

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016 Matthew Ingle
+Copyright 2021 Zuora, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,219 @@
+# Connect Gem
+
+[![Gem Version](https://badge.fury.io/rb/zuora_connect.svg)](https://badge.fury.io/rb/zuora_connect)
+
+## Requirements
+This gem requires a postgres database
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zuora_connect'
+```
+
+Then execute `bundle install` in your terminal
+
+## How to contribute to this repository
+https://confluence.zuora.com/pages/viewpage.action?spaceKey=ZCP&title=Pushing+to+GIT
+
+## Configuration
+
+### Settings
+This gem can be configured by adding `connect.rb` to the `config/initializers` folder. An example file and the available options can be seen below.
+```ruby
+ZuoraConnect.configure do |config|
+  config.url = ""
+  config.delayed_job = false
+  config.default_time_zone = Time.zone
+  config.default_locale = :en
+  config.timeout = 5.minutes
+  config.private_key = ""
+  config.mode = "Production"
+  config.dev_mode_logins = { "target_login" => {"tenant_type" => "Zuora", "username" => "user", "password" => "pass", "url" => "url"} }
+  config.dev_mode_options = {"name" => {"config_name" => "name", "datatype" => "type", "value" => "value"}}
+  config.dev_mode_mode = "Universal"
+end
+```
+
+|        Option        |                         Description                         | Required |                                      Values                                            |           Default           |                  Example                   |
+| -------------------- | ----------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------- | --------------------------- | ------------------------------------------ |
+| url                  | URL for the gem to connect to                               | Optional | https://connect.zuora.com <br/> https://connect-staging.zuora.com <br/> localhost:3000 | "https://connect.zuora.com" | config.url = `"https://connect.zuora.com"` |
+| delayed_job          | Used to indicate if Delayed Job is used by this Application | Optional | true or false | `true`| `config.delayed_job - true`|
+| default_time_zone    | Used to indicate the default timezone for the application   | Optional | A valid time zone object | `Time.zone`| `config.default_time_zone = Time.zone`     |
+| default_locale       | Used to indicate the default locale for the application     | Optional | A valid locale| `:en`| `config.default_locale = :en`|
+| private_key| Used to indicate the private key to use when decrypting the data payload|Required for Production| A valid private key| `nil`|`config.private_key = File.open(#{Rails.root/private_key})`|
+| timeout|Used to indicate the amount of time the current session stays active before syncing with ZuoraConnect| Optional |ActiveSupport::Duration |`5.minutes`|`config.timeout = 1.hour`|
+| mode|Used to indicate current environment the gem should run against|Optional |Production or Development|`"Production"`|`config.mode = "Development"`|
+| dev_mode_appinstance|Used to indicate the schema name to use when in development mode|Optional|String|`"1"` |`config.dev_mode_appinstance = "1"`|
+| dev_mode_admin|Used to indicate if admin mode should be turned on in development mode. This will cause all admin calls to be evaluated to true when displaying admin only elements in your application.|Optional|true or false|`false`|`config.dev_mode_admin = true`|
+| dev_mode_pass|Used to mock up the users ZuoraConnect password|Optional |String|`"Test"`|`config.dev_mode_pass = "password1"`|
+| dev_mode_user|Used to mock up the users ZuoraConnect username|Optional|String|`"Test"`|`config.dev_mode_user = "User1"`|
+| dev_mode_logins|Used to mock up the login payload from ZuoraConnect|Optional|Hash|`nil`| `config.dev_mode_logins=  { "target_login" => {"tenant_type" => "Zuora","username" => "user","password" => "pass","url" => "url"}}`
+| dev_mode_mode|Used to mock up the mode passed from ZuoraConnect|Optional |String|`"Universal" `|`config.dev_mode_mode = "Mode2"`|
+| dev_mode_options|Used to mock up the options payload from ZuoraConnect|Optional |Hash|`nil`|'config.dev_mode_options ={"name" => {"config_name" => "name","datatype" => "type","value" => "value"}}'|
+
+
+### Controller Setup
+The following controllers should have the below lines added to them
+
+#### Application Controller ( `controllers/application_controller.rb`)
+```ruby
+before_action :authenticate_connect_app_request
+after_action :persist_connect_app_session
+```
+
+#### Admin controllers
+```ruby
+before_action :check_connect_admin!
+```
+
+#### Admin actions inside a controllers
+
+```ruby
+before_action :check_connect_admin!, :only => [:logs]
+```
+#### API Controller
+```ruby
+before_action :authenticate_app_api_request
+```
+
+An explanation of the available before_filters and what they do can be found below
+
+|             Name             |                                                                                                                                       Description                                                                                                                                       |
+| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| authenticate_app_api_request | Authenticates the incoming request, handles data segmentation, and creates the @appinstance global variable                                                                                                                                                                             |
+| persist_connect_app_session  | Saves the current user session for use after every request so that every request does not require authentication with Connect. Instead authentication to Connect is done based on the timeout value of the session set in the configuration steps above                                 |
+| check_connect_admin          | Checks if the user is labeled as an admin as deemed by the encrypted request payload coming from Connect. This filter is used to lock down certain functionality that only the Developer should have access to. <br/> Returns false if the user is not an admin                          |
+| check_connect_admin!         | The filter works the same as the above but instead raises an exception `ZuoraConnect::Exceptions::AccessDenied`                                                                                                                                                                         |
+| authenticate_app_api_request | Authenticates the incoming API request based on the token passed in. The token must match a token associate to one of the available app instances. This token is stored on the app instance object as api_token. More information can be found in the API authentication section below. |
+
+## Usage
+
+The Connect gem provides an integration with ZuoraConnect by allowing the application to read data from Connect and make the appropriate API calls.
+
+### Data Segmentation
+
+The Connect Gem provides an integration with ZuoraConnect by allowing the application to read data from Connect and make the appropriate API calls.
+
+### The App Instance object
+
+#### Methods and Attributes
+
+|     Name     |    Type     | Description  |           Example           |
+| ------------ | ----------- | ------------ | --------------------------- |
+| new_session  | `Method`    |              | @appinstance.new_sesion     |
+| updateOption | `Method`    |              | @appinstance.updateOption() |
+| options      | `Attribute` |              | @appinstance.options        |
+| mode         | `Attribute` |              | @appinstance.mode           |
+| logins       | `Attribute` |              | @appinstance.logins         |
+| task_data    | `Attribute` |              | @appinstance.task_data      |
+| token        | `Attribute` | `DEPRECATED` | @appinstance.token          |
+| api_token    | `Attribute` |              | @appinstance.api_token      |
+
+#### Accessing the Object
+
+The `@appinstance` object is accessible in every View and Controller in your application. In order to access `@appinstance` in a Model it must be pulled out of the current thread by doing the following:
+```ruby
+@appinstance = Thread.current[:appinstance]
+```
+### Login Object
+
+All Login information available to your app is passed from connect in a hash in the form `{:target_login => data, :source_login => data}`. It is important to note that target_login and source_login can be variable and that any number of logins can be passed to your application as defined by Connect. For example the following use case could exist: `{:zuora_login => data, :system1_login => data,:system2_login => data}`. This information can be retrieved by the @appinstance object through a call similiar to this `@appinstance.system2_login`. This removes the requirement of using `@appinstance.logins `and looping through the returned hash if you are aware of the logins that Connect will be sending your application.
+
+Each login is mapped as a login object associated to the `@appinstance` object. Every attribute associated to this object passed from Connect is available on this object as an attribute. At a minimum the below attributes will be available
+
+
+|    Name     |                Description                 |
+| ----------- | ------------------------------------------ |
+| tenant_type | Login type such as "Zuora" or "Salesforce" |
+| username    | The username                               |
+| password    | The password                               |
+| url         | Endpoint or URL                            |
+
+#### Zuora logins
+The Connect Gem has built-in integration with the Zuora gem and automatically creates a ZuoraLogin object for every Zuora login. This can be accessed by executing something similiar to the following:
+```ruby
+@appinstance.target_login.client.rest_call
+```
+
+### Admin authentication
+
+#### Controller
+
+Authentication is done through a before filter. Reference the above section on controller setup
+
+#### View
+
+`is_app_admin?` is a view helper that returns true if the user is an admin
+
+### API Authentication
+
+In order to allow direct access to the application without Connect for API calls the :authenticate_app_api_request before filter must be used in your controller and both authenticate_connect_app_request and persist_connect_app_session filters should be skipped to avoid collision.
+
+When making an API call to your application the token associated to the `@appinstance` object must be passed in as the password in a basic auth header with the username being the users Connect username or in the access_token param
+
+## Rails Console
+
+By Default all queries executed from Rails Console will filter against schemas that are named “Public” and your current system $user. You can verify this by executing `ActiveRecord::Base.connection.schema_search_path` in rails console which should return “”$user", public"
+
+The Connect Gem will create/use schemas tied to the TaskIds coming out of Connect. In Development mode this TaskId will default to 1. To query data out in development mode you would open up rails console and execute `ActiveRecord::Base.connection.schema_search_path = 1` before proceeding to subsequent queries
+
+## Delayed Job
+
+In order to use delayed job the configuration option “delayed_job” must be set to true for jobs to be picked up by your workers
+
+### Installation
+1. Set `config.delayed_job = true` in `config/initializers/connect.rb`
+2. Add the following line to the connect.rb init file `Dir["#{Rails.root}/lib/workers/*.rb"].each {|file| require file }`
+3. Add the following gems to your gem file
+```ruby
+gem "delayed_job"
+gem "delayed_job_active_record"
+gem "daemons"
+gem "delayed_job_web" #Optional if a web interface is needed for job management
+```
+4. Run `rails generate delayed_job:active_record` in the terminal
+5. Add `config.active_job.queue_adapter = :delayed_job` to `config/application.rb`
+
+### Usage
+
+#### Creating a Worker Class
+
+Add a worker file based on the following template to lib/workers/worker.rb
+```ruby
+class Worker
+  attr_accessor :schema
+  def initialize(instance_id,var2)
+    @instance_id = instance_id
+    @var2 = var2
+    @schema = ActiveRecord::Base.connection.schema_search_path
+  end
+
+  def perform()
+    @appinstance = ZuoraConnect::AppInstance.find(@instance_id)
+    @appinstance.new_session()
+  end
+end
+```
+
+#### Queueing Jobs
+
+Jobs can be queued anywhere in the code base by using the following code `Delayed::Job.enqueue(Worker.new(@appinstance.id, var2))`. Note that instead of passing in the @appinstance object we always pass in the id. This must happen for schema segmentation to work correctly. This can be disregarded if your worker is not processing data specific to a users app instance.
+
+Reference [here](https://github.com/collectiveidea/delayed_job) for more information on Running Jobs and creating workers
+
+#### Starting the delayed job daemon
+
+Run `bin/delayed_job -n 2 restart` in your terminal to start 2 processes that will pick up all queued jobs
+
+### License Information
+IN THE EVENT YOU ARE AN EXISTING ZUORA CUSTOMER, USE OF THIS SOFTWARE IS GOVERNED BY THE MIT LICENSE SET FORTH BELOW AND NOT THE MASTER SUBSCRIPTION AGREEMENT OR OTHER COMMERCIAL AGREEMENT ENTERED INTO BETWEEN YOU AND ZUORA (“AGREEMENT”). FOR THE AVOIDANCE OF DOUBT, ZUORA’S OBLIGATIONS WITH RESPECT TO TECHNICAL SUPPORT, UPTIME, INDEMNIFICATION, AND SECURITY SET FORTH IN THE AGREEMENT DO NOT APPLY TO THE USE OF THIS SOFTWARE.
+
+Copyright 2021 Zuora, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/app/models/zuora_connect/app_instance_base.rb

@@ -12,6 +12,7 @@ module ZuoraConnect
 
     self.table_name = "zuora_connect_app_instances"
     attr_accessor :options, :mode, :logins, :task_data, :last_refresh, :username, :password, :s3_client, :api_version, :drop_message, :new_session_message, :connect_user, :logitems, :user_timezone
+    @@telegraf_host = nil
     REFRESH_TIMEOUT = 2.minute                #Used to determine how long to wait on current refresh call before executing another
     INSTANCE_REFRESH_WINDOW = 1.hours         #Used to set how how long till app starts attempting to refresh cached task connect data
     INSTANCE_REDIS_CACHE_PERIOD = 24.hours    #Used to determine how long to cached task data will live for
@@ -348,7 +349,7 @@ module ZuoraConnect
 
     def refresh(session: {})
       refresh_count ||= 0
-      skip_connect ||= false
+      skip_connect ||= ZuoraConnect.configuration.skip_connect
       begin
         #Check how app was deployed
         if !self.auto_deployed? && !skip_connect
@@ -362,9 +363,9 @@ module ZuoraConnect
               raise ZuoraConnect::Exceptions::ConnectCommunicationError.new("JSON parse error", response.body, response.code)
             end
 
-            self.build_task(task_data: parsed_json, session: session)  
+            self.build_task(task_data: parsed_json, session: session)
             self.set_backup_creds
-            self.save(validate: false) if self.changed?    
+            self.save(validate: false) if self.changed?
           else
             raise ZuoraConnect::Exceptions::ConnectCommunicationError.new("Error Communicating with Connect", response.body, response.code)
           end
@@ -412,8 +413,8 @@ module ZuoraConnect
       def set_backup_creds
         if self.kms_key.present? && self.kms_key.match(/^arn:aws:.*/) && self.task_data.present?
           self.zuora_logins = self.strip_cache_data(object: self.task_data.dup, keys: ['applications', 'tokens', 'user_settings'])
-        end  
-      end 
+        end
+      end
 
       def zuora_logins=(val)
         write_attribute(:zuora_logins, kms_encrypt(val.to_json))
@@ -478,6 +479,15 @@ module ZuoraConnect
         end
         Thread.current[:appinstance] = self
       end
+
+      def self.write_to_telegraf(*args)
+        if ZuoraConnect.configuration.enable_metrics && !defined?(Prometheus)
+          @@telegraf_host = ZuoraConnect::Telegraf.new() if @@telegraf_host == nil
+          unicorn_stats = ZuoraObservability::Metrics.unicorn_listener if defined?(Unicorn) && Unicorn.respond_to?(:listener_names)
+          @@telegraf_host.write(direction: 'Raindrops', tags: {}, values: unicorn_stats)  unless unicorn_stats.blank?
+          return @@telegraf_host.write(*args)
+        end
+      end
     #### END Task Methods ####
 
     #### START Task Methods ####
@@ -600,7 +610,10 @@ module ZuoraConnect
               self.provisioned_app = nil
             end
           end
-          self.save(:validate => false)
+          if self.changed? 
+            self.save(:validate => false) 
+            self.refresh
+          end
 
           return parsed_json
         end

data/app/models/zuora_connect/telegraf.rb

@@ -0,0 +1,73 @@
+module ZuoraConnect
+  class Telegraf
+    attr_accessor :host
+
+    OUTBOUND_METRICS = true
+    OUTBOUND_METRICS_NAME = "request-outbound"
+    INBOUND_METRICS = true
+    INBOUND_METRICS_NAME = "request-inbound"
+
+    def initialize
+      self.connect
+    end
+
+    def connect
+      ZuoraConnect.logger.debug(self.format_metric_log('Telegraf','Need new connection')) if ZuoraConnect.configuration.telegraf_debug
+      uri = URI.parse(ZuoraConnect.configuration.telegraf_endpoint)
+      self.host = UDPSocket.new.tap do |socket|
+        socket.connect uri.host, uri.port
+      end
+    rescue => ex
+      self.host = nil
+      ZuoraConnect.logger.warn(self.format_metric_log('Telegraf', "Failed to connect: #{ex.class}")) if Rails.env.to_s != 'production'
+    end
+
+    def write(direction: 'Unknown', tags: {}, values: {})
+      time = Benchmark.measure do |bench|
+        # To avoid writing metrics from rspec tests
+        if Rails.env.to_sym != :test
+          app_instance = Thread.current[:appinstance].present? ? Thread.current[:appinstance].id : 0
+          tags = { app_name: ZuoraObservability::Env.app_name, process_type: ZuoraObservability::Env.process_type, app_instance: app_instance, pod_name: ZuoraObservability::Env.pod_name}.merge(tags)
+
+          if direction == :inbound
+            if INBOUND_METRICS && !Thread.current[:inbound_metric].to_bool
+              self.write_udp(series: INBOUND_METRICS_NAME, tags: tags, values: values)
+              Thread.current[:inbound_metric] = true
+            else
+              return
+            end
+          elsif direction == :outbound
+            self.write_udp(series: OUTBOUND_METRICS_NAME, tags: tags, values: values) if OUTBOUND_METRICS
+          else
+            self.write_udp(series: direction, tags: tags, values: values)
+          end
+        end
+      end
+      if ZuoraConnect.configuration.telegraf_debug
+        ZuoraConnect.logger.debug(self.format_metric_log('Telegraf', tags.to_s))
+        ZuoraConnect.logger.debug(self.format_metric_log('Telegraf', values.to_s))
+        ZuoraConnect.logger.debug(self.format_metric_log('Telegraf', "Writing '#{direction.capitalize}': #{time.real.round(5)} ms"))
+      end
+    end
+
+
+    def write_udp(series: '', tags: {}, values: {})
+      return if !values.present?
+      self.host.write InfluxDB::PointValue.new({series: series, tags: tags, values: values}).dump
+    rescue => ex
+      self.connect
+      ZuoraConnect.logger.warn(self.format_metric_log('Telegraf',"Failed to write udp: #{ex.class}")) if Rails.env.to_s != 'production'
+    end
+
+    def format_metric_log(message, dump = nil)
+      message_color, dump_color = "1;91", "0;1"
+      log_entry = "  \e[#{message_color}m#{message}\e[0m   "
+      log_entry << "\e[#{dump_color}m%#{String === dump ? 's' : 'p'}\e[0m" % dump if dump
+      if Rails.env == :development
+        log_entry
+      else
+        [message, dump].compact.join(' - ')
+      end
+    end
+  end
+end

data/app/models/zuora_connect/zuora_user.rb

@@ -2,6 +2,37 @@ module ZuoraConnect
   class ZuoraUser < ActiveRecord::Base
     self.table_name = "zuora_users"
     attr_accessor :session
+
     cattr_accessor :current_user_id
+
+    # zuora_user_id/zuora_entity_id both come from cookie or headers
+    # zuora_current_identity comes from session
+    # app_instance is only needed to try to migrate :/
+    def self.update_id_response(zuora_user_id, zuora_entity_id, zuora_current_identity, app_instance)
+      zuora_user = find_or_create_by!(zuora_user_id: zuora_user_id) do |user|
+        user.zuora_identity_response = { zuora_entity_id => zuora_current_identity }
+      end
+
+      if zuora_user.stale_identity?
+        zuora_user.zuora_identity_response[zuora_entity_id] = zuora_current_identity
+        zuora_user.save!
+      end
+
+      zuora_user
+    # NOTE(hartley): this rescue is deprecated. We should not be migrating in production
+    rescue ActiveRecord::StatementInvalid => e
+      raise unless e.message.include?('PG::UndefinedTable') && e.message.include?('zuora_users')
+
+      ZuoraConnect.logger.fatal('Error querying zuora_users table: attempting migration to recover')
+
+      app_instance.apartment_switch(nil, true)
+      retry
+    end
+
+    # NOTE(hartley): this value was extracted from original usage in helper,
+    # need to investigate when exactly the identity_response should be updated
+    def stale_identity?
+      updated_at < Time.now - 1.day
+    end
   end
-end
+end

data/config/initializers/unicorn.rb

@@ -6,7 +6,7 @@ if defined?(Unicorn::WorkerKiller)
       if defined?(Prometheus)
         Prometheus::UNICORN_KILLS.set(1)
       else
-        ZuoraObservability::Metrics.write_to_telegraf(direction: 'Unicorn-Killer', tags: {app_instance: 0}, values: {kill: 1})
+        ZuoraConnect::AppInstance.write_to_telegraf(direction: 'Unicorn-Killer', tags: {app_instance: 0}, values: {kill: 1})
       end
     end
   end

data/config/initializers/zuora_observability.rb

@@ -0,0 +1,21 @@
+ZuoraObservability.configure do |config|
+  config.zecs_service_hook = lambda do |controller|
+    custom_payload = {}
+    if controller.instance_variable_defined?(:@appinstance)
+      appinstance = controller.instance_variable_get(:@appinstance)
+      if appinstance.logitems.present? && appinstance.logitems.class == Hash
+        ActiveSupport::Deprecation.warn("logitems is deprecated, please use zecs_service_hook. See 'https://gitlab.zeta.tools/extension-products/incubating-projects/zuora_observability/-/blob/master/doc/logging.md' for more details.")
+        custom_payload.merge!(appinstance.logitems)
+      end
+    end
+    custom_payload
+  end
+  config.add_custom_payload_hook do |controller|
+    custom_payload = {}
+    if controller.instance_variable_defined?(:@appinstance)
+      appinstance = controller.instance_variable_get(:@appinstance)
+      custom_payload.merge!({ email: appinstance.connect_user })
+    end
+    custom_payload
+  end
+end

data/lib/metrics/influx/point_value.rb

@@ -0,0 +1,79 @@
+module InfluxDB
+  # Convert data point to string using Line protocol
+  class PointValue
+    attr_reader :series, :values, :tags, :timestamp
+
+    def initialize(data)
+      @series    = escape data[:series], :measurement
+      @values    = escape_values data[:values]
+      @tags      = escape_tags data[:tags]
+      @timestamp = data[:timestamp]
+    end
+
+    def dump
+      dump =  @series.dup
+      dump << ",#{@tags}" if @tags
+      dump << " #{@values}"
+      dump << " #{@timestamp}" if @timestamp
+      dump
+    end
+
+    private
+
+    ESCAPES = {
+      measurement:  [' '.freeze, ','.freeze],
+      tag_key:      ['='.freeze, ' '.freeze, ','.freeze],
+      tag_value:    ['='.freeze, ' '.freeze, ','.freeze],
+      field_key:    ['='.freeze, ' '.freeze, ','.freeze, '"'.freeze],
+      field_value:  ["\\".freeze, '"'.freeze],
+    }.freeze
+
+    private_constant :ESCAPES
+
+    def escape(str, type)
+      # rubocop:disable Layout/AlignParameters
+      str = str.encode "UTF-8".freeze, "UTF-8".freeze,
+        invalid: :replace,
+        undef: :replace,
+        replace: "".freeze
+      # rubocop:enable Layout/AlignParameters
+
+      ESCAPES[type].each do |ch|
+        str = str.gsub(ch) { "\\#{ch}" }
+      end
+      str
+    end
+
+    def escape_values(values)
+      return if values.nil?
+      values.map do |k, v|
+        key = escape(k.to_s, :field_key)
+        val = escape_value(v)
+        "#{key}=#{val}"
+      end.join(",".freeze)
+    end
+
+    def escape_value(value)
+      if value.is_a?(String)
+        '"'.freeze + escape(value, :field_value) + '"'.freeze
+      elsif value.is_a?(Integer)
+        "#{value}i"
+      else
+        value.to_s
+      end
+    end
+
+    def escape_tags(tags)
+      return if tags.nil?
+
+      tags = tags.map do |k, v|
+        key = escape(k.to_s, :tag_key)
+        val = escape(v.to_s, :tag_value)
+
+        "#{key}=#{val}" unless key == "".freeze || val == "".freeze
+      end.compact
+
+      tags.join(",") unless tags.empty?
+    end
+  end
+end

data/lib/metrics/net.rb

@@ -68,12 +68,12 @@ class HttpLogger
       log_request_body(request)
       log_request_headers(request)
       if defined?(response) && response
-        tags = tags.merge({status: response.code.to_i})
+        tags = tags.merge({status: response.code.to_i}) 
         log_response_code(response)
         log_response_headers(response)
         log_response_body(response.body)
       end
-      ZuoraObservability::Metrics.write_to_telegraf(direction: :outbound, tags: tags, values: values)
+      ZuoraConnect::AppInstance.write_to_telegraf(direction: :outbound, tags: tags, values: values)
     end
   end
 
@@ -95,7 +95,7 @@ class HttpLogger
   end
 
   HTTP_METHODS_WITH_BODY = Set.new(%w(POST PUT GET PATCH))
-
+  
   def log_request_body(request)
     if self.class.log_request_body
       if HTTP_METHODS_WITH_BODY.include?(request.method)
@@ -149,8 +149,8 @@ class HttpLogger
   def truncate_body(body)
     if collapse_body_limit && collapse_body_limit > 0 && body && body.size >= collapse_body_limit
       body_piece_size = collapse_body_limit / 2
-      body[0..body_piece_size] +
-        "\n\n<some data truncated>\n\n" +
+      body[0..body_piece_size] + 
+        "\n\n<some data truncated>\n\n" + 
         body[(body.size - body_piece_size)..body.size]
     else
       body
@@ -203,7 +203,7 @@ class Net::HTTP
 
   def request(request, body = nil, &block)
     HttpLogger.perform(self, request, body) do
-      request_without_logging(request, body, &block)
+      request_without_logging(request, body, &block) 
     end
   end
 end
@@ -215,4 +215,4 @@ if defined?(Rails)
       HttpLogger.logger = ZuoraConnect.logger unless HttpLogger.logger
     end
   end
-end
+end

data/lib/middleware/metrics_middleware.rb

@@ -1,6 +1,37 @@
 module ZuoraConnect
   require 'uri'
 
+  # Object of this class is passed to the ActiveSupport::Notification hook
+  class PageRequest
+
+    # This method is triggered when a non error page is loaded (not 404)
+    def call(name, started, finished, unique_id, payload)
+      # If the url contains any css or JavaScript files then do not collect metrics for them
+      return nil if ["css", "assets", "jpg", "png", "jpeg", "ico"].any? { |word| payload[:path].include?(word) }
+
+      # Getting the endpoint and the content_type
+      content_hash = {:html => "text/html", :js => "application/javascript", :json => "application/json", :csv => "text/csv"}
+      content_type = content_hash.key?(payload[:format]) ? content_hash[payload[:format]] : payload[:format]
+      content_type = content_type.to_s.gsub('text/javascript', 'application/javascript')
+
+      # payloads with 500 requests do not have status as it is not set by the controller
+      # https://github.com/rails/rails/issues/33335
+      #status_code = payload[:status] ? payload[:status] : payload[:exception_object].present? ? 500 : ""
+      if payload[:exception].present?
+        status_code, exception = [500, payload[:exception].first]
+      else
+        status_code, exception = [payload[:status], nil]
+      end
+
+      tags = {method: payload[:method], status: status_code, error_type: exception, content_type: content_type, controller: payload[:controller], action: payload[:action]}.compact
+
+      values = {view_time: payload[:view_runtime], db_time: payload[:db_runtime], response_time: ((finished-started)*1000)}.compact
+      values = values.map{ |k,v| [k,v.round(2)]}.to_h
+
+      ZuoraConnect::AppInstanceBase.write_to_telegraf(direction: :inbound, tags: tags, values: values)
+    end
+  end
+
   class MetricsMiddleware
 
     require "zuora_connect/version"
@@ -36,9 +67,9 @@ module ZuoraConnect
         if defined?(Prometheus) && env['PATH_INFO'] == '/connect/internal/metrics'
 
           # Prometheus Stuff
-          metrics = ZuoraObservability::Metrics.resque 
+          metrics = ZuoraObservability::Metrics.resque
           metrics = defined?(ZuoraConnect::AppInstance.get_metrics) ? ZuoraConnect::AppInstance.get_metrics(metrics) : metrics
-         
+
           redis_up = metrics.present? && metrics.dig(:Resque, :Workers_Total).present? ? 1 : 0
           Prometheus::REDIS_CONNECTION.set(redis_up)
 
@@ -77,7 +108,7 @@ module ZuoraConnect
 
               values = {response_time: ((Time.now - start_time)*1000).round(2) }
 
-              ZuoraObservability::Metrics.write_to_telegraf(direction: :inbound, tags: tags, values: values)
+              ZuoraConnect::AppInstanceBase.write_to_telegraf(direction: :inbound, tags: tags, values: values)
             end
           end
           Thread.current[:inbound_metric] = nil

data/lib/zuora_connect.rb

@@ -9,8 +9,8 @@ require 'resque/silence_done'
 require 'resque/self_lookup'
 require 'resque/plugins/custom_logger'
 require 'resque/plugins/app_instance_job'
+require 'metrics/influx/point_value'
 require 'metrics/net'
-require 'mono_logger'
 require 'zuora_connect/zuora_audit'
 require 'active_record'
 require 'zuora_observability'
@@ -87,7 +87,7 @@ module ZuoraConnect
       verify_server_cert: false,
       log_level: Logger::INFO,
       service_name: ENV['DEIS_APP'].present? ? ENV['DEIS_APP'] : Rails.application.class.parent_name,
-      logger: ZuoraObservability::Logger.custom_logger(name: "ElasticAPM", level: MonoLogger::WARN)
+      logger: ZuoraObservability::Logger.custom_logger(name: "ElasticAPM", level: Logger::WARN)
     })
     defaults.merge!({disable_send: true}) if defined?(Rails::Console)
 

data/lib/zuora_connect/configuration.rb

@@ -7,7 +7,7 @@ module ZuoraConnect
 
     attr_accessor :oauth_client_id, :oauth_client_secret, :oauth_client_redirect_uri
 
-    attr_accessor :dev_mode_logins, :dev_mode_options, :dev_mode_mode, :dev_mode_appinstance, :dev_mode_user, :dev_mode_pass, :dev_mode_admin, :dev_mode_secret_access_key,:dev_mode_access_key_id,:aws_region, :s3_bucket_name, :s3_folder_name, :json_logging, :insert_migrations
+    attr_accessor :dev_mode_logins, :dev_mode_options, :dev_mode_mode, :dev_mode_appinstance, :dev_mode_user, :dev_mode_pass, :dev_mode_admin, :dev_mode_secret_access_key,:dev_mode_access_key_id,:aws_region, :s3_bucket_name, :s3_folder_name, :insert_migrations, :skip_connect
 
     def initialize
       @default_locale = :en
@@ -20,6 +20,7 @@ module ZuoraConnect
       @silencer_resque_finish = true
       @blpop_queue = false
       @insert_migrations = true
+      @skip_connect = false
 
       # Setting the app name for telegraf write
       @enable_metrics = false
@@ -43,7 +44,6 @@ module ZuoraConnect
       @aws_region = "us-west-2"
       @s3_bucket_name = "rbm-apps"
       @s3_folder_name = Rails.application.class.parent_name
-      @json_logging = Rails.env.development? || Rails.env.test? ? false : true
     end
 
     def private_key

data/lib/zuora_connect/controllers/helpers.rb

@@ -125,7 +125,7 @@ module ZuoraConnect
             PaperTrail.whodunnit =  session["#{@appinstance.id}::user::email"] if defined?(PaperTrail)
           end
 
-          locale = (session["#{@appinstance.id}::user::locale"] || "").gsub("_", "-") 
+          locale = (session["#{@appinstance.id}::user::locale"] || "").gsub("_", "-")
           begin
             I18n.locale = locale.present? ? locale : @appinstance.locale
           rescue I18n::InvalidLocale => ex
@@ -303,8 +303,8 @@ module ZuoraConnect
     private
       def setup_instance_via_prod_mode
         zuora_entity_id = request.headers['ZuoraCurrentEntity'] || cookies['ZuoraCurrentEntity']
-        ZuoraConnect::ZuoraUser.current_user_id = nil 
-        
+        ZuoraConnect::ZuoraUser.current_user_id = nil
+
         if zuora_entity_id.present?
           zuora_tenant_id = cookies['Zuora-Tenant-Id']
           zuora_user_id = cookies['Zuora-User-Id']
@@ -417,28 +417,10 @@ module ZuoraConnect
 
             # One deployed instance with credentials
             if defined?(@appinstance) && !@appinstance['zuora_logins'].nil?
-              #Add user/update
-              begin
-                ZuoraConnect::ZuoraUser.reset_table_name
-                @zuora_user = ZuoraConnect::ZuoraUser.where(:zuora_user_id => zuora_user_id).first
-              rescue ActiveRecord::StatementInvalid => ex
-                if ex.message.include?("PG::UndefinedTable") && ex.message.include?("zuora_users")
-                  @appinstance.apartment_switch(nil,true)
-                  retry
-                else
-                  raise
-                end
-              end
-              if @zuora_user.present?
-                ZuoraConnect.logger.debug("Current zuora user #{zuora_user_id}")
-                if @zuora_user.updated_at < Time.now - 1.day
-                  @zuora_user.zuora_identity_response[zuora_entity_id] = session["ZuoraCurrentIdentity"]
-                  @zuora_user.save!
-                end
-              else
-                ZuoraConnect.logger.debug("New zuora user object for #{zuora_user_id}")
-                @zuora_user = ZuoraConnect::ZuoraUser.create!(:zuora_user_id => zuora_user_id, :zuora_identity_response => {zuora_entity_id => session["ZuoraCurrentIdentity"]})
-              end
+              @zuora_user = ZuoraConnect::ZuoraUser.update_id_response(
+                zuora_user_id, zuora_entity_id, session["ZuoraCurrentIdentity"],
+                @appinstance
+              )
               @zuora_user.session = session
               ZuoraConnect::ZuoraUser.current_user_id = zuora_user_id
               session["#{@appinstance.id}::user::localUserId"] = @zuora_user.id
@@ -682,15 +664,15 @@ module ZuoraConnect
       def setup_instance_via_dev_mode
         session["appInstance"] = ZuoraConnect.configuration.dev_mode_appinstance
         session["#{ZuoraConnect.configuration.dev_mode_appinstance}::admin"] =  ZuoraConnect.configuration.dev_mode_admin
- 
+
         values = {
           id: ZuoraConnect.configuration.dev_mode_appinstance,
-          access_token: ZuoraConnect.configuration.dev_mode_user, 
-          refresh_token: ZuoraConnect.configuration.dev_mode_pass, 
-          token: ZuoraConnect.configuration.dev_mode_pass+ZuoraConnect.configuration.dev_mode_pass, 
+          access_token: ZuoraConnect.configuration.dev_mode_user,
+          refresh_token: ZuoraConnect.configuration.dev_mode_pass,
+          token: ZuoraConnect.configuration.dev_mode_pass+ZuoraConnect.configuration.dev_mode_pass,
           api_token: ZuoraConnect.configuration.dev_mode_pass+ZuoraConnect.configuration.dev_mode_pass
         }
-        
+
         @appinstance = ZuoraConnect::AppInstance.find_by(:id => ZuoraConnect.configuration.dev_mode_appinstance.to_i)
         ZuoraConnect::ZuoraUser.current_user_id = 0
         if @appinstance.blank?
@@ -708,4 +690,4 @@ module ZuoraConnect
       end
     end
   end
-end
+end

data/lib/zuora_connect/railtie.rb

@@ -32,5 +32,8 @@ module ZuoraConnect
         app.config.middleware.use Rack::Deflater, if: ->(env, *) { env['PATH_INFO'] == '/connect/internal/metrics' }
       end
     end
+
+    # hook to process_action
+    ActiveSupport::Notifications.subscribe('process_action.action_controller', ZuoraConnect::PageRequest.new)
   end
 end

data/lib/zuora_connect/version.rb

@@ -1,3 +1,3 @@
 module ZuoraConnect
-  VERSION = "3.0.0-m"
+  VERSION = "3.0.0-r"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_connect
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.m
+  version: 3.0.0.pre.r
 platform: ruby
 authors:
 - Connect Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apartment
@@ -38,40 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ougai-formatters-customizable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: zuora_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.00
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.00
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.00
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.00
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -92,20 +72,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.4
-- !ruby/object:Gem::Dependency
-  name: lograge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
@@ -134,20 +100,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mono_logger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -186,16 +138,16 @@ dependencies:
   name: zuora_observability
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.pre.b
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.pre.b
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -281,7 +233,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -336,6 +288,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Description of Connect.
 email:
 - connect@zuora.com
@@ -344,6 +338,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/assets/javascripts/hallway_wrapper/after.js
 - app/assets/javascripts/hallway_wrapper/before.js
@@ -360,6 +355,7 @@ files:
 - app/models/zuora_connect/app_instance.rb
 - app/models/zuora_connect/app_instance_base.rb
 - app/models/zuora_connect/login.rb
+- app/models/zuora_connect/telegraf.rb
 - app/models/zuora_connect/zuora_user.rb
 - app/views/layouts/zuora_connect/application.html.erb
 - app/views/sql/refresh_aggregate_table.txt
@@ -378,6 +374,7 @@ files:
 - config/initializers/resque.rb
 - config/initializers/to_bool.rb
 - config/initializers/unicorn.rb
+- config/initializers/zuora_observability.rb
 - config/routes.rb
 - db/migrate/20100718151733_create_connect_app_instances.rb
 - db/migrate/20101024162319_add_tokens_to_app_instance.rb
@@ -394,6 +391,7 @@ files:
 - db/migrate/20190520232222_add_unique_index.rb
 - db/migrate/20190520232223_add_provisioning_fields.rb
 - db/migrate/20190520232224_add_environment_fields.rb
+- lib/metrics/influx/point_value.rb
 - lib/metrics/net.rb
 - lib/middleware/bad_multipart_form_data_sanitizer.rb
 - lib/middleware/json_parse_errors.rb
@@ -432,7 +430,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Summary of Connect.