1629857 - add a trace option for geckodriver

Status: RESOLVED FIXED

(Testing :: Raptor, enhancement, P5)

Description

[Tarek Ziadé (:tarek)]

Per Bug 1629809

we can add back in the BT version of raptor an option to set marionette TRACE option

Comment 1

[Nelaka Senura : Nelliya]

Hi , I'm new to open source community. I'd like to contribute . could you please guide me.

Comment 2

[Greg Mierzwinski [:sparky]]

Hi :nelakasenura94, welcome! You'll have to add the pref that was removed by this patch when an option is provided: https://hg.mozilla.org/integration/autoland/rev/b98e5909c211

We could call the flag --enable-marionette-trace to enable it. Here's a patch that adds a command line flag that you could follow for adding this one: https://phabricator.services.mozilla.com/D69051

It will need to enable a preference in Raptor when it's found. What you could do is check for args.enable_marionette_trace and if it's True, then you can add the pref to the extra_prefs list here: https://dxr.mozilla.org/mozilla-central/source/testing/raptor/raptor/raptor.py#132

Comment 3

[Nelaka Senura : Nelliya]

I'm working on this . it seems it's required to grab some domain knowledge here first .
I was able to build firefox locally . I'm planning to read little more about raptor and setup it locally .
then I will be able to understand the issue better.

Comment 4

[Elaine Neoh (:elainen98)]

Hello, can I work on this?

Comment 5

[Greg Mierzwinski [:sparky]]

Hi Elaine, yes certainly! :)

You should start by getting yourself ready for hacking on this (see the user story section above). Once your environment is setup, then you can follow the instructions in comment #2 to solve this bug.

Comment 6

[Renan Cleyson (:renancleyson)]

Hi, I would like to work on this.

Comment 7

[Akshat [:baka]]

Hello, I will like to work on this , I have read the comment #2 and understood the changes that I have to make. I will just like to confirm it and request for some more information. I need to add --enable-marionette-trace option to the raptor with the help of this already closed pull request. But what do I need to do with args.enable_marionette_trace. Can someone explain it to me. (I am new to working with mozilla, I will like to do good bugs and participate in outreachy with mozilla)

Comment 8

[Greg Mierzwinski [:sparky]]

Sure, feel free to submit a patch for this!

You'll have to add the pref mentioned above in comment #2 to the extra_prefs here when args.enable_marionette_trace is True: https://searchfox.org/mozilla-central/source/testing/raptor/raptor/raptor.py#48-59

Comment 9

[Akshat [:baka]]

(In reply to Greg Mierzwinski [:sparky] from comment #8)

Sure, feel free to submit a patch for this!

You'll have to add the pref mentioned above in comment #2 to the extra_prefs here when args.enable_marionette_trace is True: https://searchfox.org/mozilla-central/source/testing/raptor/raptor/raptor.py#48-59

Thankyou Greg, I will get cracking on this one and wait for further instructions once I submit the patch. :)

Comment 10

[Akshat [:baka]]

In file testing/mozharness/mozharness/mozilla/testing/raptor.py when adding values for --enable_marionette_trace should it look something like this?

[["--enable-marionette-trace"], {
            "action": "store_true",
            "dest": "marionette_trace",
            "default": False,
            "help": "Enable marionette tracing"
        }],

and what does "dest" option and action option mean here. If you can provide some place where I can figure out this information myself that will be more helpful. :)

Comment 11

[Greg Mierzwinski [:sparky]]

I see :bebe's already answered you're question :)

Comment 12

[Akshat [:baka]]

I have followed this bug to add a flag by the name of --enable-marionette-trace. Can you tell me how can I check if its working and debug it. I can see it in ./mach raptop --help. Should I submit the patch for you to review?

Comment 13

[Akshat [:baka]]

Attachment: Bug 1629857 - Added --enable-marionette-trace raptor flag r?sparky,Bebe

Comment 14

[Greg Mierzwinski [:sparky]]

You can use the commands in the new contributors guide to test it out: https://wiki.mozilla.org/TestEngineering/Performance/NewContributors#Performance_Testing

We should see extra logging when this patch is applied and --enable-marionette-trace is set. You might need to use --verbose to see it.

Comment 15

[Akshat [:baka]]

diff -r 22e4492faa63 testing/raptor/raptor/raptor.py
--- a/testing/raptor/raptor/raptor.py   Sun Jan 10 15:41:34 2021 +0530
+++ b/testing/raptor/raptor/raptor.py   Mon Jan 11 21:35:51 2021 +0530
@@ -55,6 +55,13 @@
             }
         )
 
+    if args.enable_marionette_trace:
+        args.extra_prefs.update(
+            {
+                "marionette.log.level": "Trace",
+            }
+        )
+
     if args.extra_prefs and args.extra_prefs.get("fission.autostart", False):
         args.enable_fission = True

I am unable to understand how to enable this flag. But from the lines removed from user.js in this patch and lines added just above to enable another flag, I predicted it should go something like this. Am I correct?

Comment 16

[Greg Mierzwinski [:sparky]]

Yup, that looks good!

Comment 17

[Bogdan Tara[:bogdan_tara | bogdant]]

Couldn't land. Please rebase.

Comment 18

[Akshat [:baka]]

Hello :NarcisB , I am unable to rebase, Can you help me out how can I ? (I am not good at using mercurial)

Comment 19

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

0. Pull the changes (e.g. ``hg pull central` if you have a "mozilla-unified" repository why contains the changes to central, beta, release and esr).
1. hg heads will list commits which have no other commits as children (which applies to your change). If you didn't run the hg update command, yours should also have the label tip.
2. If it hasn't, copy the revision hash and call hg update -r revisionHash. Replace revisionHash with the string from the clipboard.
3. Run hg rebase -s . -d central.
   You should get a message about a conflict and which files are affected.
4. Open the files with the conflict and change the code how it should look like (part between <<<< and ==== is from mozilla-central, the part between ==== and >>>> from your patch.
5. Once you fixed the code, let mercurial know about fix: hg resolve --mark.
6. Complete the rebase: hg rebase --continue

Comment 20

[Akshat [:baka]]

:aryx I followed these steps and everything seems to work fine except hg rebase did not pop up any conflicts. So I assumed I must have been because of commit I dropped earlier which I didn't push using moz-phab. I have added the check-in needed tag in the phabricator patch assuming that after rebasing I don't have to push anything.

Comment 21

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/10cf8563c5ed
Added --enable-marionette-trace raptor flag r=sparky,perftest-reviewers

Comment 22

[Andreea Pavel [:apavel]]

https://hg.mozilla.org/mozilla-central/rev/10cf8563c5ed