+
= 0 && index > firstFillIndex
+ ? { zIndex: 1 }
+ : undefined
+ }
+ >
{
const navigate = useNavigate();
const { deleteDashboard, copyDashboard, updateDashboard, exportDashboard } =
@@ -201,6 +202,7 @@ const DashboardCard = ({
const [title, setTitle] = useState(name);
const [desc, setDesc] = useState(description);
const [dashboardImage, setDashboardImage] = useState(image);
+ const [autoUpdateThumbnail, setAutoUpdateThumbnail] = useState(autoThumbnail);
const nameInput = useRef();
const descriptionInput = useRef();
const { activeAppTour } = useAppTourContext();
@@ -295,16 +297,16 @@ const DashboardCard = ({
}
};
- const onUpdateThumbnail = async (newImage) => {
+ const onUpdateThumbnail = async (newImage, newAutoThumbnail) => {
setShowThumbnailModal(false);
- const apiResponse = await updateDashboard({
- id,
- newProperties: {
- image: newImage,
- },
- });
+ const newProperties = { autoThumbnail: newAutoThumbnail };
+ // The toggle can be changed on its own, without picking a file.
+ if (newImage) newProperties.image = newImage;
+
+ const apiResponse = await updateDashboard({ id, newProperties });
if (apiResponse.success) {
- setDashboardImage(newImage);
+ if (newImage) setDashboardImage(newImage);
+ setAutoUpdateThumbnail(newAutoThumbnail);
} else {
setErrorMessage(apiResponse.message ?? "Failed to update dashboard");
}
@@ -411,11 +413,14 @@ const DashboardCard = ({
{errorMessage}
)}
- ![]()
for an inline copy fetched through our own
+ * origin, and return a function that puts the originals back.
+ */
+async function inlineCrossOriginImages() {
+ const images = Array.from(document.querySelectorAll("img")).filter((image) =>
+ isCrossOrigin(image.currentSrc || image.src),
+ );
+ const originals = [];
+
+ await Promise.all(
+ images.map(async (image) => {
+ const source = image.currentSrc || image.src;
+ const proxied = `${IMAGE_PROXY}${encodeURIComponent(source)}`;
+ try {
+ const response = await fetch(proxied, { credentials: "include" });
+ const contentType = response.headers.get("Content-Type") || "";
+
+ /* An unauthenticated request is answered with a redirect to the login
+ page. */
+ if (!response.ok || !contentType.startsWith("image/")) {
+ console.warn(
+ `Thumbnail: proxy returned ${response.status} ${contentType} for ${source} - leaving it as it is`,
+ );
+ return;
+ }
+
+ const dataUrl = await blobToDataUrl(await response.blob());
+ originals.push([image, image.getAttribute("src")]);
+ image.setAttribute("src", dataUrl);
+ } catch (error) {
+ console.warn(`Thumbnail: could not fetch ${proxied}:`, error);
+ }
+ }),
+ );
+
+ return () => {
+ for (const [image, source] of originals) {
+ if (source === null) image.removeAttribute("src");
+ else image.setAttribute("src", source);
+ }
+ };
+}
+
+function getHeaderHeight() {
+ const raw = getComputedStyle(document.documentElement).getPropertyValue(
+ "--ts-header-height",
+ );
+ const parsed = parseFloat(raw);
+ return Number.isFinite(parsed) ? parsed : 0;
+}
+
+function getActiveGrid() {
+ const grids = document.querySelectorAll(".react-grid-layout");
+ for (const grid of grids) {
+ const rect = grid.getBoundingClientRect();
+ if (rect.width > 0 && rect.height > 0) return grid;
+ }
+ return null;
+}
+
+function cropAndScale(captured, topFraction) {
+ const cropTop = Math.min(
+ Math.round(captured.height * Math.min(Math.max(topFraction, 0), 1)),
+ Math.max(0, captured.height - 1),
+ );
+ const cropHeight = captured.height - cropTop;
+ if (cropHeight <= 0 || captured.width <= 0) return null;
+
+ const width = THUMBNAIL_WIDTH;
+ const height = Math.max(1, Math.round((cropHeight / captured.width) * width));
+
+ const output = document.createElement("canvas");
+ output.width = width;
+ output.height = height;
+
+ const context = output.getContext("2d");
+ /* The dashboard background is not necessarily opaque, and a PNG with
+ transparent regions reads as a broken thumbnail against the card. */
+ context.fillStyle = "#ffffff";
+ context.fillRect(0, 0, width, height);
+ context.drawImage(
+ captured,
+ 0,
+ cropTop,
+ captured.width,
+ cropHeight,
+ 0,
+ 0,
+ width,
+ height,
+ );
+
+ return output.toDataURL("image/png");
+}
+
+function getScrollContainer(element) {
+ let node = element?.parentElement;
+ while (node && node !== document.body) {
+ if (node.scrollHeight > node.clientHeight) return node;
+ node = node.parentElement;
+ }
+ return null;
+}
+
+export default async function captureThumbnail() {
+ let scroller = null;
+ let previousScrollTop = 0;
+ let restoreImages = null;
+
+ try {
+ const grid = getActiveGrid();
+ if (!grid) return null;
+
+ /* Otherwise the thumbnail reflects wherever the user happened to be
+ scrolled when they hit save. */
+ scroller = getScrollContainer(grid);
+ if (scroller) {
+ previousScrollTop = scroller.scrollTop;
+ scroller.scrollTop = 0;
+ }
+
+ restoreImages = await inlineCrossOriginImages();
+
+ const result = await snapdom(document.body, {
+ clip: "viewport",
+ exclude: EXCLUDED_SELECTORS,
+ excludeMode: "remove",
+ backgroundColor: "#ffffff",
+ embedFonts: false,
+ });
+
+ /* Safe to read back: everything in this canvas came from snapdom's own
+ inlined SVG, so nothing in it is cross-origin. */
+ const captured = await result.toCanvas();
+ if (captured.width <= 0 || captured.height <= 0) return null;
+
+ return cropAndScale(
+ captured,
+ getHeaderHeight() / (window.innerHeight || captured.height),
+ );
+ } catch (error) {
+ console.error("Dashboard thumbnail capture failed:", error);
+ return null;
+ } finally {
+ restoreImages?.();
+ if (scroller) scroller.scrollTop = previousScrollTop;
+ }
+}
diff --git a/reactapp/components/loader/DashboardLoader.js b/reactapp/components/loader/DashboardLoader.js
index b125c0e7..47cac184 100644
--- a/reactapp/components/loader/DashboardLoader.js
+++ b/reactapp/components/loader/DashboardLoader.js
@@ -32,6 +32,7 @@ const DashboardLoader = ({
userPermission,
permissions,
unrestrictedPlacement,
+ autoThumbnail = true,
description,
owner,
}) => {
@@ -326,6 +327,7 @@ const DashboardLoader = ({
userPermission,
permissions,
unrestrictedPlacement,
+ autoThumbnail,
description,
owner,
}),
@@ -340,6 +342,7 @@ const DashboardLoader = ({
userPermission,
permissions,
unrestrictedPlacement,
+ autoThumbnail,
description,
owner,
],
@@ -401,6 +404,7 @@ DashboardLoader.propTypes = {
publicDashboard: PropTypes.bool,
description: PropTypes.string,
unrestrictedPlacement: PropTypes.bool,
+ autoThumbnail: PropTypes.bool,
uuid: PropTypes.string,
userPermission: PropTypes.string,
permissions: PropTypes.arrayOf(
diff --git a/reactapp/components/map/ModuleLoader.js b/reactapp/components/map/ModuleLoader.js
index abfe6401..2aeb2197 100644
--- a/reactapp/components/map/ModuleLoader.js
+++ b/reactapp/components/map/ModuleLoader.js
@@ -42,6 +42,15 @@ import {
const moduleCache = {};
const styleCache = new Map();
+// A "Zarr" source is sugar over the zarr/cog endpoint: the author supplies a
+// store URL + variable (+ optional index/mask_below) and we assemble the COG
+// URL, then render it as an ordinary GeoTIFF source. Variable inputs in the
+// fields (e.g. index="${Storm}") are already substituted before this runs.
+const ZARR_APP_ROOT = process.env.TETHYS_APP_ROOT_URL ?? "/apps/tethysdash/";
+
+const ISOLATED_LAYER_TYPES = new Set(["ImageLayer", "TileLayer"]);
+let isolatedLayerCount = 0;
+
// Inject an OpenLayers `imageLoadFunction` for ESRI Image and Map Service
// sources that rewrites out-of-range BBOX requests to use a shifted Web
// Mercator central meridian. Without this, panning past the antimeridian
@@ -58,11 +67,71 @@ export function withAntimeridianFix(type, props) {
};
}
-// A "Zarr" source is sugar over the zarr/cog endpoint: the author supplies a
-// store URL + variable (+ optional index/mask_below) and we assemble the COG
-// URL, then render it as an ordinary GeoTIFF source. Variable inputs in the
-// fields (e.g. index="${Storm}") are already substituted before this runs.
-const ZARR_APP_ROOT = process.env.TETHYS_APP_ROOT_URL ?? "/apps/tethysdash/";
+export function withIsolatedCanvas(type, props) {
+ if (!ISOLATED_LAYER_TYPES.has(type)) return props;
+ if (props?.className) return props;
+ isolatedLayerCount += 1;
+ return {
+ ...props,
+ className: `ol-layer tethysdash-layer-${isolatedLayerCount}`,
+ };
+}
+
+const CORS_PROBED_SOURCE_TYPES = new Set([
+ "ESRI Image and Map Service",
+ "WMS",
+ "Static Image",
+]);
+
+const CORS_PROBE_TIMEOUT_MS = 4000;
+const corsSupportByOrigin = new Map();
+
+async function serverAllowsCors(url) {
+ const controller = new AbortController();
+ const timeout = setTimeout(() => controller.abort(), CORS_PROBE_TIMEOUT_MS);
+ try {
+ await fetch(url, {
+ method: "HEAD",
+ mode: "cors",
+ signal: controller.signal,
+ });
+ return true;
+ } catch {
+ return false;
+ } finally {
+ clearTimeout(timeout);
+ }
+}
+
+function cachedCorsSupport(url) {
+ let origin;
+ try {
+ origin = new URL(url, window.location.href).origin;
+ } catch {
+ return Promise.resolve(false);
+ }
+ if (!corsSupportByOrigin.has(origin)) {
+ corsSupportByOrigin.set(origin, serverAllowsCors(url));
+ }
+ return corsSupportByOrigin.get(origin);
+}
+
+export async function withAutoCrossOrigin(type, props) {
+ if (!CORS_PROBED_SOURCE_TYPES.has(type)) return props;
+ // An explicit choice in the layer editor wins over detection.
+ if (props?.crossOrigin !== undefined) return props;
+ if (typeof props?.url !== "string" || props.url === "") return props;
+ return (await cachedCorsSupport(props.url))
+ ? { ...props, crossOrigin: "anonymous" }
+ : props;
+}
+
+async function prepareProps(type, props) {
+ return withIsolatedCanvas(
+ type,
+ await withAutoCrossOrigin(type, withAntimeridianFix(type, props)),
+ );
+}
// Single place that turns Zarr source props into a COG URL, so the layer's
// source and the stats pre-read below can never disagree about the slice.
@@ -367,7 +436,7 @@ const moduleLoader = async (config, mapProjection, getMapProjection) => {
if (type === "KML") {
resolvedProps.format = new KML();
}
- return new moduleCache[type](withAntimeridianFix(type, resolvedProps));
+ return new moduleCache[type](await prepareProps(type, resolvedProps));
}
}
const importModule = getModuleImporter(type);
@@ -403,7 +472,7 @@ const moduleLoader = async (config, mapProjection, getMapProjection) => {
} else if (type === "ESRI Feature Service") {
return loadESRIJSON(config);
} else {
- return new ModuleConstructor(withAntimeridianFix(type, resolvedProps));
+ return new ModuleConstructor(await prepareProps(type, resolvedProps));
}
} catch (error) {
console.error(`Failed to load module '${type}':`, error);
@@ -435,6 +504,13 @@ const resolveProps = async (props, mapProjection) => {
if (key === "projection" && value === "") {
continue;
}
+
+ if (key === "crossOrigin") {
+ if (value === true || value === "true" || value === "anonymous") {
+ resolvedProps[key] = "anonymous";
+ }
+ continue;
+ }
if (key === "overviews" && Array.isArray(value) && value.length === 0) {
continue;
}
diff --git a/reactapp/components/map/utilities.js b/reactapp/components/map/utilities.js
index 60c8ef24..c2b0b8ab 100644
--- a/reactapp/components/map/utilities.js
+++ b/reactapp/components/map/utilities.js
@@ -46,6 +46,11 @@ export const sourcePropertiesOptions = {
},
},
optional: {
+ crossOrigin: {
+ type: "checkbox",
+ placeholder:
+ "Force CORS on this layer's requests so it can be captured in the dashboard thumbnail. Normally detected automatically, so leave this unchecked unless the layer still renders blank in thumbnails. Only enable if the server sends Access-Control-Allow-Origin - if it does not, the layer will fail to load entirely.",
+ },
attributions: {
placeholder: "Attributions",
},
@@ -80,6 +85,11 @@ export const sourcePropertiesOptions = {
},
},
optional: {
+ crossOrigin: {
+ type: "checkbox",
+ placeholder:
+ "Force CORS on this layer's requests so it can be captured in the dashboard thumbnail. Normally detected automatically, so leave this unchecked unless the layer still renders blank in thumbnails. Only enable if the server sends Access-Control-Allow-Origin - if it does not, the layer will fail to load entirely.",
+ },
attributions: {
placeholder: "Attributions",
},
@@ -235,6 +245,11 @@ export const sourcePropertiesOptions = {
imageExtent: { placeholder: "minX,minY,maxX,maxY" },
},
optional: {
+ crossOrigin: {
+ type: "checkbox",
+ placeholder:
+ "Force CORS on this layer's requests so it can be captured in the dashboard thumbnail. Normally detected automatically, so leave this unchecked unless the layer still renders blank in thumbnails. Only enable if the server sends Access-Control-Allow-Origin - if it does not, the layer will fail to load entirely.",
+ },
attributions: {
placeholder: "Attributions",
},
diff --git a/reactapp/components/modals/DashboardThumbnail.js b/reactapp/components/modals/DashboardThumbnail.js
index 0d5b0182..30c06380 100644
--- a/reactapp/components/modals/DashboardThumbnail.js
+++ b/reactapp/components/modals/DashboardThumbnail.js
@@ -1,4 +1,5 @@
import Button from "react-bootstrap/Button";
+import Form from "react-bootstrap/Form";
import Modal from "react-bootstrap/Modal";
import { useState } from "react";
import PropTypes from "prop-types";
@@ -12,8 +13,10 @@ function DashboardThumbnailModal({
showModal,
setShowModal,
onUpdateThumbnail,
+ autoThumbnail = true,
}) {
const [imageSrc, setImageSrc] = useState(null);
+ const [autoUpdate, setAutoUpdate] = useState(autoThumbnail);
const handleModalClose = () => {
setShowModal(false);
@@ -27,6 +30,9 @@ function DashboardThumbnailModal({
setImageSrc(reader.result);
};
reader.readAsDataURL(file);
+ // Turning this off is the point of uploading one - otherwise the next
+ // save overwrites it. Flipped visibly rather than silently on save.
+ setAutoUpdate(false);
}
};
@@ -42,6 +48,15 @@ function DashboardThumbnailModal({
Update Dashboard Thumbnail
+ setAutoUpdate(event.target.checked)}
+ aria-label="Update Thumbnail On Save Toggle"
+ className="mb-3"
+ />
@@ -83,6 +98,7 @@ DashboardThumbnailModal.propTypes = {
showModal: PropTypes.bool,
setShowModal: PropTypes.func,
onUpdateThumbnail: PropTypes.func,
+ autoThumbnail: PropTypes.bool,
};
export default DashboardThumbnailModal;
diff --git a/tethysapp/tethysdash/alembic/versions/7a3c91be04d2_add_auto_thumbnail.py b/tethysapp/tethysdash/alembic/versions/7a3c91be04d2_add_auto_thumbnail.py
new file mode 100644
index 00000000..aaa60e66
--- /dev/null
+++ b/tethysapp/tethysdash/alembic/versions/7a3c91be04d2_add_auto_thumbnail.py
@@ -0,0 +1,35 @@
+"""add auto_thumbnail
+
+Revision ID: 7a3c91be04d2
+Revises: add270eff36c
+Create Date: 2026-08-13 09:12:44.000000
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision: str = "7a3c91be04d2"
+down_revision: Union[str, None] = "add270eff36c"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+ # Added nullable, backfilled, then pinned: existing rows have no value, and
+ # SQLite cannot add a NOT NULL column to a populated table in one step.
+ op.add_column("dashboards", sa.Column("auto_thumbnail", sa.Boolean(), nullable=True))
+ op.execute("UPDATE dashboards SET auto_thumbnail = TRUE")
+
+ if op.get_bind().dialect.name == "sqlite":
+ with op.batch_alter_table("dashboards") as batch_op:
+ batch_op.alter_column("auto_thumbnail", nullable=False)
+ else:
+ op.alter_column("dashboards", "auto_thumbnail", nullable=False)
+
+
+def downgrade() -> None:
+ op.drop_column("dashboards", "auto_thumbnail")
diff --git a/tethysapp/tethysdash/controllers.py b/tethysapp/tethysdash/controllers.py
index 2b5f417f..7ec3ebc6 100644
--- a/tethysapp/tethysdash/controllers.py
+++ b/tethysapp/tethysdash/controllers.py
@@ -1,10 +1,14 @@
-from django.http import HttpResponse, JsonResponse
+from django.http import JsonResponse, HttpResponse
+import ipaddress
import json
import os
import shutil
+import socket
import nh3
+import requests
from rest_framework.decorators import api_view
import uuid
+from urllib.parse import urljoin, urlparse
from datetime import datetime
from django.core.exceptions import RequestDataTooBig
from tethys_sdk.permissions import has_permission
@@ -53,6 +57,15 @@
# Load the default wordlist
profanity.load_censor_words()
+# Bounds for the thumbnail image proxy. The timeout keeps a slow host from
+# tying up a worker; the size cap keeps a large image from being read into
+# memory, and comfortably exceeds anything worth showing in a 640px thumbnail.
+IMAGE_PROXY_TIMEOUT = 10
+IMAGE_PROXY_MAX_BYTES = 10 * 1024 * 1024
+# Redirects are common for image CDNs, but each hop is re-checked, so the chain
+# is kept short rather than unbounded.
+IMAGE_PROXY_MAX_REDIRECTS = 3
+
def _get_error_message(e, fallback):
"""Return the first arg of an exception, or ``fallback`` if unavailable.
@@ -656,7 +669,9 @@ def add_dashboard(request, app_media):
- description: Optional string description
- notes: Optional string notes
- public: Optional boolean for public access
- - unrestrictedPlacement: Optional boolean for placement restrictions
+ - unrestrictedPlacement: Optional boolean for placement restrictions,
+ defaulting to True. Existing dashboards keep whatever they were
+ created with; this only sets the starting point for new ones.
- gridItems: Optional list of grid items
app_media: Tethys app media directory for storing dashboard images
@@ -672,7 +687,7 @@ def add_dashboard(request, app_media):
description = dashboard_metadata.get("description", "")
notes = dashboard_metadata.get("notes", "")
public = dashboard_metadata.get("public", False)
- unrestricted_placement = dashboard_metadata.get("unrestrictedPlacement", False)
+ unrestricted_placement = dashboard_metadata.get("unrestrictedPlacement", True)
tabs = dashboard_metadata.get("tabs", [])
grid_items = dashboard_metadata.get("gridItems", [])
owner = request.user
@@ -692,12 +707,8 @@ def add_dashboard(request, app_media):
tabs,
)
- dashboard_image = os.path.join(
- os.path.dirname(__file__), "default_dashboard.png"
- )
- shutil.copyfile(
- dashboard_image, os.path.join(app_media.path, f"{dashboard_uuid}.png")
- )
+ # No placeholder image is written: a dashboard has no thumbnail until one
+ # is captured on save or uploaded by hand.
new_dashboard = get_dashboards(owner, id=new_dashboard_id)
print(f"Successfully created the dashboard named {name}")
@@ -1047,6 +1058,169 @@ def download_json(request, app_workspace):
return JsonResponse({"success": False, "message": message})
+def _is_blocked_address(address_string):
+ """True for an address this server must never be aimed at.
+
+ A proxy that fetches whatever URL it is handed is a server-side request
+ forgery primitive: without this it would reach services bound to the
+ server's own loopback, anything on the private network, and the cloud
+ metadata endpoint (169.254.169.254) that hands out instance credentials.
+ """
+ try:
+ address = ipaddress.ip_address(address_string)
+ except ValueError:
+ return True
+
+ return (
+ address.is_private
+ or address.is_loopback
+ or address.is_link_local
+ or address.is_reserved
+ or address.is_multicast
+ or address.is_unspecified
+ )
+
+
+def _is_blocked_image_host(hostname):
+ """True when any address a hostname resolves to is off limits."""
+ try:
+ addresses = socket.getaddrinfo(hostname, None)
+ except socket.gaierror:
+ # Fail closed: a name that will not resolve is refused, not attempted.
+ return True
+
+ return any(_is_blocked_address(info[4][0]) for info in addresses)
+
+
+def _connected_peer_is_blocked(response):
+ """True when the address actually connected to is off limits.
+
+ Checking the hostname is not enough on its own. That check resolves the
+ name, and requests resolves it again when it opens the connection - two
+ lookups a hostile DNS server is free to answer differently, returning a
+ public address to be inspected and a private one to be connected to. This
+ inspects the socket, so it judges the connection that was really made
+ rather than a separate lookup that may no longer describe it.
+
+ Only meaningful for a response whose body is still unread. urllib3 returns
+ the connection to the pool as soon as a body is finished, and a redirect's
+ body is empty, so by the time one is inspected there is no socket left to
+ look at. Redirect hops are therefore covered by the hostname check alone;
+ this guards the response that actually hands bytes back to the caller.
+
+ Fails closed: if the peer cannot be determined the response is refused,
+ which costs one image in a thumbnail rather than trusting a connection that
+ was never verified.
+ """
+ try:
+ peer = response.raw._connection.sock.getpeername()[0]
+ except Exception:
+ return True
+
+ return _is_blocked_address(peer)
+
+
+@controller(url="tethysdash/images/proxy", login_required=True)
+def image_proxy(request):
+ """
+ Fetch a cross-origin image and return it from this origin.
+
+ Exists for dashboard thumbnails. Capturing one serialises the page, which
+ means re-fetching every ![]()
from JavaScript, and that re-fetch is subject
+ to CORS - so an image whose host sends no Access-Control-Allow-Origin comes
+ out blank in the thumbnail even though it displays fine in the dashboard.
+ Nothing in the browser can work around that. Fetching server-side can,
+ because server-to-server requests are not subject to CORS.
+
+ Only the capture path uses this (see components/layout/captureThumbnail),
+ and a capture only runs when a dashboard is saved, which already requires an
+ authenticated editor - hence login_required.
+
+ Args:
+ request: Django HTTP request object with query parameters:
+ - url: The absolute http(s) image URL to fetch
+
+ Returns:
+ HttpResponse: The image bytes with their upstream content type, or a
+ plain-text error with an appropriate status code.
+ """
+ url = request.GET.get("url", "")
+ response = None
+
+ for _ in range(IMAGE_PROXY_MAX_REDIRECTS + 1):
+ parsed = urlparse(url)
+ if parsed.scheme not in ("http", "https") or not parsed.hostname:
+ return HttpResponse("Only absolute http(s) URLs are allowed", status=400)
+
+ if _is_blocked_image_host(parsed.hostname):
+ return HttpResponse("That host is not permitted", status=403)
+
+ try:
+ response = requests.get(
+ url,
+ timeout=IMAGE_PROXY_TIMEOUT,
+ stream=True,
+ allow_redirects=False,
+ )
+ except requests.RequestException as e:
+ print(f"Image proxy failed to fetch {url}: {e}")
+ return HttpResponse("Could not fetch the image", status=502)
+
+ if not response.is_redirect:
+ break
+
+ location = response.headers.get("Location", "")
+ response.close()
+ if not location:
+ return HttpResponse("Could not fetch the image", status=502)
+ # Relative Locations are legal, so resolve against the URL just fetched.
+ url = urljoin(url, location)
+ else:
+ return HttpResponse("Too many redirects", status=502)
+
+ # Checked here rather than per hop: this is the response whose body is read,
+ # and the only one still holding a socket to inspect.
+ if _connected_peer_is_blocked(response):
+ response.close()
+ return HttpResponse("That host is not permitted", status=403)
+
+ try:
+ response.raise_for_status()
+ except requests.RequestException as e:
+ print(f"Image proxy failed to fetch {url}: {e}")
+ response.close()
+ return HttpResponse("Could not fetch the image", status=502)
+
+ content_type = response.headers.get("Content-Type", "").split(";")[0].strip()
+ if not content_type.startswith("image/"):
+ # An error page answering 200 must not be passed off as an image.
+ response.close()
+ return HttpResponse("That URL is not an image", status=415)
+
+ # Read with a cap rather than trusting Content-Length, which a server may
+ # understate or omit entirely. decode_content bounds the decompressed size,
+ # so a compressed payload cannot expand past the cap.
+ content = response.raw.read(IMAGE_PROXY_MAX_BYTES + 1, decode_content=True)
+ response.close()
+ if len(content) > IMAGE_PROXY_MAX_BYTES:
+ return HttpResponse("That image is too large to proxy", status=413)
+
+ proxied = HttpResponse(content, content_type=content_type)
+ # This body is written by whoever controls the remote host and is served
+ # from our own origin, so it is pinned down as tightly as an image allows.
+ # image/svg+xml matters most: an SVG can carry script, and opening one at
+ # the top level would run it as this origin. Marking every response an
+ # attachment stops that navigation from rendering, while leaving ![]()
and
+ # the capture's own fetch unaffected.
+ proxied["X-Content-Type-Options"] = "nosniff"
+ proxied["Content-Security-Policy"] = "default-src 'none'; sandbox"
+ proxied["Content-Disposition"] = "attachment"
+ # No Access-Control-Allow-Origin: the capture is same-origin and needs none,
+ # and a wildcard is refused by browsers alongside credentialed requests
+ # anyway, so it would be surface without benefit.
+ return proxied
+
+
def _cog_response(request, cog_bytes):
"""Serve COG bytes, honoring an HTTP Range header with 206 partial content
so a COG reader can fetch byte ranges instead of the whole file."""
diff --git a/tethysapp/tethysdash/default_dashboard.png b/tethysapp/tethysdash/default_dashboard.png
deleted file mode 100644
index 544d46bf..00000000
Binary files a/tethysapp/tethysdash/default_dashboard.png and /dev/null differ
diff --git a/tethysapp/tethysdash/model.py b/tethysapp/tethysdash/model.py
index a9e73d7f..24f848fe 100644
--- a/tethysapp/tethysdash/model.py
+++ b/tethysapp/tethysdash/model.py
@@ -68,6 +68,8 @@ class Dashboard(Base):
notes = Column(String)
owner = Column(String, nullable=False)
unrestricted_placement = Column(Boolean)
+ # Cleared when a thumbnail is uploaded by hand, so a save cannot overwrite it.
+ auto_thumbnail = Column(Boolean, nullable=False, default=True)
public = Column(Boolean, nullable=False, default=False)
last_updated = Column(DateTime, default=datetime.now(timezone.utc))
@@ -688,6 +690,7 @@ def copy_named_dashboard(user, id, new_name, dashboard_uuid):
public=original_dashboard.public,
owner=user.username,
unrestricted_placement=original_dashboard.unrestricted_placement,
+ auto_thumbnail=original_dashboard.auto_thumbnail,
)
# Add and flush to generate new ID
@@ -868,6 +871,9 @@ def update_named_dashboard(user, id, dashboard_updates):
"unrestrictedPlacement"
]
+ if "autoThumbnail" in dashboard_updates:
+ db_dashboard.auto_thumbnail = dashboard_updates["autoThumbnail"]
+
if "permissions" in dashboard_updates:
update_dashboard_permissions(
session, db_dashboard, user, dashboard_updates["permissions"]
@@ -1712,13 +1718,12 @@ def parse_db_dashboard(session, dashboards, user, dashboard_view):
MEDIA_URL = f"/{PREFIX_URL}/{MEDIA_URL.strip('/')}/"
for dashboard in dashboards:
- dashboard_image = os.path.join(
- MEDIA_URL, App.root_url, f"app/{dashboard.uuid}.png"
- )
+ # None until a thumbnail exists; the card renders without one.
+ dashboard_image = None
app_media = get_app_media(App)
- if not os.path.exists(os.path.join(app_media.path, f"{dashboard.uuid}.png")):
+ if os.path.exists(os.path.join(app_media.path, f"{dashboard.uuid}.png")):
dashboard_image = os.path.join(
- settings.STATIC_URL, App.root_url, "images", "default_dashboard.png"
+ MEDIA_URL, App.root_url, f"app/{dashboard.uuid}.png"
)
# Find the user's permission level for this dashboard
user_permission = get_dashboard_user_permission(session, dashboard, user)
@@ -1749,6 +1754,7 @@ def parse_db_dashboard(session, dashboards, user, dashboard_view):
"userPermission": user_permission,
"permissions": permissions_list,
"unrestrictedPlacement": dashboard.unrestricted_placement,
+ "autoThumbnail": dashboard.auto_thumbnail,
"image": dashboard_image,
"owner": dashboard.owner,
}
diff --git a/tethysapp/tethysdash/public/images/default_dashboard.png b/tethysapp/tethysdash/public/images/default_dashboard.png
deleted file mode 100644
index 544d46bf..00000000
Binary files a/tethysapp/tethysdash/public/images/default_dashboard.png and /dev/null differ
diff --git a/tethysapp/tethysdash/tests/integrated_tests/test_controllers.py b/tethysapp/tethysdash/tests/integrated_tests/test_controllers.py
index d71119e4..2ac5dc9c 100644
--- a/tethysapp/tethysdash/tests/integrated_tests/test_controllers.py
+++ b/tethysapp/tethysdash/tests/integrated_tests/test_controllers.py
@@ -14,9 +14,14 @@
from tethysapp.tethysdash.controllers import (
VisualizationConsumer,
_get_main_bundle_path,
+ _is_blocked_image_host,
+ _connected_peer_is_blocked,
+ _is_blocked_address,
zarr_cog,
zarr_meta,
)
+import requests
+import socket
from tethysapp.tethysdash.zarr_utils import StoreOpenError, ZarrCogError
from tethysapp.tethysdash.url_safety import UnsafeURLError
from channels.layers import get_channel_layer
@@ -410,8 +415,9 @@ def test_get_dashboard(
"tabs": [],
"uuid": dashboard.uuid,
"notes": "some notes",
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "image": None,
"unrestrictedPlacement": dashboard.unrestricted_placement,
+ "autoThumbnail": True,
"owner": dashboard.owner,
"permissions": [
{"permission": "admin", "username": test_owner_user.username},
@@ -516,9 +522,12 @@ def test_add_dashboard(
"description": "description",
"id": new_dashboard["id"],
"name": "some_new_dashboard_name",
- "image": "/media/tethysdash/app/123e4567-e89b-12d3-a456-426614174000.png",
+ # A new dashboard has no thumbnail until one is captured or uploaded.
+ "image": None,
"uuid": "123e4567-e89b-12d3-a456-426614174000",
- "unrestrictedPlacement": False,
+ # itemData omits unrestrictedPlacement, so this pins the creation default.
+ "unrestrictedPlacement": True,
+ "autoThumbnail": True,
"owner": test_admin_user.username,
"permissions": [{"permission": "admin", "username": test_admin_user.username}],
"publicDashboard": False,
@@ -560,7 +569,7 @@ def test_add_dashboard_failed(client, admin_user, mock_app, mocker, tmp_path):
itemData["description"],
"",
False,
- False,
+ True,
[],
[],
)
@@ -599,7 +608,7 @@ def test_add_dashboard_failed_unknown_exception(
itemData["description"],
"",
False,
- False,
+ True,
[],
[],
)
@@ -777,9 +786,10 @@ def test_update_dashboard(
"id": dashboard.id,
"name": "new_dashboard_name",
"notes": dashboard.notes,
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "image": None,
"uuid": "some_user_dashboard_uuid",
"unrestrictedPlacement": dashboard.unrestricted_placement,
+ "autoThumbnail": True,
"owner": dashboard.owner,
"permissions": [
{"permission": "admin", "username": test_owner_user.username},
@@ -924,9 +934,10 @@ def test_copy_dashboard(
"description": dashboard.description,
"id": new_dashboard["id"],
"name": "some_new_dashboard_name",
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "image": None,
"uuid": dashboard_uuid,
"unrestrictedPlacement": dashboard.unrestricted_placement,
+ "autoThumbnail": True,
"owner": admin_user.username,
"permissions": [{"permission": "admin", "username": admin_user.username}],
"publicDashboard": dashboard.public,
@@ -989,6 +1000,7 @@ def test_copy_dashboard_with_thumbnail(
"image": "/media/tethysdash/app/123e4567-e89b-12d3-a456-426614174001.png",
"uuid": "123e4567-e89b-12d3-a456-426614174001",
"unrestrictedPlacement": dashboard.unrestricted_placement,
+ "autoThumbnail": True,
"owner": admin_user.username,
"permissions": [{"permission": "admin", "username": admin_user.username}],
"publicDashboard": dashboard.public,
@@ -2529,6 +2541,378 @@ def test_get_main_bundle_path_returns_hashed_from_manifest():
assert _get_main_bundle_path(request) == "frontend/main.abc123.js"
+@pytest.mark.django_db
+def test_image_proxy_returns_the_image(client, admin_user, mock_app, mocker):
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._connected_peer_is_blocked",
+ return_value=False,
+ )
+ mock_get = mocker.patch("tethysapp.tethysdash.controllers.requests.get")
+ upstream = mock_get.return_value
+ upstream.raise_for_status.return_value = None
+ upstream.is_redirect = False
+ upstream.headers = {"Content-Type": "image/png; charset=binary"}
+ upstream.raw.read.return_value = b"\x89PNG-bytes"
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/logo.png"}
+ )
+
+ assert response.status_code == 200
+ assert response["Content-Type"] == "image/png"
+ assert response.content == b"\x89PNG-bytes"
+
+ # The body is written by whoever controls the remote host but served from
+ # our origin, so it is pinned down as tightly as an image allows. An SVG can
+ # carry script, and "attachment" is what stops a top-level visit rendering
+ # it as this origin.
+ assert response["X-Content-Type-Options"] == "nosniff"
+ assert response["Content-Security-Policy"] == "default-src 'none'; sandbox"
+ assert response["Content-Disposition"] == "attachment"
+ # The capture is same-origin, so no CORS header is needed - and a wildcard
+ # is refused alongside credentialed requests anyway.
+ assert not response.has_header("Access-Control-Allow-Origin")
+
+
+@pytest.mark.django_db
+def test_image_proxy_requires_login(client, mock_app):
+ """Unauthenticated access would make this an open server-side fetcher."""
+ mock_app("tethysapp.tethysdash.controllers.App")
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/logo.png"}
+ )
+ assert response.status_code in (302, 401, 403)
+
+
+@pytest.mark.django_db
+@pytest.mark.parametrize(
+ "url",
+ [
+ "file:///etc/passwd",
+ "ftp://example.com/logo.png",
+ "not-a-url",
+ "",
+ ],
+)
+def test_image_proxy_rejects_non_http_urls(client, admin_user, mock_app, url):
+ mock_app("tethysapp.tethysdash.controllers.App")
+ client.force_login(admin_user)
+ response = client.get(reverse("tethysdash:image_proxy"), {"url": url})
+ assert response.status_code == 400
+
+
+@pytest.mark.django_db
+def test_image_proxy_blocks_internal_hosts(client, admin_user, mock_app, mocker):
+ """Without this the endpoint is a server-side request forgery primitive."""
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mock_get = mocker.patch("tethysapp.tethysdash.controllers.requests.get")
+ client.force_login(admin_user)
+
+ response = client.get(
+ reverse("tethysdash:image_proxy"),
+ {"url": "http://169.254.169.254/latest/meta-data/"},
+ )
+
+ assert response.status_code == 403
+ # Blocked before any request leaves the server.
+ mock_get.assert_not_called()
+
+
+@pytest.mark.django_db
+def test_image_proxy_reports_an_unreachable_host(client, admin_user, mock_app, mocker):
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._connected_peer_is_blocked",
+ return_value=False,
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers.requests.get",
+ side_effect=requests.exceptions.ConnectionError("boom"),
+ )
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/logo.png"}
+ )
+ assert response.status_code == 502
+
+
+@pytest.mark.django_db
+def test_image_proxy_refuses_a_non_image(client, admin_user, mock_app, mocker):
+ """An error page answering 200 must not be passed off as an image."""
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._connected_peer_is_blocked",
+ return_value=False,
+ )
+ mock_get = mocker.patch("tethysapp.tethysdash.controllers.requests.get")
+ mock_get.return_value.raise_for_status.return_value = None
+ mock_get.return_value.is_redirect = False
+ mock_get.return_value.headers = {"Content-Type": "text/html"}
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/oops"}
+ )
+ assert response.status_code == 415
+
+
+@pytest.mark.django_db
+def test_image_proxy_rejects_an_oversized_image(client, admin_user, mock_app, mocker):
+ """Size is capped by reading, not by trusting Content-Length."""
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._connected_peer_is_blocked",
+ return_value=False,
+ )
+ mocker.patch("tethysapp.tethysdash.controllers.IMAGE_PROXY_MAX_BYTES", 10)
+ mock_get = mocker.patch("tethysapp.tethysdash.controllers.requests.get")
+ upstream = mock_get.return_value
+ upstream.raise_for_status.return_value = None
+ upstream.is_redirect = False
+ upstream.headers = {"Content-Type": "image/png"}
+ upstream.raw.read.return_value = b"x" * 11
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/huge.png"}
+ )
+ assert response.status_code == 413
+
+
+def test_is_blocked_image_host_allows_a_public_address(mocker):
+ mocker.patch(
+ "tethysapp.tethysdash.controllers.socket.getaddrinfo",
+ return_value=[(None, None, None, None, ("93.184.216.34", 0))],
+ )
+ assert _is_blocked_image_host("example.com") is False
+
+
+@pytest.mark.parametrize(
+ "address",
+ ["127.0.0.1", "10.0.0.5", "192.168.1.10", "169.254.169.254", "0.0.0.0"],
+)
+def test_is_blocked_image_host_blocks_internal_addresses(mocker, address):
+ mocker.patch(
+ "tethysapp.tethysdash.controllers.socket.getaddrinfo",
+ return_value=[(None, None, None, None, (address, 0))],
+ )
+ assert _is_blocked_image_host(address) is True
+
+
+def test_is_blocked_image_host_blocks_a_name_that_will_not_resolve(mocker):
+ """Fail closed: an unresolvable name is refused rather than attempted."""
+ mocker.patch(
+ "tethysapp.tethysdash.controllers.socket.getaddrinfo",
+ side_effect=socket.gaierror("nope"),
+ )
+ assert _is_blocked_image_host("nowhere.invalid") is True
+
+
+def _redirect_to(location):
+ """An upstream response that redirects, as requests would report it."""
+ hop = MagicMock()
+ hop.is_redirect = True
+ hop.headers = {"Location": location}
+ return hop
+
+
+@pytest.mark.django_db
+def test_image_proxy_rechecks_the_host_on_every_redirect(
+ client, admin_user, mock_app, mocker
+):
+ """A permitted public URL must not be able to bounce us onto an internal one.
+
+ Following redirects automatically is a complete bypass of the address
+ checks: only the first URL is ever inspected, so a public host answering
+ with a Location of 127.0.0.1 gets the server to fetch it anyway.
+ """
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._connected_peer_is_blocked",
+ return_value=False,
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host",
+ side_effect=lambda host: host != "public.example.com",
+ )
+ mock_get = mocker.patch("tethysapp.tethysdash.controllers.requests.get")
+ mock_get.return_value = _redirect_to("http://169.254.169.254/latest/meta-data/")
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"),
+ {"url": "https://public.example.com/innocent.png"},
+ )
+
+ assert response.status_code == 403
+ # The internal address was never requested, only the permitted first hop.
+ assert mock_get.call_count == 1
+
+
+@pytest.mark.django_db
+def test_image_proxy_follows_a_redirect_to_a_permitted_host(
+ client, admin_user, mock_app, mocker
+):
+ """Image CDNs redirect routinely, so permitted hops must still be followed."""
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._connected_peer_is_blocked",
+ return_value=False,
+ )
+ final = MagicMock()
+ final.is_redirect = False
+ final.raise_for_status.return_value = None
+ final.headers = {"Content-Type": "image/png"}
+ final.raw.read.return_value = b"\x89PNG"
+ mock_get = mocker.patch("tethysapp.tethysdash.controllers.requests.get")
+ mock_get.side_effect = [_redirect_to("https://cdn.example.com/real.png"), final]
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/start.png"}
+ )
+
+ assert response.status_code == 200
+ assert response.content == b"\x89PNG"
+
+
+@pytest.mark.django_db
+def test_image_proxy_gives_up_on_a_redirect_loop(client, admin_user, mock_app, mocker):
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ mock_get = mocker.patch("tethysapp.tethysdash.controllers.requests.get")
+ mock_get.return_value = _redirect_to("https://example.com/round-again.png")
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/start.png"}
+ )
+
+ assert response.status_code == 502
+ assert mock_get.call_count == 4 # the first request plus MAX_REDIRECTS hops
+
+
+@pytest.mark.django_db
+def test_image_proxy_blocks_a_peer_that_resolved_somewhere_else(
+ client, admin_user, mock_app, mocker
+):
+ """Guards against DNS rebinding: the socket, not a second lookup, decides.
+
+ The hostname check resolves the name, and requests resolves it again when
+ it connects. A hostile DNS server is free to answer those two differently.
+ """
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._connected_peer_is_blocked", return_value=True
+ )
+ upstream = MagicMock()
+ upstream.is_redirect = False
+ mocker.patch("tethysapp.tethysdash.controllers.requests.get", return_value=upstream)
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://rebind.example.com/x.png"}
+ )
+
+ assert response.status_code == 403
+ # Refused before any of the body was read.
+ upstream.raw.read.assert_not_called()
+
+
+@pytest.mark.parametrize(
+ "peer,expected",
+ [("93.184.216.34", False), ("127.0.0.1", True), ("169.254.169.254", True)],
+)
+def test_connected_peer_is_blocked_reads_the_socket(peer, expected):
+ response = MagicMock()
+ response.raw._connection.sock.getpeername.return_value = (peer, 443)
+ assert _connected_peer_is_blocked(response) is expected
+
+
+def test_connected_peer_is_blocked_fails_closed():
+ """An unverifiable connection is refused rather than trusted.
+
+ urllib3 releases the connection once a body is read, so this can genuinely
+ happen; losing one image from a thumbnail is the right price.
+ """
+ response = MagicMock()
+ response.raw._connection = None
+ assert _connected_peer_is_blocked(response) is True
+
+
+def test_is_blocked_address_rejects_something_that_is_not_an_address():
+ """Fail closed on anything unparseable rather than letting it through."""
+ assert _is_blocked_address("not-an-address") is True
+
+
+@pytest.mark.django_db
+def test_image_proxy_handles_a_redirect_with_no_location(
+ client, admin_user, mock_app, mocker
+):
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ hop = MagicMock()
+ hop.is_redirect = True
+ hop.headers = {}
+ mocker.patch("tethysapp.tethysdash.controllers.requests.get", return_value=hop)
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/x.png"}
+ )
+ assert response.status_code == 502
+
+
+@pytest.mark.django_db
+def test_image_proxy_reports_an_upstream_error_status(
+ client, admin_user, mock_app, mocker
+):
+ """A 404 from the far end is an upstream failure, not a broken thumbnail."""
+ mock_app("tethysapp.tethysdash.controllers.App")
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._is_blocked_image_host", return_value=False
+ )
+ mocker.patch(
+ "tethysapp.tethysdash.controllers._connected_peer_is_blocked",
+ return_value=False,
+ )
+ upstream = MagicMock()
+ upstream.is_redirect = False
+ upstream.raise_for_status.side_effect = requests.exceptions.HTTPError("404")
+ mocker.patch("tethysapp.tethysdash.controllers.requests.get", return_value=upstream)
+
+ client.force_login(admin_user)
+ response = client.get(
+ reverse("tethysdash:image_proxy"), {"url": "https://example.com/missing.png"}
+ )
+ assert response.status_code == 502
+
+
# The zarr endpoints are exercised by calling the views directly with a
# RequestFactory: they need no DB or URL routing, and the integrated
# reverse()/client harness isn't available in every environment.
@@ -2571,7 +2955,9 @@ def test_zarr_cog_requires_src_and_variable():
def test_zarr_cog_rejects_bad_index_and_mask():
r1 = zarr_cog(
- RequestFactory().get("/zarr/cog", {"src": "https://x", "variable": "t", "index": "abc"})
+ RequestFactory().get(
+ "/zarr/cog", {"src": "https://x", "variable": "t", "index": "abc"}
+ )
)
assert r1.status_code == 400 and "index" in json.loads(r1.content)["error"]
r2 = zarr_cog(
diff --git a/tethysapp/tethysdash/tests/integrated_tests/test_model.py b/tethysapp/tethysdash/tests/integrated_tests/test_model.py
index 4d6c97a5..54f9fe0d 100644
--- a/tethysapp/tethysdash/tests/integrated_tests/test_model.py
+++ b/tethysapp/tethysdash/tests/integrated_tests/test_model.py
@@ -414,6 +414,7 @@ def test_update_named_dashboard_grid_items(
"public": True,
"tabs": tabs,
"unrestrictedPlacement": True,
+ "autoThumbnail": True,
"permissions": [
{"permission": "admin", "username": test_owner_user.username},
],
@@ -525,7 +526,7 @@ def test_update_named_dashboard_image(
)
assert (
existing_dashboard[0]["image"]
- == "/static/tethysdash/images/default_dashboard.png"
+ is None
)
example_image = os.path.join(
@@ -733,7 +734,8 @@ def test_get_dashboards_all(
{"permission": "viewer", "group": permission_group["name"]},
],
"unrestrictedPlacement": dashboard.unrestricted_placement,
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "autoThumbnail": True,
+ "image": None,
"owner": test_owner_user.username,
},
{
@@ -747,7 +749,8 @@ def test_get_dashboards_all(
{"permission": "admin", "username": public_dashboard.owner}
],
"unrestrictedPlacement": public_dashboard.unrestricted_placement,
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "autoThumbnail": True,
+ "image": None,
"owner": public_dashboard.owner,
},
]
@@ -776,9 +779,10 @@ def test_get_dashboards_specific_dashboard_view(
"description": dashboard.description,
"notes": dashboard.notes,
"tabs": [],
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "image": None,
"uuid": "some_user_dashboard_uuid",
"unrestrictedPlacement": False,
+ "autoThumbnail": True,
"owner": test_owner_user.username,
"permissions": [
{"permission": "admin", "username": test_owner_user.username},
@@ -809,9 +813,10 @@ def test_get_dashboards_specific_landing_page_view(
"id": dashboard.id,
"name": dashboard.name,
"description": dashboard.description,
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "image": None,
"uuid": "some_user_dashboard_uuid",
"unrestrictedPlacement": False,
+ "autoThumbnail": True,
"owner": test_owner_user.username,
"permissions": [
{"permission": "admin", "username": test_owner_user.username},
@@ -932,8 +937,9 @@ def test_parse_db_dashboard_landing_page_view(
"uuid": dashboard.uuid,
"name": dashboard.name,
"description": dashboard.description,
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "image": None,
"unrestrictedPlacement": False,
+ "autoThumbnail": True,
"owner": test_owner_user.username,
"permissions": [
{"permission": "admin", "username": test_owner_user.username},
@@ -972,6 +978,7 @@ def test_parse_db_dashboard_landing_page_view_with_prefix(
"description": dashboard.description,
"image": "/test/media/tethysdash/app/some_user_dashboard_uuid.png",
"unrestrictedPlacement": False,
+ "autoThumbnail": True,
"owner": test_owner_user.username,
"permissions": [
{"permission": "admin", "username": test_owner_user.username},
@@ -1006,10 +1013,11 @@ def test_parse_db_dashboard_dashboard_view(
"uuid": dashboard.uuid,
"name": dashboard.name,
"description": dashboard.description,
- "image": "/static/tethysdash/images/default_dashboard.png",
+ "image": None,
"notes": dashboard.notes,
"tabs": [],
"unrestrictedPlacement": False,
+ "autoThumbnail": True,
"owner": test_owner_user.username,
"permissions": [
{"permission": "admin", "username": test_owner_user.username},
@@ -2230,3 +2238,21 @@ def test_init_primary_db_moves_json_and_geojson_files(
set_main_option_calls, any_order=True
)
mock_command.ensure_version.assert_called_once()
+
+
+def test_update_named_dashboard_auto_thumbnail(
+ db_session, dashboard, mock_app_get_ps_db, mocker, tmp_path, test_owner_user
+):
+ """The toggle behind "Update thumbnail on save"."""
+ mock_app_get_ps_db("tethysapp.tethysdash.app.App")
+ mock_get_app_media = mocker.patch("tethysapp.tethysdash.model.get_app_media")
+ mock_get_app_media.return_value = MagicMock(path=tmp_path)
+ assert dashboard.auto_thumbnail is True
+
+ update_named_dashboard(test_owner_user, dashboard.id, {"autoThumbnail": False})
+ db_session.refresh(dashboard)
+ assert dashboard.auto_thumbnail is False
+
+ update_named_dashboard(test_owner_user, dashboard.id, {"autoThumbnail": True})
+ db_session.refresh(dashboard)
+ assert dashboard.auto_thumbnail is True