Docserver: Display API features that are available to content scripts

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

 # Copyright 2013 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.
 
 import posixpath
 
 from compiled_file_system import SingleFile, Unicode
 from docs_server_utils import StringIdentity
 from extensions_paths import API_PATHS
-from features_bundle import HasParentFeature
+from features_bundle import HasParentFeature, GetParentFeature
 from file_system import FileNotFoundError
 from future import Collect, Future
+from operator import itemgetter
 from platform_util import PlatformToExtensionType
 from schema_util import ProcessSchema
 from third_party.json_schema_compiler.json_schema import DeleteNodes
 from third_party.json_schema_compiler.model import Namespace, UnixName
 
 
 class APIModels(object):
   '''Tracks APIs and their Models.
   '''
 
   def __init__(self,
                features_bundle,
                compiled_fs_factory,
                file_system,
+               object_store_creator,
                platform):
     self._features_bundle = features_bundle
     self._platform = PlatformToExtensionType(platform)
     self._model_cache = compiled_fs_factory.Create(
         file_system, self._CreateAPIModel, APIModels, category=self._platform)
+    self._object_store = object_store_creator.Create(APIModels)
 
   @SingleFile
   @Unicode
   def _CreateAPIModel(self, path, data):
     def does_not_include_platform(node):
       return ('extension_types' in node and
               node['extension_types'] != 'all' and
               self._platform not in node['extension_types'])
 
     schema = ProcessSchema(path, data, inline=True)[0]
@@ skipping 48 matching lines @@
     def resolve():
       for future in futures:
         try:
           return future.Get()
         # Either the file wasn't found or there was no schema for the file
         except (FileNotFoundError, ValueError): pass
       # Propagate the first error if neither were found.
       futures[0].Get()
     return Future(callback=resolve)
 
+  def GetContentScriptsAPIs(self):

[not at google - send to devlin, 2014/07/09 02:55:55]

s/GetContentScriptsAPIs/GetContentScriptAPIs/

+    '''Creates a dict of APIs and nodes supported by content scripts in
+    this format:
+
+      {
+        'extension': {
+          'name': 'extension',

[not at google - send to devlin, 2014/07/09 02:55:55]

Can we return an actual type rather than a dictionary?

+          'fullSupport': False,

[not at google - send to devlin, 2014/07/09 02:55:55]

'allNodes' might be more consistent with 'supportedNodes'

even so having 2 properties here seems a bit icky. maybe if you were to think of
it as "the restricted set of nodes" such that None would be "nothing
restricted".

+          'supportedNodes': [{
+            'parent': 'extension',
+            'node': sendMessage
+          },
+          ...
+          ]
+        },
+        ...
+      }
+    '''
+    content_script_apis_future = self._object_store.Get('content_script_apis')
+    api_features_future = self._features_bundle.GetAPIFeatures()
+    def resolve():
+      content_script_apis = content_script_apis_future.Get()
+      api_features = api_features_future.Get()

[not at google - send to devlin, 2014/07/09 02:55:55]

you don't need to resolve this is if content_script_apis is not None, so move it
after that.

+      if content_script_apis is not None:
+        return content_script_apis
+
+      content_script_apis = {}
+      for feature in api_features.itervalues():
+        # Gets all the features that have 'content_script' in their context.
+        if 'content_script' in feature.get('contexts', ()):

[not at google - send to devlin, 2014/07/09 02:55:55]

early-continue

+          parent = GetParentFeature(feature['name'], feature, api_features)
+          # If it has no parent, then the API is fully supported.
+          if parent is None:
+            content_script_apis[feature['name']] = {
+              'name': feature['name'],
+              'fullSupport': True,
+              'supportedNodes': []
+            }
+          else:
+            # Creates a dict for the individual node.
+            node = {'parent': parent, 'node': feature['name'][len(parent) + 1:]}
+            # Initializes the supportedNodes list if it doesn't exist yet.
+            if parent not in content_script_apis:
+              content_script_apis[parent] = {
+                'name': parent,
+                'fullSupport': False,
+                'supportedNodes': [node]
+              }
+            else:
+              content_script_apis[parent]['supportedNodes'].append(node)
+
+      # Sort all of the supportedNodes.
+      for content_script_api in content_script_apis.itervalues():
+        if content_script_api['supportedNodes']:
+          content_script_api['supportedNodes'].sort(key=itemgetter('node'))
+          # Annotate the first and last ones for use in the templates.
+          content_script_api['supportedNodes'][0]['first'] = True
+          content_script_api['supportedNodes'][-1]['last'] = True
+
+      self._object_store.Set('content_script_apis', content_script_apis)
+      return content_script_apis
+    return Future(callback=resolve)
+
   def Cron(self):
     futures = [self.GetModel(name) for name in self.GetNames()]
     return Collect(futures, except_pass=(FileNotFoundError, ValueError))
 
   def IterModels(self):
     future_models = [(name, self.GetModel(name)) for name in self.GetNames()]
     for name, future_model in future_models:
       try:
         model = future_model.Get()
       except FileNotFoundError:
         continue
       if model:
         yield name, model