Add API schema tests for Click to Load surrogate scripts (#1041)

The Click to Load feature redirects requests to certain scripts in
order to replace them with our "surrogate" scripts. It's important we
know when the original script has changed materially, so that we can
update the corresponding surrogate script. To that end, let's add
integration tests that check the schema of important Objects provided
by those scripts against the schema that we expect.

.github/workflows/tests.yml

@@ -55,3 +55,8 @@ jobs:
         sudo apt-get install xvfb
         npm run install-ci
     - run: npm run test-int-x
+    - name: Store test artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: integration-test-artifacts
+        path: integration-test/artifacts

.gitignore

@@ -14,3 +14,4 @@ build/chrome
 build/test
 test/background.js
 shared/content-scope-scripts/
+integration-test/artifacts/

Makefile

@@ -19,6 +19,11 @@ grunt-dev:
 tosdr:
 	grunt execute:tosdr --browser=$(browser) --type=$(type)
 
+setup-artifacts-dir:
+	rm -rf integration-test/artifacts
+	mkdir -p integration-test/artifacts/screenshots
+	mkdir -p integration-test/artifacts/api_schemas
+
 setup-build-dir:
 	mkdir -p build/$(browser)
 	rm -rf build/$(browser)/$(type)

integration-test/background/click-to-load-facebook.js

@@ -1,7 +1,9 @@
 const { getDomain } = require('tldts')
+
 const harness = require('../helpers/harness')
 const { logPageRequests } = require('../helpers/requests')
 const backgroundWait = require('../helpers/backgroundWait')
+const { setupAPISchemaTest } = require('../helpers/apiSchema')
 
 const testSite = 'https://privacy-test-pages.glitch.me/privacy-protections/click-to-load/'
 const facebookDomains = new Set(['facebook.com', 'facebook.net', 'fbcdn.net'])
@@ -129,3 +131,39 @@ describe('Test Facebook Click To Load', () => {
         page.close()
     })
 })
+
+describe('Facebook SDK schema', () => {
+    beforeAll(async () => {
+        ({ browser, bgPage, teardown } = await harness.setup({ loadExtension: false }))
+    })
+
+    afterAll(async () => {
+        try {
+            await teardown()
+        } catch (e) {}
+    })
+
+    it('CTL: Facebook SDK schema hasn\'t changed', async () => {
+        const page = await browser.newPage()
+        await page.goto(testSite, { waitUntil: 'networkidle2' })
+
+        // Note: If these tests fail, update the
+        //       /integration-test/data/api_schemas/facebook-sdk.json file
+        //       to match
+        //       /integration-test/artifacts/api_schemas/facebook-sdk.json
+        //       and make any corresponding changes required to the surrogate
+        //       scripts /shared/data/web_accessible_resources/facebook-sdk.js
+        //       and /shared/js/content-scripts/fb-surrogate-xray.js.
+        //       If no changes to the surrogate scripts are required, please
+        //       explain why to the reviewer!
+        //
+        //  See also https://developers.facebook.com/docs/graph-api/changelog
+
+        const { actualSchema, expectedSchema } = await setupAPISchemaTest(
+            page, 'facebook-sdk.json', ['FB']
+        )
+        expect(actualSchema).toEqual(expectedSchema)
+
+        page.close()
+    })
+})

integration-test/background/click-to-load-youtube.js

@@ -2,6 +2,7 @@ const harness = require('../helpers/harness')
 const { logPageRequests } = require('../helpers/requests')
 const { loadTestConfig, unloadTestConfig } = require('../helpers/testConfig')
 const backgroundWait = require('../helpers/backgroundWait')
+const { setupAPISchemaTest } = require('../helpers/apiSchema')
 
 const testSite = 'https://privacy-test-pages.glitch.me/privacy-protections/youtube-click-to-load/'
 const testConfig = {
@@ -293,3 +294,37 @@ describe('Test YouTube Click To Load', () => {
         page.close()
     })
 })
+
+describe('YouTube Iframe Player API schema', () => {
+    beforeAll(async () => {
+        ({ browser, bgPage, teardown } =
+         await harness.setup({ loadExtension: false }))
+    })
+
+    afterAll(async () => {
+        try {
+            await teardown()
+        } catch (e) {}
+    })
+
+    it('CTL: Iframe Player API schema hasn\'t changed', async () => {
+        const page = await browser.newPage()
+        await page.goto(testSite, { waitUntil: 'networkidle2' })
+
+        // Note: If this test fails, update
+        //       /integration-test/data/api_schemas/youtube-iframe-api.json file
+        //       to match
+        //       /integration-test/artifacts/api_schemas/youtube-iframe-api.json
+        //       and make any corresponding changes required to the surrogate
+        //       script /shared/data/web_accessible_resources/youtube-iframe-api.js
+        //       If no changes to the surrogate script are required, please
+        //       explain why to the reviewer!
+
+        const { actualSchema, expectedSchema } = await setupAPISchemaTest(
+            page, 'youtube-iframe-api.json', ['YT', 'YTConfig']
+        )
+        expect(actualSchema).toEqual(expectedSchema)
+
+        page.close()
+    })
+})