4 Commits

Author SHA1 Message Date
jknapp 7625053a6c Merge pull request 'perf(web): cache macro images in local PWA (1.1.2)' (#12) from perf/local-image-cache into main
Build Windows / preflight (push) Successful in 1s
Build Windows / build-windows (push) Successful in 5m15s
2026-07-18 06:29:20 +00:00
shadowdao 6218a46b57 perf(web): cache macro images in local PWA, bump to 1.1.2
Same fix as the relay: the local PWA re-fetched every macro image and revoked
the blob on each re-render. Cache image URL -> Promise<objectURL> and reuse
across renders (images are immutable per uuid path); add Cache-Control:
immutable on the desktop /api/image response. Verified in a browser: 7
re-renders produced only the initial 3 image fetches, none repeated.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-17 23:29:16 -07:00
jknapp e4f0471614 Merge pull request 'perf(relay): cache macro images (faster display)' (#11) from perf/relay-image-cache into main 2026-07-18 06:22:08 +00:00
shadowdao 2bbbc5e283 perf(relay): cache macro images instead of re-fetching every render
The relay web client re-fetched every macro image through the relay->desktop
proxy on each render (tab switch, WS update) and revoked the object URL on
load, so nothing was reused and fetches were serial — slow to display.

- Client: cache image_path -> Promise<objectURL> and reuse across renders
  (macro images are content-addressed by uuid, so immutable); fetch in
  parallel and de-duplicate concurrent requests.
- Proxy: send Cache-Control: private, max-age=31536000, immutable on image
  responses so the browser also disk-caches them across reloads.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-17 23:22:04 -07:00
6 changed files with 81 additions and 39 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
# Configuration and constants for MacroPad Server
VERSION = "1.1.1"
VERSION = "1.1.2"
DEFAULT_PORT = 40000
SETTINGS_FILE = "settings.json"
+36 -11
View File
@@ -7,6 +7,11 @@ class MacroPadApp {
this.tabs = [];
this.currentTab = 'All';
this.ws = null;
// Cache of image_path -> Promise<objectURL>. Macro images are
// content-addressed by uuid filename, so they are immutable: once
// fetched, an image never changes for a given path. Caching here avoids
// re-fetching every image through the relay on each re-render.
this._imageCache = new Map();
this.desktopConnected = false;
this.wsAuthenticated = false;
@@ -249,25 +254,24 @@ class MacroPadApp {
this.loadMacroImages();
}
// Fetch each macro image with the password header and display it
// as a blob object URL so the credential never appears in a URL.
async loadMacroImages() {
// Fetch each macro image with the password header and display it as a blob
// object URL so the credential never appears in a URL. Images are fetched
// in parallel and cached (see _imageCache) so re-renders reuse them instead
// of re-fetching through the relay each time.
loadMacroImages() {
for (const [id, macro] of Object.entries(this.macros)) {
if (!macro.image_path) continue;
const card = document.querySelector(`[data-macro-id="${id}"]`);
if (!card) continue;
const img = card.querySelector('.macro-image');
if (!img) continue;
this._applyMacroImage(img, macro.image_path);
}
}
async _applyMacroImage(img, imagePath) {
try {
const response = await fetch(
`/${this.sessionId}/api/image/${macro.image_path}`,
{ headers: this.getApiHeaders() }
);
if (!response.ok) continue; // keep placeholder
const blob = await response.blob();
const objectUrl = URL.createObjectURL(blob);
img.onload = () => URL.revokeObjectURL(objectUrl);
const objectUrl = await this._getImageUrl(imagePath);
img.src = objectUrl;
img.style.display = '';
const placeholder = img.nextElementSibling;
@@ -276,6 +280,27 @@ class MacroPadApp {
// Leave the placeholder visible on failure.
}
}
// Returns a cached Promise<objectURL> for an image path, fetching once.
// The object URL is retained for the page's lifetime (images are immutable
// per path, so there is nothing to invalidate); this de-duplicates
// concurrent requests and eliminates re-fetching on re-render.
_getImageUrl(imagePath) {
let entry = this._imageCache.get(imagePath);
if (entry) return entry;
entry = (async () => {
const response = await fetch(
`/${this.sessionId}/api/image/${imagePath}`,
{ headers: this.getApiHeaders() }
);
if (!response.ok) throw new Error(`image ${response.status}`);
const blob = await response.blob();
return URL.createObjectURL(blob);
})();
// Drop failed fetches from the cache so a later render can retry.
entry.catch(() => this._imageCache.delete(imagePath));
this._imageCache.set(imagePath, entry);
return entry;
}
setupEventListeners() {
+4
View File
@@ -49,6 +49,10 @@ export function createApiProxy(
if (response.body?.base64 && response.body?.contentType) {
const buffer = Buffer.from(response.body.base64, 'base64');
res.set('Content-Type', response.body.contentType);
// Macro images are content-addressed (uuid filenames) and therefore
// immutable, so let the browser cache them aggressively. 'private'
// keeps them out of shared proxy caches since they sit behind auth.
res.set('Cache-Control', 'private, max-age=31536000, immutable');
res.send(buffer);
} else {
res.status(response.status).json(response.body);
+1 -1
View File
@@ -1 +1 @@
1.1.1
1.1.2
+25 -16
View File
@@ -34,8 +34,10 @@ class MacroPadApp {
// Guards against out-of-order macro fetches
this._macroReqId = 0;
// Blob object URLs created for macro images (revoked on re-render)
this._objectUrls = [];
// Cache of image URL -> Promise<objectURL>. Macro images are
// content-addressed by uuid filename, so they are immutable; caching
// avoids re-fetching every image on each re-render.
this._imageCache = new Map();
// Set once a local-mode auth failure has been surfaced, to avoid
// reconnect loops and repeated toasts.
@@ -451,16 +453,12 @@ class MacroPadApp {
return headers;
}
// Fetch a macro image with the auth header and display it as a blob
// object URL, so no credential is ever placed on an <img> src.
// Fetch a macro image with the auth header and display it as a blob object
// URL, so no credential is ever placed on an <img> src. The fetched blob is
// cached (images are immutable per URL) and reused across re-renders.
async loadMacroImage(url, img, placeholder) {
try {
const res = await fetch(url, { headers: this.getAuthHeaders() });
if (!res.ok) throw new Error('image request failed');
const blob = await res.blob();
const objectUrl = URL.createObjectURL(blob);
// Track for best-effort revocation on the next render.
this._objectUrls.push(objectUrl);
const objectUrl = await this._getImageUrl(url);
img.src = objectUrl;
} catch (e) {
// Fall back to the placeholder if the image can't be loaded.
@@ -469,6 +467,23 @@ class MacroPadApp {
}
}
// Returns a cached Promise<objectURL> for an image URL, fetching once and
// retaining it for the page's lifetime (immutable content, nothing to
// invalidate); de-duplicates concurrent requests too.
_getImageUrl(url) {
let entry = this._imageCache.get(url);
if (entry) return entry;
entry = (async () => {
const res = await fetch(url, { headers: this.getAuthHeaders() });
if (!res.ok) throw new Error('image request failed');
const blob = await res.blob();
return URL.createObjectURL(blob);
})();
entry.catch(() => this._imageCache.delete(url));
this._imageCache.set(url, entry);
return entry;
}
// Rendering (safe DOM construction only - no user value reaches innerHTML)
renderTabs() {
const container = document.getElementById('tabs-container');
@@ -492,12 +507,6 @@ class MacroPadApp {
const container = document.getElementById('macro-grid');
if (!container) return;
// Best-effort: revoke object URLs from the previous render to avoid leaks.
if (this._objectUrls && this._objectUrls.length) {
this._objectUrls.forEach((u) => URL.revokeObjectURL(u));
}
this._objectUrls = [];
container.textContent = '';
const macroEntries = Object.entries(this.macros);
+5 -1
View File
@@ -338,7 +338,11 @@ class WebServer:
# Only serve files that resolve to inside the macro_images directory
if (os.path.commonpath([requested, images_real]) == images_real
and os.path.isfile(requested)):
return FileResponse(requested)
# Macro images are content-addressed (uuid filenames) and thus
# immutable, so let the browser cache them aggressively.
return FileResponse(requested, headers={
"Cache-Control": "private, max-age=31536000, immutable"
})
raise HTTPException(status_code=404, detail="Image not found")
@app.websocket("/ws")