-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support referrerPolicy:no-referrer in amp-analytics (#16734)
* Support referrerPolicy:no-referrer in amp-analytics * Add test * Fix type checks. * Add documentation
- Loading branch information
Showing
6 changed files
with
217 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /** | ||
| * Copyright 2018 The AMP HTML Authors. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS-IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import {createElementWithAttributes} from '../src/dom'; | ||
| import {dict} from '../src/utils/object'; | ||
| import {user} from '../src/log'; | ||
|
|
||
| /** @const {string} */ | ||
| const TAG = 'pixel'; | ||
|
|
||
| /** | ||
| * @param {!Window} win | ||
| * @param {string} src | ||
| * @param {?string=} referrerPolicy | ||
| * @return {!Element} | ||
| */ | ||
| export function createPixel(win, src, referrerPolicy) { | ||
| if (referrerPolicy && referrerPolicy !== 'no-referrer') { | ||
| user().error(TAG, 'Unsupported referrerPolicy: ' + referrerPolicy); | ||
| } | ||
|
|
||
| return referrerPolicy === 'no-referrer' | ||
| ? createNoReferrerPixel(win, src) | ||
| : createImagePixel(win, src); | ||
| } | ||
|
|
||
| /** | ||
| * @param {!Window} win | ||
| * @param {string} src | ||
| * @return {!Element} | ||
| */ | ||
| function createNoReferrerPixel(win, src) { | ||
| if (isReferrerPolicySupported()) { | ||
| return createImagePixel(win, src, true); | ||
| } else { | ||
| // if "referrerPolicy" is not supported, use iframe wrapper | ||
| // to scrub the referrer. | ||
| const iframe = createElementWithAttributes( | ||
| /** @type {!Document} */ (win.document), 'iframe', dict({ | ||
| 'src': 'about:blank', | ||
| 'style': 'display:none', | ||
| })); | ||
| win.document.body.appendChild(iframe); | ||
| createImagePixel(iframe.contentWindow, src); | ||
| return iframe; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param {!Window} win | ||
| * @param {string} src | ||
| * @param {boolean=} noReferrer | ||
| * @return {!Image} | ||
| */ | ||
| function createImagePixel(win, src, noReferrer = false) { | ||
| const image = new win.Image(); | ||
| if (noReferrer) { | ||
| image.referrerPolicy = 'no-referrer'; | ||
| } | ||
| image.src = src; | ||
| return image; | ||
| } | ||
|
|
||
| /** | ||
| * Check if element attribute "referrerPolicy" is supported by the browser. | ||
| * Safari 11.1 does not support it yet. | ||
| * | ||
| * @return {boolean} | ||
| */ | ||
| function isReferrerPolicySupported() { | ||
| return 'referrerPolicy' in Image.prototype; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| /** | ||
| * Copyright 2018 The AMP HTML Authors. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS-IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { | ||
| depositRequestUrl, | ||
| withdrawRequest, | ||
| } from '../../testing/test-helper'; | ||
|
|
||
| describe.configure().run('amp-analytics', function() { | ||
| this.timeout(15000); | ||
|
|
||
| describes.integration('amp-analytics integration test', { | ||
| body: | ||
| `<amp-analytics> | ||
| <script type="application/json"> | ||
| { | ||
| "requests": { | ||
| "endpoint": "${depositRequestUrl('analytics-has-referrer')}" | ||
| }, | ||
| "triggers": { | ||
| "pageview": { | ||
| "on": "visible", | ||
| "request": "endpoint" | ||
| } | ||
| } | ||
| } | ||
| </script> | ||
| </amp-analytics> | ||
| `, | ||
| extensions: ['amp-analytics'], | ||
| }, env => { | ||
| it('should keep referrer if no referrerpolicy specified', () => { | ||
| return withdrawRequest(env.win, | ||
| 'analytics-has-referrer').then(request => { | ||
| expect(request.headers.referer).to.be.ok; | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describes.integration('amp-analytics integration test', { | ||
| body: | ||
| `<amp-analytics> | ||
| <script type="application/json"> | ||
| { | ||
| "requests": { | ||
| "endpoint": "${depositRequestUrl('analytics-no-referrer')}" | ||
| }, | ||
| "triggers": { | ||
| "pageview": { | ||
| "on": "visible", | ||
| "request": "endpoint" | ||
| } | ||
| }, | ||
| "transport": { | ||
| "referrerPolicy": "no-referrer" | ||
| } | ||
| } | ||
| </script> | ||
| </amp-analytics> | ||
| `, | ||
| extensions: ['amp-analytics'], | ||
| }, env => { | ||
| it('should remove referrer if referrerpolicy=no-referrer', () => { | ||
| return withdrawRequest(env.win, 'analytics-no-referrer').then(request => { | ||
| expect(request.headers.referer).to.not.be.ok; | ||
| }); | ||
| }); | ||
| }); | ||
| }); |