Show UI warning to user when they need provider data but have not setup Synth yet (#1926)

* Simplify provider concerns

* Update tests

* Add UI warning for missing Synth key if family requires external data

Author: zachgoll

app/controllers/securities_controller.rb

@@ -3,7 +3,7 @@ def index
     query = params[:q]
     return render json: [] if query.blank? || query.length < 2 || query.length > 100
 
-    @securities = Security.search({
+    @securities = Security.search_provider({
       search: query,
       country: params[:country_code] == "US" ? "US" : nil
     })

app/jobs/fetch_security_info_job.rb

@@ -2,7 +2,7 @@ class FetchSecurityInfoJob < ApplicationJob
   queue_as :latency_low
 
   def perform(security_id)
-    return unless Security.security_info_provider.present?
+    return unless Security.provider.present?
 
     security = Security.find(security_id)
 
@@ -12,7 +12,7 @@ def perform(security_id)
     params[:mic_code] = security.exchange_mic if security.exchange_mic.present?
     params[:operating_mic] = security.exchange_operating_mic if security.exchange_operating_mic.present?
 
-    security_info_response = Security.security_info_provider.fetch_security_info(**params)
+    security_info_response = Security.provider.fetch_security_info(**params)
 
     security.update(
       name: security_info_response.info.dig("name")

app/models/account/data_enricher.rb

@@ -1,6 +1,4 @@
 class Account::DataEnricher
-  include Providable
-
   attr_reader :account
 
   def initialize(account)
@@ -37,7 +35,7 @@ def enrich_transaction_batch(batch_size = 50, offset = 0)
 
     candidates.each do |entry|
       begin
-        info = self.class.synth_provider.enrich_transaction(entry.name).info
+        info = entry.fetch_enrichment_info
 
         next unless info.present?
 

app/models/account/entry.rb

@@ -1,5 +1,5 @@
 class Account::Entry < ApplicationRecord
-  include Monetizable
+  include Monetizable, Provided
 
   monetize :amount
 

app/models/account/entry/provided.rb

@@ -0,0 +1,11 @@
+module Account::Entry::Provided
+  extend ActiveSupport::Concern
+
+  include Synthable
+
+  def fetch_enrichment_info
+    return nil unless synth_client.present?
+
+    synth_client.enrich_transaction(name).info
+  end
+end

app/models/concerns/providable.rb

@@ -0,0 +1,37 @@
+module Synthable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def synth_usage
+      synth_client&.usage
+    end
+
+    def synth_overage?
+      synth_usage&.usage&.utilization.to_i >= 100
+    end
+
+    def synth_healthy?
+      synth_client&.healthy?
+    end
+
+    def synth_client
+      api_key = ENV.fetch("SYNTH_API_KEY", Setting.synth_api_key)
+
+      return nil unless api_key.present?
+
+      Provider::Synth.new(api_key)
+    end
+  end
+
+  def synth_client
+    self.class.synth_client
+  end
+
+  def synth_usage
+    self.class.synth_usage
+  end
+
+  def synth_overage?
+    self.class.synth_overage?
+  end
+end

app/models/concerns/synthable.rb

@@ -1,19 +1,18 @@
 module ExchangeRate::Provided
   extend ActiveSupport::Concern
 
-  include Providable
+  include Synthable
 
   class_methods do
-    def provider_healthy?
-      exchange_rates_provider.present? && exchange_rates_provider.healthy?
+    def provider
+      synth_client
     end
 
     private
-
       def fetch_rates_from_provider(from:, to:, start_date:, end_date: Date.current, cache: false)
-        return [] unless exchange_rates_provider.present?
+        return [] unless provider.present?
 
-        response = exchange_rates_provider.fetch_exchange_rates \
+        response = provider.fetch_exchange_rates \
           from: from,
           to: to,
           start_date: start_date,
@@ -38,9 +37,9 @@ def fetch_rates_from_provider(from:, to:, start_date:, end_date: Date.current, c
       end
 
       def fetch_rate_from_provider(from:, to:, date:, cache: false)
-        return nil unless exchange_rates_provider.present?
+        return nil unless provider.present?
 
-        response = exchange_rates_provider.fetch_exchange_rate \
+        response = provider.fetch_exchange_rate \
           from: from,
           to: to,
           date: date

app/models/exchange_rate/provided.rb

@@ -1,5 +1,5 @@
 class Family < ApplicationRecord
-  include Providable, Plaidable, Syncable, AutoTransferMatchable
+  include Synthable, Plaidable, Syncable, AutoTransferMatchable
 
   DATE_FORMATS = [
     [ "MM-DD-YYYY", "%m-%d-%Y" ],
@@ -92,20 +92,23 @@ def get_link_token(webhooks_url:, redirect_url:, accountable_type: nil, region:
     ).link_token
   end
 
-  def synth_usage
-    self.class.synth_provider&.usage
+  def subscribed?
+    stripe_subscription_status == "active"
   end
 
-  def synth_overage?
-    self.class.synth_provider&.usage&.utilization.to_i >= 100
-  end
+  def requires_data_provider?
+    # If family has any trades, they need a provider for historical prices
+    return true if trades.any?
 
-  def synth_valid?
-    self.class.synth_provider&.healthy?
-  end
+    # If family has any accounts not denominated in the family's currency, they need a provider for historical exchange rates
+    return true if accounts.where.not(currency: self.currency).any?
 
-  def subscribed?
-    stripe_subscription_status == "active"
+    # If family has any entries in different currencies, they need a provider for historical exchange rates
+    uniq_currencies = entries.pluck(:currency).uniq
+    return true if uniq_currencies.count > 1
+    return true if uniq_currencies.first != self.currency
+
+    false
   end
 
   def primary_user

app/models/family.rb

@@ -1,5 +1,5 @@
 class Security < ApplicationRecord
-  include Providable
+  include Provided
 
   before_save :upcase_ticker
 
@@ -9,21 +9,6 @@ class Security < ApplicationRecord
   validates :ticker, presence: true
   validates :ticker, uniqueness: { scope: :exchange_operating_mic, case_sensitive: false }
 
-  class << self
-    def provider
-      security_prices_provider
-    end
-
-    def search(query)
-      security_prices_provider.search_securities(
-        query: query[:search],
-        dataset: "limited",
-        country_code: query[:country],
-        exchange_operating_mic: query[:exchange_operating_mic]
-      ).securities.map { |attrs| new(**attrs) }
-    end
-  end
-
   def current_price
     @current_price ||= Security::Price.find_price(security: self, date: Date.current)
     return nil if @current_price.nil?