Add feature flag to begin removal of EDU and C&P email templates #92636 (#21671)

Author: Diana20920

app/mailers/direct_deposit_mailer.rb

@@ -9,7 +9,6 @@ class DirectDepositMailer < TransactionalEmailMailer
   TEMPLATE = 'direct_deposit'
 
   DD_TYPES = {
-    ch33: 'education',
     comp_pen: 'disability compensation or pension'
   }.freeze
 

app/sidekiq/va_notify_dd_email_job.rb

@@ -42,8 +42,7 @@ def perform(email, dd_type = nil)
   end
 
   def template_type(dd_type)
-    return 'direct_deposit_edu' if dd_type&.to_sym == :ch33
-    return 'direct_deposit_comp_pen' if %i[comp_pen comp_and_pen].include? dd_type&.to_sym
+    return 'direct_deposit_comp_pen' if use_comp_pen_email_template?(dd_type)
 
     'direct_deposit'
   end
@@ -54,4 +53,12 @@ def handle_errors(ex)
 
     raise ex if ex.status_code.between?(500, 599)
   end
+
+  def use_direct_deposit_email_template?
+    Flipper.enabled?(:only_use_direct_deposit_email_template)
+  end
+
+  def use_comp_pen_email_template?(dd_type)
+    %i[comp_pen comp_and_pen].include?(dd_type&.to_sym) && !use_direct_deposit_email_template?
+  end
 end

config/features.yml

@@ -29,7 +29,7 @@ features:
     enable_in_development: true
   accredited_representative_portal_search:
     actor_type: user
-    description: Enables the people search of the accredited representative portal 
+    description: Enables the people search of the accredited representative portal
     enable_in_development: true
   aedp_vadx:
     actor_type: user
@@ -2109,3 +2109,6 @@ features:
   forms_10215_10216_release:
     actor_type: user
     description: If enabled, show links to new forms instead of download links on SCO page
+  only_use_direct_deposit_email_template:
+    description: If enabled, VANotifyDdEmailJob will not use the EDU and/or C&P email templates
+

config/settings.yml

@@ -1556,7 +1556,6 @@ vanotify:
         covid_vaccine_registration: <%= ENV['vanotify__services__va_gov__template_id__covid_vaccine_registration'] %>
         direct_deposit: <%= ENV['vanotify__services__va_gov__template_id__direct_deposit'] %>
         direct_deposit_comp_pen: <%= ENV['vanotify__services__va_gov__template_id__direct_deposit_comp_pen'] %>
-        direct_deposit_edu: <%= ENV['vanotify__services__va_gov__template_id__direct_deposit_edu'] %>
         form0994_confirmation_email: <%= ENV['vanotify__services__va_gov__template_id__form0994_confirmation_email'] %>
         form0994_extra_action_confirmation_email: <%= ENV['vanotify__services__va_gov__template_id__form0994_extra_action_confirmation_email'] %>
         form1010ez_reminder_email: <%= ENV['vanotify__services__va_gov__template_id__form1010ez_reminder_email'] %>

config/settings/development.yml

@@ -1577,7 +1577,6 @@ vanotify:
         covid_vaccine_registration: ~
         direct_deposit: direct_deposit_template_id
         direct_deposit_comp_pen: comp_pen_template_id
-        direct_deposit_edu: edu_template_id
         form0994_confirmation_email: form0994_confirmation_email_template_id
         form0994_extra_action_confirmation_email: form0994_extra_action_confirmation_email_template_id
         form1010ez_reminder_email: fake_template_id

config/settings/test.yml

@@ -1571,7 +1571,6 @@ vanotify:
         covid_vaccine_registration: ~
         direct_deposit: direct_deposit_template_id
         direct_deposit_comp_pen: comp_pen_template_id
-        direct_deposit_edu: edu_template_id
         form0994_confirmation_email: form0994_confirmation_email_template_id
         form0994_extra_action_confirmation_email: form0994_extra_action_confirmation_email_template_id
         form1010ez_reminder_email: fake_template_id

spec/mailers/direct_deposit_mailer_spec.rb

@@ -30,25 +30,5 @@
         )
       end
     end
