Add flags to prevent code running in envs where dfe-analytics isn't set up

lib/dfe/analytics/entity_table_check_job.rb

@@ -7,7 +7,7 @@ module Analytics
     # To ensure BigQuery is in sync with the database
     class EntityTableCheckJob < AnalyticsJob
       def perform
-        return unless DfE::Analytics.entity_table_checks_enabled?
+        return unless DfE::Analytics.enabled? && DfE::Analytics.entity_table_checks_enabled?
 
         entity_tag = Time.now.strftime('%Y%m%d%H%M%S')
         DfE::Analytics.entities_for_analytics.each do |entity_name|

lib/dfe/analytics/send_events.rb

@@ -4,8 +4,12 @@ module DfE
   module Analytics
     class SendEvents < AnalyticsJob
       def self.do(events)
-        # The initialise event is a one-off event that must be sent to BigQuery once only
+        unless DfE::Analytics.enabled?
+          Rails.logger.info('DfE::Analytics::SendEvents.do() called but DfE::Analytics is disabled. Please check DfE::Analytics.enabled? before sending events to BigQuery')
+          return
+        end
 
+        # The initialise event is a one-off event that must be sent to BigQuery once only
         DfE::Analytics::InitialisationEvents.trigger_initialisation_events unless DfE::Analytics::InitialisationEvents.initialisation_events_sent?
 
         events = events.map { |event| event.is_a?(Event) ? event.as_json : event }

lib/dfe/analytics/tasks/import_entities.rake

@@ -2,6 +2,8 @@ namespace :dfe do
   namespace :analytics do
     desc 'Send Analytics events for the (allowlisted) state of all records in the database'
     task :import_all_entities, %i[batch_size] => :environment do |_, args|
+      return unless DfE::Analytics.enabled?
+
       entity_tag = Time.now.strftime('%Y%m%d%H%M%S')
       DfE::Analytics.entities_for_analytics.each do |entity_name|
         DfE::Analytics::LoadEntities.new(entity_name: entity_name, **args).run(entity_tag: entity_tag)
@@ -11,6 +13,8 @@ namespace :dfe do
 
     desc 'Send Analytics events for the state of all records in a specified model'
     task :import_entity, %i[entity_name batch_size] => :environment do |_, args|
+      return unless DfE::Analytics.enabled?
+
       abort('You need to specify a model name as an argument to the Rake task, eg dfe:analytics:import_entity[Model]') unless args[:entity_name]
 
       entity_tag = Time.now.strftime('%Y%m%d%H%M%S')

spec/dfe/analytics/entity_table_check_job_spec.rb

@@ -20,9 +20,25 @@
   end
 
   describe '#perform' do
+    context 'when dfe-analytics is not enabled' do
+      before do
+        allow(DfE::Analytics).to receive(:enabled?).and_return(false)
+        allow(DfE::Analytics).to receive(:entity_table_checks_enabled?).and_return(true)
+        allow(DfE::Analytics).to receive(:entities_for_analytics).and_return(%w[Candidate Application])
+      end
+
+      it 'does not call EntityTableChecks' do
+        expect(DfE::Analytics::Services::EntityTableChecks).not_to receive(:call)
+
+        described_class.new.perform
+      end
+    end
+
     context 'when entity table checks are not enabled' do
       before do
+        allow(DfE::Analytics).to receive(:enabled?).and_return(true)
         allow(DfE::Analytics).to receive(:entity_table_checks_enabled?).and_return(false)
+        allow(DfE::Analytics).to receive(:entities_for_analytics).and_return(%w[Candidate Application])
       end
 
       it 'does not call EntityTableChecks' do
@@ -34,6 +50,7 @@
 
     context 'when entity table checks are enabled' do
       before do
+        allow(DfE::Analytics).to receive(:enabled?).and_return(true)
         allow(DfE::Analytics).to receive(:entity_table_checks_enabled?).and_return(true)
         allow(DfE::Analytics).to receive(:entities_for_analytics).and_return(%w[Candidate Application])
       end

spec/dfe/analytics/load_entity_batch_spec.rb

@@ -8,6 +8,7 @@
   end
 
   before do
+    allow(DfE::Analytics).to receive(:enabled?).and_return(true)
     allow(DfE::Analytics::SendEvents).to receive(:perform_now)
 
     allow(DfE::Analytics).to receive(:allowlist).and_return({