Extensions Docs Server: BranchUtility not fetching branch numbers correctly (fixed)

chrome/common/extensions/docs/server2/template_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 logging
 
 from docs_server_utils import FormatKey
 from file_system import FileNotFoundError
 from third_party.handlebar import Handlebar
 
 EXTENSIONS_URL = '/chrome/extensions'
 
 def _MakeBranchDict(branch):
   return {
     'showWarning': branch != 'stable',
     'branches': [
       { 'name': 'Stable', 'path': 'stable' },
       { 'name': 'Dev',    'path': 'dev' },
       { 'name': 'Beta',   'path': 'beta' },
       { 'name': 'Trunk',  'path': 'trunk' }
     ],
-    'current': branch
+    'current': None
   }
 
 class TemplateDataSource(object):
   """Renders Handlebar templates, providing them with the context in which to
   render.
 
   Also acts as a data source itself, providing partial Handlebar templates to
   those it renders.
 
   Each instance of TemplateDataSource is bound to a Request so that it can
   render templates with request-specific data (such as Accept-Language); use
   a Factory to cheaply construct these.
   """
 
   class Factory(object):
     """A factory to create lightweight TemplateDataSource instances bound to
     individual Requests.
     """
     def __init__(self,
                  branch,
                  api_data_source_factory,
                  api_list_data_source,
                  intro_data_source,
                  samples_data_source_factory,
                  cache_builder,
                  public_template_path,
                  private_template_path):
       self._branch_info = _MakeBranchDict(branch)
-      self._static_resources = ((('/' + branch) if branch != 'local' else '') +
-                                '/static')
       self._api_data_source_factory = api_data_source_factory
       self._api_list_data_source = api_list_data_source
       self._intro_data_source = intro_data_source
       self._samples_data_source_factory = samples_data_source_factory
       self._cache = cache_builder.build(Handlebar)
       self._public_template_path = public_template_path
       self._private_template_path = private_template_path
 
-    def Create(self, request):
+    def Create(self, request, channel_name):

[not at google - send to devlin, 2012/08/13 00:53:00]

See comment in handler.py. This could go in the factory constructor right?

[cduvall, 2012/08/13 21:45:04]

Done.

       """Returns a new TemplateDataSource bound to |request|.
       """
       return TemplateDataSource(
           self._branch_info,
-          self._static_resources,
           self._api_data_source_factory.Create(request),
           self._api_list_data_source,
           self._intro_data_source,
           self._samples_data_source_factory.Create(request),
           self._cache,
           self._public_template_path,
           self._private_template_path,
-          request)
+          request,
+          channel_name)
 
   def __init__(self,
                branch_info,
-               static_resources,
                api_data_source,
                api_list_data_source,
                intro_data_source,
                samples_data_source,
                cache,
                public_template_path,
                private_template_path,
-               request):
+               request,
+               channel_name):
     self._branch_info = branch_info
-    self._static_resources = static_resources
     self._api_list_data_source = api_list_data_source
     self._intro_data_source = intro_data_source
     self._samples_data_source = samples_data_source
     self._api_data_source = api_data_source
     self._cache = cache
     self._public_template_path = public_template_path
     self._private_template_path = private_template_path
     self._request = request
+    self._channel_name = channel_name
+    self._branch_info['current'] = channel_name

[not at google - send to devlin, 2012/08/13 00:53:00]

If you do that, then you could make the current channel a parameter of
_MakeBranchDict.

[cduvall, 2012/08/13 21:45:04]

Done.

+    self._static_resources = (
+        (('/' + channel_name) if channel_name != 'local' else '') + '/static')

[not at google - send to devlin, 2012/08/13 00:53:00]

Will this cause problems when we need to configure what empty-path points to?

Perhaps the static resource path should be yet-another-thing to dependency
inject.

[not at google - send to devlin, 2012/08/13 05:47:12]

I also note that SamplesDataSource does the same thing.

[cduvall, 2012/08/13 21:45:04]

This won't cause any problems. Even if the static resource is on the stable
branch (what the empty path points to), there isn't a problem explicitly
specifying stable as the branch.

It is like this because the local branch can't be accessed just by using local
for the channel name.

 
   def Render(self, template_name):
     """This method will render a template named |template_name|, fetching all
     the partial templates needed from |self._cache|. Partials are retrieved
     from the TemplateDataSource with the |get| method.
     """
     template = self.GetTemplate(self._public_template_path, template_name)
     if not template:
       return ''
       # TODO error handling
@@ skipping 15 matching lines @@
   def get(self, key):
     return self.GetTemplate(self._private_template_path, key)
 
   def GetTemplate(self, base_path, template_name):
     real_path = FormatKey(template_name)
     try:
       return self._cache.GetFromFile(base_path + '/' + real_path)
     except FileNotFoundError as e:
       logging.error(e)
       return None