Docserver: Generate a table of extension/app API owners

chrome/common/extensions/docs/server2/owners_data_source.py

+# Copyright 2014 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+from operator import itemgetter
+import random
+
+from data_source import DataSource
+from docs_server_utils import MarkLast
+from extensions_paths import BROWSER_API_PATHS, BROWSER_CHROME_EXTENSIONS
+from file_system import FileNotFoundError
+from future import All
+from path_util import Join, Split
+
+
+_COMMENT_START_MARKER = '#'
+_CORE_OWNERS = 'Core Extensions/Apps Owners'
+_OWNERS = 'OWNERS'
+
+
+def _ParseOwnersFile(content, randomize):

[not at google - send to devlin, 2014/08/21 21:39:58]

This method should probably be non-private with a comment "public for testing".

+  '''Returns a tuple (owners, notes), where
+  |owners| is a list of dicts formed from the owners in |content|,
+  |notes| is a string formed from the comments in |content|.
+  '''
+  if content is None:
+    return [], 'Use one of the ' + _CORE_OWNERS + '.'
+  owners = []
+  notes = []
+  for line in content.splitlines():
+    if line == '':
+      continue
+    if line.startswith(_COMMENT_START_MARKER):
+      notes.append(line[len(_COMMENT_START_MARKER):].lstrip())
+    else:
+      # TODO(ahernandez): Mark owners no longer on the project.
+      owners.append({'email': line, 'username': line[:line.find('@')]})
+  # Randomize the list so owners toward the front of the list aren't
+  # diproportionately inundated with reviews.
+  if randomize:
+    random.shuffle(owners)

[not at google - send to devlin, 2014/08/21 21:39:58]

Aww awesome :)

+  MarkLast(owners)
+  return owners, '\n'.join(notes)
+
+
+class OwnersDataSource(DataSource):
+  def __init__(self, server_instance, _, randomize=True):
+    self._host_fs = server_instance.host_file_system_provider.GetTrunk()
+    self._cache = server_instance.object_store_creator.Create(OwnersDataSource)
+    self._owners_fs = server_instance.compiled_fs_factory.Create(
+        self._host_fs, self._CreateAPIEntry, OwnersDataSource)
+    self._randomize = randomize
+
+  def _CreateAPIEntry(self, path, content):
+    '''Creates a dict with owners information for an API, specified
+    by |owners_file|.
+    '''
+    owners, notes = _ParseOwnersFile(content, self._randomize)
+    return {
+      'apiName': Split(path)[-2][:-1],
+      'owners': owners,
+      'notes': notes
+    }
+
+  def _CollectOwnersData(self):
+    '''Walks through the file system, collecting owners data from
+    API directories.
+    '''
+    def collect(api_owners):
+      if api_owners is not None:
+        return api_owners

[not at google - send to devlin, 2014/08/21 21:39:58]

Nit: newline after this. The method is fairly long and the block of text is hard
to follow.

+      api_owners = []

[not at google - send to devlin, 2014/08/21 21:39:58]

Comment before |api_owners|: Get API owners from every OWNERS file that exists.

+      for root in BROWSER_API_PATHS:
+        for base, dirs, _ in self._host_fs.Walk(root, depth=1):
+          for dir_ in dirs:
+            owners_file = Join(root, base, dir_, _OWNERS)
+            api_owners.append(self._owners_fs.GetFromFile(owners_file, True))

[not at google - send to devlin, 2014/08/21 21:39:58]

skip_not_found=True

+            

[not at google - send to devlin, 2014/08/26 01:15:23]

Found trailing spaces here as well.

+      def fix_core_owners(entry):

[not at google - send to devlin, 2014/08/21 21:39:58]

Nit: declare this underneath the "Add an entry..." comment.
Follow-up nit: newline after it.

+        entry['apiName'] = _CORE_OWNERS
+        return entry
+      # Add an entry for the core extensions/apps owners.
+      owners_file = Join(BROWSER_CHROME_EXTENSIONS, _OWNERS)
+      api_owners.append(self._owners_fs.GetFromFile(owners_file).Then(
+          fix_core_owners))
+      def sort_and_cache(api_owners):
+        api_owners.sort(key=itemgetter('apiName'))
+        self._cache.Set('api_owners', api_owners)
+        return api_owners
+      return All(api_owners).Then(sort_and_cache)
+    return self._cache.Get('api_owners').Then(collect)
+
+  def get(self, key):
+    return {
+      'apis': self._CollectOwnersData()
+    }.get(key).Get()
+
+  def Cron(self):
+    return self._CollectOwnersData()