From b9266c74f8fc354111aad7123832e69f8206e350 Mon Sep 17 00:00:00 2001
From: Andrey Lushnikov <aslushnikov@gmail.com>
Date: Wed, 1 Nov 2017 13:39:31 -0700
Subject: [PATCH] feat(Page): rename Page.getMetrics into Page.metrics (#1240)

BREAKING CHANGE: method page.getMetrics() got renamed into
page.metrics().
---
 docs/api.md  | 40 ++++++++++++++++++++--------------------
 lib/Page.js  |  2 +-
 test/test.js |  4 ++--
 3 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/docs/api.md b/docs/api.md
index 5f54e0f2869..927fee9a913 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -57,13 +57,13 @@
   * [page.exposeFunction(name, puppeteerFunction)](#pageexposefunctionname-puppeteerfunction)
   * [page.focus(selector)](#pagefocusselector)
   * [page.frames()](#pageframes)
-  * [page.getMetrics()](#pagegetmetrics)
   * [page.goBack(options)](#pagegobackoptions)
   * [page.goForward(options)](#pagegoforwardoptions)
   * [page.goto(url, options)](#pagegotourl-options)
   * [page.hover(selector)](#pagehoverselector)
   * [page.keyboard](#pagekeyboard)
   * [page.mainFrame()](#pagemainframe)
+  * [page.metrics()](#pagemetrics)
   * [page.mouse](#pagemouse)
   * [page.pdf(options)](#pagepdfoptions)
   * [page.queryObjects(prototypeHandle)](#pagequeryobjectsprototypehandle)
@@ -407,7 +407,7 @@ Emitted when the JavaScript [`load`](https://developer.mozilla.org/en-US/docs/We
     of metrics are of <[number]> type.
 
 Emitted when the JavaScript code makes a call to `console.timeStamp`. For the list
-of metrics see `page.getMetrics`.
+of metrics see `page.metrics`.
 
 #### event: 'pageerror'
 - <[string]> The exception message
@@ -742,24 +742,6 @@ If there's no element matching `selector`, the method throws an error.
 #### page.frames()
 - returns: <[Array]<[Frame]>> An array of all frames attached to the page.
 
-#### page.getMetrics()
-- returns: <[Object]> Object containing metrics as key/value pairs.
-  - `Timestamp` <[number]> The timestamp when the metrics sample was taken.
-  - `Documents` <[number]> Number of documents in the page.
-  - `Frames` <[number]> Number of frames in the page.
-  - `JSEventListeners` <[number]> Number of events in the page.
-  - `Nodes` <[number]> Number of DOM nodes in the page.
-  - `LayoutCount` <[number]> Total number of full or partial page layout.
-  - `RecalcStyleCount` <[number]> Total number of page style recalculations.
-  - `LayoutDuration` <[number]> Combined durations of all page layouts.
-  - `RecalcStyleDuration` <[number]> Combined duration of all page style recalculations.
-  - `ScriptDuration` <[number]> Combined duration of JavaScript execution.
-  - `TaskDuration` <[number]> Combined duration of all tasks performed by the browser.
-  - `JSHeapUsedSize` <[number]> Used JavaScript heap size.
-  - `JSHeapTotalSize` <[number]> Total JavaScript heap size.
-
-> **NOTE** All timestamps are in monotonic time: monotonically increasing time in seconds since an arbitrary point in the past.
-
 #### page.goBack(options)
 - `options` <[Object]> Navigation parameters which might have the following properties:
   - `timeout` <[number]> Maximum navigation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout.
@@ -823,6 +805,24 @@ If there's no element matching `selector`, the method throws an error.
 
 Page is guaranteed to have a main frame which persists during navigations.
 
+#### page.metrics()
+- returns: <[Promise]<[Object]>> Object containing metrics as key/value pairs.
+  - `Timestamp` <[number]> The timestamp when the metrics sample was taken.
+  - `Documents` <[number]> Number of documents in the page.
+  - `Frames` <[number]> Number of frames in the page.
+  - `JSEventListeners` <[number]> Number of events in the page.
+  - `Nodes` <[number]> Number of DOM nodes in the page.
+  - `LayoutCount` <[number]> Total number of full or partial page layout.
+  - `RecalcStyleCount` <[number]> Total number of page style recalculations.
+  - `LayoutDuration` <[number]> Combined durations of all page layouts.
+  - `RecalcStyleDuration` <[number]> Combined duration of all page style recalculations.
+  - `ScriptDuration` <[number]> Combined duration of JavaScript execution.
+  - `TaskDuration` <[number]> Combined duration of all tasks performed by the browser.
+  - `JSHeapUsedSize` <[number]> Used JavaScript heap size.
+  - `JSHeapTotalSize` <[number]> Total JavaScript heap size.
+
+> **NOTE** All timestamps are in monotonic time: monotonically increasing time in seconds since an arbitrary point in the past.
+
 #### page.mouse
 
 - returns: <[Mouse]>
diff --git a/lib/Page.js b/lib/Page.js
index 27a7e21bb4d..dc1d3fd1505 100644
--- a/lib/Page.js
+++ b/lib/Page.js
@@ -333,7 +333,7 @@ class Page extends EventEmitter {
   /**
    * @return {!Promise<!Object>}
    */
-  async getMetrics() {
+  async metrics() {
     const response = await this._client.send('Performance.getMetrics');
     return this._buildMetricsObject(response.metrics);
   }
diff --git a/test/test.js b/test/test.js
index 68fc73ecd00..4d1d0752670 100644
--- a/test/test.js
+++ b/test/test.js
@@ -841,10 +841,10 @@ describe('Page', function() {
     }));
   });
 
-  describe('Page.getMetrics', function() {
+  describe('Page.metrics', function() {
     it('should get metrics from a page', SX(async function() {
       await page.goto('about:blank');
-      const metrics = await page.getMetrics();
+      const metrics = await page.metrics();
       checkMetrics(metrics);
     }));
     it('metrics event fired on console.timeStamp', SX(async function() {