Preview panel phase 2: office formats (docx, xlsx, pptx) via vendored client-side renderers #297
Closed
opened 2026-08-20 20:40:35 +00:00 by Cordy
·
7 comments
No Branch/Tag specified
main
b12v07
b11v07
b10v07
ci-rc-publish
fx15-s3dry
b9v07
b8v07
bench742
b7v07
legal-texts-v0.2
b6v07
b5v07
b4v07
b3v07
sx1139
st742
b2v07
ix1102
fu1098
zp1097
wd1099
tr1100
qf1077
nc1070
ci1
rp1072
lk1073
ab1071
fi1074
si1070
ra1054
wo1056
oc1057
tf1055
sv1063
fg1059
st1058
fs929
mu1039
ls1033
cf975
lf835
dx1023
ml896
a11y2
av1022
r913
r7
r6
r5
r45
r23
r1
b10
b9
fix-b5
fix-b4
fix-b3
fix-b2
fix-b1
fix-922
fix-923
fix-911
fix-343b
batch-a
v0.6.413
v0.6.412
v0.6.411
v0.6.410
v0.6.409
v0.6.408
v0.6.407
v0.6.406
v0.6.405
v0.6.404
v0.6.403
v0.6.402
v0.6.401
v0.6.400
v0.6.399
v0.6.398
v0.6.397
v0.6.396
v0.6.395
v0.6.394
v0.6.393
v0.6.392
v0.6.391
v0.6.390
v0.6.389
v0.6.388
v0.6.387
v0.6.386
v0.6.385
v0.6.384
v0.6.383
v0.6.382
v0.6.381
v0.6.380
v0.6.379
v0.6.378
v0.6.377
v0.6.376
v0.6.375
v0.6.374
v0.6.373
v0.6.372
v0.6.371
v0.6.370
v0.6.369
v0.6.368
v0.6.367
v0.6.366
v0.6.365
v0.6.364
v0.6.363
v0.6.362
v0.6.361
v0.6.360
v0.6.359
v0.6.358
v0.6.357
v0.6.356
v0.6.355
v0.6.354
v0.6.353
v0.6.352
v0.6.351
v0.6.350
v0.6.349
v0.6.348
v0.6.347
v0.6.346
v0.6.345
v0.6.344
v0.6.343
v0.6.342
v0.6.341
v0.6.340
v0.6.339
v0.6.338
v0.6.337
v0.6.336
v0.6.335
v0.6.334
v0.6.333
v0.6.332
v0.6.331
v0.6.330
v0.6.329
v0.6.328
v0.6.327
v0.6.326
v0.6.325
v0.6.324
v0.6.323
v0.6.322
v0.6.321
v0.6.320
v0.6.319
v0.6.318
v0.6.317
v0.6.316
v0.6.315
v0.6.314
v0.6.313
v0.6.312
v0.6.311
v0.6.310
v0.6.309
v0.6.308
v0.6.307
v0.6.306
v0.6.305
v0.6.304
v0.6.303
v0.6.302
v0.6.301
v0.6.300
v0.6.299
v0.6.298
v0.6.297
v0.6.296
v0.6.295
v0.6.294
v0.6.293
v0.6.292
v0.6.291
v0.6.290
v0.6.289
v0.6.288
v0.6.287
v0.6.286
v0.6.285
v0.6.284
v0.6.283
v0.6.282
v0.6.281
v0.6.280
v0.6.279
v0.6.278
v0.6.277
v0.6.276
v0.6.275
v0.6.274
v0.6.273
v0.6.272
v0.6.271
v0.6.270
v0.6.269
v0.6.268
v0.6.267
v0.6.266
v0.6.265
v0.6.264
v0.6.263
v0.6.262
v0.6.261
v0.6.260
v0.6.259
v0.6.258
v0.6.257
v0.6.256
v0.6.255
v0.6.254
v0.6.253
v0.6.252
v0.6.251
v0.6.250
v0.6.249
v0.6.248
v0.6.247
v0.6.246
v0.6.245
v0.6.244
v0.6.243
v0.6.242
v0.6.241
v0.6.240
v0.6.239
v0.6.238
v0.6.237
v0.6.236
v0.6.235
v0.6.234
v0.6.233
v0.6.232
v0.6.231
v0.6.230
v0.6.229
v0.6.228
v0.6.227
v0.6.226
v0.6.225
v0.6.224
v0.6.223
v0.6.222
v0.6.221
v0.6.220
v0.6.219
v0.6.218
v0.6.217
v0.6.216
v0.6.215
v0.6.214
v0.6.213
v0.6.212
v0.6.211
v0.6.210
v0.6.209
v0.6.208
v0.6.207
v0.6.206
v0.6.205
v0.6.204
v0.6.203
v0.6.202
v0.6.201
v0.6.200
v0.6.199
v0.6.198
v0.6.197
v0.6.196
v0.6.195
v0.6.194
v0.6.193
v0.6.192
v0.6.191
v0.6.190
v0.6.189
v0.6.188
v0.6.187
v0.6.186
v0.6.185
v0.6.184
v0.6.183
v0.6.182
v0.6.181
v0.6.180
v0.6.179
v0.6.178
v0.6.177
v0.6.176
v0.6.175
v0.6.174
v0.6.173
v0.6.172
v0.6.171
v0.6.170
v0.6.169
v0.6.168
v0.6.167
v0.6.166
v0.6.165
v0.6.164
v0.6.163
v0.6.162
v0.6.161
v0.6.160
v0.6.159
v0.6.158
v0.6.157
v0.6.156
v0.6.155
v0.6.154
v0.6.153
v0.6.152
v0.6.151
v0.6.150
v0.6.149
v0.6.148
v0.6.147
v0.6.146
v0.6.145
v0.6.144
v0.6.143
v0.6.142
v0.6.141
v0.6.140
v0.6.139
v0.6.138
v0.6.137
v0.6.136
v0.6.135
v0.6.134
v0.6.133
v0.6.132
v0.6.131
v0.6.130
v0.6.129
v0.6.128
v0.6.127
v0.6.126
v0.6.125
v0.6.124
v0.6.123
v0.6.122
v0.6.121
v0.6.120
v0.6.119
v0.6.118
v0.6.117
v0.6.116
v0.6.115
v0.6.114
v0.6.113
v0.6.112
v0.6.111
v0.6.110
v0.6.109
v0.6.108
v0.6.107
v0.6.106
v0.6.105
v0.6.104
v0.6.103
v0.6.102
v0.6.101
v0.6.100
v0.6.99
v0.6.98
v0.6.97
v0.6.96
v0.6.95
v0.6.94
v0.6.93
v0.6.92
v0.6.91
v0.6.90
v0.6.89
v0.6.88
v0.6.87
v0.6.86
v0.6.85
v0.6.84
v0.6.83
v0.6.82
v0.6.81
v0.6.80
v0.6.79
v0.6.78
v0.6.77
v0.6.76
v0.6.75
v0.6.74
v0.6.73
v0.6.72
v0.6.71
v0.6.70
v0.6.69
v0.6.68
v0.6.67
v0.6.66
v0.6.65
v0.6.64
v0.6.63
v0.6.62
v0.6.61
v0.6.60
v0.6.59
v0.6.58
v0.6.57
v0.6.56
v0.6.55
v0.6.54
v0.6.53
v0.6.52
v0.6.51
v0.6.50
v0.6.49
v0.6.48
v0.6.47
v0.6.46
v0.6.45
v0.6.44
v0.6.43
v0.6.42
v0.6.41
v0.6.40
v0.6.39
v0.6.38
v0.6.37
v0.6.36
v0.6.35
v0.6.34
v0.6.33
v0.6.32
v0.6.31
v0.6.30
v0.6.29
v0.6.28
v0.6.25
v0.6.24
v0.6.23
v0.6.22
v0.6.21
v0.6.20
v0.6.19
v0.6.18
v0.6.17
v0.6.16
v0.6.15
v0.6.14
v0.6.12
v0.6.11
v0.6.10
v0.6.9
v0.6.8
v0.6.7
v0.6.6
v0.6.5
v0.6.4
v0.6.3
v0.6.2
v0.6.1
v0.6.0
v0.5.7
v0.5.6
v0.5.5
v0.5.4
v0.5.3
v0.5.2
v0.5.1
v0.5.0
v0.4.12
v0.4.11
v0.4.10
v0.4.9
v0.4.8
v0.4.7
v0.4.6
v0.4.5
v0.4.4
v0.4.3
v0.4.2
v0.4.1
v0.3.30
v0.3.29
v0.3.28
v0.3.27
v0.3.26
v0.3.25
v0.3.24
v0.3.23
v0.3.22
v0.3.21
v0.3.20
v0.3.19
v0.3.18
v0.3.17
v0.3.16
v0.3.15
v0.3.14
v0.3.13
v0.3.12
v0.3.11
v0.3.10
v0.3.9
v0.3.8
v0.3.7
v0.3.6
v0.3.5
v0.3.4
v0.3.3
v0.3.2
v0.3.1
v0.3.0
v0.2.7
v0.2.6
v0.2.5
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.0.3
v0.0.2
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".
No due date set.
Dependencies
No dependencies set.
Reference: Cordy/Cairn#297
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Phase 2 of #295 (phasing decision 2026-08-20: native formats ship first).
Approach — client-side, sovereign, no conversion server:
Constraints:
web/static/vendor/(served from the Go binary via the existing static embed) — no CDN, LAN + air-gapped instances must work.<script>injection on first office preview — keeps initial page weight unchanged (~1 MB total across the three libs, cached after first use).NOTICE/credits section.Legacy binary formats (.doc/.xls/.ppt) stay download-only.
Office previews are now implemented and live on the dogfoods (v0.6.70).
Shipped (all vendored, no CDN — served from Cairn's own origin behind auth, lazy-loaded on first use, each falling back to the existing "No preview" card on error):
i / Ncounter. PR #319, v0.6.70.Verification note: each PR was
node --check-gated in CI, but functional rendering fidelity needs a logged-in browser with real files — that's an operator visual check on the dogfood. Every renderer call is defensively wrapped so an unrenderable file degrades to the download card rather than breaking the panel.Remaining / suggested follow-up (leaving this open for it):
.doc,.ppt,.odt,.odp— are worth additional converters. They currently still fall through to the download card.Deep dive 2026-09-04: the "docx broken" report, legacy formats, and the conversion question.
1. The reported regression is not one
Verified live on cairn-openbao (browser session, console + network instrumented): docx preview renders, no errors, vendor bundles served. The operator's failure coincided with the v0.6.122/123 rollout window — Recreate wiped the session, the preview's blob fetch failed, and the catch path displayed
pvNoPreview, whose copy claims "No preview for this file type". Two real defects fall out:pvNoPreviewin their catch blocks (index.html ~4787/4817/4862). A transient failure masquerades as a capability gap. Fix: dedicatedpvRenderFailedcopy + a Retry button.inWrapper+ width capping).2. Legacy formats (.doc, .ppt, .odt, .odp) — the "easy win" isn't, client-side
So client-side has reached its ceiling. The industry answer for legacy (and for print-grade fidelity generally) is server-side conversion to PDF, feeding the existing PDF viewer:
Costs and constraints (Pi-class honesty): a LibreOffice-based converter is a ~1 GB image, ~200–500 MB RAM idle, spikes to ~1 GB per conversion, 1–6 s per typical document, and LibreOffice's internal lock serialises conversions per instance (scale = more replicas). Security: it parses hostile documents — containerised, no network egress, tight limits, treat as untrusted-input surface. On this cluster it belongs on the x86 Proxmox side as one shared service, not per-Pi.
Sovereignty fit: all self-hosted, but a hard dependency would break the single-binary ethos — so it must be an optional
preview.converterUrl-style config. Unconfigured ⇒ legacy formats keep today's download card. Cache converted PDFs (bounded, ETag-keyed, local scratch — never written plaintext to the backend, which holds ciphertext only).Rejected: vendoring WebODF (AGPL + dead), client-side .doc (does not exist), full WOPI editor suites (heavyweight editors, not previews; licensing/seat limits).
3. Recommendation, tiered
sofficesidecar as the minimal alternative) → convert doc/ppt/odt/odp → PDF → existing viewer. Also gives a "high fidelity" path for complex docx/pptx that the JS renderers butcher. Design-first: mockup the converting/unconfigured/failed card states before building.Decision 2026-09-04 — blessed by Nikola, design-first.
pvNoPreviewcopy — unknown-type card stays; render/fetch failures get their own "Preview failed" copy + Retry. Scale-to-fit for the docx render.converter.*values block (renders Deployment + ClusterIP Service, optional NetworkPolicy, injectsCAIRN_PREVIEW_CONVERTER_URL, orurlto reuse an external instance) and docker-compose service underprofiles: ["preview"]with no published ports. Env override wins over config.json (CAIRN_LICENSE_KEY precedent).Order: mockups of the preview panel states → tier-1 fixes → converter client + packaging + docs.
Tier 1 shipped — v0.6.124 (PR #420, merged; both dogfoods rolled at 02:13 UTC).
pvFail, re-runsrenderPvBodyin place). "No preview for this file type" survives only on the genuinely-unpreviewable path — one use left in the file, verified by post-condition.pvFitzooms.docx-wrapperto the panel width and re-fits on panel resize (ResizeObserver).pvFailTitle/pvFailBody/pvRetry×4 locales.Remaining on this issue: converter service (client +
CAIRN_PREVIEW_CONVERTER_URL+ per-format routing), Helmconverter.*block + composepreviewprofile, handbook docs. Mockups approved (states A–E, single Download button in the footer only).Converter shipped end-to-end — v0.6.125 (PRs #421 code, #422 packaging+docs; both dogfoods rolled at 03:33 UTC).
Code (
internal/preview+internal/api/convert.go): Gotenberg-compatible client with streaming multipart upload, version-keyed bounded disk cache (path+ETag+size+mtime;preview.cacheMB, default 200, oldest-evicted), per-key single-flight, 2-min timeout, 100 MB source cap. EndpointsGET /api/v1/preview/formats(boot probe) andGET /api/v1/preview/pdf(auth'd, inline PDF, records recents, 502 on converter failure). Configpreview.converterUrl/convertFormats/cacheDir/cacheMB; envCAIRN_PREVIEW_CONVERTER_URLwins. Test suite: cache hit, single-flight (1 upstream call for 2 concurrent viewers), eviction order, error path caches nothing, URL-route rules.Frontend:
feat.convertprobe; converting card → converted PDF in the existing viewer with "Converted preview" chip; legacy formats without a converter get the honest card + admin-only deployment-guide link; failures land on the retryable card. Default routing doc/ppt/odt/odp/rtf/docx/pptx (Nikola's call after the scale-to-fit fix still looked poor on template-heavy docx); spreadsheets stay client-side, overridable both ways.Packaging: Helm
converter.*(default off; Deployment + ClusterIP + optional NetworkPolicy; env injection;converter.urlto share one converter across releases; chart 0.2.0/appVersion v0.6.125). Composeprofiles: ["preview"], no published ports.Docs: deployment.md "Preview converter" — trust model (single plaintext hop, converter sees no keys/backend), config table, Helm/compose/bare-binary walkthroughs, security notes. Anchor
#preview-convertermatches the UI admin hint.Not yet done: no converter instance deployed for the dogfoods — currently both instances show the new legacy card on .doc/.odt and keep client renderers for docx/pptx. Deploying one (shared, x86 side) + setting the env on both is the remaining dogfood step.
Decision + shipped — packaging defaults flipped (v0.6.126, PR #424). Nikola's product line, recorded: either fully in Kubernetes or fully in Docker — the packaged paths are batteries-included, the bare binary stays the converter-less minimal floor.
converter.enabled: trueby default (chart 0.3.0). Opt-out one line;networkPolicystays default-false (CNI-dependent), recommended true in docs.CAIRN_PREVIEW_CONVERTER_URLwired; profile removed. Opt-out = delete the service + env line.gotenberg/gotenberg:8from Docker Hub (airgapped/private-registry installs mirror the image or disable; a blocked pull leaves the converter in ImagePullBackOff while Cairn runs fine), and the default footprint grows by ~1 GB image + a 1 Gi-limit workload.Dogfood converter (previous session step, for the record): shared
cairn-converter(gotenberg:8) runs in k3s nscairnon the workers — ClusterIP only, requests 100m/256Mi, limits 1000m/1Gi, nodeAffinity off the control planes, deliberately not critical-tier. Both instances logpreview converter enabled endpoint=http://cairn-converter:3000/forms/libreoffice/convert formats=[doc ppt odt odp rtf docx pptx].Still open on this issue: visual verification of converted previews on the dogfoods (docx/pptx/odt/doc through the PDF viewer), then #297 can close.
Closing — visually verified by Nikola on the dogfoods (2026-09-05): converted previews render cleanly through the PDF viewer with the chip; caching makes reopens instant.
Final state of this issue, shipped across v0.6.124–v0.6.127:
internal/previewclient (version-keyed bounded cache, single-flight),/api/v1/preview/formats+/api/v1/preview/pdf, frontend routing with converting/converted/legacy/failed states, default formats doc/ppt/odt/odp/rtf/docx/pptx (spreadsheets client-side, overridable).cairn-converterin k3s serving both instances; false-alert ServiceMonitor overlap fixed same day in homelab-config.Legacy support (.doc/.ppt/.odt/.odp/.rtf) and the modern-format fidelity pivot both land through the converter path — the client-side-renderer-only era of this issue is over.