Extensions Docs Server: Fix 404s from API links on the samples page

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

 # Copyright (c) 2012 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 hashlib
 import json
 import logging
 import re
 
 import compiled_file_system as compiled_fs
@@ skipping 10 matching lines @@
   class Factory(object):
     """A factory to create SamplesDataSource instances bound to individual
     Requests.
     """
     def __init__(self,
                  channel,
                  file_system,
                  github_file_system,
                  cache_factory,
                  github_cache_factory,
+                 api_list_data_source_factory,
                  samples_path):
       self._file_system = file_system
       self._github_file_system = github_file_system
       self._static_path = ((('/' + channel) if channel != 'local' else '') +
                            '/static')
       self._extensions_cache = cache_factory.Create(self._MakeSamplesList,
                                                     compiled_fs.EXTENSIONS)
       self._apps_cache = github_cache_factory.Create(
           lambda x: self._MakeSamplesList(x, is_apps=True),
           compiled_fs.APPS)
+      self._api_list_data_source = api_list_data_source_factory.Create()
       self._samples_path = samples_path
 
     def Create(self, request):
       """Returns a new SamplesDataSource bound to |request|.
       """
       return SamplesDataSource(self._extensions_cache,
                                self._apps_cache,
                                self._samples_path,
                                request)
 
-    def _GetApiItems(self, js_file):
+    def _MakeAPIList(self):

[not at google - send to devlin, 2012/09/11 23:40:00]

_GetAllAPINames?

we're going to be calculating it a lot though; for each link on the samples
page. that's unnecessary. perhaps pass it in as an argument to _MakeApiLink and
calculate it once from _MakeSamplesList?

[cduvall, 2012/09/12 21:59:05]

Done.

+      apis = []
+      for k1 in ['apps', 'extensions']:
+        for k2 in ['chrome', 'experimental']:
+          apis.extend(
+              [api['name'] for api in self._api_list_data_source[k1][k2]])
+      return apis
+
+    def _GetAPIItems(self, js_file):
       return set(re.findall('(chrome\.[a-zA-Z0-9\.]+)', js_file))
 
-    def _MakeApiLink(self, prefix, item):
-      api, name = item.replace('chrome.', '').split('.', 1)
-      return api + '.html#' + prefix + '-' + name
+    def _MakeAPILink(self, prefix, item):
+      item = item.replace('chrome.', '')
+      parts = item.split('.')
+      api_name = []
+      api_list = self._MakeAPIList()
+      for i in range(1, len(parts) + 1):
+        if '.'.join(parts[:i]) in api_list:
+          return '%s.html#%s-%s' % ('.'.join(parts[:i]),
+                                    prefix,
+                                    '.'.join(parts[i:]))
+      return None
 
     def _GetDataFromManifest(self, path, file_system):
       manifest = file_system.ReadSingle(path + '/manifest.json')
       try:
         manifest_json = json.loads(json_comment_eater.Nom(manifest))
       except ValueError as e:
         logging.error('Error parsing manifest.json for %s: %s' % (path, e))
         return None
       l10n_data = {
         'name': manifest_json.get('name', ''),
@@ skipping 27 matching lines @@
         if filename.rsplit('/')[-1] != 'manifest.json':
           continue
         # This is a little hacky, but it makes a sample page.
         sample_path = filename.rsplit('/', 1)[-2]
         sample_files = [path for path in files
                         if path.startswith(sample_path + '/')]
         js_files = [path for path in sample_files if path.endswith('.js')]
         js_contents = file_system.Read(js_files).Get()
         api_items = set()
         for js in js_contents.values():
-          api_items.update(self._GetApiItems(js))
+          api_items.update(self._GetAPIItems(js))
 
         api_calls = []
         for item in api_items:
           if len(item.split('.')) < 3:
             continue
+          if item.endswith('.removeListener'):
+            continue

[not at google - send to devlin, 2012/09/11 23:40:00]

You might also want to add hasListener for completeness:

http://developer.chrome.com/extensions/events.html

p.s. that page has broken anchors. we should fix that.

[cduvall, 2012/09/12 21:59:05]

Done.

           if item.endswith('.addListener'):
-            item = item.replace('.addListener', '')
+            item = item[:-len('.addListener')]
+            link = self._MakeAPILink('event', item)
+            if link is None:
+              continue
             api_calls.append({
               'name': item,
-              'link': self._MakeApiLink('event', item)
+              'link': link
             })
           else:
+            link = self._MakeAPILink('method', item)

[not at google - send to devlin, 2012/09/11 23:40:00]

TODO(cduvall): this might be a property.

[cduvall, 2012/09/12 21:59:05]

Done.

[not at google - send to devlin, 2012/09/14 00:47:19]

or a type (sorry)

[cduvall, 2012/09/14 01:10:28]

Done.

+            if link is None:
+              continue
             api_calls.append({
               'name': item,
-              'link': self._MakeApiLink('method', item)
+              'link': link
             })
         manifest_data = self._GetDataFromManifest(sample_path, file_system)
         if manifest_data is None:
           continue
 
         sample_base_path = sample_path.split('/', 1)[1]
         if is_apps:
           url = url_constants.GITHUB_BASE + '/' + sample_base_path
           icon_base = url_constants.RAW_GITHUB_BASE + '/' + sample_base_path
           download_url = url
@@ skipping 86 matching lines @@
     return return_list
 
   def __getitem__(self, key):
     return self.get(key)
 
   def get(self, key):
     return {
       'apps': lambda: self._CreateSamplesDict('apps'),
       'extensions': lambda: self._CreateSamplesDict('extensions')
     }.get(key, lambda: {})()