Merge pull request #1322 from thebiggive/DON-888-ab-test

DON-888 – A/B testing setup + proof of concept
thebiggive · Oct 4, 2023 · f85ea73 · f85ea73
2 parents 7e559f7 + c876575
commit f85ea73
Show file tree

Hide file tree

Showing 10 changed files with 117 additions and 26 deletions.
diff --git a/src/app/app.component.ts b/src/app/app.component.ts
@@ -2,6 +2,7 @@ import {APP_BASE_HREF, isPlatformBrowser} from '@angular/common';
 import {AfterViewInit, Component, HostListener, Inject, OnInit, PLATFORM_ID, ViewChild} from '@angular/core';
 import {Event as RouterEvent, NavigationEnd, NavigationStart, Router,} from '@angular/router';
 import {BiggiveMainMenu} from '@biggive/components-angular';
+import {MatomoTracker} from "ngx-matomo";
 import {filter} from 'rxjs/operators';
 
 import {DonationService} from './donation.service';
@@ -17,7 +18,6 @@ import {
   CookiePreferences,
   CookiePreferenceService
 } from "./cookiePreference.service";
-import {MatomoTracker} from "ngx-matomo";
 
 @Component({
   selector: 'app-root',

diff --git a/src/app/app.module.ts b/src/app/app.module.ts
@@ -48,7 +48,7 @@ const matomoTrackers = environment.matomoSiteId ? [
       routeTracking: {
         enable: true,
       },
-        requireCookieConsent: flags.cookieBannerEnabled,
+      requireCookieConsent: flags.cookieBannerEnabled,
     }),
     RouterModule.forRoot(routes, {
       bindToComponentInputs: true,

diff --git a/src/app/donation-complete/donation-complete.component.ts b/src/app/donation-complete/donation-complete.component.ts
@@ -229,8 +229,14 @@ export class DonationCompleteComponent implements OnInit {
     });
 
     if (donation && this.donationService.isComplete(donation)) {
+      // This is linked to the Donation Complete goal in Matomo, so we don't need to separately
+      // `trackGoal()` for that.
       this.matomoTracker.trackEvent('donate', 'thank_you_fully_loaded', `Donation to campaign ${donation.projectId}`);
 
+      if (donation.tipAmount > 0 && environment.matomoNonZeroTipGoalId && donation.currencyCode === 'GBP') {
+        this.matomoTracker.trackGoal(environment.matomoNonZeroTipGoalId, donation.tipAmount);
+      }
+
       this.cardChargedAmount = donation.donationAmount + donation.feeCoverAmount + donation.tipAmount;
       this.giftAidAmount = donation.giftAid ? 0.25 * donation.donationAmount : 0;
       this.totalValue = donation.donationAmount + this.giftAidAmount + donation.matchedAmount;

diff --git a/src/app/donation-start/donation-start-form/donation-start-form.component.html b/src/app/donation-start/donation-start-form/donation-start-form.component.html
@@ -64,8 +64,13 @@
 
           <h2 class="b-rt-0 b-m-0 b-bold">Tip Big Give</h2>
           <p *ngIf="!campaign.feePercentage && creditPenceToUse === 0">
-            Big Give doesn't charge platform fees. That means we're only able to continue offering our services thanks to
-            the generosity of donors who leave an optional tip amount here.
+            <span *ngIf="!alternateCopy">
+              Big Give doesn't charge platform fees. That means we're only able to continue offering our services thanks to
+              the generosity of donors who leave a tip.
+            </span>
+            <span *ngIf="alternateCopy">
+              Big Give is a registered charity (1136547), and since 2008, our aim has been to help thousands of charities double the difference of their donations. Thanks to the generosity of people like you who leave a tip, we can continue providing a match funding platform for the charities and causes you care about. 
+            </span>
           </p>
 
           <div *ngIf="campaign.feePercentage && creditPenceToUse === 0">
@@ -101,6 +106,8 @@ <h2 class="b-rt-0 b-m-0 b-bold">Tip Big Give</h2>
                   slot="input"
                 />
               </biggive-text-input>
+
+              <p>Did you know Big Give is a charity, too? Tips help us provide a platform that doubles the difference of your donation to the causes closest to your heart. We truly appreciate any tip you can give - no matter the size.</p>
             </div>
 
             <div
@@ -149,32 +156,45 @@ <h2 class="b-rt-0 b-m-0 b-bold">Tip Big Give</h2>
             <mat-expansion-panel-header>
             </mat-expansion-panel-header>
           </mat-expansion-panel>
-          <mat-expansion-panel (opened)="panelOpenState = true"
-                               (closed)="panelOpenState = false">
+          <mat-expansion-panel
+            (opened)="panelOpenState = true"
+            (closed)="panelOpenState = false"
+          >
             <mat-expansion-panel-header>
               <h3 class="b-rt-0 b-m-0 b-bold"><span class="span-hr"></span>How does Big Give use tips?</h3>
-
             </mat-expansion-panel-header>
-            <p>
-              Big Give is a registered charity, no 1136547. We don’t charge charities for using our platform; we rely on the generosity of people who donate to leave a Voluntary Tip, which helps us run our match funding campaigns.
-            </p>
-            <p>Your tips will be going to:</p>
-            <ul>
-              <li>Supporting our website and team, allowing charities to double their
-                donations to good causes.
-              </li>
-              <li>Providing match funds. Through tips, charities can receive funds from Big Give to launch their own campaign.
-                <a href="https://biggive.org/anchor-match-fund/" target="_blank"><mat-icon class="b-va-bottom" aria-hidden="false" aria-label="Open in new tab">open_in_new</mat-icon>
-                  Read more about the Anchor Match fund.
-                </a>
-              </li>
-            </ul>
-
-    <p>
-    Thank you for your generosity! Your tips ensure that we can continue to support charities and causes that are important to you.
 
-            </p>
+            <div *ngIf="!alternateCopy">
+              <p>
+                Big Give is a registered charity, no 1136547. We don't charge charities for using our platform; we rely on the generosity of people who donate to leave a Voluntary Tip, which helps us run our match funding campaigns.
+              </p>
+              <p>Your tips will be going to:</p>
+              <ul>
+                <li>Supporting our website and team, allowing charities to double their
+                  donations to good causes.
+                </li>
+                <li>Providing match funds. Through tips, charities can receive funds from Big Give to launch their own campaign.
+                  <a href="https://biggive.org/anchor-match-fund/" target="_blank"><mat-icon class="b-va-bottom" aria-hidden="false" aria-label="Open in new tab">open_in_new</mat-icon>
+                    Read more about the Anchor Match fund.
+                  </a>
+                </li>
+              </ul>
+              <p>
+                Thank you for your generosity! Your tips ensure that we can continue to support charities and causes that are important to you.
+              </p>
+            </div>
 
+            <div *ngIf="alternateCopy">
+              <p>
+                We don't charge charities for using our platform; instead, we rely on the generosity of people who donate to leave a Voluntary Tip, which helps us run our match funding campaigns.
+              </p>
+              <p>Everything we make goes back into supporting charities. Your tips will be:</p>
+              <ul>
+                <li>Doubling the difference onwards by providing match funding. Through tips, charities will receive funding in our <a href="https://biggive.org/anchor-match-fund/" target="_blank"><mat-icon class="b-va-bottom" aria-hidden="false" aria-label="Open in new tab">open_in_new</mat-icon> Anchor Match fund</a> to help launch their campaigns.</li>
+                <li>Helping us maintain our website and support our team, so we can keep working with your favourite charities for many years to come.</li>
+              </ul>
+              <p>Thank you! If you have any questions about tips, please contact us at [email protected].</p>
+            </div>
           </mat-expansion-panel>
         </div>
         <div aria-live="polite">

diff --git a/src/app/donation-start/donation-start-form/donation-start-form.component.ts b/src/app/donation-start/donation-start-form/donation-start-form.component.ts
@@ -65,6 +65,10 @@ import {DonationTippingSliderComponent} from "./donation-tipping-slider/donation
 import {MatomoTracker} from 'ngx-matomo';
 import {MatSnackBar} from "@angular/material/snack-bar";
 
+declare var _paq: {
+  push: (args: Array<string|object>) => void,
+};
+
 @Component({
   selector: 'app-donation-start-form',
   templateUrl: './donation-start-form.component.html',
@@ -80,6 +84,8 @@ export class DonationStartFormComponent implements AfterContentChecked, AfterCon
   @ViewChild('stepper') private stepper: MatStepper;
   @ViewChild('donationTippingSlider') private donationTippingSlider: DonationTippingSliderComponent|undefined;
 
+  alternateCopy = false; // Varies tip copy for A/B test.
+
   stripePaymentElement: StripePaymentElement | undefined;
   cardHandler = this.onStripeCardChange.bind(this);
   don819FlagEnabled = flags.don819FlagEnabled;
@@ -273,6 +279,38 @@ export class DonationStartFormComponent implements AfterContentChecked, AfterCon
   ngOnInit() {
     if (isPlatformBrowser(this.platformId)) {
       this.stripeService.init();
+
+      // ngx-matomo sets up window._paq internally, and doesn't have
+      // A/B test methods, so we work with the global ourselves.
+      if (environment.matomoAbTest && globalThis.hasOwnProperty('_paq')) {
+        _paq.push(['AbTesting::create', {
+          name: environment.matomoAbTest.name,
+          percentage: 100,
+          includedTargets: [{"attribute":"url","inverted":"0","type":"any","value":""}],
+          excludedTargets: [],
+          startDateTime: environment.matomoAbTest.startDate,
+          endDateTime: environment.matomoAbTest.endDate,
+          variations: [
+            {
+                name: 'original',
+                activate: (_event: any) => {
+                  // No change from the original form.
+                  console.log('Original test variant active!');
+                }
+            },
+            {
+                name: environment.matomoAbTest.variantName,
+                activate: (_event: any) => {
+                  this.alternateCopy = true;
+                  console.log('Copy B test variant active!');
+                }
+            },
+          ],
+          trigger: () => {
+              return true;
+          },
+        }]);
+      }
     }
 
     this.setCampaignBasedVars();

diff --git a/src/environments/environment.interface.ts b/src/environments/environment.interface.ts
@@ -20,14 +20,21 @@ export interface Environment {
   /** Domain for cookies to be shared between donate-frontend, wordpress etc.
    * Currently, ".biggive.org" in production.
    */
-   sharedCookieDomain: string;
+  sharedCookieDomain: string;
 
   /** Prefix for pages served by the SF Experience Cloud */
   experienceUriPrefix: string,
   donationsApiPrefix: string,
   getSiteControlId: string,
   identityApiPrefix: string,
   matomoSiteId: number | null, // null for no Matomo tracking.
+  matomoNonZeroTipGoalId: number | null, // Only tracks GBP campaigns; sends tip as value in £.
+  matomoAbTest?: {
+    name: string,
+    variantName: string, // The one that's not 'original'.
+    startDate: string,
+    endDate?: string, // Typically omit for dev/staging evaluation.
+  },
   minimumCreditAmount: number,
   maximumCreditAmount: number,
   postcodeLookupKey: string,

diff --git a/src/environments/environment.production.ts b/src/environments/environment.production.ts
@@ -16,6 +16,13 @@ export const environment: Environment = {
   getSiteControlId: '97792',
   identityApiPrefix: 'https://identity-production.thebiggive.org.uk/v1',
   matomoSiteId: 2,
+  matomoNonZeroTipGoalId: 11,
+  matomoAbTest: {
+    name: 'new_tip_copy_wgmf_2023',
+    variantName: 'test_b',
+    startDate: '2023/10/10 11:00:00 UTC',
+    endDate: '2023/10/18 12:00:00 UTC',
+  },
   minimumCreditAmount: 500,
   maximumCreditAmount: 500_000,
   postcodeLookupKey: 'gq9-k9zYakORdv2uoY_yVw33182',

diff --git a/src/environments/environment.regression.ts b/src/environments/environment.regression.ts
@@ -24,6 +24,7 @@ export const environment: Environment = {
   getSiteControlId: '97792',
   identityApiPrefix: 'https://identity-regression.thebiggivetest.org.uk/v1',
   matomoSiteId: null,
+  matomoNonZeroTipGoalId: null,
   minimumCreditAmount: 500,
   maximumCreditAmount: 500_000,
   postcodeLookupKey: 'gq9-k9zYakORdv2uoY_yVw33182',

diff --git a/src/environments/environment.staging.ts b/src/environments/environment.staging.ts
@@ -22,6 +22,12 @@ export const environment: Environment = {
   getSiteControlId: '97792',
   identityApiPrefix: 'https://identity-staging.thebiggivetest.org.uk/v1',
   matomoSiteId: 4,
+  matomoNonZeroTipGoalId: 1,
+  matomoAbTest: {
+    name: 'new_tip_copy_2023_10_02_b',
+    startDate: '2023/10/02 18:30:11 UTC',
+    variantName: 'copy_b',
+  },
   minimumCreditAmount: 500,
   maximumCreditAmount: 500_000,
   postcodeLookupKey: 'gq9-k9zYakORdv2uoY_yVw33182',

diff --git a/src/environments/environment.ts b/src/environments/environment.ts
@@ -22,6 +22,12 @@ export const environment: Environment = {
   getSiteControlId: '97792',
   identityApiPrefix: 'http://localhost:30050/v1',
   matomoSiteId: 4,
+  matomoNonZeroTipGoalId: 1,
+  matomoAbTest: {
+    name: 'new_tip_copy_2023_10_02_b',
+    startDate: '2023/10/02 18:30:11 UTC',
+    variantName: 'copy_b',
+  },
   minimumCreditAmount: 500,
   maximumCreditAmount: 500_000,
   postcodeLookupKey: 'gq9-k9zYakORdv2uoY_yVw33182',