From ebcd63cf29494a66299bb31c1d432024d02fad15 Mon Sep 17 00:00:00 2001
From: Dima Voytenko <dvoytenko@google.com>
Date: Tue, 2 Feb 2016 09:52:04 -0800
Subject: [PATCH] Propagate analytics events in access

---
 examples/article-access.amp.html              |  35 +++++
 extensions/amp-access/0.1/amp-access.js       |  37 +++++
 .../amp-access/0.1/test/test-amp-access.js    | 112 ++++++++++++++
 extensions/amp-access/amp-access-analytics.md | 145 ++++++++++++++++++
 extensions/amp-access/amp-access-spec.md      |   2 +-
 extensions/amp-analytics/amp-analytics.md     |   9 +-
 6 files changed, 337 insertions(+), 3 deletions(-)
 create mode 100644 extensions/amp-access/amp-access-analytics.md
diff --git a/examples/article-access.amp.html b/examples/article-access.amp.html
index 255aaedebeaa..e185a732abf5 100644
--- a/examples/article-access.amp.html
+++ b/examples/article-access.amp.html
@@ -147,6 +147,41 @@
   <script async src="./viewer-integr.js"></script>
 </head>
 <body>
+<amp-analytics type="googleanalytics" id="analytics2">
+<script type="application/json">
+{
+  "vars": {
+    "account": "UA-YYYY-Y"
+  },
+  "triggers": {
+    "defaultPageview": {
+      "on": "visible",
+      "request": "pageview",
+      "vars": {
+        "title": "Example Pageview"
+      }
+    },
+    "authorizationReceived": {
+      "on": "access-authorization-received",
+      "request": "event",
+      "vars": {
+        "eventCategory": "amp-access",
+        "eventAction": "access-authorization-received"
+      }
+    },
+    "pingbackSent": {
+      "on": "access-pingback-sent",
+      "request": "event",
+      "vars": {
+        "eventCategory": "amp-access",
+        "eventAction": "access-pingback-sent"
+      }
+    }
+  }
+}
+</script>
+</amp-analytics>
+
   <header>
     <div class="brand-logo">
       PublisherLogo
diff --git a/extensions/amp-access/0.1/amp-access.js b/extensions/amp-access/0.1/amp-access.js
index 58485747c76e..980e7db63723 100644
--- a/extensions/amp-access/0.1/amp-access.js
+++ b/extensions/amp-access/0.1/amp-access.js
@@ -16,6 +16,7 @@
 
 import {all} from '../../../src/promise';
 import {actionServiceFor} from '../../../src/action';
+import {analyticsFor} from '../../../src/analytics';
 import {assert, assertEnumValue} from '../../../src/asserts';
 import {assertHttpsUrl, getSourceOrigin} from '../../../src/url';
 import {cidFor} from '../../../src/cid';
@@ -23,6 +24,7 @@ import {documentStateFor} from '../../../src/document-state';
 import {evaluateAccessExpr} from './access-expr';
 import {getService} from '../../../src/service';
 import {installStyles} from '../../../src/styles';
+import {isExperimentOn} from '../../../src/experiments';
 import {listenOnce} from '../../../src/event-helper';
 import {log} from '../../../src/log';
 import {onDocumentReady} from '../../../src/document-state';
