availability_finder.py revision effb81e5f8246d0db0270817048dc992db66e9fb
1eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch# Copyright 2013 The Chromium Authors. All rights reserved. 2eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch# Use of this source code is governed by a BSD-style license that can be 3eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch# found in the LICENSE file. 4eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 51e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles)from collections import Mapping 65d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)import posixpath 7eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)from api_schema_graph import APISchemaGraph 9eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochfrom branch_utility import BranchUtility 10effb81e5f8246d0db0270817048dc992db66e9fbBen Murdochfrom extensions_paths import API_PATHS, JSON_TEMPLATES 11effb81e5f8246d0db0270817048dc992db66e9fbBen Murdochfrom features_bundle import FeaturesBundle 12effb81e5f8246d0db0270817048dc992db66e9fbBen Murdochimport features_utility 13a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)from file_system import FileNotFoundError 14effb81e5f8246d0db0270817048dc992db66e9fbBen Murdochfrom third_party.json_schema_compiler.memoize import memoize 15424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)from third_party.json_schema_compiler.model import UnixName 16eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 17eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 1868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)_EXTENSION_API = 'extension_api.json' 1968043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 20a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)# The version where api_features.json is first available. 21a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)_API_FEATURES_MIN_VERSION = 28 22a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)# The version where permission_ and manifest_features.json are available and 23a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)# presented in the current format. 24a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)_ORIGINAL_FEATURES_MIN_VERSION = 20 25a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)# API schemas are aggregated in extension_api.json up to this version. 26a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)_EXTENSION_API_MAX_VERSION = 17 27a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)# The earliest version for which we have SVN data. 28a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)_SVN_MIN_VERSION = 5 29a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 30a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 31effb81e5f8246d0db0270817048dc992db66e9fbBen Murdochdef _GetChannelFromFeatures(api_name, features): 32effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch '''Finds API channel information for |api_name| from |features|. 33effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch Returns None if channel information for the API cannot be located. 34eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ''' 35effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch feature = features.Get().get(api_name) 36effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch return feature.get('channel') if feature else None 37eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 38eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 39eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochclass AvailabilityFinder(object): 40424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) '''Generates availability information for APIs by looking at API schemas and 41424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) _features files over multiple release versions of Chrome. 42eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ''' 43eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 44eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch def __init__(self, 4568043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) branch_utility, 461e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) compiled_fs_factory, 471e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) file_system_iterator, 481e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) host_file_system, 491e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) object_store_creator): 501e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) self._branch_utility = branch_utility 511e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) self._compiled_fs_factory = compiled_fs_factory 52424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) self._file_system_iterator = file_system_iterator 531e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) self._host_file_system = host_file_system 54eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch self._object_store_creator = object_store_creator 5568043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) def create_object_store(category): 5668043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) return object_store_creator.Create(AvailabilityFinder, category=category) 5768043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) self._top_level_object_store = create_object_store('top_level') 5868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) self._node_level_object_store = create_object_store('node_level') 59f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) self._json_fs = compiled_fs_factory.ForJson(self._host_file_system) 60f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 61f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) def _GetPredeterminedAvailability(self, api_name): 62f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) '''Checks a configuration file for hardcoded (i.e. predetermined) 63f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) availability information for an API. 64f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) ''' 65f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) api_info = self._json_fs.GetFromFile( 665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) JSON_TEMPLATES + 'api_availabilities.json').Get().get(api_name) 67f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) if api_info is None: 68f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) return None 69f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) if api_info['channel'] == 'stable': 70a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return self._branch_utility.GetStableChannelInfo(api_info['version']) 71f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) else: 72a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return self._branch_utility.GetChannelInfo(api_info['channel']) 73a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 74a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) def _GetApiSchemaFilename(self, api_name, file_system, version): 75a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) '''Gets the name of the file which may contain the schema for |api_name| in 76a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) |file_system|, or None if the API is not found. Note that this may be the 77a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) single _EXTENSION_API file which all APIs share in older versions of Chrome, 78a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) in which case it is unknown whether the API actually exists there. 79a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) ''' 80a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if version == 'trunk' or version > _ORIGINAL_FEATURES_MIN_VERSION: 81a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) # API schema filenames switch format to unix_hacker_style. 82a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) api_name = UnixName(api_name) 83a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 84a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) futures = [(path, file_system.ReadSingle(path)) 85effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch for path in API_PATHS] 86a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) for path, future in futures: 87a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) try: 88a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) filenames = future.Get() 89a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) for ext in ('json', 'idl'): 90a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) filename = '%s.%s' % (api_name, ext) 91a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) if filename in filenames: 92a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) return path + filename 93a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) if _EXTENSION_API in filenames: 94a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) return path + _EXTENSION_API 95a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) except FileNotFoundError: 96a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) pass 97a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return None 98a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 99a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) def _GetApiSchema(self, api_name, file_system, version): 100a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) '''Searches |file_system| for |api_name|'s API schema data, and processes 101a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) and returns it if found. 102a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) ''' 103a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) api_filename = self._GetApiSchemaFilename(api_name, file_system, version) 104a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if api_filename is None: 105a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) # No file for the API could be found in the given |file_system|. 106a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return None 107a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 108a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) schema_fs = self._compiled_fs_factory.ForApiSchema(file_system) 109a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) api_schemas = schema_fs.GetFromFile(api_filename).Get() 110a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) matching_schemas = [api for api in api_schemas 111a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if api['namespace'] == api_name] 112a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) # There should only be a single matching schema per file, or zero in the 113a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) # case of no API data being found in _EXTENSION_API. 114a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) assert len(matching_schemas) <= 1 115a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return matching_schemas or None 116a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 117a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) def _HasApiSchema(self, api_name, file_system, version): 118a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) '''Whether or not an API schema for |api_name|exists in the given 119a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) |file_system|. 120a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) ''' 121a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) filename = self._GetApiSchemaFilename(api_name, file_system, version) 122a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if filename is None: 123a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return False 124a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if filename.endswith(_EXTENSION_API): 125a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return self._GetApiSchema(api_name, file_system, version) is not None 126a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return True 127424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) 128424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) def _CheckStableAvailability(self, api_name, file_system, version): 129424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) '''Checks for availability of an API, |api_name|, on the stable channel. 130424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) Considers several _features.json files, file system existence, and 131424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) extension_api.json depending on the given |version|. 132eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ''' 133a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if version < _SVN_MIN_VERSION: 134a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) # SVN data isn't available below this version. 135424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) return False 136effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch features_bundle = self._CreateFeaturesBundle(file_system) 137424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) available_channel = None 138a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if version >= _API_FEATURES_MIN_VERSION: 139424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) # The _api_features.json file first appears in version 28 and should be 140424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) # the most reliable for finding API availability. 141effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch available_channel = self._GetChannelFromApiFeatures(api_name, 142effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch features_bundle) 143a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if version >= _ORIGINAL_FEATURES_MIN_VERSION: 144424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) # The _permission_features.json and _manifest_features.json files are 145424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) # present in Chrome 20 and onwards. Use these if no information could be 146424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) # found using _api_features.json. 147effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch available_channel = ( 148effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch available_channel or 149effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self._GetChannelFromPermissionFeatures(api_name, features_bundle) or 150effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self._GetChannelFromManifestFeatures(api_name, features_bundle)) 151424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) if available_channel is not None: 152424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) return available_channel == 'stable' 153a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if version >= _SVN_MIN_VERSION: 15468043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) # Fall back to a check for file system existence if the API is not 15568043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) # stable in any of the _features.json files, or if the _features files 15668043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) # do not exist (version 19 and earlier). 157a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return self._HasApiSchema(api_name, file_system, version) 158424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) 159a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) def _CheckChannelAvailability(self, api_name, file_system, channel_info): 1601e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) '''Searches through the _features files in a given |file_system|, falling 1611e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) back to checking the file system for API schema existence, to determine 162a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) whether or not an API is available on the given channel, |channel_info|. 163eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ''' 164effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch features_bundle = self._CreateFeaturesBundle(file_system) 165effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch available_channel = ( 166effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self._GetChannelFromApiFeatures(api_name, features_bundle) or 167effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self._GetChannelFromPermissionFeatures(api_name, features_bundle) or 168effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self._GetChannelFromManifestFeatures(api_name, features_bundle)) 169a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) if (available_channel is None and 170a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) self._HasApiSchema(api_name, file_system, channel_info.version)): 171eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch # If an API is not represented in any of the _features files, but exists 172eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch # in the filesystem, then assume it is available in this version. 173a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) # The chrome.windows API is an example of this. 174a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) available_channel = channel_info.channel 175424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) # If the channel we're checking is the same as or newer than the 176424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) # |available_channel| then the API is available at this channel. 177a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) newest = BranchUtility.NewestChannel((available_channel, 178a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) channel_info.channel)) 179a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return available_channel is not None and newest == channel_info.channel 180424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) 181effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch @memoize 182effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def _CreateFeaturesBundle(self, file_system): 183effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch return FeaturesBundle(file_system, 184effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self._compiled_fs_factory, 185effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self._object_store_creator) 186effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 187effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def _GetChannelFromApiFeatures(self, api_name, features_bundle): 188effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch return _GetChannelFromFeatures(api_name, features_bundle.GetAPIFeatures()) 189effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 190effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def _GetChannelFromManifestFeatures(self, api_name, features_bundle): 191effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch # _manifest_features.json uses unix_style API names. 192effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch api_name = UnixName(api_name) 193effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch return _GetChannelFromFeatures(api_name, 194effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch features_bundle.GetManifestFeatures()) 195effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 196effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def _GetChannelFromPermissionFeatures(self, api_name, features_bundle): 197effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch return _GetChannelFromFeatures(api_name, 198effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch features_bundle.GetPermissionFeatures()) 199effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch 200424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) def _CheckApiAvailability(self, api_name, file_system, channel_info): 201424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) '''Determines the availability for an API at a certain version of Chrome. 202424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) Two branches of logic are used depending on whether or not the API is 203424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) determined to be 'stable' at the given version. 204424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) ''' 205424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) if channel_info.channel == 'stable': 206424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) return self._CheckStableAvailability(api_name, 207424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) file_system, 208424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) channel_info.version) 209424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) return self._CheckChannelAvailability(api_name, 210424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) file_system, 211a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) channel_info) 212eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 213eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch def GetApiAvailability(self, api_name): 214424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) '''Performs a search for an API's top-level availability by using a 215424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) HostFileSystemIterator instance to traverse multiple version of the 216424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) SVN filesystem. 217eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ''' 21868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) availability = self._top_level_object_store.Get(api_name).Get() 219eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch if availability is not None: 220eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch return availability 221eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 222f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # Check for predetermined availability and cache this information if found. 223f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) availability = self._GetPredeterminedAvailability(api_name) 224f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) if availability is not None: 225f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) self._top_level_object_store.Set(api_name, availability) 226f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) return availability 227f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 228424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) def check_api_availability(file_system, channel_info): 229a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) return self._CheckApiAvailability(api_name, file_system, channel_info) 230eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 231424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) availability = self._file_system_iterator.Descending( 232424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) self._branch_utility.GetChannelInfo('dev'), 233424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) check_api_availability) 2343551c9c881056c480085172ff9840cab31610854Torne (Richard Coles) if availability is None: 235424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) # The API wasn't available on 'dev', so it must be a 'trunk'-only API. 236424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) availability = self._branch_utility.GetChannelInfo('trunk') 23768043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) self._top_level_object_store.Set(api_name, availability) 238eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch return availability 23968043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 24068043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) def GetApiNodeAvailability(self, api_name): 24168043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) '''Returns an APISchemaGraph annotated with each node's availability (the 24268043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) ChannelInfo at the oldest channel it's available in). 24368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) ''' 24468043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) availability_graph = self._node_level_object_store.Get(api_name).Get() 24568043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) if availability_graph is not None: 24668043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) return availability_graph 24768043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 248f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) def assert_not_none(value): 249f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) assert value is not None 250f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) return value 2514e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 25268043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) availability_graph = APISchemaGraph() 253f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 254f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) host_fs = self._host_file_system 255a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) trunk_stat = assert_not_none(host_fs.Stat(self._GetApiSchemaFilename( 256a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) api_name, host_fs, 'trunk'))) 257f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 258f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # Weird object thing here because nonlocal is Python 3. 259f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) previous = type('previous', (object,), {'stat': None, 'graph': None}) 260f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 26168043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) def update_availability_graph(file_system, channel_info): 262a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) version_filename = assert_not_none(self._GetApiSchemaFilename( 263a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) api_name, file_system, channel_info.version)) 264a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) version_stat = assert_not_none(file_system.Stat(version_filename)) 265f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 266f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # Important optimisation: only re-parse the graph if the file changed in 267f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # the last revision. Parsing the same schema and forming a graph on every 268f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # iteration is really expensive. 269f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) if version_stat == previous.stat: 270f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) version_graph = previous.graph 271f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) else: 272f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # Keep track of any new schema elements from this version by adding 273f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # them to |availability_graph|. 274f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # 275f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # Calling |availability_graph|.Lookup() on the nodes being updated 276f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) # will return the |annotation| object -- the current |channel_info|. 277a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) version_graph = APISchemaGraph(self._GetApiSchema( 278a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) api_name, file_system, channel_info.version)) 279f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) availability_graph.Update(version_graph.Subtract(availability_graph), 280f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) annotation=channel_info) 281f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 282f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) previous.stat = version_stat 283f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) previous.graph = version_graph 28468043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 28568043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) # Continue looping until there are no longer differences between this 28668043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) # version and trunk. 287f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) return version_stat != trunk_stat 28868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 2894e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) self._file_system_iterator.Ascending(self.GetApiAvailability(api_name), 2904e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) update_availability_graph) 29168043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 29268043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) self._node_level_object_store.Set(api_name, availability_graph) 29368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) return availability_graph 294