from pype.api import ( get_project_settings, get_current_project_settings) import threading import concurrent.futures from concurrent.futures._base import CancelledError from enum import Enum from datetime import datetime from .providers import lib import os from bson.objectid import ObjectId from avalon.api import AvalonMongoDB from .utils import time_function import six from pype.lib import PypeLogger from .. import PypeModule, ITrayModule if six.PY2: web = asyncio = STATIC_DIR = WebSocketAsync = None else: import asyncio log = PypeLogger().get_logger("SyncServer") class SyncStatus(Enum): DO_NOTHING = 0 DO_UPLOAD = 1 DO_DOWNLOAD = 2 class SyncServer(PypeModule, ITrayModule): """ Synchronization server that is syncing published files from local to any of implemented providers (like GDrive, S3 etc.) Runs in the background and checks all representations, looks for files that are marked to be in different location than 'studio' (temporary), checks if 'created_dt' field is present denoting successful sync with provider destination. Sites structure is created during publish and by default it will always contain 1 record with "name" == self.presets["active_site"] and filled "created_dt" AND 1 or multiple records for all defined remote sites, where "created_dt" is not present. This highlights that file should be uploaded to remote destination ''' - example of synced file test_Cylinder_lookMain_v010.ma to GDrive "files" : [ { "path" : "{root}/Test/Assets/Cylinder/publish/look/lookMain/v010/ test_Cylinder_lookMain_v010.ma", "_id" : ObjectId("5eeb25e411e06a16209ab78f"), "hash" : "test_Cylinder_lookMain_v010,ma|1592468963,24|4822", "size" : NumberLong(4822), "sites" : [ { "name": "john_local_XD4345", "created_dt" : ISODate("2020-05-22T08:05:44.000Z") }, { "id" : ObjectId("5eeb25e411e06a16209ab78f"), "name": "gdrive", "created_dt" : ISODate("2020-05-55T08:54:35.833Z") ] } }, ''' Each Tray app has assigned its own self.presets["local_id"] used in sites as a name. Tray is searching only for records where name matches its self.presets["active_site"] + self.presets["remote_site"]. "active_site" could be storage in studio ('studio'), or specific "local_id" when user is working disconnected from home. If the local record has its "created_dt" filled, it is a source and process will try to upload the file to all defined remote sites. Remote files "id" is real id that could be used in appropriate API. Local files have "id" too, for conformity, contains just file name. It is expected that multiple providers will be implemented in separate classes and registered in 'providers.py'. """ # limit querying DB to look for X number of representations that should # be sync, we try to run more loops with less records # actual number of files synced could be lower as providers can have # different limits imposed by its API # set 0 to no limit REPRESENTATION_LIMIT = 100 DEFAULT_SITE = 'studio' LOG_PROGRESS_SEC = 5 # how often log progress to DB name = "sync_server" label = "Sync Server" def initialize(self, module_settings): """ Called during Module Manager creation. Collects needed data, checks asyncio presence. Sets 'enabled' according to global settings for the module. Shouldnt be doing any initialization, thats a job for 'tray_init' """ sync_server_settings = module_settings[self.name] self.enabled = sync_server_settings["enabled"] if asyncio is None: raise AssertionError( "SyncServer module requires Python 3.5 or higher." ) # some parts of code need to run sequentially, not in async self.lock = None self.connection = None # connection to avalon DB to update state self.presets = None # settings for all enabled projects for sync self.sync_server_thread = None # asyncio requires new thread self.action_show_widget = None def connect_with_modules(self, *_a, **kw): return def tray_init(self): """ Actual initialization of Sync Server. Called when tray is initialized, it checks if module should be enabled. If not, no initialization necessary. """ if not self.enabled: return self.presets = None self.lock = threading.Lock() self.connection = AvalonMongoDB() self.connection.install() try: self.presets = self.get_synced_presets() self.set_active_sites(self.presets) self.sync_server_thread = SyncServerThread(self) from .tray.app import SyncServerWindow self.widget = SyncServerWindow(self) except ValueError: log.info("No system setting for sync. Not syncing.", exc_info=True) self.enabled = False except KeyError: log.info(( "There are not set presets for SyncServer OR " "Credentials provided are invalid, " "no syncing possible"). format(str(self.presets)), exc_info=True) self.enabled = False def tray_start(self): """ Triggered when Tray is started. Checks if configuration presets are available and if there is any provider ('gdrive', 'S3') that is activated (eg. has valid credentials). Returns: None """ if self.presets and self.active_sites: self.sync_server_thread.start() else: log.info("No presets or active providers. " + "Synchronization not possible.") def tray_exit(self): """ Stops sync thread if running. Called from Module Manager """ if not self.sync_server_thread: return if not self.is_running: return try: log.info("Stopping sync server server") self.sync_server_thread.is_running = False self.sync_server_thread.stop() except Exception: log.warning( "Error has happened during Killing sync server", exc_info=True ) def tray_menu(self, parent_menu): if not self.enabled: return from Qt import QtWidgets """Add menu or action to Tray(or parent)'s menu""" action = QtWidgets.QAction("SyncServer", parent_menu) action.triggered.connect(self.show_widget) parent_menu.addAction(action) parent_menu.addSeparator() self.action_show_widget = action @property def is_running(self): return self.sync_server_thread.is_running def get_sites_for_project(self, project_name=None): """ Checks if sync is enabled globally and on project. In that case return local and remote site Args: project_name (str): Returns: (tuple): of strings, labels for (local_site, remote_site) """ if self.enabled: if project_name: settings = get_project_settings(project_name) else: settings = get_current_project_settings() sync_server_presets = settings["global"]["sync_server"]["config"] if settings["global"]["sync_server"]["enabled"]: local_site = sync_server_presets.get("active_site", "studio").strip() remote_site = sync_server_presets.get("remote_site") return local_site, remote_site return self.DEFAULT_SITE, None def get_synced_presets(self): """ Collects all projects which have enabled syncing and their settings Returns: (dict): of settings, keys are project names """ sync_presets = {} for collection in self.connection.database.collection_names(False): sync_settings = self.get_synced_preset(collection) if sync_settings: sync_presets[collection] = sync_settings if not sync_presets: log.info("No enabled and configured projects for sync.") return sync_presets def get_synced_preset(self, project_name): """ Handles pulling sync_server's settings for enabled 'project_name' Args: project_name (str): used in project settings Returns: (dict): settings dictionary for the enabled project, empty if no settings or sync is disabled """ settings = get_project_settings(project_name) sync_settings = settings.get("global")["sync_server"] if not sync_settings: log.info("No project setting for {}, not syncing.". format(project_name)) return {} if sync_settings.get("enabled"): return sync_settings return {} def set_active_sites(self, settings): """ Sets 'self.active_sites' as a dictionary from provided 'settings' Format: { 'project_name' : ('provider_name', 'site_name') } Args: settings (dict): all enabled project sync setting (sites labesl, retries count etc.) """ self.active_sites = {} for project_name, project_setting in settings.items(): for site_name, config in project_setting.get("sites").items(): handler = lib.factory.get_provider(config["provider"], site_name, presets=config) if handler.is_active(): if not self.active_sites.get('project_name'): self.active_sites[project_name] = [] self.active_sites[project_name].append( (config["provider"], site_name)) if not self.active_sites: log.info("No sync sites active, no working credentials provided") def get_active_sites(self, project_name): """ Returns active sites (provider configured and able to connect) per project. Args: project_name (str): used as a key in dict Returns: (dict): Format: { 'project_name' : ('provider_name', 'site_name') } """ return self.active_sites[project_name] @time_function def get_sync_representations(self, collection, active_site, remote_site): """ Get representations that should be synced, these could be recognised by presence of document in 'files.sites', where key is a provider (GDrive, S3) and value is empty document or document without 'created_dt' field. (Don't put null to 'created_dt'!). Querying of 'to-be-synched' files is offloaded to Mongod for better performance. Goal is to get as few representations as possible. Args: collection (string): name of collection (in most cases matches project name active_site (string): identifier of current active site (could be 'local_0' when working from home, 'studio' when working in the studio (default) remote_site (string): identifier of remote site I want to sync to Returns: (list) of dictionaries """ log.debug("Check representations for : {}".format(collection)) self.connection.Session["AVALON_PROJECT"] = collection # retry_cnt - number of attempts to sync specific file before giving up retries_arr = self._get_retries_arr(collection) query = { "type": "representation", "$or": [ {"$and": [ { "files.sites": { "$elemMatch": { "name": active_site, "created_dt": {"$exists": True} } }}, { "files.sites": { "$elemMatch": { "name": {"$in": [remote_site]}, "created_dt": {"$exists": False}, "tries": {"$in": retries_arr} } } }]}, {"$and": [ { "files.sites": { "$elemMatch": { "name": active_site, "created_dt": {"$exists": False}, "tries": {"$in": retries_arr} } }}, { "files.sites": { "$elemMatch": { "name": {"$in": [remote_site]}, "created_dt": {"$exists": True} } } } ]} ] } log.debug("get_sync_representations.query: {}".format(query)) representations = self.connection.find(query) return representations def check_status(self, file, provider_name, config_preset): """ Check synchronization status for single 'file' of single 'representation' by single 'provider'. (Eg. check if 'scene.ma' of lookdev.v10 should be synced to GDrive Always is comparing local record, eg. site with 'name' == self.presets[PROJECT_NAME]['config']["active_site"] Args: file (dictionary): of file from representation in Mongo provider_name (string): - gdrive etc. config_preset (dict): config about active site, retries Returns: (string) - one of SyncStatus """ sites = file.get("sites") or [] # if isinstance(sites, list): # temporary, old format of 'sites' # return SyncStatus.DO_NOTHING _, provider_rec = self._get_provider_rec(sites, provider_name) or {} if provider_rec: # sync remote target created_dt = provider_rec.get("created_dt") if not created_dt: tries = self._get_tries_count_from_rec(provider_rec) # file will be skipped if unsuccessfully tried over threshold # error metadata needs to be purged manually in DB to reset if tries < int(config_preset["retry_cnt"]): return SyncStatus.DO_UPLOAD else: _, local_rec = self._get_provider_rec( sites, config_preset["active_site"]) or {} if not local_rec or not local_rec.get("created_dt"): tries = self._get_tries_count_from_rec(local_rec) # file will be skipped if unsuccessfully tried over # threshold times, error metadata needs to be purged # manually in DB to reset if tries < int(config_preset["retry_cnt"]): return SyncStatus.DO_DOWNLOAD return SyncStatus.DO_NOTHING async def upload(self, collection, file, representation, provider_name, site_name, tree=None, preset=None): """ Upload single 'file' of a 'representation' to 'provider'. Source url is taken from 'file' portion, where {root} placeholder is replaced by 'representation.Context.root' Provider could be one of implemented in provider.py. Updates MongoDB, fills in id of file from provider (ie. file_id from GDrive), 'created_dt' - time of upload Args: collection (str): source collection file (dictionary): of file from representation in Mongo representation (dictionary): of representation provider_name (string): gdrive, gdc etc. site_name (string): site on provider, single provider(gdrive) could have multiple sites (different accounts, credentials) tree (dictionary): injected memory structure for performance preset (dictionary): site config ('credentials_url', 'root'...) """ # create ids sequentially, upload file in parallel later with self.lock: # this part modifies structure on 'remote_site', only single # thread can do that at a time, upload/download to prepared # structure should be run in parallel handler = lib.factory.get_provider(provider_name, site_name, tree=tree, presets=preset) remote_file = self._get_remote_file_path(file, handler.get_roots_config() ) local_root = representation.get("context", {}).get("root") local_file = self._get_local_file_path(file, local_root) target_folder = os.path.dirname(remote_file) folder_id = handler.create_folder(target_folder) if not folder_id: err = "Folder {} wasn't created. Check permissions.".\ format(target_folder) raise NotADirectoryError(err) _, remote_site = self.get_sites_for_project(collection) loop = asyncio.get_running_loop() file_id = await loop.run_in_executor(None, handler.upload_file, local_file, remote_file, self, collection, file, representation, remote_site, True ) return file_id async def download(self, collection, file, representation, provider_name, site_name, tree=None, preset=None): """ Downloads file to local folder denoted in representation.Context. Args: collection (str): source collection file (dictionary) : info about processed file representation (dictionary): repr that 'file' belongs to provider_name (string): 'gdrive' etc site_name (string): site on provider, single provider(gdrive) could have multiple sites (different accounts, credentials) tree (dictionary): injected memory structure for performance preset (dictionary): site config ('credentials_url', 'root'...) Returns: (string) - 'name' of local file """ with self.lock: handler = lib.factory.get_provider(provider_name, site_name, tree=tree, presets=preset) remote_file = self._get_remote_file_path(file, handler.get_roots_config() ) local_root = representation.get("context", {}).get("root") local_file = self._get_local_file_path(file, local_root) local_folder = os.path.dirname(local_file) os.makedirs(local_folder, exist_ok=True) local_site, _ = self.get_sites_for_project(collection) loop = asyncio.get_running_loop() file_id = await loop.run_in_executor(None, handler.download_file, remote_file, local_file, False, self, collection, file, representation, local_site ) return file_id def update_db(self, collection, new_file_id, file, representation, site, error=None, progress=None): """ Update 'provider' portion of records in DB with success (file_id) or error (exception) Args: collection (string): name of project - force to db connection as each file might come from different collection new_file_id (string): file (dictionary): info about processed file (pulled from DB) representation (dictionary): parent repr of file (from DB) site (string): label ('gdrive', 'S3') error (string): exception message progress (float): 0-1 of progress of upload/download Returns: None """ representation_id = representation.get("_id") file_id = file.get("_id") query = { "_id": representation_id, "files._id": file_id } file_index, _ = self._get_file_info(representation.get('files', []), file_id) site_index, _ = self._get_provider_rec(file.get('sites', []), site) update = {} if new_file_id: update["$set"] = self._get_success_dict(file_index, site_index, new_file_id) # reset previous errors if any update["$unset"] = self._get_error_dict(file_index, site_index, "", "", "") elif progress is not None: update["$set"] = self._get_progress_dict(file_index, site_index, progress) else: tries = self._get_tries_count(file, site) tries += 1 update["$set"] = self._get_error_dict(file_index, site_index, error, tries) self.connection.Session["AVALON_PROJECT"] = collection self.connection.update_one( query, update ) if progress is not None: return status = 'failed' error_str = 'with error {}'.format(error) if new_file_id: status = 'succeeded with id {}'.format(new_file_id) error_str = '' source_file = file.get("path", "") log.debug("File {source_file} process {status} {error_str}". format(status=status, source_file=source_file, error_str=error_str)) def _get_file_info(self, files, _id): """ Return record from list of records which name matches to 'provider' Could be possibly refactored with '_get_provider_rec' together. Args: files (list): of dictionaries with info about published files _id (string): _id of specific file Returns: (int, dictionary): index from list and record with metadata about site (if/when created, errors..) OR (-1, None) if not present """ for index, rec in enumerate(files): if rec.get("_id") == _id: return index, rec return -1, None def _get_provider_rec(self, sites, provider): """ Return record from list of records which name matches to 'provider' Args: sites (list): of dictionaries provider (string): 'local_XXX', 'gdrive' Returns: (int, dictionary): index from list and record with metadata about site (if/when created, errors..) OR (-1, None) if not present """ for index, rec in enumerate(sites): if rec.get("name") == provider: return index, rec return -1, None def reset_provider_for_file(self, collection, representation_id, file_id, side): """ Reset information about synchronization for particular 'file_id' and provider. Useful for testing or forcing file to be reuploaded. Args: collection (string): name of project (eg. collection) in DB representation_id(string): _id of representation file_id (string): file _id in representation side (string): local or remote side Returns: None """ # TODO - implement reset for ALL files or ALL sites query = { "_id": ObjectId(representation_id) } representation = list(self.connection.database[collection].find(query)) if not representation: raise ValueError("Representation {} not found in {}". format(representation_id, collection)) local_site, remote_site = self.get_sites_for_project(collection) if side == 'local': site_name = local_site else: site_name = remote_site files = representation[0].get('files', []) file_index, _ = self._get_file_info(files, file_id) site_index, _ = self._get_provider_rec(files[file_index]. get('sites', []), site_name) if file_index >= 0 and site_index >= 0: elem = {"name": site_name} update = { "$set": {"files.{}.sites.{}".format(file_index, site_index): elem } } self.connection.database[collection].update_one( query, update ) def get_loop_delay(self, project_name): """ Return count of seconds before next synchronization loop starts after finish of previous loop. Returns: (int): in seconds """ return int(self.presets[project_name]["config"]["loop_delay"]) def show_widget(self): """Show dialog to enter credentials""" self.widget.show() def _get_success_dict(self, file_index, site_index, new_file_id): """ Provide success metadata ("id", "created_dt") to be stored in Db. Used in $set: "DICT" part of query. Sites are array inside of array(file), so real indexes for both file and site are needed for upgrade in DB. Args: file_index: (int) - index of modified file site_index: (int) - index of modified site of modified file new_file_id: id of created file Returns: (dictionary) """ val = {"files.{}.sites.{}.id".format(file_index, site_index): new_file_id, "files.{}.sites.{}.created_dt".format(file_index, site_index): datetime.utcnow()} return val def _get_error_dict(self, file_index, site_index, error="", tries="", progress=""): """ Provide error metadata to be stored in Db. Used for set (error and tries provided) or unset mode. Args: file_index: (int) - index of modified file site_index: (int) - index of modified site of modified file error: (string) - message tries: how many times failed Returns: (dictionary) """ val = {"files.{}.sites.{}.last_failed_dt". format(file_index, site_index): datetime.utcnow(), "files.{}.sites.{}.error".format(file_index, site_index): error, "files.{}.sites.{}.tries".format(file_index, site_index): tries, "files.{}.sites.{}.progress".format(file_index, site_index): progress } return val def _get_tries_count_from_rec(self, rec): """ Get number of failed attempts to sync from site record Args: rec (dictionary): info about specific site record Returns: (int) - number of failed attempts """ if not rec: return 0 return rec.get("tries", 0) def _get_tries_count(self, file, provider): """ Get number of failed attempts to sync Args: file (dictionary): info about specific file provider (string): name of site ('gdrive' or specific user site) Returns: (int) - number of failed attempts """ _, rec = self._get_provider_rec(file.get("sites", []), provider) return rec.get("tries", 0) def _get_progress_dict(self, file_index, site_index, progress): """ Provide progress metadata to be stored in Db. Used during upload/download for GUI to show. Args: file_index: (int) - index of modified file site_index: (int) - index of modified site of modified file progress: (float) - 0-1 progress of upload/download Returns: (dictionary) """ val = {"files.{}.sites.{}.progress". format(file_index, site_index): progress } return val def _get_local_file_path(self, file, local_root): """ Auxiliary function for replacing rootless path with real path Args: file (dictionary): file info, get 'path' to file with {root} local_root (string): value of {root} for local projects Returns: (string) - absolute path on local system """ if not local_root: raise ValueError("Unknown local root for file {}") path = file.get("path", "") return path.format(**{"root": local_root}) def _get_remote_file_path(self, file, root_config): """ Auxiliary function for replacing rootless path with real path Args: file (dictionary): file info, get 'path' to file with {root} root_config (dict): value of {root} for remote location Returns: (string) - absolute path on remote location """ path = file.get("path", "") if not root_config.get("root"): root_config = {"root": root_config} path = path.format(**root_config) return path def _get_retries_arr(self, project_name): """ Returns array with allowed values in 'tries' field. If repre contains these values, it means it was tried to be synchronized but failed. We try up to 'self.presets["retry_cnt"]' times before giving up and skipping representation. Returns: (list) """ retry_cnt = self.presets[project_name].get("config")["retry_cnt"] arr = [i for i in range(int(retry_cnt))] arr.append(None) return arr class SyncServerThread(threading.Thread): """ Separate thread running synchronization server with asyncio loop. Stopped when tray is closed. """ def __init__(self, module): super(SyncServerThread, self).__init__() self.module = module self.loop = None self.is_running = False self.executor = concurrent.futures.ThreadPoolExecutor(max_workers=3) def run(self): self.is_running = True try: log.info("Starting Sync Server") self.loop = asyncio.new_event_loop() # create new loop for thread asyncio.set_event_loop(self.loop) self.loop.set_default_executor(self.executor) asyncio.ensure_future(self.check_shutdown(), loop=self.loop) asyncio.ensure_future(self.sync_loop(), loop=self.loop) self.loop.run_forever() except Exception: log.warning( "Sync Server service has failed", exc_info=True ) finally: self.loop.close() # optional async def sync_loop(self): """ Runs permanently, each time: - gets list of collections in DB - gets list of active remote providers (has configuration, credentials) - for each collection it looks for representations that should be synced - synchronize found collections - update representations - fills error messages for exceptions - waits X seconds and repeat Returns: """ try: while self.is_running: import time start_time = None for collection, preset in self.module.get_synced_presets().\ items(): start_time = time.time() sync_repres = self.module.get_sync_representations( collection, preset.get('config')["active_site"], preset.get('config')["remote_site"] ) local = preset.get('config')["active_site"] task_files_to_process = [] files_processed_info = [] # process only unique file paths in one batch # multiple representation could have same file path # (textures), # upload process can find already uploaded file and # reuse same id processed_file_path = set() for check_site in self.module.get_active_sites(collection): provider, site = check_site site_preset = preset.get('sites')[site] handler = lib.factory.get_provider(provider, site, presets=site_preset) limit = lib.factory.get_provider_batch_limit(provider) # first call to get_provider could be expensive, its # building folder tree structure in memory # call only if needed, eg. DO_UPLOAD or DO_DOWNLOAD for sync in sync_repres: if limit <= 0: continue files = sync.get("files") or [] if files: for file in files: # skip already processed files file_path = file.get('path', '') if file_path in processed_file_path: continue status = self.module.check_status( file, provider, preset.get('config')) if status == SyncStatus.DO_UPLOAD: tree = handler.get_tree() limit -= 1 task = asyncio.create_task( self.module.upload(collection, file, sync, provider, site, tree, site_preset)) task_files_to_process.append(task) # store info for exception handlingy files_processed_info.append((file, sync, site, collection )) processed_file_path.add(file_path) if status == SyncStatus.DO_DOWNLOAD: tree = handler.get_tree() limit -= 1 task = asyncio.create_task( self.module.download(collection, file, sync, provider, site, tree, site_preset)) task_files_to_process.append(task) files_processed_info.append((file, sync, local, collection )) processed_file_path.add(file_path) log.debug("Sync tasks count {}". format(len(task_files_to_process))) files_created = await asyncio.gather( *task_files_to_process, return_exceptions=True) for file_id, info in zip(files_created, files_processed_info): file, representation, site, collection = info error = None if isinstance(file_id, BaseException): error = str(file_id) file_id = None self.module.update_db(collection, file_id, file, representation, site, error) duration = time.time() - start_time log.debug("One loop took {:.2f}s".format(duration)) await asyncio.sleep(self.module.get_loop_delay(collection)) except ConnectionResetError: log.warning("ConnectionResetError in sync loop, trying next loop", exc_info=True) except CancelledError: # just stopping server pass except Exception: self.stop() log.warning("Unhandled exception in sync loop, stopping server", exc_info=True) def stop(self): """Sets is_running flag to false, 'check_shutdown' shuts server down""" self.is_running = False async def check_shutdown(self): """ Future that is running and checks if server should be running periodically. """ while self.is_running: await asyncio.sleep(0.5) tasks = [task for task in asyncio.all_tasks() if task is not asyncio.current_task()] list(map(lambda task: task.cancel(), tasks)) # cancel all the tasks results = await asyncio.gather(*tasks, return_exceptions=True) log.debug(f'Finished awaiting cancelled tasks, results: {results}...') await self.loop.shutdown_asyncgens() # to really make sure everything else has time to stop self.executor.shutdown(wait=True) await asyncio.sleep(0.07) self.loop.stop()