@@ -67,6 +69,9 @@ const AccessType = {
 /** @const */
 const TAG = 'AmpAccess';
 
+/** @const */
+const ANALYTICS_EXPERIMENT = 'amp-access-analytics';
+
 /** @const {number} */
 const VIEW_TIMEOUT = 2000;
 
@@ -89,6 +94,10 @@ export class AccessService {
     /** @const @private {boolean} */
     this.isExperimentOn_ = true;
 
+    /** @const @private {boolean} */
+    this.isAnalyticsExperimentOn_ = (this.isExperimentOn_ &&
+        isExperimentOn(this.win, ANALYTICS_EXPERIMENT));
+
     const accessElement = document.getElementById('amp-access');
 
     /** @const @private {boolean} */
@@ -156,6 +165,13 @@ export class AccessService {
 
     /** @private {?Promise} */
     this.loginPromise_ = null;
+
+    /** @private {!Promise<!InstrumentationService>} */
+    this.analyticsPromise_ = analyticsFor(this.win);
+
+    this.firstAuthorizationPromise_.then(() => {
+      this.analyticsEvent_('access-authorization-received');
+    });
   }
 
   /**
@@ -208,6 +224,18 @@ export class AccessService {
     return this.enabled_;
   }
 
+  /**
+   * @param {string} eventType
+   * @private
+   */
+  analyticsEvent_(eventType) {
+    if (this.isAnalyticsExperimentOn_) {
+      this.analyticsPromise_.then(analytics => {
+        analytics.triggerEvent(eventType);
+      });
+    }
+  }
+
   /**
    * @return {!AccessService}
    * @private
@@ -336,6 +364,7 @@ export class AccessService {
       });
     }).catch(error => {
       log.error(TAG, 'Authorization failed: ', error);
+      this.analyticsEvent_('access-authorization-failed');
       this.toggleTopClass_('amp-access-loading', false);
       this.toggleTopClass_('amp-access-error', true);
     });
@@ -487,6 +516,7 @@ export class AccessService {
     log.fine(TAG, 'start view monitoring');
     this.reportViewPromise_ = this.whenViewed_()
         .then(() => {
+          this.analyticsEvent_('access-viewed');
           // Wait for the first authorization flow to complete.
           return this.firstAuthorizationPromise_;
         })
@@ -561,8 +591,10 @@ export class AccessService {
       });
     }).then(() => {
       log.fine(TAG, 'Pingback complete');
+      this.analyticsEvent_('access-pingback-sent');
     }).catch(error => {
       log.error(TAG, 'Pingback failed: ', error);
+      this.analyticsEvent_('access-pingback-failed');
       throw error;
     });
   }
@@ -603,6 +635,7 @@ export class AccessService {
     assert(this.config_.login, 'Login URL is not configured');
     // Login URL should always be available at this time.
     const loginUrl = assert(this.loginUrl_, 'Login URL is not ready');
+    this.analyticsEvent_('access-login-started');
     this.loginPromise_ = this.openLoginDialog_(loginUrl).then(result => {
       log.fine(TAG, 'Login dialog completed: ', result);
       this.loginPromise_ = null;
@@ -610,12 +643,16 @@ export class AccessService {
       const s = query['success'];
       const success = (s == 'true' || s == 'yes' || s == '1');
       if (success) {
+        this.analyticsEvent_('access-login-success');
         this.broadcastReauthorize_();
         // Repeat the authorization flow.
         return this.runAuthorization_();
+      } else {
+        this.analyticsEvent_('access-login-rejected');
       }
     }).catch(reason => {
       log.fine(TAG, 'Login dialog failed: ', reason);
+      this.analyticsEvent_('access-login-failed');
       this.loginPromise_ = null;
       throw reason;
     });
diff --git a/extensions/amp-access/0.1/test/test-amp-access.js b/extensions/amp-access/0.1/test/test-amp-access.js
index 9919c1cd3c7d..5b487083a265 100644
--- a/extensions/amp-access/0.1/test/test-amp-access.js
+++ b/extensions/amp-access/0.1/test/test-amp-access.js
@@ -210,6 +210,18 @@ describe('AccessService', () => {
     expect(service.pubOrigin_).to.exist;
     expect(service.pubOrigin_).to.match(/^http.*/);
   });
+
+  it('should NOT send events by default', () => {
+    element.textContent = JSON.stringify({
+      'authorization': 'https://acme.com/a',
+      'pingback': 'https://acme.com/p',
+      'login': 'https://acme.com/l'
+    });
+    const service = new AccessService(window);
+    service.analyticsPromise_ = {then: sandbox.spy()};
+    service.analyticsEvent_('an-event');
+    expect(service.analyticsPromise_.then.callCount).to.equal(0);
+  });
 });
 
 
