Docserver: Factor SamplesModel out of SamplesDataSource

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 data_source import DataSource
 from docs_server_utils import StringIdentity
 from environment import IsPreviewServer
 from file_system import FileNotFoundError
 from future import Future, All
 from jsc_view import JSCView, GetEventByNameFromEvents
 from platform_util import GetPlatforms
-
-
-class _LazySamplesGetter(object):
-  '''This class is needed so that an extensions API page does not have to fetch
-  the apps samples page and vice versa.
-  '''
-
-  def __init__(self, api_name, samples):
-    self._api_name = api_name
-    self._samples = samples
-
-  def get(self, key):
-    return self._samples.FilterSamples(key, self._api_name)
+from samples_data_source import CreateSamplesView
 
 
 class APIDataSource(DataSource):
   '''This class fetches and loads JSON APIs from the FileSystem passed in with
   |compiled_fs_factory|, so the APIs can be plugged into templates.
   '''
   def __init__(self, server_instance, request):
     file_system = server_instance.host_file_system_provider.GetTrunk()
     self._json_cache = server_instance.compiled_fs_factory.ForJson(file_system)
     self._template_cache = server_instance.compiled_fs_factory.ForTemplates(
         file_system)
     self._platform_bundle = server_instance.platform_bundle
     self._view_cache = server_instance.object_store_creator.Create(
         APIDataSource,
         # Update the models when any of templates, APIs, or Features change.
         category=StringIdentity(self._json_cache.GetIdentity(),
                                 self._template_cache.GetIdentity(),
                                 self._platform_bundle.GetIdentity()))
 
     # This caches the result of _LoadEventByName.
     self._event_byname_futures = {}
-    self._samples = server_instance.samples_data_source_factory.Create(request)
+    self._request = request
 
   def _LoadEventByName(self, platform):
     '''All events have some members in common. We source their description
     from Event in events.json.
     '''
     if platform not in self._event_byname_futures:
       future = self._GetSchemaView(platform, 'events')
       self._event_byname_futures[platform] = Future(
           callback=lambda: GetEventByNameFromEvents(future.Get()))
     return self._event_byname_futures[platform]
@@ skipping 20 matching lines @@
       return jsc_view
     return Future(callback=resolve)
 
   def _GetImpl(self, platform, api_name):
     jsc_view_future = self._GetSchemaView(platform, api_name)
     def resolve():
       jsc_view = jsc_view_future.Get()
       # Parsing samples on the preview server takes seconds and doesn't add
       # anything. Don't do it.
       if not IsPreviewServer():
-        jsc_view['samples'] = _LazySamplesGetter(
-            jsc_view['name'],
-            self._samples)
+        jsc_view['samples'] = type('getter', (object,), {

[ahernandez, 2014/08/05 19:15:54]

I hope this isn't too hacky, I thought it would be good to keep it lazy.

[not at google - send to devlin, 2014/08/05 19:56:35]

ok - fair enough, makes sense. That's pretty hacky :)

you should at least be able to store the SamplesModel locally so it's not so
crazy.

and add a comment.

+          'get': lambda _, platform: CreateSamplesView(
+              self._platform_bundle.GetSamplesModel(platform).FilterSamples(
+                  jsc_view['name']),
+              self._request)
+          })()
       return jsc_view
     return Future(callback=resolve)
 
   def get(self, platform):
     '''Return a getter object so that templates can perform lookups such
     as apis.extensions.runtime.
     '''
     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 All(futures, except_pass=FileNotFoundError)