Pass document to onDocumentReady callback

extensions/amp-form/0.1/amp-form.js

@@ -280,8 +280,8 @@ function reportInputValidity(input) {
  * @param {!Window} win
  */
 function installSubmissionHandlers(win) {
-  onDocumentReady(win.document, () => {
-    toArray(win.document.forms).forEach(form => {
+  onDocumentReady(win.document, doc => {
+    toArray(doc.forms).forEach(form => {
       new AmpForm(form);
     });
   });

src/document-ready.js

@@ -28,18 +28,18 @@ export function isDocumentReady(doc) {
 /**
  * Calls the callback when document is ready.
  * @param {!Document} doc
- * @param {!Function} callback
+ * @param {function(!Document)} callback
  */
 export function onDocumentReady(doc, callback) {
   let ready = isDocumentReady(doc);
   if (ready) {
-    callback();
+    callback(doc);
   } else {
     const readyListener = () => {
       if (isDocumentReady(doc)) {
         if (!ready) {
           ready = true;
-          callback();
+          callback(doc);
         }
         doc.removeEventListener('readystatechange', readyListener);
       }
@@ -51,7 +51,7 @@ export function onDocumentReady(doc, callback) {
 /**
  * Returns a promise that is resolved when document is ready.
  * @param {!Document} doc
- * @return {!Promise}
+ * @return {!Promise<!Document>}
  */
 export function whenDocumentReady(doc) {
   return new Promise(resolve => {

src/service/performance-impl.js

@@ -15,7 +15,7 @@
  */
 
 import {documentInfoFor} from '../document-info';
-import {onDocumentReady} from '../document-ready';
+import {whenDocumentReady} from '../document-ready';
 import {fromClass} from '../service';
 import {loadPromise} from '../event-helper';
 import {resourcesFor} from '../resources';
@@ -94,15 +94,14 @@ export class Performance {
     this.isMessagingReady_ = false;
 
     /** @private @const {!Promise} */
-    this.whenReadyToRetrieveResourcesPromise_ = new Promise(resolve => {
-      onDocumentReady(this.win.document, () => {
-        // We need to add a delay, since this can execute earlier
-        // than the onReady callback registered inside of `Resources`.
-        // Should definitely think of making `getResourcesInViewport` async.
-        timer.delay(resolve);
-      });
-    });
-
+    this.whenReadyToRetrieveResourcesPromise_ =
+        whenDocumentReady(this.win.document)
+        .then(() => {
+          // Two fold. First, resolve the promise to undefined.
+          // Second, causes a delay by introducing another async request
+          // (this `#then` block) so that Resources' onDocumentReady event
+          // is guaranteed to fire.
+        });
     // Tick window.onload event.
     loadPromise(win).then(() => {
       this.tick('ol');

src/service/viewport-impl.js

@@ -23,7 +23,7 @@ import {getService} from '../service';
 import {layoutRectLtwh} from '../layout-rect';
 import {dev} from '../log';
 import {numeric} from '../transition';
-import {onDocumentReady} from '../document-ready';
+import {onDocumentReady, whenDocumentReady} from '../document-ready';
 import {platform} from '../platform';
 import {px, setStyle, setStyles} from '../style';
 import {timer} from '../timer';
@@ -212,9 +212,8 @@ export class Viewport {
    * @param {number} paddingBottom
    */
   updatePaddingBottom(paddingBottom) {
-    onDocumentReady(this.win_.document, () => {
-      this.win_.document.body.style.borderBottom =
-          `${paddingBottom}px solid transparent`;
+    onDocumentReady(this.win_.document, doc => {
+      doc.body.style.borderBottom = `${paddingBottom}px solid transparent`;
     });
   }
 
@@ -906,13 +905,9 @@ export class ViewportBindingNaturalIosEmbed_ {
     /** @private {number} */
     this.paddingTop_ = 0;
 
-    onDocumentReady(this.win.document, () => {
-      // Microtask is necessary here to let Safari to recalculate scrollWidth
-      // post DocumentReady signal.
-      timer.delay(() => {
-        this.setup_();
-      }, 0);
-    });
+    // Microtask is necessary here to let Safari to recalculate scrollWidth
+    // post DocumentReady signal.
+    whenDocumentReady(this.win.document).then(() => this.setup_());
     this.win.addEventListener('resize', () => this.resizeObservable_.fire());
 
     dev.fine(TAG_, 'initialized natural viewport for iOS embeds');
@@ -1013,22 +1008,20 @@ export class ViewportBindingNaturalIosEmbed_ {
 
   /** @override */
   updatePaddingTop(paddingTop) {
-    onDocumentReady(this.win.document, () => {
+    onDocumentReady(this.win.document, doc => {
       this.paddingTop_ = paddingTop;
       // Also tried `paddingTop` but it didn't work for `position:absolute`
       // on iOS.
-      this.win.document.body.style.borderTop =
-          `${paddingTop}px solid transparent`;
+      doc.body.style.borderTop = `${paddingTop}px solid transparent`;
     });
   }
 
   /** @override */
   updateLightboxMode(lightboxMode) {
     // This code will no longer be needed with the newer iOS viewport
     // implementation.
-    onDocumentReady(this.win.document, () => {
-      this.win.document.body.style.borderStyle =
-          lightboxMode ? 'none' : 'solid';
+    onDocumentReady(this.win.document, doc => {
+      doc.body.style.borderStyle = lightboxMode ? 'none' : 'solid';
     });
   }
 

test/functional/test-document-ready.js

@@ -62,6 +62,7 @@ describe('documentReady', () => {
     const callback = sandbox.spy();
     onDocumentReady(testDoc, callback);
     expect(callback.callCount).to.equal(1);
+    expect(callback.getCall(0).args).to.deep.equal([testDoc]);
   });
 
   it('should wait to call callback until ready', () => {
@@ -75,6 +76,7 @@ describe('documentReady', () => {
     testDoc.readyState = 'complete';
     eventListeners['readystatechange']();
     expect(callback.callCount).to.equal(1);
+    expect(callback.getCall(0).args).to.deep.equal([testDoc]);
     expect(eventListeners['readystatechange']).to.equal(undefined);
   });
 
@@ -94,6 +96,7 @@ describe('documentReady', () => {
     testDoc.readyState = 'complete';
     eventListeners['readystatechange']();
     expect(callback.callCount).to.equal(1);
+    expect(callback.getCall(0).args).to.deep.equal([testDoc]);
     expect(eventListeners['readystatechange']).to.equal(undefined);
   });
 
@@ -115,6 +118,7 @@ describe('documentReady', () => {
 
       return timer.promise().then(() => {
         expect(spy.callCount).to.equal(1);
+        expect(spy.getCall(0).args).to.deep.equal([testDoc]);
         expect(spy2.callCount).to.equal(1);
         expect(spy3.callCount).to.equal(1);
       });
@@ -144,6 +148,7 @@ describe('documentReady', () => {
 
         return timer.promise().then(() => {
           expect(callback.callCount).to.equal(1);
+          expect(callback.getCall(0).args).to.deep.equal([testDoc]);
           expect(eventListeners['readystatechange']).to.equal(undefined);
         });
       });