1461001 - Implement frontend for console.timeLog

Status: RESOLVED FIXED

(DevTools :: Console, enhancement)

Description

[Brian Grinstead [:bgrins]]

The platform handling is being added in Bug 1458466. We'll need to add a stub for the API call and then render basically the same message we render for timeEnd.

Comment 1

[Brian Grinstead [:bgrins]]

Nicolas: is this something you think we'll have bandwidth to take in 62? It seems like this'll be a simple frontend change, but I want to make sure we ship the frontend part in the same release where we land the platform part.

Comment 2

[Nicolas Chevobbe [:nchevobbe]]

It seems like a small thing to me, and I'm almost 100% positive it can be done in 62

Comment 3

[Nicolas Chevobbe [:nchevobbe]]

Should we have different output between timeLog and timeEnd ?
I know that timeLog can have multiple arguments to clarify what call it refers to, but if none provided, it's a bit hard to follow what's going on.

The following code: 

```js
console.time("bar");
console.timeLog("bar");
console.timeLog("bar");
console.timeEnd("bar");
```

will output: 

> 14:12:46.661 bar: 1ms debugger eval code:2:1
> 14:12:46.662 bar: 2ms debugger eval code:3:1
> 14:12:46.663 bar: 3ms debugger eval code:4:1 

I feel like the timeEnd should have either a different label, or an icon or something that indicate that it _is_ the timeEnd.

Comment 4

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1461001 - Implement frontend for console.timeLog; .

The patch handles timeLog packets we receive from the backend.
We add some stubs in order to have access to packets in mocha,
and some mocha tests to make sure we render those messages as expected,
be it when the timer exists or not.
The BASE_PATH constant now makes use of MOZ_DEVELOPER_REPO_DIR environment
variable in order to have an absolute path; without it the stubs couldn't
be written to local files.

Review commit: https://reviewboard.mozilla.org/r/245482/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/245482/

Comment 5

[Brian Grinstead [:bgrins]]

Comment on attachment 8979294 [details]
Bug 1461001 - Implement frontend for console.timeLog; .

https://reviewboard.mozilla.org/r/245482/#review251472

::: devtools/client/webconsole/utils/messages.js:109
(Diff revision 1)
>        } else {
>          // We don't show anything for console.time calls to match Chrome's behaviour.
>          type = MESSAGE_TYPE.NULL_MESSAGE;
>        }
>        break;
> +    case "timeLog":

Nit: given the amount of code / comments shared between them, I'd rather collapse timeLog and timeEnd into the same `case` and have a condition inside of the else if that sets `parameters` in one case and `messageText` in the other. Up to you.

Comment 6

[Nicolas Chevobbe [:nchevobbe]]

Comment on attachment 8979294 [details]
Bug 1461001 - Implement frontend for console.timeLog; .

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/245482/diff/1-2/

Comment 7

[Nicolas Chevobbe [:nchevobbe]]

Comment on attachment 8979294 [details]
Bug 1461001 - Implement frontend for console.timeLog; .

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/245482/diff/2-3/

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d441f5a05fbc
Implement frontend for console.timeLog; r=bgrins.

Comment 9

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/d441f5a05fbc

Comment 10

[Irene Smith]

Added a new page to: https://developer.mozilla.org/en-US/docs/Web/API/Console/Console.timeLog()

Comment 11

[Nicolas Chevobbe [:nchevobbe]]

(In reply to Irene Smith from comment #10)
> Added a new page to:
> https://developer.mozilla.org/en-US/docs/Web/API/Console/Console.timeLog()

thanks Irene, that looks good.
Do you plan to update the example you point to ([1]), since it does not have a `console.timeLog(timer)` line in it ?

[1] https://developer.mozilla.org/en-US/docs/Web/API/console#Timers

Comment 12

[Irene Smith]

Thank you for the reminder. I will update that later this afternoon.

Comment 13

[Irene Smith]

The actual page is located here: https://developer.mozilla.org/en-US/docs/Web/API/Console/timeLog

I had the wrong location to begin with and had to move it.

I have updated the example here: https://developer.mozilla.org/en-US/docs/Web/API/Console