User:Manuel Bucher: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(add original foxkeh website)
(use permalink)
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
I am a mozillian in the [[Networking|Necko]]-Team. I like improving docs when reading through them.
I am a mozillian in the [[Privacy]]-Team. I'm a former [[Networking|Necko]]-Team member. I like improving docs when reading through them.


== Resources to integrate somewhere into firefox-source-docs (or wiki) ==
== Accumulated personal notes ==
My personal TODO-List for my outstanding documentation changes (where I don't have the time to do them immediately)/My non-trivially learned lessons about Firefox development:
My personal TODO-List for my outstanding documentation changes (where I don't have the time to do them immediately)/My non-trivially learned lessons about Firefox development:


Line 18: Line 18:
* Documentation of the test <code>.ini</code> files: https://firefox-source-docs.mozilla.org/build/buildsystem/test_manifests.html
* Documentation of the test <code>.ini</code> files: https://firefox-source-docs.mozilla.org/build/buildsystem/test_manifests.html
* Moz-config helper:
* Moz-config helper:
** '''buildwith''': https://github.com/emilio/mozconfigs
** https://github.com/ahal/mozconfigwrapper
** https://github.com/ahal/mozconfigwrapper
** https://github.com/emilio/mozconfigs


* Old error page dinosaur picture:
* Old error page dinosaur picture:
Line 28: Line 28:
** [https://hg.mozilla.org/mozilla-central/raw-file/ab74bac09a68daab7a7e94ad5ffd6b476a704777/browser/themes/shared/illustrations/error-malformed-url.svg error-malformed-url.svg]
** [https://hg.mozilla.org/mozilla-central/raw-file/ab74bac09a68daab7a7e94ad5ffd6b476a704777/browser/themes/shared/illustrations/error-malformed-url.svg error-malformed-url.svg]


* Searchfox shows the Bugzilla component for files in the navigation box on the right side: https://searchfox.org/mozilla-central/source/netwerk/cache/nsCacheUtils.h
* Searchfox shows the Bugzilla component for files in the navigation box on the right side: https://searchfox.org/mozilla-central/rev/4582d908c17fbf7924f5699609fe4a12c28ddc4a/netwerk/cache2/CacheFile.h


* [https://mozilla.github.io/mozregression/ mozregression]
* [https://mozilla.github.io/mozregression/ mozregression]
Line 46: Line 46:
* foxkeh dance [https://foxkehdance.com/ v1], [https://foxkehdance.com/2.0/ v2] [https://foxkeh.com/ original]
* foxkeh dance [https://foxkehdance.com/ v1], [https://foxkehdance.com/2.0/ v2] [https://foxkeh.com/ original]
* See tree status of all branches: https://treestatus.mozilla-releng.net/static/ui/treestatus/
* See tree status of all branches: https://treestatus.mozilla-releng.net/static/ui/treestatus/
* bugzilla reminder feature of BugBot: https://groups.google.com/a/mozilla.org/g/dev-platform/c/QznyG9gzwYc/m/aGS52shgAAAJ
** https://github.com/mozilla/bugbot/blob/7382d562b62dcee4492d242a2113310413d64550/bugbot/rules/reminder.py#L14
* Searching for Open and closed bugs in Bugzilla: Start the search query with "ALL"
* Firefox Nightly Asan builds: https://firefox-source-docs.mozilla.org/tools/sanitizer/asan_nightly.html
* Firefox .desktop file: https://blog.nightly.mozilla.org/2016/09/19/getting-firefox-nightly-to-stick-to-ubuntus-unity-dock/
* Firefox release calendar: https://whattrainisitnow.com/calendar/
* my [https://fishshell.com fish] aliases:


alias --save mb="mach build"
alias --save mbf="mach build faster"
alias --save mc="mach clobber"
alias --save mcb="mach clobber && mach build"
alias --save mr="mach run"
alias --save mrr='mach run --debugger=rr --debugger-args="record --disable-avx-512 --disable-cpuid-features-ext 0xfc230000,0x2c42,0xc"'
alias --save mt="mach test"
alias --save mtr='mach test --debugger=rr --debugger-args="record --disable-avx-512 --disable-cpuid-features-ext 0xfc230000,0x2c42,0xc"'
alias --save mp="moz-phab"
* my bookmarks for address bar shortcuts:
{| class="wikitable"
|-
! Name !! URL !! Keyword
|-
| Searchfox || <nowiki>https://searchfox.org/mozilla-central/search?path=&q=%s</nowiki> || s
|-
| Bugzilla || <nowiki>https://bugzilla.mozilla.org/buglist.cgi?quicksearch=%s</nowiki> || b
|-
| Bugzilla bug || <nowiki>https://bugzilla.mozilla.org/show_bug.cgi?id=%s</nowiki> || bug
|-
| Phabricator patch || <nowiki>https://phabricator.services.mozilla.com/%s</nowiki> || p
|-
| RFCs datatracker || <nowiki>https://datatracker.ietf.org/doc/html/rfc%s</nowiki> || rfc
|-
| Tor Bug || <nowiki>https://gitlab.torproject.org/tpo/applications/tor-browser/-/issues/%s</nowiki> || tor
|}
* <code>./mach test path/to/test.js --jsdebugger</code> and adding <code>debugger;</code>-statement allows to stepping through js test code in devtools
* sccache-dist: [https://github.com/mozilla/sccache/blob/main/docs/DistributedQuickstart.md setup doc], [https://firefox-source-docs.mozilla.org/build/buildsystem/sccache-dist.html ffsd], [https://wiki.mozilla.org/index.php?title=IT/WeeklyMinIT&oldid=1221132#2019-10-21 wiki doc]
* Public Roadmap 2024: https://connect.mozilla.org/t5/discussions/here-s-what-we-re-working-on-in-firefox/td-p/57694
* Pre Mercurial history commit history: https://github.com/ehsan/mozilla-cvs-history
* Oldest bug fixed on bugzilla: https://my-oldest-fixed-bugs.glitch.me/
* <code>./mach try fuzzy --env "MOZ_LOG=nsHttp:5,EarlyHint:5" --rebuild 20 netwerk/test/browser/browser_103_*</code>:
** env for recording MOZ_LOGS and
** rebuild for running test cases multiple times (here 20)
==Fun code==
==Fun code==


Line 81: Line 125:
  // rarely as we can.
  // rarely as we can.


* [blib blab blob](https://bugzilla.mozilla.org/show_bug.cgi?id=797234)
* [https://bugzilla.mozilla.org/show_bug.cgi?id=797234 blib blab blob]
 
* Reason for socks proxy not being supported via system proxy settings on linux[https://searchfox.org/mozilla-central/rev/b3f40fd7c4671537ed29a232e76c962977650045/toolkit/system/unixproxy/nsUnixSystemProxySettings.cpp#187-191]
 
// Is there a way to specify "socks://" or something in these environment
// variables? I can't find any documentation.
if (!proxyURI->SchemeIs("http")) {
  return NS_ERROR_UNKNOWN_PROTOCOL;
}


== Good documentation comments ==
== Good documentation comments ==
Line 107: Line 159:
** https://bholley.net/blog/2015/mozpromise.html
** https://bholley.net/blog/2015/mozpromise.html
* ScopeExit documentation: https://searchfox.org/mozilla-central/rev/aa3ccd258b64abfd4c5ce56c1f512bc7f65b844c/mfbt/ScopeExit.h#13-80
* ScopeExit documentation: https://searchfox.org/mozilla-central/rev/aa3ccd258b64abfd4c5ce56c1f512bc7f65b844c/mfbt/ScopeExit.h#13-80
* [https://searchfox.org/mozilla-central/rev/97feebcab27f1a92e70ceacaa77211e9eaba0e6e/xpcom/base/nsIMemoryReporter.idl nsIMemoryReporter]
* It is possible to search for open tabs by starting the search with a "%" character
* [https://searchfox.org/mozilla-central/rev/202c48686136360a23b73a49b611a19e64f3e1b8/xpcom/string/nsTPromiseFlatString.h#14-69 PromiseFlatString/PromiseFlatCString]
== Firefox Setting ==
AddOns:
* [https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager Bitwarden]
* [https://addons.mozilla.org/en-US/firefox/addon/cliget cliget]
* [https://addons.mozilla.org/en-US/firefox/addon/tree-style-tab Tree Style Tab]
* [https://addons.mozilla.org/en-US/firefox/addon/ublock-origin uBlock Origin]
* [https://addons.mozilla.org/en-US/firefox/addon/whowrotethat Who Wrote That?]
Preferences:
* HTTPS-Only mode in all windows
* Firefox Sync -> Most things don't have to be setup again. Not being synced is [https://bugzilla.mozilla.org/show_bug.cgi?id=978010 Bug 978010 Cookies and Site Data exceptions] and [https://bugzilla.mozilla.org/show_bug.cgi?id=1676519 Bug 1676519 Extensions "Run in Private Browsing"]. Both depend on permissions being able to be synced.
Config:
* <code>toolkit.legacyUserProfileCustomizations.stylesheets true</code>: to load userChrome/userContent
* <code>browser.compactmode.show true</code>: to enable compact mode
Further customization:
* chrome/userChrome.css
/* Hide horizontal tabs at the top of the window */
#tabbrowser-tabs { visibility: collapse !important; }
/* Hide the "Tree Style Tab" header at the top of the sidebar */
#sidebar-header { display: none; }
* chrome/userContent.css
/* https://gist.github.com/boppreh/64f98fa499c946d3e38b2b852f9517fb */
/* Give a grey title to visited Youtube links */
@-moz-document domain(www.youtube.com)
{
    a:visited {
        color: grey !important;
    }
   
    a:visited > h3.ytd-compact-video-renderer {
        color: grey !important;
    }
   
    a:visited > yt-formatted-string {
        color: grey !important;
    }
}
* Advanced css settings in TreeStyleTab:
/* Show title of unread tabs with red and italic font */
:root.sidebar tab-item.unread .label-content {
  color: red !important;
  font-style: italic !important;
}
/* Change tab height */
tab-item {
  --tab-size: 22px !important;
  height: var(--tab-size);
}
/* Add private browsing indicator per tab */
:root.sidebar tab-item.private-browsing tab-label:before {
  content: "🕶";
}


== Networking component size ==
== Networking component size ==

Latest revision as of 10:30, 12 June 2024

I am a mozillian in the Privacy-Team. I'm a former Necko-Team member. I like improving docs when reading through them.

Accumulated personal notes

My personal TODO-List for my outstanding documentation changes (where I don't have the time to do them immediately)/My non-trivially learned lessons about Firefox development: 

ac_add_options --enable-debug
ac_add_options --enable-clang-plugin
#ac_add_options --disable-unified-build
ac_add_options --with-ccache=sccache
ac_add_options CCACHE=/home/user/.mozbuild/sccache/sccache

alias --save mb="mach build"
alias --save mbf="mach build faster"
alias --save mc="mach clobber"
alias --save mcb="mach clobber && mach build"
alias --save mr="mach run"
alias --save mrr='mach run --debugger=rr --debugger-args="record --disable-avx-512 --disable-cpuid-features-ext 0xfc230000,0x2c42,0xc"'
alias --save mt="mach test"
alias --save mtr='mach test --debugger=rr --debugger-args="record --disable-avx-512 --disable-cpuid-features-ext 0xfc230000,0x2c42,0xc"'
alias --save mp="moz-phab"
  • my bookmarks for address bar shortcuts:
Name URL Keyword
Searchfox https://searchfox.org/mozilla-central/search?path=&q=%s s
Bugzilla https://bugzilla.mozilla.org/buglist.cgi?quicksearch=%s b
Bugzilla bug https://bugzilla.mozilla.org/show_bug.cgi?id=%s bug
Phabricator patch https://phabricator.services.mozilla.com/%s p
RFCs datatracker https://datatracker.ietf.org/doc/html/rfc%s rfc
Tor Bug https://gitlab.torproject.org/tpo/applications/tor-browser/-/issues/%s tor

Fun code

  • Interesting workaround to have a public constructor, but not really [1]
class WorkerThread {
  // Using this struct we restrict access to the constructor while still being
  // able to use MakeSafeRefPtr.
  struct ConstructorKey {};

public:
  explicit WorkerThread(ConstructorKey);
}
  • A long function name indicating that this function must not be called in non-test code[2]
/**
 *  NOTE: This function is used only for testing!
 *
 *  @param aDisable If true, disable all security check and make
 *                  hasMatchingOverride always return true.
 */
void setDisableAllSecurityChecksAndLetAttackersInterceptMyData(in boolean aDisable);
  • backwards possible binary detection fun to read comment[3]
// Make sure to do a case-sensitive exact match comparison here.  Apache
// 1.x just sends text/plain for "unknown", while Apache 2.x sends
// text/plain with a ISO-8859-1 charset.  Debian's Apache version, just to
// be different, sends text/plain with iso-8859-1 charset.  For extra fun,
// FC7, RHEL4, and Ubuntu Feisty send charset=UTF-8.  Don't do general
// case-insensitive comparison, since we really want to apply this crap as
// rarely as we can.
  • Reason for socks proxy not being supported via system proxy settings on linux[4]
// Is there a way to specify "socks://" or something in these environment
// variables? I can't find any documentation.
if (!proxyURI->SchemeIs("http")) {
  return NS_ERROR_UNKNOWN_PROTOCOL;
}

Good documentation comments

https://searchfox.org/mozilla-central/rev/3840d8109501fbebdf22212165ea15a391280dcb/netwerk/ipc/DocumentChannel.h#32-39 

DocumentChannel is a protocol agnostic placeholder nsIChannel implementation
that we use so that nsDocShell knows about a connecting load. It transfers
all data into a DocumentLoadListener (running in the parent process), which
will create the real channel for the connection, and decide which process to
load the resulting document in. If the document is to be loaded in the
current process, then we'll synthesize a redirect replacing this placeholder
channel with the real one, otherwise the originating docshell will be removed
during the process switch.

https://searchfox.org/mozilla-central/rev/3840d8109501fbebdf22212165ea15a391280dcb/netwerk/ipc/DocumentChannel.h#62-65 

Will create the appropriate document channel:
Either a DocumentChannelChild if called from the content process or
a ParentProcessDocumentChannel if called from the parent process.
This operation is infallible.

Firefox Setting

AddOns:

Preferences:

Config:

  • toolkit.legacyUserProfileCustomizations.stylesheets true: to load userChrome/userContent
  • browser.compactmode.show true: to enable compact mode

Further customization:

  • chrome/userChrome.css
/* Hide horizontal tabs at the top of the window */
#tabbrowser-tabs { visibility: collapse !important; }
/* Hide the "Tree Style Tab" header at the top of the sidebar */
#sidebar-header { display: none; }
  • chrome/userContent.css
/* https://gist.github.com/boppreh/64f98fa499c946d3e38b2b852f9517fb */
/* Give a grey title to visited Youtube links */
@-moz-document domain(www.youtube.com)
{
    a:visited {
        color: grey !important;
    }
    
    a:visited > h3.ytd-compact-video-renderer {
        color: grey !important;
    }
    
    a:visited > yt-formatted-string {
        color: grey !important;
    }
}
  • Advanced css settings in TreeStyleTab:
/* Show title of unread tabs with red and italic font */
:root.sidebar tab-item.unread .label-content {
  color: red !important;
  font-style: italic !important;
}

/* Change tab height */
tab-item {
  --tab-size: 22px !important;
  height: var(--tab-size);
}

/* Add private browsing indicator per tab */
:root.sidebar tab-item.private-browsing tab-label:before {
  content: "🕶";
}

Networking component size

(roughly on 118.0a1 2023-08-03 https://hg.mozilla.org/mozilla-central/rev/1eb2f6905e74) 

netwerk/$ fd {} | xargs cat | wc -l
  • Http2: 11276
  • Http3: 5219
  • HttpChannel: 24753
  • Channel: 61179
  • Transaction: 7973
  • Connection: 13077
  • ConnectionMgr: 5190
  • WebSocket: 9375
Retrieved from "https://wiki.allizom.org/index.php?title=User:Manuel_Bucher&oldid=1251001"