-
-    context 'ch33 email' do
-      let(:dd_type) { :ch33 }
-
-      it 'includes the right text' do
-        expect(subject.body.raw_source).to include(
-          "We'll use your updated information to deposit any education benefits you may receive"
-        )
-      end
-
-      context 'string dd_type' do
-        let(:dd_type) { 'ch33' }
-
-        it 'includes the right text' do
-          expect(subject.body.raw_source).to include(
-            "We'll use your updated information to deposit any education benefits you may receive"
-          )
-        end
-      end
-    end
   end
 end

spec/sidekiq/va_notify_dd_email_job_spec.rb

@@ -14,10 +14,10 @@
         ]
 
         emails.each do |email|
-          expect(described_class).to receive(:perform_async).with(email, 'ch33')
+          expect(described_class).to receive(:perform_async).with(email, 'direct_deposit')
         end
 
-        described_class.send_to_emails(emails, 'ch33')
+        described_class.send_to_emails(emails, 'direct_deposit')
       end
     end
 
@@ -30,50 +30,91 @@
           feature: 'direct_deposit'
         )
 
-        described_class.send_to_emails([], 'ch33')
+        described_class.send_to_emails([], 'direct_deposit')
       end
     end
   end
 
   describe '#perform' do
     let(:notification_client) { double('Notifications::Client') }
 
-    context 'with a dd type of ch33' do
-      it 'sends a confirmation email using the edu template' do
-        allow(VaNotify::Service).to receive(:new)
-          .with(Settings.vanotify.services.va_gov.api_key).and_return(notification_client)
+    context 'with a dd_type of comp_pen' do
+      context 'with Flipper :only_use_direct_deposit_email_template' do
+        context 'enabled' do
+          before do
+            allow(Flipper).to receive(:enabled?)
+              .with(:only_use_direct_deposit_email_template).and_return(true)
+          end
 
-        expect(notification_client).to receive(:send_email).with(
-          email_address: email, template_id: 'edu_template_id'
-        )
+          it 'sends a confirmation email using the direct_deposit template' do
+            allow(VaNotify::Service).to receive(:new)
+              .with(Settings.vanotify.services.va_gov.api_key).and_return(notification_client)
 
-        described_class.new.perform(email, 'ch33')
-      end
-    end
+            expect(notification_client).to receive(:send_email).with(
+              email_address: email, template_id: 'direct_deposit_template_id'
+            )
 
-    context 'with a dd type of comp_pen' do
-      it 'sends a confirmation email using the comp and pen template' do
-        allow(VaNotify::Service).to receive(:new)
-          .with(Settings.vanotify.services.va_gov.api_key).and_return(notification_client)
+            described_class.new.perform(email, 'comp_pen')
+          end
+        end
 
-        expect(notification_client).to receive(:send_email).with(
-          email_address: email, template_id: 'comp_pen_template_id'
-        )
+        context 'disabled' do
+          before do
+            allow(Flipper).to receive(:enabled?)
+              .with(:only_use_direct_deposit_email_template).and_return(false)
+          end
+
+          it 'sends a confirmation email using the comp and pen template' do
+            allow(VaNotify::Service).to receive(:new)
+              .with(Settings.vanotify.services.va_gov.api_key).and_return(notification_client)
+
+            expect(notification_client).to receive(:send_email).with(
+              email_address: email, template_id: 'comp_pen_template_id'
+            )
 
-        described_class.new.perform(email, 'comp_pen')
+            described_class.new.perform(email, 'comp_pen')
+          end
+        end
       end
     end
 
-    context 'with a dd type of comp_and_pen' do
-      it 'sends a confirmation email using the comp and pen template' do
-        allow(VaNotify::Service).to receive(:new)
-          .with(Settings.vanotify.services.va_gov.api_key).and_return(notification_client)
+    context 'with a dd_type of comp_and_pen' do
+      context 'with Flipper :only_use_direct_deposit_email_template' do
+        context 'enabled' do
+          before do
+            allow(Flipper).to receive(:enabled?)
+              .with(:only_use_direct_deposit_email_template).and_return(true)
+          end
 
