1134845 - Add clearHistory jsterm helper to remove persisted console input history

Status: RESOLVED FIXED

(DevTools :: Console, defect)

Description

[Brian Grinstead [:bgrins]]

This is a follow up to Bug 943306 to allow a way to clear the saved console history.

The proposal is to add a jsterm helper for "clearHistory()" that will send a helperResult of clearHistory to indicate to the frontend to do so.

Comment 1

[Jeff Griffiths (:canuckistani) (:⚡︎)]

We have this old bug to alias our clear() helper to console.clear - I wonder if it would make sense to also add this method to the console object as they are related? We could see if the chrome folks were interested in adding it as well.

See bug 659625

Comment 2

[Brian Grinstead [:bgrins]]

(In reply to Jeff Griffiths (:canuckistani) from comment #1)
> We have this old bug to alias our clear() helper to console.clear - I wonder
> if it would make sense to also add this method to the console object as they
> are related? We could see if the chrome folks were interested in adding it
> as well.

The only problem with that is that a web page could call console.clearHistory and wipe out your saved data. (and/or clear your output).  To me, this makes sense as a js term helper (only available when inputting directly into the console).

Comment 3

[Jeff Griffiths (:canuckistani) (:⚡︎)]

(In reply to Brian Grinstead [:bgrins] from comment #2)
> (In reply to Jeff Griffiths (:canuckistani) from comment #1)
> > We have this old bug to alias our clear() helper to console.clear - I wonder
> > if it would make sense to also add this method to the console object as they
> > are related? We could see if the chrome folks were interested in adding it
> > as well.
> 
> The only problem with that is that a web page could call
> console.clearHistory and wipe out your saved data. (and/or clear your
> output).  To me, this makes sense as a js term helper (only available when
> inputting directly into the console).

Yeah, forget I said anything.

Comment 4

[Brian Grinstead [:bgrins]]

Attachment: console-clearHistory.patch

Adds a jsterm helper for clearHistory() that will remove all entries from the active toolbox any future ones.

Try push: https://treeherder.mozilla.org/#/jobs?repo=try&revision=443cf848d591

Comment 5

[Panos Astithas (he/him) [:past] (please ni?)]

Comment on attachment 8567361 [details] [diff] [review]
console-clearHistory.patch

Review of attachment 8567361 [details] [diff] [review]:
-----------------------------------------------------------------

Great, don't forget to update MDN once this lands:

https://developer.mozilla.org/docs/Tools/Web_Console/Helpers

Comment 6

[Brian Grinstead [:bgrins]]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=f7604b7f7cf6

Comment 7

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/fx-team/rev/e1a7c0e78a9d

Comment 8

[Brian Grinstead [:bgrins]]

Will, could you please add a note for this new 'clearHistory()' jsterm helper?  It will clear out any webconsole commands that have been saved to your profile (a feature added for 39 in Bug 943306).

Comment 9

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

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

Comment 10

[Will Bamberg [:wbamberg]]

I'll update MDN when this is in Developer Edition, unless you need it sooner.

Comment 11

[Brian Grinstead [:bgrins]]

(In reply to Will Bamberg [:wbamberg] from comment #10)
> I'll update MDN when this is in Developer Edition, unless you need it sooner.

That'd be perfect, thanks!

Comment 12

[Will Bamberg [:wbamberg]]

bgrins, I've added notes here: https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Command_history
and here: https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Helper_commands. Does that cover it?

Comment 13

[Brian Grinstead [:bgrins]]

(In reply to Will Bamberg [:wbamberg] from comment #12)
> bgrins, I've added notes here:
> https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Command_history
> and here:
> https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Helper_commands.
> Does that cover it?

Looks good, thanks.