Docserver: Add 'deprecated since' message for API nodes

chrome/common/extensions/docs/server2/api_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.
 
 from copy import copy
 import logging
 import os
 import posixpath
 
 from data_source import DataSource
@@ skipping 153 matching lines @@
       assert 'callback' in lookup_path, self
       callback_index = lookup_path.index('callback')
       try:
         lookup_path.pop(callback_index)
         node_availability = self._LookupNodeAvailability(lookup_path)
       finally:
         lookup_path.insert(callback_index, 'callback')
       return node_availability
     return None
 
-  def _LookupAvailability(self, lookup_path):
+  def _LookupAvailability(self, lookup_path, no_assert=False):
     '''Runs all the lookup checks on self._lookup_path and
     returns the node availability if found, None otherwise.
     '''
     for lookup in (self._LookupNodeAvailability,
                    self._CheckEventCallback,
                    self._CheckNamespacePrefix):
-      node_availability = lookup(lookup_path)
-      if node_availability is not None:
-        return node_availability
+      try:
+        node_availability = lookup(lookup_path)
+        if node_availability is not None:
+          return node_availability
+      except AssertionError:

[not at google - send to devlin, 2014/07/10 16:28:48]

Catching AssertionError is quite dangerous, because there's no saying what the
assertion actually was. You should plumb through that flag to where it's
actually needed.

And "no_assert" isn't the best name... what are you actually disabling
assertions for? I.e. what condition are you allowing that isn't usually allowed?
Call the flag that.

+        if not no_assert:
+          raise
     return None
 
   def _GetCategory(self):
     '''Returns the category this node belongs to.
     '''
     if self._lookup_path[-2] in _NODE_CATEGORIES:
       return self._lookup_path[-2]
     # If lookup_path[-2] is not in _NODE_CATEGORIES and
     # lookup_path[-1] is 'callback', then we know we have
     # an event callback.
@@ skipping 10 matching lines @@
       # lookup paths like
       # 'events > types > Rule > properties > tags > tagsType'.
       # These nodes are treated as properties.
       return 'properties'
     if self._lookup_path[0] == 'events':
       # HACK(ahernandez.miralles): This catches a few edge cases,
       # such as 'webviewTag > events > consolemessage > level'.
       return 'properties'
     raise AssertionError('Could not classify node %s' % self)
 
+  def GetDeprecated(self):
+    '''Returns when this node became deprecated, or None if it
+    is not deprecated.
+    '''
+    # HACK(ahernadez.miralles): Tacking on 'deprecated' to the lookup
+    # path is a slight abuse of the lookup functions, which is why
+    # assertions need to be ignored. However, this ensures that
+    # we find when a node became deprecated, if it did at all.
+    return self._LookupAvailability(self._lookup_path + ['deprecated'],
+                                    no_assert=True)
+
   def GetAvailability(self):
     '''Returns availability information for this node.
     '''
     if self._GetCategory() in self._ignored_categories:
       return None
     node_availability = self._LookupAvailability(self._lookup_path)
     if node_availability is None:
       logging.warning('No availability found for: %s' % self)
       return None
 
@@ skipping 333 matching lines @@
     return intro_rows
 
   def _GetAvailabilityTemplate(self, status=None, version=None, scheduled=None):
     '''Returns an object that the templates use to display availability
     information.
     '''
     if status is None:
       availability_info = self._current_node.GetAvailability()
       if availability_info is None:
         return None
-      status = availability_info.channel
+      if self._current_node.GetDeprecated() is not None:
+        status = 'deprecated'
+      else:
+        status = availability_info.channel
       version = availability_info.version
     return {
       'partial': self._template_cache.GetFromFile(
           '%sintro_tables/%s_message.html' % (PRIVATE_TEMPLATES, status)).Get(),
       'scheduled': scheduled,
       'version': version
     }
 
   def _GetIntroDescriptionRow(self):
     ''' Generates the 'Description' row data for an API intro table.
@@ skipping 191 matching lines @@
     getter = lambda: 0
     getter.get = lambda api_name: self._GetImpl(platform, api_name).Get()
     return getter
 
   def Cron(self):
     futures = []
     for platform in GetPlatforms():
       futures += [self._GetImpl(platform, name)
           for name in self._platform_bundle.GetAPIModels(platform).GetNames()]
     return Collect(futures, except_pass=FileNotFoundError)