-        expect(notification_client).to receive(:send_email).with(
-          email_address: email, template_id: 'comp_pen_template_id'
-        )
+          it 'sends a confirmation email using the direct_deposit template' do
+            allow(VaNotify::Service).to receive(:new)
+              .with(Settings.vanotify.services.va_gov.api_key).and_return(notification_client)
 
-        described_class.new.perform(email, 'comp_and_pen')
+            expect(notification_client).to receive(:send_email).with(
+              email_address: email, template_id: 'direct_deposit_template_id'
+            )
+
+            described_class.new.perform(email, 'comp_and_pen')
+          end
+        end
+
+        context 'disabled' do
+          before do
+            allow(Flipper).to receive(:enabled?)
+              .with(:only_use_direct_deposit_email_template).and_return(false)
+          end
+
+          it 'sends a confirmation email using the comp and pen template' do
+            allow(VaNotify::Service).to receive(:new)
+              .with(Settings.vanotify.services.va_gov.api_key).and_return(notification_client)
+
+            expect(notification_client).to receive(:send_email).with(
+              email_address: email, template_id: 'comp_pen_template_id'
+            )
+
+            described_class.new.perform(email, 'comp_and_pen')
+          end
+        end
       end
     end
 
@@ -126,36 +167,58 @@
     end
   end
 
-  describe '#get_template' do
+  describe '#template_type' do
     let(:job) { VANotifyDdEmailJob.new }
 
-    context 'when dd_type is nil' do
-      it 'returns the direct_deposit template' do
-        expect(job.template_type(nil)).to eq('direct_deposit')
+    shared_examples 'template type with feature flag' do |dd_type, expected_template|
+      it "returns the #{expected_template} template when dd_type is #{dd_type}" do
+        expect(job.template_type(dd_type)).to eq(expected_template)
       end
     end
 
-    context 'when dd_type is unknown' do
-      it 'returns the direct_deposit template' do
-        expect(job.template_type('fake')).to eq('direct_deposit')
+    context 'with Flipper :only_use_direct_deposit_email_template enabled' do
+      before do
+        allow(Flipper).to receive(:enabled?)
+          .with(:only_use_direct_deposit_email_template).and_return(true)
       end
-    end
 
-    context 'when dd_type is comp_pen' do
-      it 'returns the direct_deposit_comp_pen template' do
-        expect(job.template_type('comp_pen')).to eq('direct_deposit_comp_pen')
+      context 'when dd_type is nil' do
+        include_examples 'template type with feature flag', nil, 'direct_deposit'
       end
-    end
 
-    context 'when dd_type is comp_and_pen' do
-      it 'returns the direct_deposit_comp_pen template' do
-        expect(job.template_type('comp_and_pen')).to eq('direct_deposit_comp_pen')
+      context 'when dd_type is unknown' do
+        include_examples 'template type with feature flag', 'fake', 'direct_deposit'
+      end
+
+      context 'when dd_type is comp_pen' do
+        include_examples 'template type with feature flag', 'comp_pen', 'direct_deposit'
+      end
+
+      context 'when dd_type is comp_and_pen' do
+        include_examples 'template type with feature flag', 'comp_and_pen', 'direct_deposit'
       end
     end
 
-    context 'when dd_type is edu' do
-      it 'returns the direct_deposit_edu template' do
-        expect(job.template_type('ch33')).to eq('direct_deposit_edu')
+    context 'with Flipper :only_use_direct_deposit_email_template disabled' do
+      before do
+        allow(Flipper).to receive(:enabled?)
+          .with(:only_use_direct_deposit_email_template).and_return(false)
+      end
+
+      context 'when dd_type is nil' do
+        include_examples 'template type with feature flag', nil, 'direct_deposit'
+      end
+
+      context 'when dd_type is unknown' do
+        include_examples 'template type with feature flag', 'fake', 'direct_deposit'
+      end
+
+      context 'when dd_type is comp_pen' do
+        include_examples 'template type with feature flag', 'comp_pen', 'direct_deposit_comp_pen'
+      end
+
+      context 'when dd_type is comp_and_pen' do
+        include_examples 'template type with feature flag', 'comp_and_pen', 'direct_deposit_comp_pen'
       end
     end
   end