Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Catalog] Make update from hosted catalog lazy #3802

Merged
merged 4 commits into from
Aug 6, 2024
Merged

[Catalog] Make update from hosted catalog lazy #3802

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7ba7ab9
Make update from hosted catalog lazy
Michaelvll Jul 31, 2024
79880be
format
Michaelvll Jul 31, 2024
db9565f
Merge branch 'master' of github.com:skypilot-org/skypilot into lazy-u…
Michaelvll Aug 6, 2024
fcc717b
fix comment
Michaelvll Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 58 additions & 54 deletions sky/clouds/service_catalog/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import os
import time
import typing
from typing import Dict, List, NamedTuple, Optional, Tuple
from typing import Callable, Dict, List, NamedTuple, Optional, Tuple

import filelock
import requests
Expand Down Expand Up @@ -118,19 +118,21 @@ def _get_modified_catalogs() -> List[str]:


class LazyDataFrame:
"""A lazy data frame that reads the catalog on demand.
"""A lazy data frame that updates and reads the catalog on demand.

We don't need to load the catalog for every SkyPilot call, and this class
allows us to load the catalog only when needed.
"""

def __init__(self, filename: str):
def __init__(self, filename: str, update_func: Callable[[], None]):
self._filename = filename
self._df: Optional['pd.DataFrame'] = None
self._update_func = update_func

def _load_df(self) -> 'pd.DataFrame':
if self._df is None:
try:
self._update_func()
self._df = pd.read_csv(self._filename)
except Exception as e: # pylint: disable=broad-except
# As users can manually modify the catalog, read_csv can fail.
Expand Down Expand Up @@ -172,58 +174,60 @@ def read_catalog(filename: str,
meta_path = os.path.join(_ABSOLUTE_VERSIONED_CATALOG_DIR, '.meta', filename)
os.makedirs(os.path.dirname(meta_path), exist_ok=True)

# Atomic check, to avoid conflicts with other processes.
# TODO(mraheja): remove pylint disabling when filelock version updated
# pylint: disable=abstract-class-instantiated
with filelock.FileLock(meta_path + '.lock'):

def _need_update() -> bool:
if not os.path.exists(catalog_path):
return True
if pull_frequency_hours is None:
return False
if is_catalog_modified(filename):
# If the catalog is modified by a user manually, we should
# avoid overwriting the catalog by fetching from GitHub.
return False

last_update = os.path.getmtime(catalog_path)
return last_update + pull_frequency_hours * 3600 < time.time()

if _need_update():
url = f'{constants.HOSTED_CATALOG_DIR_URL}/{constants.CATALOG_SCHEMA_VERSION}/{filename}' # pylint: disable=line-too-long
update_frequency_str = ''
if pull_frequency_hours is not None:
update_frequency_str = f' (every {pull_frequency_hours} hours)'
with rich_utils.safe_status((f'Updating {cloud} catalog: '
f'{filename}'
f'{update_frequency_str}')):
try:
r = requests.get(url)
r.raise_for_status()
except requests.exceptions.RequestException as e:
error_str = (f'Failed to fetch {cloud} catalog '
f'{filename}. ')
if os.path.exists(catalog_path):
logger.warning(
f'{error_str}Using cached catalog files.')
# Update catalog file modification time.
os.utime(catalog_path, None) # Sets to current time
def _need_update() -> bool:
if not os.path.exists(catalog_path):
return True
if pull_frequency_hours is None:
return False
if is_catalog_modified(filename):
# If the catalog is modified by a user manually, we should
# avoid overwriting the catalog by fetching from GitHub.
return False

last_update = os.path.getmtime(catalog_path)
return last_update + pull_frequency_hours * 3600 < time.time()

def _update_catalog():
# Atomic check, to avoid conflicts with other processes.
with filelock.FileLock(meta_path + '.lock'):
if _need_update():
url = f'{constants.HOSTED_CATALOG_DIR_URL}/{constants.CATALOG_SCHEMA_VERSION}/{filename}' # pylint: disable=line-too-long
update_frequency_str = ''
if pull_frequency_hours is not None:
update_frequency_str = (
f' (every {pull_frequency_hours} hours)')
with rich_utils.safe_status((f'Updating {cloud} catalog: '
f'{filename}'
f'{update_frequency_str}')):
try:
r = requests.get(url)
r.raise_for_status()
except requests.exceptions.RequestException as e:
error_str = (f'Failed to fetch {cloud} catalog '
f'{filename}. ')
if os.path.exists(catalog_path):
logger.warning(
f'{error_str}Using cached catalog files.')
# Update catalog file modification time.
os.utime(catalog_path, None) # Sets to current time
else:
logger.error(
f'{error_str}Please check your internet '
'connection.')
with ux_utils.print_exception_no_traceback():
raise e
else:
logger.error(
f'{error_str}Please check your internet connection.'
)
with ux_utils.print_exception_no_traceback():
raise e
else:
# Download successful, save the catalog to a local file.
os.makedirs(os.path.dirname(catalog_path), exist_ok=True)
with open(catalog_path, 'w', encoding='utf-8') as f:
f.write(r.text)
with open(meta_path + '.md5', 'w', encoding='utf-8') as f:
f.write(hashlib.md5(r.text.encode()).hexdigest())

return LazyDataFrame(catalog_path)
# Download successful, save the catalog to a local file.
os.makedirs(os.path.dirname(catalog_path),
exist_ok=True)
with open(catalog_path, 'w', encoding='utf-8') as f:
f.write(r.text)
with open(meta_path + '.md5', 'w',
encoding='utf-8') as f:
f.write(hashlib.md5(r.text.encode()).hexdigest())
logger.info(f'Updated {cloud} catalog.')

return LazyDataFrame(catalog_path, update_func=_update_catalog)


def _get_instance_type(
Expand Down
Loading