From 87dd53ff71d163a44a754da0a3af39997fb10973 Mon Sep 17 00:00:00 2001 From: Pablo Galindo Salgado Date: Fri, 20 Nov 2026 17:06:32 +0000 Subject: [PATCH 1/2] Refresh the release dashboard in the background --- .github/workflows/check.yml | 2 + master/custom/release_dashboard.py | 66 ++++++++--- master/custom/templates/releasedashboard.html | 2 +- tests/test_release_dashboard_refresh.py | 108 ++++++++++++++++++ 4 files changed, 158 insertions(+), 20 deletions(-) create mode 100644 tests/test_release_dashboard_refresh.py diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index bf07b26d..54958922 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -26,6 +26,8 @@ jobs: python-version: ${{ matrix.python-version }} - name: Check configuration run: make check PIP=pip BUILDBOT=buildbot PYTHON_VERSION=${{ matrix.python-version }} + - name: Check custom components + run: PYTHONPATH=master python -m unittest discover -s tests - name: Compare configuration reports run: | # Use the same formatter for both configurations, including older main revisions. diff --git a/master/custom/release_dashboard.py b/master/custom/release_dashboard.py index 3f0c024d..9666ebc3 100644 --- a/master/custom/release_dashboard.py +++ b/master/custom/release_dashboard.py @@ -1,20 +1,19 @@ -import contextlib import datetime import os import re +import threading import time from functools import cached_property, total_ordering import enum from dataclasses import dataclass import itertools import urllib.request -import urllib.error import json from pathlib import Path from xml.etree import ElementTree from flask import Flask -from flask import render_template, request +from flask import render_template, request, url_for import jinja2 import humanize @@ -30,6 +29,8 @@ # cronjob that forces a refresh every 5 minutes, so all human requests should # get a cache hit. CACHE_DURATION = 6 * 60 +REFRESH_RETRY_DELAY = 60 + BRANCHES_URL = "https://peps.python.org/api/release-cycle.json" @@ -739,31 +740,40 @@ class ReleaseDashboard: def __init__(self, test_result_dir=None): self.flask_app = Flask("test", root_path=os.path.dirname(__file__)) self.cache = None - - self._refresh_branch_info() + self.branch_info = {} + self.refresh_lock = threading.Lock() + self.retry_at = 0 self.flask_app.jinja_env.add_extension('jinja2.ext.loopcontrols') self.flask_app.jinja_env.undefined = jinja2.StrictUndefined - self.test_result_dir = Path(test_result_dir).resolve() + self.test_result_dir = Path(test_result_dir).resolve() if test_result_dir is not None else None @self.flask_app.route('/') @self.flask_app.route("/index.html") def main(): force_refresh = request.args.get("refresh", "").lower() in {"1", "yes", "true"} - if self.cache is not None and not force_refresh: - result, deadline = self.cache - if time.monotonic() <= deadline: - return result - - with contextlib.suppress(urllib.error.HTTPError): - self._refresh_branch_info() - - result = self.get_release_status() - deadline = time.monotonic() + CACHE_DURATION - self.cache = (result, deadline) - return result + cached = self.cache + now = time.monotonic() + if cached is not None and not force_refresh and now <= cached[1]: + return cached[0] + + if now >= self.retry_at and self.refresh_lock.acquire(blocking=False): + try: + threading.Thread( + target=self._refresh, + kwargs={'stylesheet_url': url_for('static', filename='dashboard.css')}, + name='release-dashboard-refresh', + daemon=True, + ).start() + except Exception: + self.refresh_lock.release() + raise + + if cached is not None: + return cached[0] + return 'Release status is not yet available. Retry in five seconds.', 503, {'Retry-After': '5'} @self.flask_app.template_filter('first_line') def first_line(text): @@ -794,7 +804,24 @@ def _refresh_branch_info(self): with urllib.request.urlopen(BRANCHES_URL) as file: self.branch_info = json.load(file) - def get_release_status(self): + def _refresh(self, stylesheet_url): + try: + try: + self._refresh_branch_info() + except (OSError, ValueError): + self.flask_app.logger.warning('Could not refresh release branch data', exc_info=True) + if not self.branch_info: + raise ValueError('Release branch data is unavailable') + with self.flask_app.app_context(): + result = self.get_release_status(stylesheet_url) + self.cache = (result, time.monotonic() + CACHE_DURATION) + except Exception: + self.flask_app.logger.exception('Could not refresh release dashboard') + finally: + self.retry_at = time.monotonic() + REFRESH_RETRY_DELAY + self.refresh_lock.release() + + def get_release_status(self, stylesheet_url): state = DashboardState(self) return strip_indentation( @@ -803,6 +830,7 @@ def get_release_status(self): state=state, Severity=Severity, generated_at=state.now, + stylesheet_url=stylesheet_url, ) ) diff --git a/master/custom/templates/releasedashboard.html b/master/custom/templates/releasedashboard.html index 6dd9a8b6..f09fa6d9 100644 --- a/master/custom/templates/releasedashboard.html +++ b/master/custom/templates/releasedashboard.html @@ -4,7 +4,7 @@ Python Branch Release Status Dashboard - + diff --git a/tests/test_release_dashboard_refresh.py b/tests/test_release_dashboard_refresh.py new file mode 100644 index 00000000..cc3fef9c --- /dev/null +++ b/tests/test_release_dashboard_refresh.py @@ -0,0 +1,108 @@ +import tempfile +import threading +import unittest +from unittest import mock + +from custom import release_dashboard as dashboard + + +class ReleaseDashboardTests(unittest.TestCase): + def setUp(self): + self.directory = tempfile.TemporaryDirectory() + self.addCleanup(self.directory.cleanup) + self.dashboard = dashboard.ReleaseDashboard(test_result_dir=self.directory.name) + self.client = self.dashboard.flask_app.test_client() + patcher = mock.patch.object(dashboard.threading, 'Thread') + self.thread = patcher.start() + self.addCleanup(patcher.stop) + + def test_cold_requests_start_only_one_refresh(self): + first = self.client.get('/') + second = self.client.get('/') + self.assertEqual(first.status_code, 503) + self.assertEqual(second.headers['Retry-After'], '5') + self.thread.return_value.start.assert_called_once() + + def test_expired_cache_remains_available_during_refresh(self): + self.dashboard.cache = ('old page', 0) + for _ in range(3): + response = self.client.get('/') + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data, b'old page') + self.thread.return_value.start.assert_called_once() + + def test_failed_refresh_preserves_cache_and_delays_retry(self): + self.dashboard.cache = ('cached', 0) + self.dashboard.branch_info = {'3.15': {}} + self.dashboard.refresh_lock.acquire() + with mock.patch.object(self.dashboard, '_refresh_branch_info'), \ + mock.patch.object(self.dashboard, 'get_release_status', side_effect=RuntimeError('database unavailable')), \ + self.assertLogs(self.dashboard.flask_app.logger, level='ERROR'): + self.dashboard._refresh('/static/dashboard.css') + self.assertEqual(self.dashboard.cache, ('cached', 0)) + self.assertFalse(self.dashboard.refresh_lock.locked()) + response = self.client.get('/') + self.assertEqual(response.data, b'cached') + self.thread.assert_not_called() + + def test_refresh_uses_app_context_and_replaces_cache(self): + self.dashboard.branch_info = {'3.15': {}} + self.dashboard.refresh_lock.acquire() + def render(stylesheet_url): + from flask import current_app + self.assertIs(current_app._get_current_object(), self.dashboard.flask_app) + return 'new page' + with mock.patch.object(self.dashboard, '_refresh_branch_info'), \ + mock.patch.object(self.dashboard, 'get_release_status', side_effect=render): + self.dashboard._refresh('/static/dashboard.css') + self.assertEqual(self.dashboard.cache[0], 'new page') + self.assertFalse(self.dashboard.refresh_lock.locked()) + + def test_background_render_preserves_stylesheet_mount_path(self): + self.dashboard.branch_info = {'3.15': {'branch': '3.15', 'status': 'bugfix'}} + self.dashboard.flask_app.buildbot_api = mock.Mock() + self.dashboard.flask_app.buildbot_api.dataGet.return_value = [] + self.dashboard.refresh_lock.acquire() + with mock.patch.object(self.dashboard, '_refresh_branch_info'): + self.dashboard._refresh('/plugins/wsgi_dashboards/release_status/static/dashboard.css') + self.assertIsNotNone(self.dashboard.cache) + self.assertIn('/plugins/wsgi_dashboards/release_status/static/dashboard.css', self.dashboard.cache[0]) + + +class BackgroundRefreshTests(unittest.TestCase): + def test_refresh_continues_after_http_request_finishes(self): + page = dashboard.ReleaseDashboard() + page.branch_info = {'3.15': {}} + entered = threading.Event() + release = threading.Event() + threads = [] + real_thread = threading.Thread + + def make_thread(**kwargs): + thread = real_thread(**kwargs) + threads.append(thread) + return thread + + def render(stylesheet_url): + entered.set() + if not release.wait(5): + raise RuntimeError('Refresh did not receive release event') + return 'ready' + + try: + with mock.patch.object(dashboard.threading, 'Thread', side_effect=make_thread), \ + mock.patch.object(page, '_refresh_branch_info'), \ + mock.patch.object(page, 'get_release_status', side_effect=render): + client = page.flask_app.test_client() + self.assertEqual(client.get('/').status_code, 503) + self.assertTrue(entered.wait(5)) + self.assertEqual(client.get('/').status_code, 503) + self.assertEqual(len(threads), 1) + release.set() + threads[0].join(5) + self.assertFalse(threads[0].is_alive()) + self.assertEqual(client.get('/').data, b'ready') + finally: + release.set() + for thread in threads: + thread.join(5) From ec4dd21948c0ce9b3643ebdf0454c49f944f490b Mon Sep 17 00:00:00 2001 From: Pablo Galindo Salgado Date: Fri, 20 Nov 2026 18:27:00 +0000 Subject: [PATCH 2/2] Simplify background refresh failure handling --- .github/workflows/check.yml | 2 - master/custom/release_dashboard.py | 13 +-- tests/test_release_dashboard_refresh.py | 108 ------------------------ 3 files changed, 4 insertions(+), 119 deletions(-) delete mode 100644 tests/test_release_dashboard_refresh.py diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 54958922..bf07b26d 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -26,8 +26,6 @@ jobs: python-version: ${{ matrix.python-version }} - name: Check configuration run: make check PIP=pip BUILDBOT=buildbot PYTHON_VERSION=${{ matrix.python-version }} - - name: Check custom components - run: PYTHONPATH=master python -m unittest discover -s tests - name: Compare configuration reports run: | # Use the same formatter for both configurations, including older main revisions. diff --git a/master/custom/release_dashboard.py b/master/custom/release_dashboard.py index 9666ebc3..3e55e0fa 100644 --- a/master/custom/release_dashboard.py +++ b/master/custom/release_dashboard.py @@ -741,13 +741,13 @@ def __init__(self, test_result_dir=None): self.flask_app = Flask("test", root_path=os.path.dirname(__file__)) self.cache = None self.branch_info = {} - self.refresh_lock = threading.Lock() - self.retry_at = 0 self.flask_app.jinja_env.add_extension('jinja2.ext.loopcontrols') self.flask_app.jinja_env.undefined = jinja2.StrictUndefined - self.test_result_dir = Path(test_result_dir).resolve() if test_result_dir is not None else None + self.test_result_dir = Path(test_result_dir).resolve() + self.refresh_lock = threading.Lock() + self.retry_at = 0 @self.flask_app.route('/') @self.flask_app.route("/index.html") @@ -806,12 +806,7 @@ def _refresh_branch_info(self): def _refresh(self, stylesheet_url): try: - try: - self._refresh_branch_info() - except (OSError, ValueError): - self.flask_app.logger.warning('Could not refresh release branch data', exc_info=True) - if not self.branch_info: - raise ValueError('Release branch data is unavailable') + self._refresh_branch_info() with self.flask_app.app_context(): result = self.get_release_status(stylesheet_url) self.cache = (result, time.monotonic() + CACHE_DURATION) diff --git a/tests/test_release_dashboard_refresh.py b/tests/test_release_dashboard_refresh.py deleted file mode 100644 index cc3fef9c..00000000 --- a/tests/test_release_dashboard_refresh.py +++ /dev/null @@ -1,108 +0,0 @@ -import tempfile -import threading -import unittest -from unittest import mock - -from custom import release_dashboard as dashboard - - -class ReleaseDashboardTests(unittest.TestCase): - def setUp(self): - self.directory = tempfile.TemporaryDirectory() - self.addCleanup(self.directory.cleanup) - self.dashboard = dashboard.ReleaseDashboard(test_result_dir=self.directory.name) - self.client = self.dashboard.flask_app.test_client() - patcher = mock.patch.object(dashboard.threading, 'Thread') - self.thread = patcher.start() - self.addCleanup(patcher.stop) - - def test_cold_requests_start_only_one_refresh(self): - first = self.client.get('/') - second = self.client.get('/') - self.assertEqual(first.status_code, 503) - self.assertEqual(second.headers['Retry-After'], '5') - self.thread.return_value.start.assert_called_once() - - def test_expired_cache_remains_available_during_refresh(self): - self.dashboard.cache = ('old page', 0) - for _ in range(3): - response = self.client.get('/') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.data, b'old page') - self.thread.return_value.start.assert_called_once() - - def test_failed_refresh_preserves_cache_and_delays_retry(self): - self.dashboard.cache = ('cached', 0) - self.dashboard.branch_info = {'3.15': {}} - self.dashboard.refresh_lock.acquire() - with mock.patch.object(self.dashboard, '_refresh_branch_info'), \ - mock.patch.object(self.dashboard, 'get_release_status', side_effect=RuntimeError('database unavailable')), \ - self.assertLogs(self.dashboard.flask_app.logger, level='ERROR'): - self.dashboard._refresh('/static/dashboard.css') - self.assertEqual(self.dashboard.cache, ('cached', 0)) - self.assertFalse(self.dashboard.refresh_lock.locked()) - response = self.client.get('/') - self.assertEqual(response.data, b'cached') - self.thread.assert_not_called() - - def test_refresh_uses_app_context_and_replaces_cache(self): - self.dashboard.branch_info = {'3.15': {}} - self.dashboard.refresh_lock.acquire() - def render(stylesheet_url): - from flask import current_app - self.assertIs(current_app._get_current_object(), self.dashboard.flask_app) - return 'new page' - with mock.patch.object(self.dashboard, '_refresh_branch_info'), \ - mock.patch.object(self.dashboard, 'get_release_status', side_effect=render): - self.dashboard._refresh('/static/dashboard.css') - self.assertEqual(self.dashboard.cache[0], 'new page') - self.assertFalse(self.dashboard.refresh_lock.locked()) - - def test_background_render_preserves_stylesheet_mount_path(self): - self.dashboard.branch_info = {'3.15': {'branch': '3.15', 'status': 'bugfix'}} - self.dashboard.flask_app.buildbot_api = mock.Mock() - self.dashboard.flask_app.buildbot_api.dataGet.return_value = [] - self.dashboard.refresh_lock.acquire() - with mock.patch.object(self.dashboard, '_refresh_branch_info'): - self.dashboard._refresh('/plugins/wsgi_dashboards/release_status/static/dashboard.css') - self.assertIsNotNone(self.dashboard.cache) - self.assertIn('/plugins/wsgi_dashboards/release_status/static/dashboard.css', self.dashboard.cache[0]) - - -class BackgroundRefreshTests(unittest.TestCase): - def test_refresh_continues_after_http_request_finishes(self): - page = dashboard.ReleaseDashboard() - page.branch_info = {'3.15': {}} - entered = threading.Event() - release = threading.Event() - threads = [] - real_thread = threading.Thread - - def make_thread(**kwargs): - thread = real_thread(**kwargs) - threads.append(thread) - return thread - - def render(stylesheet_url): - entered.set() - if not release.wait(5): - raise RuntimeError('Refresh did not receive release event') - return 'ready' - - try: - with mock.patch.object(dashboard.threading, 'Thread', side_effect=make_thread), \ - mock.patch.object(page, '_refresh_branch_info'), \ - mock.patch.object(page, 'get_release_status', side_effect=render): - client = page.flask_app.test_client() - self.assertEqual(client.get('/').status_code, 503) - self.assertTrue(entered.wait(5)) - self.assertEqual(client.get('/').status_code, 503) - self.assertEqual(len(threads), 1) - release.set() - threads[0].join(5) - self.assertFalse(threads[0].is_alive()) - self.assertEqual(client.get('/').data, b'ready') - finally: - release.set() - for thread in threads: - thread.join(5)