Add OneTrust wrapper integration tests (#944)

packages/consent/consent-tools-integration-tests/package.json

@@ -20,9 +20,7 @@
     "@wdio/cli": "^8.10.6",
     "@wdio/local-runner": "^8.10.6",
     "@wdio/mocha-framework": "^8.10.6",
-    "@wdio/sauce-service": "^8.10.6",
     "@wdio/spec-reporter": "^8.10.6",
-    "@wdio/static-server-service": "^8.10.6",
     "@wdio/types": "8",
     "expect": "^29.4.1",
     "globby": "^11.0.2",

packages/consent/consent-tools-integration-tests/src/page-objects/base-page.ts

@@ -15,7 +15,18 @@ export abstract class BasePage {
     const baseURL = browser.options.baseUrl
     assert(baseURL)
     await waitUntilReady()
-
     await browser.url(baseURL + '/' + this.page)
   }
+
+  async clearStorage() {
+    await browser.deleteAllCookies()
+    await browser.execute(() => localStorage.clear())
+  }
+
+  /**
+   * Hard reload the page
+   */
+  reload() {
+    return browser.execute(() => window.location.reload())
+  }
 }

packages/consent/consent-tools-integration-tests/src/page-objects/onetrust.ts

@@ -13,6 +13,24 @@ class OneTrustPage extends BasePage {
   clickAcceptButtonAndClosePopup() {
     return $('#onetrust-accept-btn-handler').click()
   }
+
+  /**
+   * Whenever a consent event is sent, increment a counter
+   */
+  detectConsentChanged() {
+    const getConsentChangedCallCount = (): Promise<number> =>
+      browser.execute(() => window._segmentConsentCalls)
+
+    void browser.execute(() => {
+      window._segmentConsentCalls ??= 0
+      window.analytics.on('track', (name) => {
+        if (name.includes('Segment Consent')) {
+          window._segmentConsentCalls += 1
+        }
+      })
+    })
+    return { getConsentChangedCallCount }
+  }
 }
 
 export default new OneTrustPage()

packages/consent/consent-tools-integration-tests/src/tests/onetrust.test.ts

@@ -2,9 +2,19 @@
 import page from '../page-objects/onetrust'
 import { expect } from 'expect'
 import { Context } from '@segment/analytics-next'
+
+declare global {
+  interface Window {
+    _segmentConsentCalls: number
+  }
+}
+
+afterEach(async () => {
+  await page.clearStorage()
+})
+
 it('should stamp each event', async () => {
   await page.load()
-
   const commands = [
     `analytics.track("hello world")`,
     `analytics.alias("foo", "bar")`,
@@ -13,15 +23,31 @@ it('should stamp each event', async () => {
     `analytics.identify("bar", { bar: 123 })`,
   ]
 
-  const r = Promise.all<Context>(commands.map((cmd) => browser.execute(cmd)))
+  const eventsP = Promise.all<Context>(
+    commands.map((cmd) => browser.execute(cmd))
+  )
 
   await page.clickAcceptButtonAndClosePopup()
-
-  const responses = await r
-
-  responses.forEach((ctx) => {
+  ;(await eventsP).forEach((ctx) => {
     expect(
       Object.keys((ctx.event.context as any).consent.categoryPreferences).length
     ).toBeGreaterThan(0)
   })
 })
+
+it('should send a consent changed event when user clicks accept on popup', async () => {
+  await page.load()
+
+  const { getConsentChangedCallCount } = await page.detectConsentChanged()
+
+  await browser.pause(1000)
+  await expect(getConsentChangedCallCount()).resolves.toBe(0)
+
+  // make a consent selection in the OneTrust popup
+  await page.clickAcceptButtonAndClosePopup()
+
+  // 1 consent changed event should now be sent
+  await browser.waitUntil(
+    async () => (await getConsentChangedCallCount()) === 1
+  )
+})

packages/consent/consent-tools-integration-tests/src/types/analytics.d.ts

@@ -0,0 +1,7 @@
+import type { AnalyticsSnippet } from '@segment/analytics-next'
+
+declare global {
+  interface Window {
+    analytics: AnalyticsSnippet
+  }
+}

packages/consent/consent-tools-integration-tests/tsconfig.json

@@ -10,7 +10,7 @@
       "node",
       "expect-webdriverio",
       "@wdio/mocha-framework",
-      "@wdio/sauce-service"
+      "wdio-intercept-service"
     ]
   }
 }

packages/consent/consent-tools-integration-tests/wdio.conf.local.ts

@@ -1,6 +1,15 @@
 import type { Options } from '@wdio/types'
 
 export const config: Options.Testrunner = {
+  afterTest(test, _, { error, passed }) {
+    console.log(
+      [
+        `${passed ? '✅ Passed' : '❌ Failed'}! ${test.title}`,
+        test.file,
+        error ? error : '',
+      ].join('\n')
+    )
+  },
   services: ['intercept'],
   // services: [ /* Using webpack-dev-server instead */
   //   [

turbo.json

@@ -9,7 +9,7 @@
         "**/*.tsx",
         ":!**/__tests__/**"
       ],
-      "outputs": ["dist/**", ".next/**"]
+      "outputs": ["**/dist/**", ".next/**"]
     },
     "test": {
       "dependsOn": ["^build"]