components/README.md

   1 # About //components
   2
   3 This directory is meant to house features or subsystems that are used in more
   4 than one part of the Chromium codebase.
   5
   6 ## Use cases:
   7
   8   * Features that are shared by Chrome on iOS (`//ios/chrome`) and Chrome on
   9     other platforms (`//chrome`).
  10       * Note: `//ios` doesn't depend on `//chrome`.
  11   * Features that are shared between multiple embedders of content. For example,
  12     `//chrome` and `//android_webview`.
  13   * Features that are shared between Blink and the browser process.
  14       * Note: It is also possible to place code shared between Blink and the
  15         browser process into `//third_party/blink/common`. The distinction comes
  16         down to (a) whether Blink is the owner of the code in question or a
  17         consumer of it and (b) whether the code in question is shared by Chrome
  18         on iOS as well. If the code is conceptually its own cross-process
  19         feature with Blink as a consumer, then `//components` can make sense. If
  20         it's conceptually Blink code, then `//third_party/blink/common` likely
  21         makes more sense. (In the so-far hypothetical case where it's
  22         conceptually Blink code that is shared by iOS, raise the question on
  23         chromium-dev@, where the right folks will see it).
  24
  25 Note that the above list is meant to be exhaustive. A component should not be
  26 added just to separate it from other code in the same layer that is the only
  27 consumer; that can be done with strict DEPS or GN visibility rules.
  28
  29 ## Guidelines for adding a new component
  30
  31   * You will be added to an OWNERS file under `//components/{your component}`
  32     and be responsible for maintaining your addition.
  33   * A `//components/OWNER` must approve of the location of your code.
  34   * Code must be needed in at least 2 places in Chrome that don't have a "higher
  35     layered" directory that could facilitate sharing (e.g. `//content/common`,
  36     `//chrome/utility`, etc.).
  37   * The CL adding a new component should be substantial enough so that
  38     //components/OWNERS can see its basic intended structure and usage before
  39     approving the addition (e.g., it should not just be an empty shell).
  40
  41 ## Dependencies of a component
  42
  43 Components **cannot** depend on the higher layers of the Chromium codebase:
  44
  45   * `//android_webview`
  46   * `//chrome`
  47   * `//chromecast`
  48   * `//headless`
  49   * `//ios/chrome`
  50   * `//content/shell`
  51
  52 Components **can** depend on the lower layers of the Chromium codebase:
  53
  54   * `//base`
  55   * `//gpu`
  56   * `//mojo`
  57   * `//net`
  58   * `//printing`
  59   * `//ui`
  60
  61 Components **can** depend on each other. This must be made explicit in the
  62 `DEPS` file of the component.
  63
  64 Components **can** depend on `//content/public`, `//ipc`, and
  65 `//third_party/blink/public`. This must be made explicit in the `DEPS` file of
  66 the component. If such a component is used by Chrome for iOS (which does not
  67 use content or IPC), the component will have to be in the form of a [layered
  68 component](http://www.chromium.org/developers/design-documents/layered-components-design).
  69
  70 `//chrome`, `//ios/chrome`, `//content` and `//ios/web` **can** depend on
  71 individual components. The dependency might have to be made explicit in the
  72 `DEPS` file of the higher layer (e.g. in `//content/browser/DEPS`). Circular
  73 dependencies are not allowed: if `//content` depends on a component, then that
  74 component cannot depend on  `//content/public`, directly or indirectly.
  75
  76 ## Structure of a component
  77
  78 As mentioned above, components that depend on `//content/public`, `//ipc`, or
  79 `third_party/blink/public` might have to be in the form of a [layered
  80 component](http://www.chromium.org/developers/design-documents/layered-components-design).
  81
  82 Components that have bits of code that need to live in different processes (e.g.
  83 some code in the browser process, some in the renderer process, etc.) should
  84 separate the code into different subdirectories. Hence for a component named
  85 'foo' you might end up with a structure like the following (assuming that foo is
  86 not used by iOS and thus does not need to be a layered component):
  87
  88   * `components/foo`          - DEPS, OWNERS, BUILD.gn
  89   * `components/foo/browser`  - code that needs the browser process
  90   * `components/foo/common`   - for e.g. Mojo interfaces and such
  91   * `components/foo/renderer` - code that needs renderer process
  92
  93 These subdirectories should have DEPS files with the relevant restrictions in
  94 place, i.e. only `components/foo/browser` should be allowed to #include from
  95 `content/public/browser`. Note that `third_party/blink/public` is a
  96 renderer process directory except for `third_party/blink/public/common` which
  97 can be used by all processes.
  98
  99 Note that there may also be an `android` subdir, with a Java source code
 100 structure underneath it where the package name is org.chromium.components.foo,
 101 and with subdirs after 'foo' to illustrate process, e.g. 'browser' or
 102 'renderer':
 103
 104   * `components/foo/android/OWNERS`, `DEPS`
 105   * `components/foo/android/java/src/org/chromium/components/foo/browser/`
 106   * `components/foo/android/javatests/src/org/chromium/components/foo/browser/`
 107
 108 Code in a component should be placed in a namespace corresponding to the name of
 109 the component; e.g. for a component living in `//components/foo`, code in that
 110 component should be in the `foo::` namespace.