File: LayoutCodeReviewerChecklist.rst

package info (click to toggle)
firefox 141.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,550,616 kB
  • sloc: cpp: 7,426,508; javascript: 6,367,238; ansic: 3,707,354; python: 1,368,984; xml: 623,983; asm: 426,916; java: 184,324; sh: 64,488; makefile: 19,203; objc: 13,059; perl: 12,955; yacc: 4,583; cs: 3,846; pascal: 3,352; lex: 1,720; ruby: 1,071; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10
file content (31 lines) | stat: -rw-r--r-- 1,533 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Layout Code Reviewer Checklist
==============================

General
-------
- Follow the general `reviewer checklist
  <https://firefox-source-docs.mozilla.org/contributing/reviewer_checklist.html>`__.

Security issues
---------------

- **Watch for raw pointers that may have their data deleted out from under
  them**. Examples:

  - If you ever have a raw pointer to a dynamically allocated object, it's good
    to scrutinize whether the object might be destroyed before the last
    possible use of the raw pointer. For example: if you have a local variable
    that points to an object that's owned by a `frame's property table
    <https://searchfox.org/mozilla-central/source/layout/base/FrameProperties.h>`__,
    then consider whether the frame might remove/replace the property-table
    entry (or whether the frame itself might be destroyed) inside any of the
    function calls that happen while the local pointer is in scope.
  - Be aware that layout flushes
    (e.g. ``doc->FlushPendingNotifications(FlushType::Layout)``) can
    synchronously cause the frame tree (and even the document!) to be
    destroyed. Specifically: a layout flush can synchronously cause resize
    events to fire; and the event-listeners for those events can run arbitrary
    script, which could e.g. remove the iframe element that's hosting the
    document whose layout we're in the midst of flushing; and that can cause
    that document to be immediately destroyed, if there aren't any other strong
    references keeping it alive.