From 7eef405a362b7e03d30c551b1cda65f3cbe75efe Mon Sep 17 00:00:00 2001
From: Amanda Sposito <amanda.sposito@plataformatec.com.br>
Date: Tue, 4 Dec 2018 11:42:14 -0200
Subject: [PATCH] Add BlockValidationCounter config to disable it in test env.

---
 apps/explorer/config/config.exs               |  4 +--
 apps/explorer/config/test.exs                 |  6 ++--
 .../counters/block_validation_counter.ex      | 33 ++++++++++++++++---
 3 files changed, 34 insertions(+), 9 deletions(-)

diff --git a/apps/explorer/config/config.exs b/apps/explorer/config/config.exs
index 0bc7a67090..79d226eb5d 100644
--- a/apps/explorer/config/config.exs
+++ b/apps/explorer/config/config.exs
@@ -17,8 +17,6 @@ config :explorer, Explorer.Integrations.EctoLogger, query_time_ms_threshold: 2_0
 
 config :explorer, Explorer.ExchangeRates, enabled: true
 
-config :explorer, Explorer.Counters.BlockValidationCounter, enabled: true
-
 config :explorer, Explorer.Market.History.Cataloger, enabled: true
 
 config :explorer, Explorer.Repo,
@@ -32,6 +30,8 @@ config :explorer, Explorer.Tracer,
 
 config :explorer, Explorer.Counters.TokenTransferCounter, enabled: true
 
+config :explorer, Explorer.Counters.BlockValidationCounter, enabled: true, enable_consolidation: true
+
 config :explorer, Explorer.Counters.TokenHoldersCounter, enabled: true, enable_consolidation: true
 
 config :explorer, Explorer.Counters.AddessesWithBalanceCounter, enabled: true, enable_consolidation: true
diff --git a/apps/explorer/config/test.exs b/apps/explorer/config/test.exs
index d5715ba2b6..d4b2c74b01 100644
--- a/apps/explorer/config/test.exs
+++ b/apps/explorer/config/test.exs
@@ -3,8 +3,6 @@ use Mix.Config
 # Lower hashing rounds for faster tests
 config :bcrypt_elixir, log_rounds: 4
 
-config :explorer, Explorer.Counters.TokenHoldersCounter, enabled: true, enable_consolidation: false
-
 # Configure your database
 config :explorer, Explorer.Repo,
   adapter: Ecto.Adapters.Postgres,
@@ -21,6 +19,10 @@ config :explorer, Explorer.Market.History.Cataloger, enabled: false
 
 config :explorer, Explorer.Tracer, disabled?: false
 
+config :explorer, Explorer.Counters.BlockValidationCounter, enabled: true, enable_consolidation: false
+
+config :explorer, Explorer.Counters.TokenHoldersCounter, enabled: true, enable_consolidation: false
+
 config :explorer, Explorer.Counters.AddessesWithBalanceCounter, enabled: true, enable_consolidation: false
 
 config :logger, :explorer,
diff --git a/apps/explorer/lib/explorer/counters/block_validation_counter.ex b/apps/explorer/lib/explorer/counters/block_validation_counter.ex
index 6d12ba3971..8b47b213fb 100644
--- a/apps/explorer/lib/explorer/counters/block_validation_counter.ex
+++ b/apps/explorer/lib/explorer/counters/block_validation_counter.ex
@@ -2,7 +2,7 @@ defmodule Explorer.Counters.BlockValidationCounter do
   use GenServer
 
   @moduledoc """
-  Module responsible for fetching and consolidating the number of 
+  Module responsible for fetching and consolidating the number of
   validations from an address.
   """
 
@@ -15,6 +15,14 @@ defmodule Explorer.Counters.BlockValidationCounter do
     @table
   end
 
+  # It is undesirable to automatically start the consolidation in all environments.
+  # Consider the test environment: if the consolidation initiates but does not
+  # finish before a test ends, that test will fail. This way, hundreds of
+  # tests were failing before disabling the consolidation and the scheduler in
+  # the test env.
+  config = Application.get_env(:explorer, Explorer.Counters.BlockValidationCounter)
+  @enable_consolidation Keyword.get(config, :enable_consolidation)
+
   @doc """
   Creates a process to continually monitor the validation counts.
   """
@@ -28,7 +36,9 @@ defmodule Explorer.Counters.BlockValidationCounter do
   def init(args) do
     create_table()
 
-    Task.start_link(&consolidate_blocks/0)
+    if enable_consolidation?() do
+      Task.start_link(&consolidate_blocks/0)
+    end
 
     Chain.subscribe_to_events(:blocks)
 
@@ -40,8 +50,7 @@ defmodule Explorer.Counters.BlockValidationCounter do
       :set,
       :named_table,
       :public,
-      read_concurrency: true,
-      write_concurrency: true
+      read_concurrency: true
     ]
 
     :ets.new(table_name(), opts)
@@ -59,7 +68,7 @@ defmodule Explorer.Counters.BlockValidationCounter do
   end
 
   @doc """
-  Fetches the number of validations related to an `address_hash`. 
+  Fetches the number of validations related to an `address_hash`.
   """
   @spec fetch(Hash.Address.t()) :: non_neg_integer
   def fetch(addr_hash) do
@@ -91,4 +100,18 @@ defmodule Explorer.Counters.BlockValidationCounter do
 
     :ets.update_counter(table_name(), string_addr, number, default)
   end
+
+  @doc """
+  Returns a boolean that indicates whether consolidation is enabled
+
+  In order to choose whether or not to enable the scheduler and the initial
+  consolidation, change the following Explorer config:
+
+  `config :explorer, Explorer.Counters.BlockValidationCounter, enable_consolidation: true`
+
+  to:
+
+  `config :explorer, Explorer.Counters.BlockValidationCounter, enable_consolidation: false`
+  """
+  def enable_consolidation?, do: @enable_consolidation
 end