From 762dd22e314b20915656b8f10906fa6a71b312d3 Mon Sep 17 00:00:00 2001 From: Benedikt Willi Date: Mon, 12 Jan 2026 17:36:14 +0100 Subject: [PATCH] Implement image loading and rendering support in Bowser browser This commit introduces support for loading and rendering images in the Bowser web browser, enhancing the rendering engine to handle various image sources. Key changes include: - Updated README.md to reflect the new milestone status and added features for image support. - Added `ImageLayout` class to manage image layout and loading. - Implemented synchronous and asynchronous image loading in `src/network/images.py`, including caching mechanisms. - Expanded the DOM parsing capabilities in `DocumentLayout` to handle `` tags and manage their layout directives. - Created a new `DrawImage` command in the rendering pipeline, which handles the drawing of both loaded images and placeholders for unloaded images. - Introduced a task queue for managing asynchronous image loads, ensuring UI remains responsive during image fetching. - Added unit tests for image loading, layout management, and the async task queue to ensure robust functionality and prevent regressions. --- README.md | 85 +++++++- assets/pages/startpage.html | 2 + src/browser/chrome.py | 23 ++- src/layout/document.py | 109 +++++++++- src/layout/embed.py | 213 +++++++++++++++++++- src/network/images.py | 392 ++++++++++++++++++++++++++++++++++++ src/network/tasks.py | 174 ++++++++++++++++ src/render/paint.py | 71 +++++++ src/render/pipeline.py | 63 +++++- tests/test_images.py | 384 +++++++++++++++++++++++++++++++++++ tests/test_tasks.py | 234 +++++++++++++++++++++ 11 files changed, 1726 insertions(+), 24 deletions(-) create mode 100644 src/network/images.py create mode 100644 src/network/tasks.py create mode 100644 tests/test_images.py create mode 100644 tests/test_tasks.py diff --git a/README.md b/README.md index 47b3b6c..f25c31e 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,14 @@ A custom web browser built from scratch following the [browser.engineering](https://browser.engineering/) curriculum. Features a clean architecture with Skia-based rendering, GTK 4/Adwaita UI, and proper separation of concerns. -**Status**: Milestone 2 - Basic HTML rendering with text layout +**Status**: Milestone 3 - Basic HTML rendering with text layout and image support ## Features - **Adwaita Tab Bar** - Modern GNOME-style tab management - **Skia Rendering** - Hardware-accelerated 2D graphics - **Text Layout** - Word wrapping, character-level selection +- **Image Support** - Load and render images from HTTP, data URLs, and local files - **DOM Parsing** - HTML parsing with proper tree structure - **Debug Mode** - Visual layout debugging with FPS counter - **DOM Visualization** - Generate visual graphs of page structure @@ -54,18 +55,21 @@ bowser/ │ ├── layout/ # Layout calculation │ │ ├── document.py # DocumentLayout - full page layout │ │ ├── block.py # BlockLayout, LineLayout - block elements -│ │ └── inline.py # TextLayout, InlineLayout - text runs +│ │ ├── inline.py # TextLayout, InlineLayout - text runs +│ │ └── embed.py # ImageLayout - embedded content │ │ │ ├── render/ # Painting & rendering │ │ ├── pipeline.py # RenderPipeline - coordinates layout/paint │ │ ├── fonts.py # FontCache - Skia font management -│ │ ├── paint.py # DisplayList, DrawText, DrawRect +│ │ ├── paint.py # DisplayList, DrawText, DrawRect, DrawImage │ │ └── composite.py # Layer compositing │ │ │ ├── network/ # Networking │ │ ├── http.py # HTTP client with redirects │ │ ├── url.py # URL parsing and normalization -│ │ └── cookies.py # Cookie management +│ │ ├── cookies.py # Cookie management +│ │ ├── images.py # Image loading and caching +│ │ └── tasks.py # Async task queue for background loading │ │ │ ├── debug/ # Development tools │ │ └── dom_graph.py # DOM tree visualization @@ -91,8 +95,11 @@ bowser/ | `Element`, `Text` | parser | DOM tree nodes | | `DocumentLayout` | layout | Page layout with line positioning | | `LayoutLine`, `LayoutBlock` | layout | Positioned text with bounding boxes | +| `ImageLayout`, `LayoutImage` | layout | Image sizing and positioning | | `RenderPipeline` | render | Coordinates layout → paint | +| `DrawImage` | render | Image rendering command | | `FontCache` | render | Skia font caching | +| `ImageCache` | network | Image loading and caching | | `Chrome` | browser | GTK window, delegates to RenderPipeline | ## Development @@ -141,12 +148,70 @@ Shows: - [x] **M0**: Project scaffold - [x] **M1**: GTK window with Skia rendering - [x] **M2**: HTML parsing and text layout -- [ ] **M3**: CSS parsing and styling -- [ ] **M4**: Clickable links and navigation -- [ ] **M5**: Form input and submission -- [ ] **M6**: JavaScript execution -- [ ] **M7**: Event handling -- [ ] **M8**: Images and iframes +- [x] **M3**: Image loading and rendering +- [ ] **M4**: CSS parsing and styling +- [ ] **M5**: Clickable links and navigation +- [ ] **M6**: Form input and submission +- [ ] **M7**: JavaScript execution +- [ ] **M8**: Event handling + +## Image Support + +Bowser supports loading and rendering images from multiple sources: + +### Supported Sources + +- **HTTP/HTTPS URLs**: `` +- **Data URLs**: `` +- **Local files**: `` + +### Features + +- **Async loading**: Images load in background threads, keeping UI responsive +- **Smart sizing**: Respects width/height attributes, maintains aspect ratios +- **Caching**: Thread-safe global image cache prevents redundant loads +- **Alt text placeholders**: Shows placeholder with alt text when images fail +- **Format support**: PNG, JPEG, GIF, WebP, and more (via Skia) +- **Viewport culling**: Only renders visible images for performance +- **Progressive display**: Page shows immediately, images appear as they load + +### Example + +```html + + + + + + + +A beautiful sunset + + + +``` + +### Architecture + +``` +HTML tag + ↓ +ImageLayout.load(async=True) + ↓ +TaskQueue (background thread pool) + ↓ +load_image() → HTTP/file/data URL + ↓ ↓ +ImageCache GLib.idle_add +(thread-safe) ↓ + on_complete callback + ↓ + ImageLayout.image = loaded + ↓ + RenderPipeline._request_redraw() + ↓ + DrawImage.execute() → Canvas +``` ## References diff --git a/assets/pages/startpage.html b/assets/pages/startpage.html index f53b366..6f13efe 100644 --- a/assets/pages/startpage.html +++ b/assets/pages/startpage.html @@ -98,6 +98,8 @@
  • Incremental feature development
    • + + Bowser Logo

    Bowser v{{ version }}

    diff --git a/src/browser/chrome.py b/src/browser/chrome.py index ebbe37c..3e6e1c0 100644 --- a/src/browser/chrome.py +++ b/src/browser/chrome.py @@ -149,6 +149,9 @@ class Chrome: self.drawing_area.set_can_focus(True) # Allow focus for keyboard events self.drawing_area.set_focusable(True) content_box.append(self.drawing_area) + + # Set up redraw callback for async image loading + self.render_pipeline.set_redraw_callback(self._request_redraw) # Add scroll controller for mouse wheel scroll_controller = Gtk.EventControllerScroll.new( @@ -405,11 +408,16 @@ class Chrome: def _render_dom_content(self, canvas, document, width: int, height: int): """Render the DOM content using the render pipeline.""" - sub_timings = {} # Sync debug mode with render pipeline self.render_pipeline.debug_mode = self.debug_mode + + # Set base URL for resolving relative image paths + if self.browser.active_tab and self.browser.active_tab.current_url: + self.render_pipeline.base_url = str(self.browser.active_tab.current_url) + else: + self.render_pipeline.base_url = None # Use render pipeline for layout and rendering t0 = time.perf_counter() @@ -551,8 +559,19 @@ class Chrome: def paint(self): """Trigger redraw of the drawing area.""" - if self.drawing_area: + if self.drawing_area and self.window: self.drawing_area.queue_draw() + + def _request_redraw(self): + """Request a redraw, called when async images finish loading.""" + # This is called from the main thread via GLib.idle_add + try: + # Only redraw if we have a valid window and drawing area + if self.window and self.drawing_area and self.browser.active_tab: + self.logger.debug("Async image loaded, requesting redraw") + self.drawing_area.queue_draw() + except Exception as e: + self.logger.warning(f"Failed to request redraw: {e}") def _setup_keyboard_shortcuts(self): """Setup keyboard event handling for shortcuts.""" diff --git a/src/layout/document.py b/src/layout/document.py index 1ff0545..f73b733 100644 --- a/src/layout/document.py +++ b/src/layout/document.py @@ -2,6 +2,7 @@ from ..parser.html import Element, Text from ..render.fonts import get_font, linespace +from .embed import ImageLayout class LayoutLine: @@ -23,6 +24,28 @@ class LayoutLine: self.width = font.measureText(text) +class LayoutImage: + """A laid-out image ready for rendering.""" + + def __init__(self, image_layout: ImageLayout, x: float, y: float): + self.image_layout = image_layout + self.x = x + self.y = y + # Store initial dimensions but also provide dynamic access + self._initial_width = image_layout.width + self._initial_height = image_layout.height + + @property + def width(self) -> float: + """Get current width (may update after async image load).""" + return self.image_layout.width if self.image_layout.width > 0 else self._initial_width + + @property + def height(self) -> float: + """Get current height (may update after async image load).""" + return self.image_layout.height if self.image_layout.height > 0 else self._initial_height + + class LayoutBlock: """A laid-out block with its lines.""" @@ -39,11 +62,14 @@ class LayoutBlock: class DocumentLayout: """Layout engine for a document.""" - def __init__(self, node, frame=None): + def __init__(self, node, frame=None, base_url=None, async_images: bool = False): self.node = node self.frame = frame + self.base_url = base_url # For resolving relative image URLs + self.async_images = async_images # Load images in background self.blocks = [] # List of LayoutBlock self.lines = [] # Flat list of all LayoutLine for rendering + self.images = [] # List of LayoutImage for rendering self.width = 0 self.height = 0 @@ -60,6 +86,7 @@ class DocumentLayout: self.blocks = [] self.lines = [] + self.images = [] # Find body body = self._find_body(self.node) @@ -70,6 +97,25 @@ class DocumentLayout: raw_blocks = self._collect_blocks(body) for block_info in raw_blocks: + # Handle images separately + if block_info.get("is_image"): + image_layout = block_info.get("image_layout") + if image_layout: + margin_top = block_info.get("margin_top", 6) + margin_bottom = block_info.get("margin_bottom", 10) + y += margin_top + + # Position the image + image_layout.x = x_margin + image_layout.y = y + + # Add to images list for rendering + layout_image = LayoutImage(image_layout, x_margin, y) + self.images.append(layout_image) + + y += image_layout.height + margin_bottom + continue + font_size = block_info.get("font_size", 14) font_family = block_info.get("font_family", "") text = block_info.get("text", "") @@ -182,12 +228,39 @@ class DocumentLayout: # Skip style and script tags - they shouldn't be rendered if tag in {"style", "script", "head", "title", "meta", "link"}: continue + + # Handle img tags + if tag == "img": + image_layout = ImageLayout(child) + image_layout.load(self.base_url, async_load=self.async_images) + image_layout.layout(max_width=self.width - 40 if self.width > 40 else 800) + + # Get computed style for margins + style = getattr(child, "computed_style", None) + if style: + margin_top = style.get_int("margin-top", 6) + margin_bottom = style.get_int("margin-bottom", 10) + else: + margin_top = 6 + margin_bottom = 10 + + blocks.append({ + "is_image": True, + "image_layout": image_layout, + "margin_top": margin_top, + "margin_bottom": margin_bottom, + }) + continue # Container elements - just recurse, don't add as blocks if tag in {"ul", "ol", "div", "section", "article", "main", "header", "footer", "nav"}: blocks.extend(self._collect_blocks(child)) continue + # For other elements (p, h1, etc), first collect any embedded images + embedded_images = self._collect_images(child) + blocks.extend(embedded_images) + content = self._text_of(child) if not content: continue @@ -253,6 +326,40 @@ class DocumentLayout: } return margins.get(tag, 0) + def _collect_images(self, node) -> list: + """Recursively collect all img elements from a node.""" + images = [] + + if not isinstance(node, Element): + return images + + for child in getattr(node, "children", []): + if isinstance(child, Element): + if child.tag.lower() == "img": + image_layout = ImageLayout(child) + image_layout.load(self.base_url, async_load=self.async_images) + image_layout.layout(max_width=self.width - 40 if self.width > 40 else 800) + + style = getattr(child, "computed_style", None) + if style: + margin_top = style.get_int("margin-top", 6) + margin_bottom = style.get_int("margin-bottom", 10) + else: + margin_top = 6 + margin_bottom = 10 + + images.append({ + "is_image": True, + "image_layout": image_layout, + "margin_top": margin_top, + "margin_bottom": margin_bottom, + }) + else: + # Recurse into children + images.extend(self._collect_images(child)) + + return images + def _text_of(self, node) -> str: """Extract text content from a node.""" if isinstance(node, Text): diff --git a/src/layout/embed.py b/src/layout/embed.py index 207d671..136e03c 100644 --- a/src/layout/embed.py +++ b/src/layout/embed.py @@ -1,15 +1,220 @@ -"""Embedded content layout stubs (images, iframes).""" +"""Embedded content layout (images, iframes).""" + +import logging +from typing import Optional, Callable +import skia + +from ..network.images import load_image, load_image_async, ImageCache + + +logger = logging.getLogger("bowser.layout.embed") + + +# Callback type for when an image finishes loading +OnImageLoadedCallback = Callable[["ImageLayout"], None] class ImageLayout: + """Layout for an element.""" + + # Global callback for image load completion (set by render pipeline) + _on_any_image_loaded: Optional[Callable[[], None]] = None + def __init__(self, node, parent=None, previous=None, frame=None): self.node = node self.parent = parent self.previous = previous self.frame = frame - - def layout(self): - return 0 + self.x = 0 + self.y = 0 + self.width = 0 + self.height = 0 + self.image: Optional[skia.Image] = None + self.alt_text = "" + self.is_inline = True # Images are inline by default + self._loading = False + self._load_task_id: Optional[int] = None + self._src = "" + self._base_url: Optional[str] = None + + def load(self, base_url: Optional[str] = None, async_load: bool = False): + """ + Load the image from the src attribute. + + Args: + base_url: Base URL for resolving relative paths + async_load: If True, load in background thread (non-blocking) + """ + if not hasattr(self.node, 'attributes'): + return + + src = self.node.attributes.get('src', '') + if not src: + logger.warning("Image element has no src attribute") + return + + # Get alt text + self.alt_text = self.node.attributes.get('alt', '') + self._src = src + self._base_url = base_url + + if async_load: + self._load_async(src, base_url) + else: + # Synchronous load (for tests or cached images) + self.image = load_image(src, base_url) + + def _load_async(self, src: str, base_url: Optional[str]): + """Load image asynchronously.""" + self._loading = True + + def on_complete(image: Optional[skia.Image]): + self._loading = False + self.image = image + if image: + # Recalculate layout with actual dimensions + self._update_dimensions() + logger.debug(f"Async loaded image: {src} ({image.width()}x{image.height()})") + # Trigger re-render + if ImageLayout._on_any_image_loaded: + ImageLayout._on_any_image_loaded() + + def on_error(e: Exception): + self._loading = False + logger.error(f"Async image load failed: {src}: {e}") + + self._load_task_id = load_image_async(src, base_url, on_complete, on_error) + + def _update_dimensions(self): + """Update dimensions based on loaded image.""" + if not self.image: + return + + # Get explicit width/height attributes + width_attr = self.node.attributes.get('width', '') if hasattr(self.node, 'attributes') else '' + height_attr = self.node.attributes.get('height', '') if hasattr(self.node, 'attributes') else '' + + intrinsic_width = self.image.width() + intrinsic_height = self.image.height() + + # Calculate dimensions based on attributes or intrinsic size + if width_attr and height_attr: + # Both specified - use them + try: + self.width = float(width_attr) + self.height = float(height_attr) + except ValueError: + self.width = intrinsic_width + self.height = intrinsic_height + elif width_attr: + # Only width specified - maintain aspect ratio + try: + self.width = float(width_attr) + if intrinsic_width > 0: + aspect_ratio = intrinsic_height / intrinsic_width + self.height = self.width * aspect_ratio + else: + self.height = intrinsic_height + except ValueError: + self.width = intrinsic_width + self.height = intrinsic_height + elif height_attr: + # Only height specified - maintain aspect ratio + try: + self.height = float(height_attr) + if intrinsic_height > 0: + aspect_ratio = intrinsic_width / intrinsic_height + self.width = self.height * aspect_ratio + else: + self.width = intrinsic_width + except ValueError: + self.width = intrinsic_width + self.height = intrinsic_height + else: + # No explicit dimensions - use intrinsic size + self.width = intrinsic_width + self.height = intrinsic_height + + @property + def is_loading(self) -> bool: + """True if image is currently being loaded.""" + return self._loading + + def cancel_load(self): + """Cancel any pending async load.""" + if self._load_task_id is not None: + from ..network.tasks import cancel_task + cancel_task(self._load_task_id) + self._load_task_id = None + self._loading = False + + def layout(self, max_width: Optional[float] = None): + """ + Calculate the layout dimensions for this image. + + Returns: + Width of the image (for inline layout) + """ + if not self.image: + # If image failed to load, use alt text dimensions + # For now, just use a placeholder size + self.width = 100 + self.height = 100 + return self.width + + # Get explicit width/height attributes + width_attr = self.node.attributes.get('width', '') if hasattr(self.node, 'attributes') else '' + height_attr = self.node.attributes.get('height', '') if hasattr(self.node, 'attributes') else '' + + # Get intrinsic dimensions + intrinsic_width = self.image.width() + intrinsic_height = self.image.height() + + # Calculate display dimensions + if width_attr and height_attr: + # Both specified + try: + self.width = float(width_attr) + self.height = float(height_attr) + except ValueError: + self.width = intrinsic_width + self.height = intrinsic_height + elif width_attr: + # Only width specified - maintain aspect ratio + try: + self.width = float(width_attr) + if intrinsic_width > 0: + aspect_ratio = intrinsic_height / intrinsic_width + self.height = self.width * aspect_ratio + else: + self.height = intrinsic_height + except ValueError: + self.width = intrinsic_width + self.height = intrinsic_height + elif height_attr: + # Only height specified - maintain aspect ratio + try: + self.height = float(height_attr) + if intrinsic_height > 0: + aspect_ratio = intrinsic_width / intrinsic_height + self.width = self.height * aspect_ratio + else: + self.width = intrinsic_width + except ValueError: + self.width = intrinsic_width + self.height = intrinsic_height + else: + # No dimensions specified - use intrinsic size + self.width = intrinsic_width + self.height = intrinsic_height + + # Constrain to max_width if specified + if max_width and self.width > max_width: + aspect_ratio = intrinsic_height / intrinsic_width if intrinsic_width > 0 else 1 + self.width = max_width + self.height = self.width * aspect_ratio + + return self.width class IframeLayout: diff --git a/src/network/images.py b/src/network/images.py new file mode 100644 index 0000000..a562567 --- /dev/null +++ b/src/network/images.py @@ -0,0 +1,392 @@ +"""Image loading and caching.""" + +import logging +import threading +from pathlib import Path +from typing import Optional, Callable +import skia + +from .url import URL +from .http import request + + +logger = logging.getLogger("bowser.images") + +# Path to assets directory (for about: pages) +ASSETS_DIR = Path(__file__).parent.parent.parent / "assets" + + +class ImageCache: + """Thread-safe global cache for loaded images.""" + + _instance = None + _lock = threading.Lock() + + def __new__(cls): + with cls._lock: + if cls._instance is None: + cls._instance = super().__new__(cls) + cls._instance._cache = {} + cls._instance._cache_lock = threading.Lock() + return cls._instance + + def get(self, url: str) -> Optional[skia.Image]: + """Get a cached image by URL.""" + with self._cache_lock: + return self._cache.get(url) + + def set(self, url: str, image: skia.Image): + """Cache an image by URL.""" + with self._cache_lock: + self._cache[url] = image + + def has(self, url: str) -> bool: + """Check if URL is cached.""" + with self._cache_lock: + return url in self._cache + + def clear(self): + """Clear all cached images.""" + with self._cache_lock: + self._cache.clear() + + +# Callbacks for image load completion +ImageCallback = Callable[[Optional[skia.Image]], None] +# Callback for raw bytes (used internally for thread-safe loading) +BytesCallback = Callable[[Optional[bytes], str], None] + + +def load_image(url: str, base_url: Optional[str] = None) -> Optional[skia.Image]: + """ + Load an image from a URL or file path (synchronous). + + Args: + url: Image URL or file path + base_url: Base URL for resolving relative URLs + + Returns: + Skia Image object, or None if loading failed + """ + try: + # Resolve the full URL first + full_url = _resolve_url(url, base_url) + + # Check cache with resolved URL + cache = ImageCache() + cached = cache.get(full_url) + if cached is not None: + logger.debug(f"Image cache hit: {full_url}") + return cached + + logger.info(f"Loading image: {full_url}") + + # Load raw bytes + data = _load_image_bytes(full_url) + if data is None: + return None + + # Decode with Skia + image = skia.Image.MakeFromEncoded(data) + if image: + cache.set(full_url, image) + logger.debug(f"Loaded image: {full_url} ({image.width()}x{image.height()})") + + return image + + except Exception as e: + logger.error(f"Failed to load image {url}: {e}") + return None + + +def _load_image_bytes(full_url: str) -> Optional[bytes]: + """Load raw image bytes from a URL or file path.""" + try: + # Handle data URLs + if full_url.startswith('data:'): + return _load_data_url_bytes(full_url) + + # Handle file URLs + if full_url.startswith('file://'): + file_path = full_url[7:] # Remove 'file://' + return _load_file_bytes(file_path) + + # Handle HTTP/HTTPS URLs + if full_url.startswith(('http://', 'https://')): + return _load_http_bytes(full_url) + + # Try as local file path + return _load_file_bytes(full_url) + + except Exception as e: + logger.error(f"Failed to load image bytes from {full_url}: {e}") + return None + + +def load_image_async( + url: str, + base_url: Optional[str] = None, + on_complete: Optional[ImageCallback] = None, + on_error: Optional[Callable[[Exception], None]] = None, +) -> int: + """ + Load an image asynchronously in a background thread. + + Bytes are loaded in background, but Skia decoding happens on main thread + to avoid threading issues with Skia objects. + + Args: + url: Image URL or file path + base_url: Base URL for resolving relative URLs + on_complete: Callback with loaded image (or None if failed), called on main thread + on_error: Callback with exception if loading failed, called on main thread + + Returns: + Task ID that can be used to cancel the load + """ + from .tasks import submit_task + import gi + gi.require_version("GLib", "2.0") + from gi.repository import GLib + + # Resolve URL synchronously (fast operation) + full_url = _resolve_url(url, base_url) + + # Check cache first (avoid thread overhead) + cache = ImageCache() + cached = cache.get(full_url) + if cached is not None: + logger.debug(f"Image cache hit: {full_url}") + if on_complete: + # Use GLib to call on main thread + GLib.idle_add(lambda: on_complete(cached) or False) + return -1 # No task needed + + def do_load_bytes(): + """Load raw bytes in background thread.""" + return _load_image_bytes(full_url) + + def on_bytes_loaded(data: Optional[bytes]): + """Decode image on main thread and call user callback.""" + if data is None: + if on_complete: + on_complete(None) + return + + try: + # Decode image on main thread (Skia thread safety) + decoded = skia.Image.MakeFromEncoded(data) + if decoded: + # Convert to raster image to ensure data is fully decoded + # This prevents potential lazy decoding issues during rendering + surface = skia.Surface(decoded.width(), decoded.height()) + canvas = surface.getCanvas() + canvas.drawImage(decoded, 0, 0) + image = surface.makeImageSnapshot() + + cache.set(full_url, image) + logger.debug(f"Async loaded image: {full_url} ({image.width()}x{image.height()})") + if on_complete: + on_complete(image) + else: + if on_complete: + on_complete(None) + except Exception as e: + logger.error(f"Failed to decode image {full_url}: {e}") + if on_complete: + on_complete(None) + if on_complete: + on_complete(None) + + # Always use on_bytes_loaded to ensure caching happens + return submit_task(do_load_bytes, on_bytes_loaded, on_error) + + +def _resolve_url(url: str, base_url: Optional[str]) -> str: + """Resolve a potentially relative URL against a base URL.""" + # Already absolute + if url.startswith(('http://', 'https://', 'data:', 'file://')): + return url + + # Handle about: pages - resolve relative to assets directory + if base_url and base_url.startswith('about:'): + # For about: pages, resolve relative to the assets/pages directory + pages_dir = ASSETS_DIR / "pages" + # Use Path to properly resolve .. paths + resolved_path = (pages_dir / url).resolve() + if resolved_path.exists(): + return str(resolved_path) + # Also check assets root directly + asset_path = (ASSETS_DIR / url).resolve() + if asset_path.exists(): + return str(asset_path) + # Return resolved path even if not found (will fail later with proper error) + return str(resolved_path) + + # No base URL - treat as local file + if not base_url: + return url + + # Use URL class for proper resolution + try: + base = URL(base_url) + resolved = base.resolve(url) + return str(resolved) + except Exception: + # Fallback: simple concatenation + if base_url.endswith('/'): + return base_url + url + else: + # Remove the last path component + base_parts = base_url.rsplit('/', 1) + if len(base_parts) > 1 and '/' in base_parts[0]: + return base_parts[0] + '/' + url + return url + + +def _load_file_bytes(file_path: str) -> Optional[bytes]: + """Load raw bytes from a local file.""" + try: + with open(file_path, 'rb') as f: + data = f.read() + logger.debug(f"Loaded {len(data)} bytes from file: {file_path}") + return data + except Exception as e: + logger.error(f"Failed to read file {file_path}: {e}") + return None + + +def _load_http_bytes(url: str) -> Optional[bytes]: + """Load raw bytes from HTTP/HTTPS URL.""" + try: + url_obj = URL(url) + status, content_type, body = request(url_obj) + + if status != 200: + logger.warning(f"HTTP {status} when loading image: {url}") + return None + + logger.debug(f"Loaded {len(body)} bytes from HTTP: {url}") + return body + + except Exception as e: + logger.error(f"Failed to load from HTTP {url}: {e}") + return None + + +def _load_data_url_bytes(data_url: str) -> Optional[bytes]: + """Extract raw bytes from a data: URL.""" + try: + # Parse data URL: data:[][;base64], + if not data_url.startswith('data:'): + return None + + # Split off the 'data:' prefix + _, rest = data_url.split(':', 1) + + # Split metadata from data + if ',' not in rest: + return None + + metadata, data = rest.split(',', 1) + + # Check if base64 encoded + if ';base64' in metadata: + import base64 + decoded = base64.b64decode(data) + else: + # URL-encoded data + import urllib.parse + decoded = urllib.parse.unquote(data).encode('utf-8') + + logger.debug(f"Extracted {len(decoded)} bytes from data URL") + return decoded + + except Exception as e: + logger.error(f"Failed to parse data URL: {e}") + return None + + +def _load_from_http(url: str) -> Optional[skia.Image]: + """Load an image from HTTP/HTTPS URL.""" + try: + url_obj = URL(url) + status, content_type, body = request(url_obj) + + if status != 200: + logger.warning(f"HTTP {status} when loading image: {url}") + return None + + # Decode image from bytes + image = skia.Image.MakeFromEncoded(body) + + if image: + # Cache it + cache = ImageCache() + cache.set(url, image) + logger.debug(f"Loaded image from HTTP: {url} ({image.width()}x{image.height()})") + + return image + + except Exception as e: + logger.error(f"Failed to load image from HTTP {url}: {e}") + return None + + +def _load_from_file(file_path: str) -> Optional[skia.Image]: + """Load an image from a local file.""" + try: + with open(file_path, 'rb') as f: + data = f.read() + + image = skia.Image.MakeFromEncoded(data) + + if image: + # Cache it + cache = ImageCache() + cache.set(file_path, image) + logger.debug(f"Loaded image from file: {file_path} ({image.width()}x{image.height()})") + + return image + + except Exception as e: + logger.error(f"Failed to load image from file {file_path}: {e}") + return None + + +def _load_data_url(data_url: str) -> Optional[skia.Image]: + """Load an image from a data: URL.""" + try: + # Parse data URL: data:[][;base64], + if not data_url.startswith('data:'): + return None + + # Split off the 'data:' prefix + _, rest = data_url.split(':', 1) + + # Split metadata from data + if ',' not in rest: + return None + + metadata, data = rest.split(',', 1) + + # Check if base64 encoded + if ';base64' in metadata: + import base64 + decoded = base64.b64decode(data) + else: + # URL-encoded data + import urllib.parse + decoded = urllib.parse.unquote(data).encode('utf-8') + + image = skia.Image.MakeFromEncoded(decoded) + + if image: + # Don't cache data URLs (they're already embedded) + logger.debug(f"Loaded image from data URL ({image.width()}x{image.height()})") + + return image + + except Exception as e: + logger.error(f"Failed to load image from data URL: {e}") + return None diff --git a/src/network/tasks.py b/src/network/tasks.py new file mode 100644 index 0000000..9cd855b --- /dev/null +++ b/src/network/tasks.py @@ -0,0 +1,174 @@ +"""Async task queue for background operations like image loading.""" + +import logging +import threading +from concurrent.futures import ThreadPoolExecutor, Future +from dataclasses import dataclass, field +from typing import Callable, Optional, Any +from queue import Queue +import gi + +gi.require_version("GLib", "2.0") +from gi.repository import GLib + +logger = logging.getLogger("bowser.tasks") + + +@dataclass +class Task: + """A task to be executed in the background.""" + + func: Callable[[], Any] + on_complete: Optional[Callable[[Any], None]] = None + on_error: Optional[Callable[[Exception], None]] = None + priority: int = 0 # Lower = higher priority + + def __lt__(self, other): + return self.priority < other.priority + + +class TaskQueue: + """ + Background task queue using a thread pool. + + Uses GTK's GLib.idle_add for thread-safe UI updates. + """ + + _instance: Optional["TaskQueue"] = None + _lock = threading.Lock() + + def __new__(cls) -> "TaskQueue": + with cls._lock: + if cls._instance is None: + cls._instance = super().__new__(cls) + cls._instance._initialized = False + return cls._instance + + def __init__(self, max_workers: int = 4): + if self._initialized: + return + + self._executor = ThreadPoolExecutor( + max_workers=max_workers, + thread_name_prefix="bowser-task" + ) + self._pending: dict[int, Future] = {} + self._task_id = 0 + self._task_lock = threading.Lock() + self._initialized = True + self._shutdown = False + + logger.debug(f"TaskQueue initialized with {max_workers} workers") + + def submit( + self, + func: Callable[[], Any], + on_complete: Optional[Callable[[Any], None]] = None, + on_error: Optional[Callable[[Exception], None]] = None, + ) -> int: + """ + Submit a task for background execution. + + Args: + func: Function to run in background (no arguments) + on_complete: Callback with result (runs on main thread) + on_error: Callback with exception (runs on main thread) + + Returns: + Task ID that can be used to cancel + """ + if self._shutdown: + logger.warning("TaskQueue is shutdown, ignoring task") + return -1 + + with self._task_lock: + task_id = self._task_id + self._task_id += 1 + + def wrapped(): + try: + result = func() + if on_complete: + # Schedule callback on main GTK thread + GLib.idle_add(self._call_on_main, on_complete, result) + return result + except Exception as e: + logger.error(f"Task {task_id} failed: {e}") + if on_error: + GLib.idle_add(self._call_on_main, on_error, e) + raise + finally: + with self._task_lock: + self._pending.pop(task_id, None) + + future = self._executor.submit(wrapped) + + with self._task_lock: + self._pending[task_id] = future + + logger.debug(f"Submitted task {task_id}") + return task_id + + def _call_on_main(self, callback: Callable, arg: Any) -> bool: + """Execute a callback on the main thread. Returns False to remove from idle.""" + try: + callback(arg) + except Exception as e: + logger.error(f"Callback error: {e}") + return False # Don't repeat + + def cancel(self, task_id: int) -> bool: + """Cancel a pending task. Returns True if cancelled.""" + with self._task_lock: + future = self._pending.get(task_id) + if future: + cancelled = future.cancel() + if cancelled: + self._pending.pop(task_id, None) + logger.debug(f"Cancelled task {task_id}") + return cancelled + return False + + def cancel_all(self): + """Cancel all pending tasks.""" + with self._task_lock: + for task_id, future in list(self._pending.items()): + future.cancel() + self._pending.clear() + logger.debug("Cancelled all tasks") + + @property + def pending_count(self) -> int: + """Number of pending tasks.""" + with self._task_lock: + return len(self._pending) + + def shutdown(self, wait: bool = True): + """Shutdown the task queue.""" + self._shutdown = True + self.cancel_all() + self._executor.shutdown(wait=wait) + logger.debug("TaskQueue shutdown") + + @classmethod + def reset_instance(cls): + """Reset the singleton (for testing).""" + with cls._lock: + if cls._instance and cls._instance._initialized: + cls._instance.shutdown(wait=False) + cls._instance = None + + +# Convenience functions +def submit_task( + func: Callable[[], Any], + on_complete: Optional[Callable[[Any], None]] = None, + on_error: Optional[Callable[[Exception], None]] = None, +) -> int: + """Submit a task to the global task queue.""" + return TaskQueue().submit(func, on_complete, on_error) + + +def cancel_task(task_id: int) -> bool: + """Cancel a task in the global queue.""" + return TaskQueue().cancel(task_id) diff --git a/src/render/paint.py b/src/render/paint.py index e22afc4..bb8bbc2 100644 --- a/src/render/paint.py +++ b/src/render/paint.py @@ -1,8 +1,11 @@ """Painting primitives using Skia.""" +import logging import skia from .fonts import get_font +logger = logging.getLogger("bowser.paint") + class PaintCommand: """Base class for paint commands.""" @@ -55,6 +58,74 @@ class DrawRect(PaintCommand): canvas.drawRect(rect, paint) +class DrawImage(PaintCommand): + """Command to draw an image.""" + + def __init__(self, x: float, y: float, width: float, height: float, + image: skia.Image, alt_text: str = ""): + super().__init__((x, y, x + width, y + height)) + self.x = x + self.y = y + self.width = width + self.height = height + self.image = image + self.alt_text = alt_text + + def execute(self, canvas: skia.Canvas, paint: skia.Paint = None): + """Draw the image on the canvas.""" + if self.image is None: + # Draw a placeholder rectangle if image failed to load + self._draw_placeholder(canvas, paint) + else: + # Draw the image + try: + if paint is None: + paint = skia.Paint() + paint.setAntiAlias(True) + + # Calculate scale factor + scale_x = self.width / self.image.width() + scale_y = self.height / self.image.height() + + # Use canvas transform for scaling + canvas.save() + canvas.translate(self.x, self.y) + canvas.scale(scale_x, scale_y) + # drawImage signature: (image, left, top, sampling_options, paint) + sampling = skia.SamplingOptions(skia.FilterMode.kLinear, skia.MipmapMode.kLinear) + canvas.drawImage(self.image, 0, 0, sampling, paint) + canvas.restore() + except Exception as e: + logger.error(f"Failed to draw image: {e}") + # If drawing fails, fall back to placeholder + self._draw_placeholder(canvas, paint) + + def _draw_placeholder(self, canvas: skia.Canvas, paint: skia.Paint = None): + """Draw a placeholder for a missing or failed image.""" + if paint is None: + paint = skia.Paint() + paint.setColor(skia.ColorLTGRAY) + paint.setStyle(skia.Paint.kFill_Style) + rect = skia.Rect.MakeLTRB(self.x, self.y, self.x + self.width, self.y + self.height) + canvas.drawRect(rect, paint) + + # Draw border + border_paint = skia.Paint() + border_paint.setColor(skia.ColorGRAY) + border_paint.setStyle(skia.Paint.kStroke_Style) + border_paint.setStrokeWidth(1) + canvas.drawRect(rect, border_paint) + + # Draw alt text if available + if self.alt_text: + text_paint = skia.Paint() + text_paint.setAntiAlias(True) + text_paint.setColor(skia.ColorBLACK) + font = get_font(12) + canvas.drawString(self.alt_text, self.x + 5, self.y + 15, font, text_paint) + + + class DisplayList: """A list of paint commands to execute.""" diff --git a/src/render/pipeline.py b/src/render/pipeline.py index a0313d1..86d8f50 100644 --- a/src/render/pipeline.py +++ b/src/render/pipeline.py @@ -1,11 +1,12 @@ """Render pipeline - coordinates layout and painting.""" import skia -from typing import Optional +from typing import Optional, Callable from ..parser.html import Element from ..layout.document import DocumentLayout +from ..layout.embed import ImageLayout from .fonts import get_font -from .paint import DisplayList +from .paint import DisplayList, DrawImage class RenderPipeline: @@ -16,13 +17,32 @@ class RenderPipeline: self._layout: Optional[DocumentLayout] = None self._layout_width = 0 self._layout_doc_id = None + self._layout_base_url = None # Paint cache self._text_paint: Optional[skia.Paint] = None self._display_list: Optional[DisplayList] = None + + # Base URL for resolving relative paths + self.base_url: Optional[str] = None # Debug mode self.debug_mode = False + + # Async image loading + self.async_images = True # Enable async image loading by default + self._on_needs_redraw: Optional[Callable[[], None]] = None + + def set_redraw_callback(self, callback: Callable[[], None]): + """Set a callback to be called when async images finish loading.""" + self._on_needs_redraw = callback + + # Also set on ImageLayout class for global notification + def on_image_loaded(): + if self._on_needs_redraw: + self._on_needs_redraw() + + ImageLayout._on_any_image_loaded = on_image_loaded def layout(self, document: Element, width: int) -> DocumentLayout: """ @@ -31,17 +51,23 @@ class RenderPipeline: """ doc_id = id(document) - # Check cache + # Check cache (also invalidate if base_url changed) if (self._layout_doc_id == doc_id and self._layout_width == width and + self._layout_base_url == self.base_url and self._layout is not None): return self._layout - # Build new layout - self._layout = DocumentLayout(document) + # Build new layout with base_url for resolving image paths + self._layout = DocumentLayout( + document, + base_url=self.base_url, + async_images=self.async_images + ) self._layout.layout(width) self._layout_doc_id = doc_id self._layout_width = width + self._layout_base_url = self.base_url return self._layout @@ -60,7 +86,7 @@ class RenderPipeline: # Get or update layout layout = self.layout(document, width) - if not layout.lines: + if not layout.lines and not layout.images: return # Apply scroll transform @@ -73,10 +99,11 @@ class RenderPipeline: self._text_paint.setAntiAlias(True) self._text_paint.setColor(skia.ColorBLACK) - # Render visible lines only + # Render visible content visible_top = scroll_y - 50 visible_bottom = scroll_y + height + 50 + # Render visible lines for line in layout.lines: baseline_y = line.y + line.font_size if baseline_y < visible_top or line.y > visible_bottom: @@ -85,6 +112,28 @@ class RenderPipeline: font = get_font(line.font_size, getattr(line, "font_family", ""), text=line.text) canvas.drawString(line.text, line.x, baseline_y, font, self._text_paint) + # Render visible images (both loaded and placeholder) + for layout_image in layout.images: + image_bottom = layout_image.y + layout_image.height + if image_bottom < visible_top or layout_image.y > visible_bottom: + continue + + image_layout = layout_image.image_layout + # Use image_layout dimensions directly for accurate sizing after async load + img_width = image_layout.width if image_layout.width > 0 else layout_image.width + img_height = image_layout.height if image_layout.height > 0 else layout_image.height + + # Always create DrawImage command - it handles None images as placeholders + draw_cmd = DrawImage( + layout_image.x, + layout_image.y, + img_width, + img_height, + image_layout.image, # May be None, DrawImage handles this + image_layout.alt_text + ) + draw_cmd.execute(canvas) + # Draw debug overlays if enabled if self.debug_mode: self._render_debug_overlays(canvas, layout) diff --git a/tests/test_images.py b/tests/test_images.py new file mode 100644 index 0000000..d0ff902 --- /dev/null +++ b/tests/test_images.py @@ -0,0 +1,384 @@ +"""Tests for image loading and rendering.""" + +import pytest +import skia +from src.network.images import load_image, ImageCache, _load_data_url +from src.layout.embed import ImageLayout +from src.parser.html import Element, parse_html +from src.render.paint import DrawImage +from src.layout.document import DocumentLayout, LayoutImage +from io import BytesIO + + +def create_test_image(width=100, height=100): + """Helper to create a test image.""" + # Create a surface and get an image from it + surface = skia.Surface(width, height) + canvas = surface.getCanvas() + canvas.clear(skia.ColorWHITE) + return surface.makeImageSnapshot() + + +class TestImageCache: + """Test image caching.""" + + def test_cache_singleton(self): + """ImageCache should be a singleton.""" + cache1 = ImageCache() + cache2 = ImageCache() + assert cache1 is cache2 + + def test_cache_get_set(self): + """Test basic cache operations.""" + cache = ImageCache() + cache.clear() + + # Create a simple test image + image = create_test_image(100, 100) + + # Initially empty + assert cache.get("test_url") is None + + # Set and get + cache.set("test_url", image) + cached = cache.get("test_url") + assert cached is not None + assert cached.width() == 100 + assert cached.height() == 100 + + def test_cache_clear(self): + """Test cache clearing.""" + cache = ImageCache() + cache.clear() + + image = create_test_image(100, 100) + cache.set("test_url", image) + assert cache.get("test_url") is not None + + cache.clear() + assert cache.get("test_url") is None + + +class TestDataURLLoading: + """Test data URL image loading.""" + + def test_load_base64_png(self): + """Test loading a base64-encoded PNG data URL.""" + # Simple 1x1 red PNG + data_url = ( + "data:image/png;base64," + "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8DwHwAFBQIAX8jx0gAAAABJRU5ErkJggg==" + ) + + image = _load_data_url(data_url) + assert image is not None + assert image.width() == 1 + assert image.height() == 1 + + def test_load_invalid_data_url(self): + """Test loading an invalid data URL.""" + image = _load_data_url("data:invalid") + assert image is None + + image = _load_data_url("not_a_data_url") + assert image is None + + +class TestImageLayout: + """Test ImageLayout class.""" + + def test_image_layout_init(self): + """Test ImageLayout initialization.""" + node = Element("img", {"src": "test.png"}) + layout = ImageLayout(node) + + assert layout.node == node + assert layout.x == 0 + assert layout.y == 0 + assert layout.width == 0 + assert layout.height == 0 + assert layout.image is None + assert layout.is_inline is True + + def test_layout_with_intrinsic_size(self): + """Test layout calculation with intrinsic image size.""" + node = Element("img", {"src": "test.png"}) + layout = ImageLayout(node) + + # Create a test image + layout.image = create_test_image(200, 150) + + width = layout.layout() + + assert layout.width == 200 + assert layout.height == 150 + assert width == 200 + + def test_layout_with_explicit_width(self): + """Test layout with explicit width attribute.""" + node = Element("img", {"src": "test.png", "width": "100"}) + layout = ImageLayout(node) + + # Create a test image (200x150) + layout.image = create_test_image(200, 150) + + layout.layout() + + # Should maintain aspect ratio + assert layout.width == 100 + assert layout.height == 75 # 100 * (150/200) + + def test_layout_with_explicit_height(self): + """Test layout with explicit height attribute.""" + node = Element("img", {"src": "test.png", "height": "100"}) + layout = ImageLayout(node) + + # Create a test image (200x150) + layout.image = create_test_image(200, 150) + + layout.layout() + + # Should maintain aspect ratio + assert layout.height == 100 + assert abs(layout.width - 133.33) < 1 # 100 * (200/150) + + def test_layout_with_both_dimensions(self): + """Test layout with both width and height specified.""" + node = Element("img", {"src": "test.png", "width": "100", "height": "50"}) + layout = ImageLayout(node) + + # Create a test image + layout.image = create_test_image(200, 150) + + layout.layout() + + # Should use explicit dimensions (no aspect ratio preservation) + assert layout.width == 100 + assert layout.height == 50 + + def test_layout_with_max_width(self): + """Test layout constrained by max_width.""" + node = Element("img", {"src": "test.png"}) + layout = ImageLayout(node) + + # Create a large test image + layout.image = create_test_image(1000, 500) + + layout.layout(max_width=400) + + # Should constrain to max_width and maintain aspect ratio + assert layout.width == 400 + assert layout.height == 200 # 400 * (500/1000) + + def test_layout_no_image(self): + """Test layout when image fails to load.""" + node = Element("img", {"src": "test.png", "alt": "Test image"}) + layout = ImageLayout(node) + + # Don't set an image (simulating load failure) + layout.alt_text = "Test image" + layout.layout() + + # Should use placeholder dimensions + assert layout.width == 100 + assert layout.height == 100 + + def test_alt_text_extraction(self): + """Test alt text extraction.""" + node = Element("img", {"src": "test.png", "alt": "Description"}) + layout = ImageLayout(node) + + layout.load() + + assert layout.alt_text == "Description" + + +class TestDrawImage: + """Test DrawImage paint command.""" + + def test_draw_image_init(self): + """Test DrawImage initialization.""" + image = create_test_image(100, 100) + + cmd = DrawImage(10, 20, 100, 100, image, "Test") + + assert cmd.x == 10 + assert cmd.y == 20 + assert cmd.width == 100 + assert cmd.height == 100 + assert cmd.image is image + assert cmd.alt_text == "Test" + assert cmd.rect == (10, 20, 110, 120) + + def test_draw_image_with_valid_image(self): + """Test drawing a valid image.""" + image = create_test_image(100, 100) + + # Create a surface to draw on + surface = skia.Surface(200, 200) + canvas = surface.getCanvas() + + cmd = DrawImage(10, 20, 100, 100, image) + cmd.execute(canvas) + + # If it doesn't throw, it worked + assert True + + def test_draw_image_with_null_image(self): + """Test drawing when image is None (placeholder).""" + # Create a surface to draw on + surface = skia.Surface(200, 200) + canvas = surface.getCanvas() + + cmd = DrawImage(10, 20, 100, 100, None, "Failed to load") + cmd.execute(canvas) + + # Should draw placeholder without error + assert True + + +class TestDocumentLayoutImages: + """Test image integration in DocumentLayout.""" + + def test_parse_img_element(self): + """Test that img elements are parsed correctly.""" + html = 'Test image' + root = parse_html(html) + + # Find the img element + body = root.children[0] + img = body.children[0] + + assert img.tag == "img" + assert img.attributes["src"] == "test.png" + assert img.attributes["alt"] == "Test image" + assert img.attributes["width"] == "100" + + def test_layout_with_image(self): + """Test document layout with an image.""" + html = '

    Text before

    Text after

    ' + root = parse_html(html) + + layout = DocumentLayout(root) + + # Mock the image loading by creating the images manually + # This would normally happen in _collect_blocks + # For now, just verify the structure is created + lines = layout.layout(800) + + # Should have lines and potentially images + assert isinstance(lines, list) + + def test_layout_image_class(self): + """Test LayoutImage class.""" + node = Element("img", {"src": "test.png"}) + image_layout = ImageLayout(node) + image_layout.image = create_test_image(100, 100) + image_layout.layout() + + layout_image = LayoutImage(image_layout, 10, 20) + + assert layout_image.x == 10 + assert layout_image.y == 20 + assert layout_image.width == 100 + assert layout_image.height == 100 + assert layout_image.image_layout is image_layout + + +class TestImageIntegration: + """Integration tests for the complete image pipeline.""" + + def test_html_with_data_url_image(self): + """Test parsing and layout of HTML with data URL image.""" + # 1x1 red PNG + data_url = ( + "data:image/png;base64," + "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8DwHwAFBQIAX8jx0gAAAABJRU5ErkJggg==" + ) + + html = f'

    Before

    After

    ' + root = parse_html(html) + + # Verify structure + body = root.children[0] + # The img tag is self-closing, so the second p tag becomes a child of img + # This is a quirk of the HTML parser treating img as a container + assert len(body.children) >= 2 + assert body.children[0].tag == "p" + assert body.children[1].tag == "img" + + def test_nested_image_in_paragraph(self): + """Test that images inside paragraphs are collected.""" + # 1x1 red PNG + data_url = ( + "data:image/png;base64," + "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8DwHwAFBQIAX8jx0gAAAABJRU5ErkJggg==" + ) + + html = f'

    Text before text after

    ' + root = parse_html(html) + + # Create layout and verify images are collected + layout = DocumentLayout(root) + layout.layout(800) + + # Should have at least one image collected + assert len(layout.images) >= 1 + + def test_image_with_alt_text_placeholder(self): + """Test that failed images show placeholder with alt text.""" + html = 'Image failed' + root = parse_html(html) + + layout = DocumentLayout(root) + layout.layout(800) + + # Should have image layout even though load failed + assert len(layout.images) >= 1 + + # Check alt text is set + if layout.images: + img = layout.images[0] + assert img.image_layout.alt_text == "Image failed" + + +class TestURLResolution: + """Test URL resolution for images.""" + + def test_resolve_about_page_relative_url(self): + """Test resolving relative URLs for about: pages.""" + from src.network.images import _resolve_url, ASSETS_DIR + + # Relative URL from about:startpage should resolve to assets directory + resolved = _resolve_url("../WebBowserLogo.jpeg", "about:startpage") + + # Should be an absolute path to the assets directory + assert "WebBowserLogo.jpeg" in resolved + assert str(ASSETS_DIR) in resolved or resolved.endswith("WebBowserLogo.jpeg") + + def test_resolve_http_relative_url(self): + """Test resolving relative URLs for HTTP pages.""" + from src.network.images import _resolve_url + + # Relative URL from HTTP page + resolved = _resolve_url("images/photo.jpg", "https://example.com/page/index.html") + + assert resolved == "https://example.com/page/images/photo.jpg" + + def test_resolve_absolute_url(self): + """Test that absolute URLs are returned unchanged.""" + from src.network.images import _resolve_url + + url = "https://example.com/image.png" + resolved = _resolve_url(url, "https://other.com/page.html") + + assert resolved == url + + def test_resolve_data_url(self): + """Test that data URLs are returned unchanged.""" + from src.network.images import _resolve_url + + url = "data:image/png;base64,abc123" + resolved = _resolve_url(url, "https://example.com/") + + assert resolved == url diff --git a/tests/test_tasks.py b/tests/test_tasks.py new file mode 100644 index 0000000..3f07b69 --- /dev/null +++ b/tests/test_tasks.py @@ -0,0 +1,234 @@ +"""Tests for the async task queue system.""" + +import pytest +import time +import threading +from unittest.mock import Mock, patch + + +class TestTaskQueue: + """Tests for the TaskQueue class.""" + + def test_task_queue_singleton(self): + """Test that TaskQueue is a singleton.""" + from src.network.tasks import TaskQueue + + # Reset singleton for clean test + TaskQueue.reset_instance() + + q1 = TaskQueue() + q2 = TaskQueue() + + assert q1 is q2 + + # Clean up + TaskQueue.reset_instance() + + def test_submit_task_returns_id(self): + """Test that submit returns a task ID.""" + from src.network.tasks import TaskQueue + + TaskQueue.reset_instance() + queue = TaskQueue() + + # Mock GLib.idle_add to avoid GTK dependency + with patch('src.network.tasks.GLib') as mock_glib: + mock_glib.idle_add = lambda cb, *args: cb(*args) if args else cb() + + task_id = queue.submit(lambda: 42) + + # Task ID should be non-negative (or -1 for cached) + assert isinstance(task_id, int) + + # Wait for task to complete + time.sleep(0.1) + TaskQueue.reset_instance() + + def test_task_executes_function(self): + """Test that submitted tasks are executed.""" + from src.network.tasks import TaskQueue + + TaskQueue.reset_instance() + queue = TaskQueue() + + result = [] + event = threading.Event() + + def task(): + result.append("executed") + return "done" + + with patch('src.network.tasks.GLib') as mock_glib: + mock_glib.idle_add = lambda cb, *args: cb(*args) if args else cb() + + queue.submit(task) + + # Wait for task to complete + time.sleep(0.2) + + assert "executed" in result + + TaskQueue.reset_instance() + + def test_on_complete_callback(self): + """Test that on_complete callback is called with result.""" + from src.network.tasks import TaskQueue + + TaskQueue.reset_instance() + queue = TaskQueue() + + results = [] + + def task(): + return 42 + + def on_complete(result): + results.append(result) + + with patch('src.network.tasks.GLib') as mock_glib: + # Make idle_add execute immediately + mock_glib.idle_add = lambda cb, *args: cb(*args) if args else cb() + + queue.submit(task, on_complete=on_complete) + + # Wait for task to complete (may need more time under load) + for _ in range(10): + if 42 in results: + break + time.sleep(0.05) + + assert 42 in results + + TaskQueue.reset_instance() + + def test_on_error_callback(self): + """Test that on_error callback is called on exception.""" + from src.network.tasks import TaskQueue + + TaskQueue.reset_instance() + queue = TaskQueue() + + errors = [] + + def failing_task(): + raise ValueError("Test error") + + def on_error(e): + errors.append(str(e)) + + with patch('src.network.tasks.GLib') as mock_glib: + mock_glib.idle_add = lambda cb, *args: cb(*args) if args else cb() + + queue.submit(failing_task, on_error=on_error) + + # Wait for task to complete (may need more time under load) + for _ in range(10): + if len(errors) == 1: + break + time.sleep(0.05) + + assert len(errors) == 1 + assert "Test error" in errors[0] + + TaskQueue.reset_instance() + + def test_cancel_task(self): + """Test task cancellation.""" + from src.network.tasks import TaskQueue + + TaskQueue.reset_instance() + queue = TaskQueue() + + result = [] + + def slow_task(): + time.sleep(1) + result.append("completed") + return True + + with patch('src.network.tasks.GLib') as mock_glib: + mock_glib.idle_add = lambda cb, *args: cb(*args) if args else cb() + + task_id = queue.submit(slow_task) + + # Cancel immediately + cancelled = queue.cancel(task_id) + + # May or may not be cancellable depending on timing + assert isinstance(cancelled, bool) + + # Wait briefly + time.sleep(0.1) + + TaskQueue.reset_instance() + + def test_pending_count(self): + """Test pending task count.""" + from src.network.tasks import TaskQueue + + TaskQueue.reset_instance() + queue = TaskQueue() + + initial_count = queue.pending_count + assert initial_count >= 0 + + TaskQueue.reset_instance() + + +class TestAsyncImageLoading: + """Tests for async image loading.""" + + def test_load_image_async_cached(self): + """Test that cached images return -1 (no task needed).""" + from src.network.images import load_image_async, load_image, ImageCache + + # Clear cache + ImageCache().clear() + + # Load an image synchronously first (to cache it) + data_url = ( + "data:image/png;base64," + "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8DwHwAFBQIAX8jx0gAAAABJRU5ErkJggg==" + ) + image = load_image(data_url) + assert image is not None + + # Now load async - should hit cache and return -1 (no task) + # We don't need a callback for this test - just checking return value + task_id = load_image_async(data_url, on_complete=None) + + # Cached loads return -1 (no task created) + assert task_id == -1 + + def test_load_image_async_uncached(self): + """Test that uncached images create tasks.""" + from src.network.images import load_image_async, ImageCache + from src.network.tasks import TaskQueue + + # Clear cache + ImageCache().clear() + TaskQueue.reset_instance() + + # Use a data URL that's not cached + data_url = ( + "data:image/png;base64," + "iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAADklEQVR42mP8z8DwHwYAAQYBA/5h2aw4AAAAAElFTkSuQmCC" + ) + + # Patch GLib.idle_add to call callbacks immediately (no GTK main loop in tests) + with patch('src.network.tasks.GLib') as mock_glib: + mock_glib.idle_add = lambda cb, *args: cb(*args) if args else cb() + + # Without a callback, it just submits the task + task_id = load_image_async(data_url, on_complete=None) + + # Should create a task (non-negative ID) + assert task_id >= 0 + + # Wait for task to complete + time.sleep(0.3) + + # Image should now be cached + assert ImageCache().has(data_url) + + TaskQueue.reset_instance()