@@ -219,6 +231,7 @@ describe('AccessService authorization', () => {
   let configElement, elementOn, elementOff;
   let xhrMock;
   let cidMock;
+  let analyticsMock;
 
   beforeEach(() => {
     sandbox = sinon.sandbox.create();
@@ -268,6 +281,13 @@ describe('AccessService authorization', () => {
     };
     cidMock = sandbox.mock(cid);
     service.cid_ = Promise.resolve(cid);
+
+    const analytics = {
+      triggerEvent: () => {}
+    };
+    analyticsMock = sandbox.mock(analytics);
+    service.analyticsPromise_ = {then: callback => callback(analytics)};
+    service.isAnalyticsExperimentOn_ = true;
   });
 
   afterEach(() => {
@@ -280,6 +300,7 @@ describe('AccessService authorization', () => {
     if (elementOff.parentElement) {
       elementOff.parentElement.removeChild(elementOff);
     }
+    analyticsMock.verify();
     sandbox.restore();
     sandbox = null;
   });
@@ -347,6 +368,9 @@ describe('AccessService authorization', () => {
         })
         .returns(Promise.resolve({access: true}))
         .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-authorization-received')
+        .once();
     return service.runAuthorization_().then(() => {
       expect(service.firstAuthorizationPromise_).to.exist;
       return service.firstAuthorizationPromise_;
@@ -362,6 +386,12 @@ describe('AccessService authorization', () => {
         })
         .returns(Promise.reject('intentional'))
         .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-authorization-received')
+        .never();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-authorization-failed')
+        .once();
     return service.runAuthorization_().then(() => {
       expect(service.firstAuthorizationPromise_).to.exist;
       let resolved = false;
@@ -548,6 +578,7 @@ describe('AccessService pingback', () => {
   let configElement;
   let xhrMock;
   let cidMock;
+  let analyticsMock;
   let visibilityChanged;
   let scrolled;
 
@@ -580,6 +611,13 @@ describe('AccessService pingback', () => {
     cidMock = sandbox.mock(cid);
     service.cid_ = Promise.resolve(cid);
 
+    const analytics = {
+      triggerEvent: () => {}
+    };
+    analyticsMock = sandbox.mock(analytics);
+    service.analyticsPromise_ = {then: callback => callback(analytics)};
+    service.isAnalyticsExperimentOn_ = true;
+
     this.docState_ = {
       onReady: callback => callback()
     };
@@ -605,6 +643,7 @@ describe('AccessService pingback', () => {
     if (configElement.parentElement) {
       configElement.parentElement.removeChild(configElement);
     }
+    analyticsMock.verify();
     sandbox.restore();
     sandbox = null;
   });
@@ -620,6 +659,9 @@ describe('AccessService pingback', () => {
 
   it('should register "viewed" signal after timeout', () => {
     service.reportViewToServer_ = sandbox.spy();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-viewed')
+        .once();
     const p = service.reportWhenViewed_();
     return Promise.resolve().then(() => {
       clock.tick(2001);
@@ -633,6 +675,9 @@ describe('AccessService pingback', () => {
 
   it('should register "viewed" signal after scroll', () => {
     service.reportViewToServer_ = sandbox.spy();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-viewed')
+        .once();
     const p = service.reportWhenViewed_();
     return Promise.resolve().then(() => {
       scrolled.fire();
@@ -646,6 +691,9 @@ describe('AccessService pingback', () => {
 
   it('should register "viewed" signal after click', () => {
     service.reportViewToServer_ = sandbox.spy();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-viewed')
+        .once();
     const p = service.reportWhenViewed_();
     return Promise.resolve().then(() => {
       let clickEvent;
@@ -671,6 +719,9 @@ describe('AccessService pingback', () => {
     service.firstAuthorizationPromise_ = new Promise(resolve => {
       firstAuthorizationResolver = resolve;
     });
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-viewed')
+        .once();
     service.reportViewToServer_ = sandbox.spy();
     service.reportWhenViewed_();
     return Promise.resolve().then(() => {
@@ -763,6 +814,9 @@ describe('AccessService pingback', () => {
             }))
         .returns(Promise.resolve())
         .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-pingback-sent')
+        .once();
     return service.reportViewToServer_().then(() => {
       return 'SUCCESS';
     }, error => {
@@ -788,6 +842,35 @@ describe('AccessService pingback', () => {
     });
   });
 
+  it('should NOT send analytics event if postback failed', () => {
+    expectGetReaderId('reader1');
+    xhrMock.expects('sendSignal')
+        .withExactArgs('https://acme.com/p?rid=reader1&type=',
+            sinon.match(init => {
+              return (init.method == 'POST' &&
+                  init.credentials == 'include' &&
+                  init.requireAmpResponseSourceOrigin == true &&
+                  init.body == '' &&
+                  init.headers['Content-Type'] ==
+                      'application/x-www-form-urlencoded');
+            }))
+        .returns(Promise.reject('intentional'))
+        .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-pingback-sent')
+        .never();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-pingback-failed')
+        .once();
+    return service.reportViewToServer_().then(() => {
+      return 'SUCCESS';
+    }, error => {
+      return 'ERROR ' + error;
+    }).then(result => {
+      expect(result).to.match(/ERROR/);
+    });
+  });
+
   it('should broadcast "viewed" signal to other documents', () => {
     service.reportViewToServer_ = sandbox.stub().returns(Promise.resolve());
     const broadcastStub = sandbox.stub(service.viewer_, 'broadcast');
@@ -812,6 +895,7 @@ describe('AccessService login', () => {
   let sandbox;
   let configElement;
   let cidMock;
+  let analyticsMock;
   let serviceMock;
 
   beforeEach(() => {
@@ -840,6 +924,13 @@ describe('AccessService login', () => {
     cidMock = sandbox.mock(cid);
     service.cid_ = Promise.resolve(cid);
 
+    const analytics = {
+      triggerEvent: () => {}
+    };
+    analyticsMock = sandbox.mock(analytics);
+    service.analyticsPromise_ = {then: callback => callback(analytics)};
+    service.isAnalyticsExperimentOn_ = true;
+
     service.openLoginDialog_ = () => {};
     serviceMock = sandbox.mock(service);
 
@@ -884,6 +975,9 @@ describe('AccessService login', () => {
   it('should open dialog in the same microtask', () => {
     service.openLoginDialog_ = sandbox.stub();
     service.openLoginDialog_.returns(Promise.resolve());
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-login-started')
+        .once();
     service.login();
     expect(service.openLoginDialog_.callCount).to.equal(1);
     expect(service.openLoginDialog_.firstCall.args[0])
@@ -902,6 +996,12 @@ describe('AccessService login', () => {
         .withExactArgs('https://acme.com/l?rid=R')
         .returns(Promise.resolve('#success=true'))
         .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-login-started')
+        .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-login-success')
+        .once();
     return service.login().then(() => {
       expect(service.loginPromise_).to.not.exist;
       expect(service.runAuthorization_.callCount).to.equal(1);
@@ -919,6 +1019,12 @@ describe('AccessService login', () => {
         .withExactArgs('https://acme.com/l?rid=R')
         .returns(Promise.resolve('#success=no'))
         .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-login-started')
+        .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-login-rejected')
+        .once();
     return service.login().then(() => {
       expect(service.loginPromise_).to.not.exist;
       expect(service.runAuthorization_.callCount).to.equal(0);
@@ -943,6 +1049,12 @@ describe('AccessService login', () => {
         .withExactArgs('https://acme.com/l?rid=R')
         .returns(Promise.reject('abort'))
         .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-login-started')
+        .once();
+    analyticsMock.expects('triggerEvent')
+        .withExactArgs('access-login-failed')
+        .once();
     return service.login().then(() => 'SUCCESS', () => 'ERROR').then(result => {
       expect(result).to.equal('ERROR');
       expect(service.loginPromise_).to.not.exist;
diff --git a/extensions/amp-access/amp-access-analytics.md b/extensions/amp-access/amp-access-analytics.md
new file mode 100644
index 000000000000..2f0b9f4a7770
--- /dev/null
+++ b/extensions/amp-access/amp-access-analytics.md
@@ -0,0 +1,145 @@
+<!---
+Copyright 2016 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.
+-->
+
+### <a name="amp-access-analytics"></a>AMP Access and Analytics
+
+Experiment: "amp-access-analytics" should be enabled via https://cdn.ampproject.org/experiments.html or
+`AMP.toggleExperiment('amp-access-analytics')`. See [Experiments Guide](../../tools/experiments/README.md).
+
+An integration with *amp-analytics* is under development and can be tracked on [Issue #1556](https://github.com/ampproject/amphtml/issues/1556). This document will be updated when more details on the integration are available.
+
+#### Access analytics triggers
+
+Access service issues events for major states in the access flow. These events can be reported via an analytics package using triggers.
+
+See [amp-analytics.md](../amp-analytics/amp-analytics.md) for details on *amp-analytics* configuration.
+
+###### Authorization received trigger (`"on": "access-authorization-received"`)
+
+The `access-authorization-received` event is issued when the Authorization endpoint has succeeded. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessAuthorizationReceived": {
+    "on": "access-authorization-received",
+    "request": "event"
+  }
+}
+```
+
+###### Authorization received trigger (`"on": "access-authorization-failed"`)
+
+The `access-authorization-failed` event is issued when the Authorization endpoint has failed. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessAuthorizationFailed": {
+    "on": "access-authorization-failed",
+    "request": "event"
+  }
+}
+```
+
+###### Access view registered trigger (`"on": "access-viewed"`)
+
+The `access-viewed` event is issued when the access system considers the page viewed and right before pingback is sent. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessViewed": {
+    "on": "access-viewed",
+    "request": "event"
+  }
+}
+```
+
+###### Pingback sent trigger (`"on": "access-pingback-sent"`)
+
+The `access-pingback-sent` event is issued when the Pingback endpoint has succeeded. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessPingbackSent": {
+    "on": "access-pingback-sent",
+    "request": "event"
+  }
+}
+```
+
+###### Pingback failed trigger (`"on": "access-pingback-failed"`)
+
+The `access-pingback-failed` event is issued when the Pingback endpoint has failed. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessPingbackFailed": {
+    "on": "access-pingback-failed",
+    "request": "event"
+  }
+}
+```
+
+###### Login started trigger (`"on": "access-login-started"`)
+
+The `access-login-started` event is issued right before the Login dialog has been opened. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessLoginStarted": {
+    "on": "access-login-started",
+    "request": "event"
+  }
+}
+```
+
+###### Login success trigger (`"on": "access-login-success"`)
+
+The `access-login-success` event is issued when Login dialog has succeeded. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessLoginSuccess": {
+    "on": "access-login-success",
+    "request": "event"
+  }
+}
+```
+
+###### Login rejected trigger (`"on": "access-login-rejected"`)
+
+The `access-login-rejected` event is issued when Login dialog has been rejected by the user. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessLoginRejected": {
+    "on": "access-login-rejected",
+    "request": "event"
+  }
+}
+```
+
+###### Login failed trigger (`"on": "access-login-failed"`)
+
+The `access-login-failed` event is issued when Login dialog has failed due to an unknown reason. Use these configurations to fire a request for this event.
+
+```javascript
+"triggers": {
+  "accessLoginFailed": {
+    "on": "access-login-failed",
+    "request": "event"
+  }
+}
+```
diff --git a/extensions/amp-access/amp-access-spec.md b/extensions/amp-access/amp-access-spec.md
index 18aac46ac309..fa8cb5d9dde8 100644
--- a/extensions/amp-access/amp-access-spec.md
+++ b/extensions/amp-access/amp-access-spec.md
@@ -323,7 +323,7 @@ Notice the use of a URL hash parameter “status”. The value is either “true
 
 #Integration with *amp-analytics*
 
-An integration with *amp-analytics* is under development and can be tracked on [Issue #1556][10]. This document will be updated when more details on the integration are available.
+An integration with *amp-analytics* is documented in the [amp-access-analytics.md](./amp-access-analytics.md).
 
 #CORS Origin Security
 
diff --git a/extensions/amp-analytics/amp-analytics.md b/extensions/amp-analytics/amp-analytics.md
index 165f082b5785..77ee52eace0a 100644
--- a/extensions/amp-analytics/amp-analytics.md
+++ b/extensions/amp-analytics/amp-analytics.md
@@ -184,7 +184,7 @@ Use this configuration to fire a request when a specified element is clicked. Us
 ###### Scroll trigger (`"on": "scroll"`)
 Use this configuration to fire a request under certain conditions when the page is scrolled. Use `scrollSpec` to control when this will fire:
   - `scrollSpec` This object can contain `verticalBoundaries` and `horizontalBoundaries`. At least one of the two properties is required for a scroll event to fire. The values for both of the properties should be arrays of numbers containing the boundaries on which a scroll event is generated. For instance, in the following code snippet, the scroll event will be fired when page is scrolled vertically by 25%, 50% and 90%. Additionally, the event will also fire when the page is horizontally scrolled to 90% of scroll width.
- 
+
 
     ```javascript
     "triggers": {
@@ -203,7 +203,7 @@ Use this configuration to fire a request on a regular time interval. Use `timerS
   - `timerSpec` Specification for triggers of type `timer`. The timer will trigger immediately and then at a specified interval thereafter.
     - `interval` Length of the timer interval, in seconds.
     - `maxTimerLength` Maximum duration for which the timer will fire, in seconds.
-    
+
     ```javascript
     "triggers": {
       "pageTimer": {
@@ -217,6 +217,11 @@ Use this configuration to fire a request on a regular time interval. Use `timerS
     }
     ```
 
+###### Access triggers (`"on": "amp-access-*"`)
+
+AMP Access system issues numerous events for different states in the access flow. See [amp-access-analytics.md](../amp-access/amp-access-analytics.md) for details.
+
+
 ##### Transport
 The `transport` attribute specifies how to send a request. The value is an object with fields that
 indicate which transport methods are acceptable.
