Compare commits

...
34 Commits
Author SHA1 Message Date
james.maesandClaude Fable 5.2 589b6d41ee fix(renderer): scene 2 text after independent review: a proof that never cuts, a bounded shrink search, named refusals
maven / build (push) Successful in 10m28s
build / maven (push) Successful in 10m28s
The proof of `maxLength`
- The proof never cuts. With `overflow: truncate` the proof was given a cut
  block, which counts as fitting, so a bound element whose box held ten
  characters validated clean with `maxLength: 40` and every long value was cut
  at print. The proof now runs with cutting off. When it fails, an element
  that did not ask for cutting is refused as before; one that did still
  validates, since cutting is what its author chose, with the warning
  FIT_NOT_PROVEN at every validation carrying `measured.provenCharacters`,
  the longest length proven to fit whole (found by halving: fewer characters
  never fit worse), against `limit.characters`. No new code: FIT_NOT_PROVEN
  already means that the fit of a bound value is not proven.
- A bound element with `maxLength` is judged for legibility, when validated,
  at the size the proof shrank to (the floor when it fails and the element
  cuts), not at its stated size.

The shrink search
- The size chosen is still exactly the one a search of every quarter-point
  step gives, but that search is no longer made. A count that errs only
  toward yes says whether a size could hold the text: lines filled at any
  character, each held to a width no real line can be under, and a block to
  its lines' ascent, pitches and descent. It never refuses a size that fits
  and, once it allows a size, allows every smaller one, so the largest size it
  allows is found by halving and only the steps from there are laid out. When
  one line at the floor is higher than the box nothing is searched, and a cut
  tries no line count the box is too low for.
- 1024 characters at 600 dpi from 1000 pt to 1 pt took 180 to 250 ms a fit and
  now takes under 1 ms: at most 21 555 characters visited where the search of
  every size visits 15.6 million.
- A text is fitted once: what `check` composed is what `paint` draws.
- The text of one scene may take 64 million steps (a character visited while
  fitting is one, a character to be drawn 16, a glyph the scene draws for the
  first time at a size 4096, since the runtime rasterises it once). The
  element that passes it, and every text after it, is SCENE_INVALID at the
  element with `textWorkSteps`, as the painted-area limit is. The count is
  integer arithmetic: the same on every machine, and the same validated or
  rendered. A thousand of the worst elements validate in well under a second.

Ink outside the measure
- TEXT_INK_OUTSIDE_MEASURE was an IllegalStateException thrown while
  painting, which failed the whole render after part of the text was on the
  label. The dots of a text are now gathered first and reach the label only
  when none strayed; otherwise the one element is refused as
  TEXT_DOES_NOT_FIT with `glyphsOutsideMeasure` and `dotsOutsideMeasure`. A
  literal is held to the glyph bounds when the scene is validated.
- The bound is tested at 1, 2, 300 and 1000 pt as well as from 5 to 72 pt, for
  every character of every face at the three resolutions; nothing strays.

Schema and vocabulary
- `fit` declares `maxLines`, `shrinkTo` and `overflow` under `properties` with
  `additionalProperties: false`. The three names are in the renderer's and the
  host bridge's pointer vocabularies, and a wrong member is reported at the
  member (`/elements/3/fit/maxLines`, or in the override that states `fit`).
- A bound number is printed as the schema says: plain decimal digits, no
  exponent, no fraction that is only zeros (`1.0E10` prints `10000000000`,
  `2.50` prints `2.5`). A number that is not finite is VALUE_MISSING.

Tests
- The widest-advance check covers every character a face draws, inked or not
  (a no-break space advances the pen), so a font update cannot break the proof
  unseen.
- Property: `fit` equals the search of every size, block for block, over 3600
  generated texts, boxes, sizes, floors and line counts.
- The goldens are unchanged. A README beside them records the JDK builds and the
  FreeType each ships.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 14:58:53 -06:00
james.maesandClaude Fable 5.2 f5acf93e3d feat(renderer): scene 2 text: bundled faces, measurement before drawing, stated fit rules (P2)
maven / build (push) Successful in 10m16s
build / maven (push) Successful in 10m16s
A version 2 `text` element is now drawn. It replaces the placeholder that
parsed and placed a text and refused it as RENDERER_TOO_OLD.

What a scene can say
- `font` names one of the five bundled faces (or comes from `defaults`); any
  other name is FONT_UNKNOWN. There is no printer font and no installed font.
- `size` is the em as a physical length (1 pt to 1000 pt), not rounded to dots.
- `value` or `valuePath`; `align`/`valign` place the block in the box and each
  line in the block; `lineHeight`, `rotation`, `reverse`, `threshold`.
- `fit`: one line by default, shrunk in quarter-point steps to 70% of the size
  (not below 5 pt), then refused. Opt in to more lines (`maxLines`) and to
  cutting with an ellipsis (`overflow: truncate`).
- `maxLength`: validation proves the longest value fits, so a length refusal
  happens when a scene is published; printing refuses a longer value first.

How it is measured and drawn
- Measurement is integer arithmetic on the face's own numbers (thousandths of
  the em, read once at a reference size), so it is the same on every machine.
  Every character sits at a whole-dot pen position and is drawn there by the
  Java rasteriser that version 1 raster text uses, then reduced to ink at the
  threshold. A line's box is its advance widened to its ink plus two dots a
  side; a render whose ink would leave it fails instead of clipping.
- At each size a line is broken between words while that fits and at any
  character when it does not, which is also what makes a length provable.
- One glyph for each character, left to right: no kerning, ligatures, mark
  placement or bidirectional text. A character that cannot be drawn that way
  is FONT_MISSING_GLYPH with a count.

Diagnostics (ids and numbers only; no value ever enters one)
TEXT_DOES_NOT_FIT, VALUE_MISSING, VALUE_TOO_LONG, FONT_UNKNOWN,
FONT_MISSING_GLYPH, RESERVED_FONT_NAME; TEXT_TRUNCATED, TEXT_SMALL_FOR_DPI,
TEXT_LIGHT_FACE, FIT_NOT_PROVEN; TEXT_SHRUNK, TEXT_WRAPPED.

Core seams added: `ElementSource.inherit` gives an element the scene's
`defaults` for the properties its type reads, and `ElementSource.refuse`
raises a coded refusal at a property (FONT_UNKNOWN at the place that names
the face, in the element, the defaults or an override).

Tests: goldens for the five faces and for fit, rotation and reverse at 203,
300 and 600 dpi, generated in the CI image (Linux, Temurin 21.0.9) and the
same bytes on Windows (21.0.12) and on Linux Temurin 21.0.13; every character
of every face drawn inside its measured line; seeded property tests of fit
(never shrunk when it fits, the largest size that fits, never below the floor,
never more lines than allowed, cut only when asked and always with the mark,
a proven length never refused); licence, provenance and hash of every face;
the version 2 mutation campaign extended to text. The version 1 corpus is
untouched. 100% line coverage of the scene 2 packages.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 13:37:13 -06:00
james.maesandClaude Fable 5.2 d3378825d7 feat(renderer): bundle five OFL fonts for version 2 label text
Version 2 label scenes draw text in faces shipped inside the renderer, so a
label needs no printer font, no installed font and no object storage:

  qqq-sans, qqq-sans-bold   IBM Plex Sans Regular and Bold (@ibm/plex-sans@1.1.0)
  qqq-condensed-bold        IBM Plex Sans Condensed Bold (@ibm/plex-sans-condensed@2.0.0)
  qqq-mono, qqq-mono-bold   JetBrains Mono Regular and Bold (v2.304)

The files are unmodified, taken from each project's official release archive.
Each licence was confirmed as the SIL Open Font License 1.1 from the archive's
own licence file, which is shipped byte for byte beside the fonts with a
provenance note (release, archive URL and hash, path in the archive, font
version). /fonts/SHA256SUMS lists the hashes. git is told never to rewrite
anything under /fonts.

THIRD-PARTY.md and NOTICE record the fonts. The OFL is not on the K22-DEP-02
allowlist; the maintainer approved one recorded exception for unmodified OFL
fonts shipped as data, and the register entry is proposed with the pull request.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 13:26:38 -06:00
james.maes bb25d6c46a Merge pull request 'feat(bridge): accept renderer 0.2.0, structured diagnostics, ZplRaster and preview; render target dpi end to end (P5, P7)' (#15) from feat/bridge-preview into develop
maven / build (push) Successful in 10m58s
build / maven (push) Successful in 10m58s
2026-11-12 18:28:12 +00:00
james.maesandClaude Fable 5.2 bf546e16c5 feat(bridge): accept renderer 0.2.0, read its diagnostics, preview a label (P5)
maven / build (push) Successful in 12m32s
build / maven (push) Successful in 12m32s
On develop the renderer speaks qqq-renderer-0.2.0 and the bridge accepted
only 0.1.0, so the bridge refused its own renderer, a label could not be
previewed, and a render target was accepted and then ignored.

The version rule (RendererVersion). The bridge accepts 0.1.0 (the released
fields, the 13 released refusals) and 0.2.0 (the same with diagnostics and
detail, those refusals and the 15 scene refusals); any other version is
rejected. Each set is written out, replacing the temporary enum range. A
job is framed as 0.1.0 reads it unless it needs more. Before a job only
0.2.0 can do (a version 2 scene, a preview) the bridge asks the worker its
version by validating a fixed, empty version 1 scene, so an old image is
refused as RENDERER_TOO_OLD and receives nothing of the scene or the
record; an answer from 0.1.0 to such a job is refused whatever it says.

Diagnostics (WorkerAnswer, SceneFacts). A version 2 refusal is
RenderException(code, diagnostic). The worker is untrusted, so every field
is checked again: the closed vocabulary, whole numbers in bounds, an
element only if the scene that was sent declares it, and a pointer only of
array indexes, schema property names and declared ids. An answer holds at
most 2048 diagnostics in one megabyte beside its label, and no frame
passes the frame of the largest document the deployment admits. A refused
answer that carries any part of a label is rejected.

Render target. targetDpi is sent with a version 2 scene and the label is
held by the output policy to the page at that resolution. A version 1
scene or a PDF asked for another resolution than its stock's is refused as
TARGET_REQUIRES_SCENE_2 before any worker is contacted, because renderer
0.1.0 does not read the field. supportsRenderTarget() is true.

Preview. preview() is the print path stopped before retention: the same
job with collected diagnostics, the same integrity checks and output
policy, and a page decoded by ZplRaster from the accepted label bytes.
ZplRaster is its own strict reader of the policy's grammar and runs the
policy first; it paints ^GFA and ^GB exactly, hatches printer font text
(the page is then not exact) and writes a one-bit PNG itself. Refusals
come back as diagnostics, never as a label. A refused scene is drawn on
the host from the diagnostics' boxes alone: the worker sends no label for
it and the wire gains no field for the partial canvas, so no host can
print a label with elements missing. The design records the decision in
sections 6.1 and B.1, the version question in 11.3 and what the host now
reads from a scene in 8.1.

renderer/qualification.json said qqq-renderer-0.1.0 and qqq-barcodes-1;
it now says what the worker reports, and a test holds it to the answer.

The mutation campaign covers the page decoder and the answer frames. The
new classes are gated at 100% line coverage and the bundle gate rises to
the measured 90% of instructions and 88% of lines. The version 1 corpus is
untouched.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 12:02:54 -06:00
james.maesandClaude Fable 5.2 9b908ac516 feat(foundation): a generation request names its render target (P7)
A request could not say which printer resolution to render a label for:
RenderRequest.targetDpi existed and nothing set it.

DocumentGenerationService.Request gains a trailing targetDpi (absent, 203,
300 or 600; every earlier constructor stays and means none). It is stored
in a new nullable column, target_dpi, on document_generation_request,
compared on retry and lookup beside destination, media and copies, framed
into the intent digest as target-dpi/v1 when stated, and passed to the
renderer. A request without a target has exactly the digest it had, so
earlier rows and their retries are unchanged; the same key with another
target, or with none, is another intent.

Nobody who asks for 300 dpi may silently get another resolution, so a
target is refused before any row exists when it cannot be honoured: for a
PDF, and for any renderer that does not declare the new
IsolatedRenderer.supportsRenderTarget() (false by default, so an adapter
written before the target cannot be handed one and ignore it).

A host applies one statement, from the shipped script for its database:
db/migrations/20261112-render-target-dpi-{h2,mysql,postgres}.sql
(ALTER TABLE document_generation_request ADD COLUMN target_dpi INTEGER
NULL). The generate process form offers the target and the request status
shows it. Batches, the queue and reprints carry none.

Also from the review of the ports: RenderRequest and PreviewRequest hold
their own unmodifiable copy of the context (null values allowed) and
print only their format and render target (and the request id), never the
record data or the template source. Neither wire form changes.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 12:02:38 -06:00
james.maes 595d094ec8 Merge pull request 'feat(renderer): scene 2 core: labels in physical units, one canvas, structured diagnostics (P1)' (#14) from feat/scene2-core into develop
maven / build (push) Successful in 7m15s
build / maven (push) Successful in 7m15s
2026-11-12 17:11:17 +00:00
james.maesandClaude Fable 5.2 58051e7b99 fix(renderer): scene 2 core: the findings of the independent review
maven / build (push) Successful in 11m29s
build / maven (push) Successful in 11m29s
1. A length too long for any stock is a named refusal. Length.parse
   narrowed the micrometres to an int before it applied the 2 m limit, so
   "84600in" or "99999in" threw ArithmeticException: the opaque
   RENDER_FAILED, and an error instead of a REFUSED answer when collecting.
   The limit is now compared in long before narrowing, so it is
   SCENE_INVALID at the pointer of the length.

2. The printable area holds a box of its own size at every resolution. It
   was floor(far edge) less ceil(near margin), which can be one dot smaller
   than a box of the stated printable width: 100 mm stock with 3 mm margins
   and a 94 mm box fitted at 203 and 600 dpi and was refused at 300. It is
   now floor((W - L - R) x dpi) by floor((H - T - B) x dpi), the rounding of
   a box size, starting at ceil(L x dpi), ceil(T x dpi), moved back one dot
   where it would otherwise pass the page edge. New golden case `margins`
   with fractional-dot margins; the three existing goldens at 600 dpi are
   regenerated (the area grew by one dot each way; 203 and 300 unchanged).

3. The version 2 mutation campaign accepts only a Refusal (the package's
   own invariants are IllegalArgumentExceptions too) and renders about one
   input in four, reading the label back and comparing with validation. It
   found nothing at 20000 or 100000 iterations for either seed.

4. A refused answer carries no label bytes: with COLLECT and an error the
   answer had base64 of a label with elements missing. Scene2.render answers
   no label for a refused scene and the answer has no document fields. This
   changes the wire contract of section B.1 of the design, which records it.

5. One scene may paint sixteen times its printable area, an overlap counted
   each time, counted before any ink and in validation too. The element
   that would pass it is SCENE_INVALID with measured.paintedPercent against
   limit.paintedPercent 1600. 1000 fills of a 64 million dot canvas were
   8 GB of byte writes; the worst scene is now 128 MB.

6. The README states what changed in the version 1 answer envelope in
   0.2.0 (diagnostics on every answer; SCENE_INVALID with detail where
   unreadable JSON and a missing or unknown schema were RENDER_FAILED) and
   what the bridge must handle. The version 1 ZPL bytes are unchanged.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 10:59:20 -06:00
james.maesandClaude Fable 5.2 1992fdf703 perf(renderer): paint a canvas box a byte of dots at a time
maven / build (push) Successful in 13m51s
build / maven (push) Successful in 13m51s
A scene may hold 1000 elements and a canvas 64 million dots, so a scene of
many large filled boxes visited tens of billions of dots one at a time.
Filling and reversing a box now write whole bytes, check the box against
the canvas before any dot changes (a box that leaves the canvas paints
nothing rather than its first rows), and a seeded property test holds the
result to painting each dot, at byte boundaries as everywhere else. The
goldens are unchanged.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 10:07:48 -06:00
james.maesandClaude Fable 5.2 ad6b0ffa88 feat(renderer): scene 2 core: layout in physical units, one canvas, diagnostics (P1)
A source with schema qqq-zpl-scene/2 is a label layout in millimetres,
inches, points, percentages and dots that renders at 203, 300 or 600 dpi.
The worker routes by the schema alone: version 1 takes exactly the path it
always took (the compatibility corpus is unchanged and green), version 2
takes the new package com.kingsrook.qbits.renderer.scene2, and anything
else is refused by name.

- Length: parse, whole micrometres, dots by the rule of each use
  (position nearest, box size down, thickness nearest and at least one,
  module up, font size not rounded).
- Layout: nine-point anchors, offsets inward from the anchored edge,
  omitted sizes, content alignment, groups four deep, percentages of the
  container. Coordinates start at the top left of the printable area.
- Canvas and ZplEmitter: the whole label on one 1-bit canvas, emitted as
  trimmed ^GFA bands that pass the unchanged ZplOutputPolicy.
- Diagnostics: every refusal is one diagnostic with a code, the element
  id, the box and named integers; SCENE_INVALID carries a JSON pointer.
  A diagnostic names only an id the scene declares and points only
  through schema names, indexes and declared ids.
- box and group elements; overrides by resolution, checked for all three
  resolutions; samples accepted and ignored. Text, barcodes and images
  are parsed and placed and then refused as RENDERER_TOO_OLD by
  placeholder factories in their own sub-packages.
- Renderer 0.2.0: optional targetDpi and "diagnostics": "COLLECT" on the
  request, diagnostics on the answer, detail on a version 2 error, the
  REFUSED outcome, and INSPECT_ASSET and UPGRADE_SCENE routed and refused
  as UNSUPPORTED_OPERATION. A version 1 scene with a target other than
  its stock's dpi is refused as TARGET_REQUIRES_SCENE_2.

Tests: every length and rounding rule; all nine anchors; seeded property
tests (mirrored anchors, boxes never leave the printable area, the bitmap
rebuilt from the emitted fields equals the canvas); goldens at three
resolutions as pictures and as ZPL, the ZPL also checked against the host
gate in bridges/renderer; every refusal asserted as the whole diagnostic;
a mutation campaign over the version 2 parser. The new package is at 100%
line coverage.

Also, from the review of the foundations: the mutation campaigns accept
only declared refusals (a NullPointerException in a parser is now a
finding), git no longer treats the stored corpus as text, and both
compatibility tests pin the digest of the corpus manifest.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 10:01:21 -06:00
james.maesandClaude Fable 5.2 4cd2f93e37 feat(foundation): a diagnostic carries the pointer of SCENE_INVALID
The design says SCENE_INVALID carries the JSON pointer of the offending
property, and GenerationPorts.Diagnostic had no field for one. It gains an
optional seventh component, pointer, held to the shape of at most sixteen
segments that are array indexes or names; the six-argument constructor
stays, so existing callers compile unchanged. The renderer builds a
pointer only from schema property names, indexes and declared element ids.

Section 8.1 of the design records this decision and the others made while
building the scene 2 core.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-12 10:01:20 -06:00
james.maes f4342e345b Merge remote-tracking branch 'origin/docs/label-layout-preview-design' into feat/scene2-core 2026-11-12 09:24:59 -06:00
james.maes fda9ad0de6 Merge pull request 'feat: scene 2 foundations: version 1 compatibility corpus, coverage and fuzz gates, preview ports (P0, P13, P6a)' (#13) from feat/scene2-foundations into develop
maven / build (push) Successful in 10m41s
build / maven (push) Successful in 10m41s
2026-11-12 15:15:18 +00:00
james.maesandClaude Fable 5.2 c6aa0bf6b0 feat(foundation): preview, diagnostic and render target ports with registration hooks (P6a)
maven / build (push) Successful in 6m19s
build / maven (push) Successful in 6m19s
The contracts the preview, bridge and render target packages plug into. No
label prints differently and no existing host adapter changes.

GenerationPorts:
- Diagnostic (with Severity): a code from a closed vocabulary, an author
  element id, a box and named integers. It has no field that holds free text.
- PreviewRequest, PreviewPage and Preview, and IsolatedRenderer.preview as a
  default that refuses, so an adapter written before it compiles unchanged.
- 15 version 2 FailureCode values after the 13 released ones, and
  RenderException(FailureCode, Diagnostic) beside the existing constructor.
- Integer targetDpi on RenderRequest (absent, 203, 300 or 600); the
  seven-argument constructor is kept and nothing reads the value yet.

Registration points, each an empty class that is already called:
GenerationPreviewProcesses, GenerationAssetProcesses,
GenerationUpgradeProcesses and GenerationAssetTables from the producer, and
GenerationPreviewWidget.section(table) from GenerationTables.

Bridge: IsolatedRendererBridge maps any FailureCode name from a 0.1.0 worker
to a typed refusal, so growing the enum alone would have widened what such a
worker can name. The 13 released codes are now the set a 0.1.0 worker may
name; BridgeTest asserts the other 15 stay generic.

Tests: record validation, default refusals, source compatibility of the
existing constructors, and that the producer registers exactly the tables,
processes, choices, widgets and template sections it did before (the lists
were captured from the untouched v1.1.0-RC.2 tag).

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-11 17:28:43 -06:00
james.maesandClaude Fable 5.2 3ba676106f build(coverage): gate renderer and bridge coverage at baseline; seeded mutation campaigns (P13)
Coverage gates:
- renderer and bridges/renderer gain JaCoCo (prepare-agent, report, check at
  verify) with a bundle rule at the measured baseline, rounded down: renderer
  94% instructions and 91% lines, bridge 85% instructions and 82% lines.
- New code is held to 100% line coverage from its first commit: packages
  com.kingsrook.qbits.renderer.scene2 and below, AssetInspector, ZplRaster,
  and the new foundation classes the label layout design names. The rules
  match nothing until those exist, so later packages do not edit these poms.
- The foundation's 85% instruction and 90% class rule is unchanged.

Fuzz scaffolding:
- MutationCampaign in each module's test tree: a seeded, bounded mutation
  harness with no clock and no unseeded randomness; a finding replays from
  its seed and iteration.
- One campaign per module in the normal test phase: what the version 1 scene
  parser accepts is a version 1 scene (checked by a second parser), and what
  the host printer gate accepts holds only the renderer's command set.
- docs/security/fuzzing.md: targets, properties, limits, seeds and replay.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-11 17:28:42 -06:00
james.maesandClaude Fable 5.2 ea776391ca test(renderer): version 1 scene compatibility corpus from v1.1.0-RC.2 (P0)
Version 1 scenes (qqq-zpl-scene/1) are frozen. This adds 42 render requests
and the exact ZPL the released renderer returned for each, so later work can
prove that labels already printing are untouched.

- renderer/src/test/resources/compat-v1: cases, stored ZPL, SHA256SUMS and a
  README with provenance and rules. The bytes were produced by the source of
  tag v1.1.0-RC.2 (e9ffba48), not by this branch, and the same test passed
  against the tag on Temurin 21.0.12 (Windows) and 21.0.9 (the CI image).
- renderer ZplSceneOneCompatibilityTest: fails on the first differing byte,
  on a manifest that does not name exactly the cases, and on a corpus that
  misses a version 1 element type, property or resolution.
- bridges/renderer ZplSceneOneCompatibilityTest: every stored output has its
  manifest hash and passes the unchanged ZplOutputPolicy. It reads the
  renderer's directory in place, so there is one copy of the corpus.

Covered: the four shapes Forge publishes at 203 and 300 dpi (GS1-128 with
fit and quiet, text in font 0, rasterText with fontAsset), the README and
BARCODE-FIT.md examples, and one scene per element and option at 203, 300
and 600 dpi. All values are synthetic.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-11 17:28:25 -06:00
james.maesandClaude Fable 5.2 22063ccfb1 docs(design): labels in physical units, text and barcode fit, fonts everywhere, preview in the QBit
maven / build (push) Successful in 8m37s
build / maven (push) Successful in 8m37s
Design and work plan only; no code changes. Covers scene version 2 beside a frozen
version 1, bundled and database-stored fonts, whole-dot barcode fitting with
centring, structured diagnostics, a preview decoded from the validated ZPL, the
release order and what GG Forge pins and deletes.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-11 16:42:32 -06:00
CI 9a355670c0 Bump version to 1.4.0-SNAPSHOT [skip ci] 2026-11-10 23:13:57 +00:00
james.maes 228931a937 Merge pull request 'fix(postgres): accept full_page_writes off on Amazon Aurora PostgreSQL only' (#9) from fix/aurora-full-page-writes into develop
maven / build (push) Successful in 16m12s
build / maven (push) Successful in 16m12s
2026-11-10 22:57:56 +00:00
james.maesandClaude Fable 5.2 cfbf0744f9 fix(postgres): accept full_page_writes off on Amazon Aurora PostgreSQL only
maven / build (push) Successful in 6m14s
build / maven (push) Successful in 6m14s
Generation qualification refused every Amazon Aurora PostgreSQL server:
Aurora always reports full_page_writes = off and has no parameter to change
it, because its storage layer does not write torn pages.

The settings query now also returns
to_regprocedure('aurora_version()') IS NOT NULL (true on Aurora, false on
stock PostgreSQL, never an error). full_page_writes = off is accepted only
when that is true. Stock PostgreSQL must still report it on, and fsync on,
synchronous_commit on or remote_apply and every other check are unchanged
on both. The refusal text now says full-page writes are not required on
Aurora.

Tests run on a real postgres:17 engine whose settings are really changed;
only Aurora is simulated, by creating a function named aurora_version() in
the test database.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-09 20:25:55 -06:00
CI 1dc265647d Bump version to 1.3.0-SNAPSHOT [skip ci] 2026-11-09 02:46:35 +00:00
james.maes e762dac5d5 Merge pull request 'build(renderer): build engine and service images from a released version' (#7) from fix/renderer-images into develop
maven / build (push) Successful in 6m43s
build / maven (push) Successful in 6m43s
2026-11-09 02:39:57 +00:00
james.maesandClaude Sonnet 5.5 e19feb01a8 build(renderer): build the engine and service images from a released version
maven / build (push) Successful in 6m2s
build / maven (push) Successful in 6m2s
Both Dockerfiles copied 0.1.0-SNAPSHOT jars that the reactor no longer produces
(version is ${revision}), so neither built a released version. They now resolve the
released qbit-document-renderer and qqq-remote-renderer-transport (and their runtime
libraries) at an exact, required RENDERER_VERSION / TRANSPORT_VERSION from the
QRun-IO Gitea Maven registry and Maven Central, refusing SNAPSHOT and local
(*forge*) versions. The reviewed hardening is unchanged: digest-pinned
BUILD_IMAGE/JAVA_IMAGE, non-root 65532, read-only-root friendly, Zint built from
vendor/. The reactor build context is no longer needed.

Adds IMAGE-PUBLISH.md (repeatable build/scan/publish steps and the 1.0.0 pins) and
image-pins.sh (prints the gg-forge-cd classpath and SHA256 pins from a published
image). Images for 1.0.0 were built, smoke-tested over mTLS and published to GHCR
under gg-engineering by hand; no workflow publishes images.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-08 20:07:14 -06:00
CI d8a57607fd Bump version to 1.2.0-SNAPSHOT [skip ci] 2026-11-07 19:19:02 +00:00
james.maes 889296d8f5 Merge pull request 'build(deps): align with Gitea registry (parent 2.2.1, QQQ 4.1.0-RC.26)' (#6) from deps/align-gitea into develop
maven / build (push) Successful in 11m52s
build / maven (push) Successful in 11m52s
2026-11-07 19:07:22 +00:00
james.maesandClaude Opus 5.5 e085859a25 build(deps): move qqq.version into <properties>
maven / build (push) Successful in 7m0s
build / maven (push) Successful in 7m0s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 18:59:59 +00:00
james.maesandClaude Opus 5.5 4f850c2cf3 build(deps): align with Gitea registry (parent 2.2.1, QQQ 4.1.0-RC.26)
maven / build (push) Failing after 9s
build / maven (push) Failing after 9s
bridges/printing/pom.xml: qqq.version: 4.1.0-RC.22 -> 4.1.0-RC.26
bridges/printing/pom.xml: qbit-record-files.version: 0.1.0-RC.1 -> 0.4.0-RC.1
bridges/printing/pom.xml: qbit-printing.version: 1.0.0 -> 1.2.0-RC.1
bridges/record-files/pom.xml: qqq.version: 4.1.0-RC.22 -> 4.1.0-RC.26
bridges/record-files/pom.xml: qbit-record-files.version: 0.1.0-RC.1 -> 0.4.0-RC.1
bridges/scripting/pom.xml: qqq.version: 4.1.0-RC.22 -> 4.1.0-RC.26
bridges/scripting/pom.xml: qbit-scripting.version: 1.0.0 -> 1.1.0-RC.3
foundation/pom.xml: qqq.version: 4.1.0-RC.22 -> 4.1.0-RC.26
pom.xml: parent -> 2.2.1
pom.xml: added qqq.version=4.1.0-RC.26 (parent BOM import)
pom.xml: revision -> 1.1.0-SNAPSHOT

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 18:59:01 +00:00
CI f9adf1d3d3 Bump version to 0.3.0-SNAPSHOT [skip ci] 2026-11-06 23:35:57 +00:00
james.maes 2dcee6fbea Merge pull request 'ci: pin shared workflow to v1' (#4) from ci/pin-v1-develop into develop
QRun-IO/ci-policy: ci / fork-guard (push) Skipped
QRun-IO/ci-policy: native / fork-deny (push) Skipped
QRun-IO/ci-policy: native / dotnet-0 (push) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 9cb8c13124a99d18da83cbcd4faa795859ac9e55] (push) Successful in 9s
QRun-IO/ci-policy: native / native-result (push) Successful in 6s
QRun-IO/ci-policy: ci / head-profile (push) Skipped
QRun-IO/ci-policy: ci / repository-policy (push) Skipped
QRun-IO/ci-policy: ci / application-template-0 (push) Skipped
QRun-IO/ci-policy: ci / gradle-1 (push) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (push) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (push) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (push) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (push) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (push) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (push) Skipped
QRun-IO/ci-policy: ci / node-8 (push) Skipped
QRun-IO/ci-policy: ci / node-9 (push) Skipped
QRun-IO/ci-policy: ci / node-10 (push) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (push) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (push) Skipped
QRun-IO/ci-policy: ci / source-config-13 (push) Skipped
QRun-IO/ci-policy: ci / source-config-14 (push) Skipped
QRun-IO/ci-policy: ci / original-business (push) Skipped
QRun-IO/ci-policy: ci / original-voyage (push) Skipped
QRun-IO/ci-policy: ci / original-cli (push) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (push) Skipped
QRun-IO/ci-policy: ci / ci-result (push) Waiting to run
maven / build (push) Successful in 19m19s
build / maven (push) Successful in 19m19s
QRun-IO/ci-policy: ci / java-docker-3-head (push) Skipped
QRun-IO/ci-policy: ci / android-0 (push) Skipped
QRun-IO/ci-policy: ci / original-mcp (push) Skipped
QRun-IO/ci-policy: ci / not-enrolled (push) Skipped
2026-11-06 23:11:03 +00:00
James MaesandClaude Opus 5.5 34a3666bbf Merge develop: adopt the released Document Generation 1.0 changes
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 9cb8c13124a99d18da83cbcd4faa795859ac9e55] (pull_request) Successful in 7s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 6s
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
QRun-IO/ci-policy: ci / ci-result (pull_request) Waiting to run
maven / build (push) Successful in 8m5s
build / maven (push) Successful in 8m5s
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
develop (PR #5) already fixed the renderer BarcodeDeclaredCapabilityTest
gaps, moved the family to QQQ 4.1.0-RC.22 and pinned the released Record
Files 0.1.0-RC.1 and Scripting 1.0.0, which is what resolves the scripting
bridge's "reviewed core isolation marker metadata" errors from run 6360.
Take develop's implementation and docs wholesale so this branch only
carries its own change: pinning the shared Maven workflow to v1.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 16:54:15 -06:00
James MaesandClaude Opus 5.5 6a3153456e build: align the family on QQQ 4.1.0-RC.22
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 9cb8c13124a99d18da83cbcd4faa795859ac9e55] (pull_request) Successful in 6s
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 5s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
QRun-IO/ci-policy: ci / ci-result (pull_request) Successful in 4s
maven / build (push) Successful in 8m48s
build / maven (push) Successful in 8m48s
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
The published qbit-scripting 0.1.0-SNAPSHOT (and its tests jar) is built
against QQQ Core 4.1.0-RC.22, whose Script entity carries the reviewed
executionMode isolation marker. The scripting bridge pinned RC.21 through
dependencyManagement, so ScriptingQBitProducer rejected the core script
table ("Scripting requires the reviewed core isolation marker metadata")
in every PublishedScriptContextAdapterTest. qbit-record-files and
qbit-printing have also moved to RC.22, so move foundation and all bridges
together rather than pinning older sibling snapshots.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 16:53:07 -06:00
CI 9073e9bf1c Bump version to 0.2.0-SNAPSHOT [skip ci] 2026-11-06 21:07:16 +00:00
James MaesandClaude Opus 5.5 207e3ce034 fix(renderer): make the renderer test suite pass on the shared CI workflow
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 539bec410f7926fec3ef7fabe51934a91e0248be] (pull_request) Successful in 7s
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 6s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
QRun-IO/ci-policy: ci / ci-result (pull_request) Successful in 6s
maven / build (push) Failing after 9m59s
build / maven (push) Failing after 10m0s
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
- BackgroundImageQualification expected the patched OpenHTML provider at the
  old fixed version 1.1.105-qqq-p1, but PR #1 publishes the vendored module at
  the family revision. The exact-GAV check now takes the expected version from
  the build's own ${revision} (surefire system property) and fails closed if
  absent; group, artifact, single-class-definition and companion checks are
  unchanged.
- barHeight was advertised and accepted for every Okapi family but silently
  ignored by fixed-geometry encoders. It is now advertised/accepted only where
  it changes the symbol; the 16 fixed-geometry families and gs1-databar in
  STACKED mode refuse it with UNSUPPORTED_BARCODE_OPTION (catalog metadata
  carries notWithMode=STACKED).
- UNSUPPORTED_BARCODE_OPTION now crosses the worker boundary as its closed
  code (foundation already models it), and PDF VALIDATE checks literal
  (template-free) barcode options of in-process encoders.

Resolves the 3 known BarcodeDeclaredCapabilityTest failures and the
PDF_PROVIDER_GAV_MISMATCH error; no tests skipped or weakened.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 11:37:12 -06:00
james.maesandClaude Opus 5.5 063b1e8136 ci: pin shared workflow to v1
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 1e25bb5a243dfdcd95d4b9a4f780200ff8c8778a] (pull_request) Successful in 13s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 13s
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Failing after 10s
QRun-IO/ci-policy: ci / ci-result (pull_request) Failing after 10s
maven / build (push) Failing after 10m5s
build / maven (push) Failing after 10m5s
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 15:55:32 +00:00
260 changed files with 23491 additions and 218 deletions

No files matched your search

+7
View File
@@ -12,3 +12,10 @@
*.woff2 binary
*.jar binary
*.mmdb binary
# Stored renderer outputs are compared byte for byte: git must never rewrite them.
renderer/src/test/resources/compat-v1/** -text
renderer/src/test/resources/scene2/golden/** -text
# Bundled fonts and their licence texts are shipped exactly as released and are hashed: git must never rewrite them.
renderer/src/main/resources/fonts/** -text
+1 -1
View File
@@ -3,5 +3,5 @@ on:
push:
jobs:
maven:
uses: self:KofTwentyTwo/ci-workflows/.gitea/workflows/maven.yaml@main
uses: self:KofTwentyTwo/ci-workflows/.gitea/workflows/maven.yaml@v1
secrets: inherit
+1 -1
View File
@@ -72,7 +72,7 @@ The root `pom.xml` is an aggregator only and lists every module, so one build pr
Run `./mvnw verify` (`.\mvnw.cmd verify` on Windows) at the repository root. The foundation's tests include disposable MySQL 8.4 and PostgreSQL suites started with Testcontainers, so Docker access is required. They verify publication concurrency/commit/rollback, physical pooled-connection restoration, mapping/settings drift refusal, bounded lock contention, current-authorized context selection and immutable pins, audit/receipt failures, restart and incomplete results. They do not qualify production storage, hostile workers or physical printer output.
The build enforces Checkstyle plus 85% instruction/90% class coverage in the foundation. The published `qbit-build-parent` POMs leave `${revision}` in their own version, which causes a Maven parent-resolution warning despite a successful build. That upstream publication issue remains open; it is neither suppressed nor patched.
The build enforces Checkstyle plus 85% instruction/90% class coverage in the foundation, and holds the renderer (94% instructions, 91% lines) and its bridge (85% instructions, 82% lines) to their measured baselines; the new packages and classes named in each `pom.xml` must reach 100% line coverage. Bounded mutation campaigns over the scene parser and the host printer gate run in the test phase; see [docs/security/fuzzing.md](docs/security/fuzzing.md). The published `qbit-build-parent` POMs leave `${revision}` in their own version, which causes a Maven parent-resolution warning despite a successful build. That upstream publication issue remains open; it is neither suppressed nor patched.
## Maven publication
+2 -2
View File
@@ -4,9 +4,9 @@
<parent><groupId>com.kingsrook.qbits</groupId><artifactId>qbit-document-generation-reactor</artifactId><version>${revision}</version><relativePath>../../pom.xml</relativePath></parent>
<groupId>com.kingsrook.qbits</groupId><artifactId>qbit-document-generation-printing</artifactId><version>${revision}</version>
<name>Document Generation Printing Bridge</name>
<properties><qqq.version>4.1.0-RC.22</qqq.version><!-- Released sibling QBit coordinates from the Gitea Maven registry --><qbit-record-files.version>0.1.0-RC.1</qbit-record-files.version><maven.compiler.release>21</maven.compiler.release><maven.compiler.proc>none</maven.compiler.proc><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<properties><qqq.version>4.1.0-RC.26</qqq.version><!-- Released sibling QBit coordinates from the Gitea Maven registry --><qbit-record-files.version>0.4.0-RC.1</qbit-record-files.version><maven.compiler.release>21</maven.compiler.release><maven.compiler.proc>none</maven.compiler.proc><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<!-- Released Printing 1.0.0: RetainedPrintFacade.Acceptance carries title/optionsJson and PrintingService enforces options.mediaProfile id+revision. -->
<qbit-printing.version>1.0.0</qbit-printing.version><enforcer.skip>true</enforcer.skip></properties>
<qbit-printing.version>1.2.0-RC.1</qbit-printing.version><enforcer.skip>true</enforcer.skip></properties>
<dependencyManagement><dependencies><dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-bom-pom</artifactId><version>${qqq.version}</version><type>pom</type><scope>import</scope></dependency>
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-backend-core</artifactId><version>${qqq.version}</version></dependency>
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-backend-module-rdbms</artifactId><version>${qqq.version}</version></dependency>
+1 -1
View File
@@ -4,7 +4,7 @@
<parent><groupId>com.kingsrook.qbits</groupId><artifactId>qbit-document-generation-reactor</artifactId><version>${revision}</version><relativePath>../../pom.xml</relativePath></parent>
<groupId>com.kingsrook.qbits</groupId><artifactId>qbit-document-generation-record-files</artifactId><version>${revision}</version>
<name>Document Generation Record Files Bridge</name>
<properties><qqq.version>4.1.0-RC.22</qqq.version><!-- Released sibling QBit coordinates from the Gitea Maven registry --><qbit-record-files.version>0.1.0-RC.1</qbit-record-files.version><maven.compiler.release>21</maven.compiler.release><maven.compiler.proc>none</maven.compiler.proc><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><enforcer.skip>true</enforcer.skip></properties>
<properties><qqq.version>4.1.0-RC.26</qqq.version><!-- Released sibling QBit coordinates from the Gitea Maven registry --><qbit-record-files.version>0.4.0-RC.1</qbit-record-files.version><maven.compiler.release>21</maven.compiler.release><maven.compiler.proc>none</maven.compiler.proc><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><enforcer.skip>true</enforcer.skip></properties>
<dependencyManagement><dependencies><dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-bom-pom</artifactId><version>${qqq.version}</version><type>pom</type><scope>import</scope></dependency>
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-backend-core</artifactId><version>${qqq.version}</version></dependency>
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-backend-module-rdbms</artifactId><version>${qqq.version}</version></dependency>
+17 -4
View File
@@ -1,9 +1,22 @@
# Build only on an operator-approved, immutable existing renderer image.
# This file does not build/download the engine or confer isolation qualification.
# Build only on an operator-approved, immutable existing renderer image (RENDERER_IMAGE, the engine image from
# renderer/Dockerfile). This file does not build the engine or confer isolation qualification.
# The service is the RELEASED transport artifact, resolved at the exact TRANSPORT_VERSION from the QRun-IO Gitea Maven
# registry and Maven Central (no SNAPSHOT, no local build, no default). BUILD_IMAGE must be an immutable digest.
# docker build --build-arg BUILD_IMAGE=... --build-arg RENDERER_IMAGE=... --build-arg TRANSPORT_VERSION=1.0.0 bridges/remote-renderer/
ARG BUILD_IMAGE
ARG RENDERER_IMAGE
FROM ${BUILD_IMAGE} AS release
ARG TRANSPORT_VERSION
WORKDIR /release
COPY release-image/pom.xml ./pom.xml
RUN test -n "${TRANSPORT_VERSION}" && case "${TRANSPORT_VERSION}" in *SNAPSHOT*|*forge*) echo "TRANSPORT_VERSION must be a released version" >&2; exit 1;; esac \
&& mvn -B -Dtransport.version="${TRANSPORT_VERSION}" -Dmaven.repo.local=/release/.m2 package \
&& mv "target/lib/qqq-remote-renderer-transport-${TRANSPORT_VERSION}.jar" target/service.jar \
&& test -f target/service.jar && ls target/lib
FROM ${RENDERER_IMAGE}
COPY transport/target/qqq-remote-renderer-transport-0.1.0-SNAPSHOT.jar /remote/service.jar
COPY transport/target/lib/ /remote/lib/
COPY --from=release /release/target/service.jar /remote/service.jar
COPY --from=release /release/target/lib/ /remote/lib/
COPY LICENSE NOTICE /usr/share/doc/qqq-remote-renderer/
USER 65532:65532
EXPOSE 18445
@@ -73,6 +73,25 @@ public final class RemoteRendererBridge implements GenerationPorts.IsolatedRende
return (delegate.render(request));
}
/***************************************************************************
** The existing bridge renders, validates the label exactly as for printing
** and decodes the page from it; nothing is retained.
***************************************************************************/
@Override
public GenerationPorts.Preview preview(GenerationPorts.PreviewRequest request) throws QException
{
return (delegate.preview(request));
}
/***************************************************************************
** The existing bridge honours a render target or refuses it by name.
***************************************************************************/
@Override
public boolean supportsRenderTarget()
{
return (delegate.supportsRenderTarget());
}
/***************************************************************************
** The host closes this adapter during its normal shutdown lifecycle.
***************************************************************************/
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Image-assembly project, not a published module. It resolves the RELEASED remote renderer transport service and its runtime
libraries from the QRun-IO Gitea Maven registry (and Maven Central) at one exact version, so the service image
carries release bytes and not a local build. transport.version has no default: pass -Dtransport.version=<released>. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.kingsrook.qbits</groupId><artifactId>qqq-remote-renderer-image</artifactId><version>0</version><packaging>pom</packaging>
<repositories>
<repository><id>central</id><url>https://repo.maven.apache.org/maven2</url><snapshots><enabled>false</enabled></snapshots></repository>
<repository><id>qrun-io</id><url>https://git.kof22.com/api/packages/QRun-IO/maven</url><snapshots><enabled>false</enabled></snapshots><releases><checksumPolicy>fail</checksumPolicy></releases></repository>
</repositories>
<dependencies>
<dependency><groupId>com.kingsrook.qbits</groupId><artifactId>qqq-remote-renderer-transport</artifactId><version>${transport.version}</version></dependency>
</dependencies>
<build><plugins>
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-dependency-plugin</artifactId><version>3.9.0</version>
<executions><execution><id>release-libraries</id><phase>package</phase><goals><goal>copy-dependencies</goal></goals>
<configuration><includeScope>runtime</includeScope><outputDirectory>${project.build.directory}/lib</outputDirectory></configuration>
</execution></executions></plugin>
</plugins></build>
</project>
+29
View File
@@ -11,6 +11,35 @@ verification (private source-matched reactor, 2026-11-02): bridge 52 tests, rend
167 tests, zero failures/errors/skips, Checkstyle 0; see
`docs/reviews/code-standards-followup-20261102/` in `qbit-documents` for exact commands.
## Renderer versions, render target and preview
The bridge accepts renderer `qqq-renderer-0.1.0` and `qqq-renderer-0.2.0` (`RendererVersion` is the rule):
| Renderer | Answers | Refusals it may name | Version 2 scene, render target, preview |
|---|---|---|---|
| `0.1.0` | the released fields only | the 13 released codes | refused: `RENDERER_TOO_OLD` |
| `0.2.0` | the same, with `diagnostics` (and `detail` on an error) | those and the 15 scene codes | rendered |
Upgrade this library before the renderer image. A job is framed as renderer 0.1.0 reads it unless it needs more,
so version 1 printing is unchanged against either image. Before a job only 0.2.0 can do, the bridge asks the
worker its version with a fixed, empty validation; an old image is refused with `RENDERER_TOO_OLD` and receives
nothing of the scene or the record.
- **Render target.** `RenderRequest.targetDpi` (203, 300 or 600) is sent with a version 2 scene, and the label
is held by the output policy to the page at that resolution. A version 1 scene or a PDF asked for another
resolution than its stock's is refused as `TARGET_REQUIRES_SCENE_2` before any worker is contacted.
`supportsRenderTarget()` is true.
- **Diagnostics.** A version 2 refusal arrives as `RenderException(code, diagnostic)`. The worker's answer is
untrusted: every diagnostic is checked again on the host, including that its element is an id the scene that
was sent declares and that its pointer is made only of array indexes, schema property names and those ids.
An answer holds at most 2048 diagnostics in one megabyte beside its label.
- **Preview.** `preview(PreviewRequest)` is the print path stopped before retention: the same job with collected
diagnostics, the same integrity checks and output policy, and a page decoded by `ZplRaster` from the accepted
label bytes (`PreviewPage` is a one-bit PNG, one pixel for each dot). Refusals come back as diagnostics with
`printable: false`, never as a label: a refused scene has no output, and its page shows only the hatched
boxes of the refused elements. A page of more than sixteen million dots is `PREVIEW_TOO_LARGE`. PDF previews
are not provided. The bridge writes and logs nothing for a preview.
Three transports share the same bridge, asset, wire and output policy:
- **Production (default):** `new IsolatedRendererBridge(configuration, assetReader)`
+20
View File
@@ -37,6 +37,26 @@
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><version>3.5.4</version><configuration><dependenciesToScan combine.self="override"/></configuration></plugin>
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-dependency-plugin</artifactId><version>3.8.1</version><executions><execution><id>runtime-distribution</id><phase>package</phase><goals><goal>copy-dependencies</goal></goals><configuration><includeScope>runtime</includeScope><outputDirectory>${project.build.directory}/lib</outputDirectory></configuration></execution></executions></plugin>
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-checkstyle-plugin</artifactId><version>3.3.1</version><dependencies><dependency><groupId>com.puppycrawl.tools</groupId><artifactId>checkstyle</artifactId><version>10.12.6</version></dependency></dependencies><configuration><configLocation>${project.basedir}/checkstyle/config.xml</configLocation><propertyExpansion>checkstyle.reactor.root=${project.basedir}</propertyExpansion><includeTestSourceDirectory>true</includeTestSourceDirectory><consoleOutput>true</consoleOutput><violationSeverity>warning</violationSeverity><failOnViolation>true</failOnViolation></configuration><executions><execution><phase>validate</phase><goals><goal>check</goal></goals></execution></executions></plugin>
<plugin>
<!-- Coverage gates. The BUNDLE rule is the measured baseline of the bridge, rounded down (2026-11-12, with the preview classes: 90.9% of instructions and 88.4% of lines; 2026-11-11: 85.6% and 82.6%); raise it when coverage rises and
never lower it. The PACKAGE and CLASS rules hold new code to 100% line coverage from its first commit; a pattern matches nothing until its package or class exists, so the package that adds
it needs no change here. The classes of the bridge preview package (ZplRaster, and WorkerAnswer, SceneFacts and RendererVersion, which read the worker's answers) are listed by name. Nothing is excluded: JaCoCo skips only code annotated as generated, and this build defines no such annotation. There is no skip switch. -->
<groupId>org.jacoco</groupId><artifactId>jacoco-maven-plugin</artifactId><version>0.8.15</version><executions>
<execution><goals><goal>prepare-agent</goal></goals></execution>
<execution><id>report</id><phase>verify</phase><goals><goal>report</goal></goals></execution>
<execution><id>coverage</id><phase>verify</phase><goals><goal>check</goal></goals><configuration><rules>
<rule><element>BUNDLE</element><limits>
<limit><counter>INSTRUCTION</counter><value>COVEREDRATIO</value><minimum>0.90</minimum></limit>
<limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>0.88</minimum></limit>
</limits></rule>
<rule><element>CLASS</element><includes><include>com.kingsrook.qbits.documentgeneration.renderer.ZplRaster</include><include>com.kingsrook.qbits.documentgeneration.renderer.ZplRaster.*</include>
<include>com.kingsrook.qbits.documentgeneration.renderer.WorkerAnswer</include><include>com.kingsrook.qbits.documentgeneration.renderer.WorkerAnswer.*</include>
<include>com.kingsrook.qbits.documentgeneration.renderer.SceneFacts</include><include>com.kingsrook.qbits.documentgeneration.renderer.SceneFacts.*</include>
<include>com.kingsrook.qbits.documentgeneration.renderer.RendererVersion</include><include>com.kingsrook.qbits.documentgeneration.renderer.RendererVersion.*</include></includes><limits>
<limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>1.00</minimum></limit>
</limits></rule>
</rules></configuration></execution>
</executions></plugin>
<plugin>
<!-- Publish a self-contained POM: ${revision}/property versions are resolved at build time, so a consumer needs no -Drevision -->
<groupId>org.codehaus.mojo</groupId><artifactId>flatten-maven-plugin</artifactId><version>1.7.3</version>
@@ -34,20 +34,44 @@ import java.util.Set;
import java.util.UUID;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.Diagnostic;
import com.kingsrook.qqq.backend.core.exceptions.QException;
/*******************************************************************************
** Optional host adapter. All template interpretation remains inside the isolated
** worker; this class authorizes bytes and validates the transport/output contract.
**
** It accepts renderer 0.1.0 and 0.2.0 (`RendererVersion` is the rule). A job
** that only 0.2.0 can do (a version 2 scene, a render target, a preview) is
** refused as `RENDERER_TOO_OLD` when the worker is older: the host asks the
** worker its version with a fixed, empty job before it sends such a scene, and
** an answer from an older worker to such a job is refused whatever it says.
*******************************************************************************/
public final class IsolatedRendererBridge implements GenerationPorts.IsolatedRenderer
{
private static final int ENVELOPE_BYTES = 4096;
private static final List<Integer> RESOLUTIONS = List.of(203, 300, 600);
////////////////////////////////////////////////////////////////////////////////////////////////
// the version question: validate an empty version 1 scene on a fixed stock. Every released //
// renderer answers it, it holds nothing of any template or record, and the answer names the //
// renderer's version //
////////////////////////////////////////////////////////////////////////////////////////////////
static final String PROBE_SCENE = "{\"schema\":\"qqq-zpl-scene/1\",\"elements\":[]}";
static final GenerationPorts.Stock PROBE_STOCK = new GenerationPorts.Stock(101600, 152400, 0, 0, 0, 0, 203);
private final RendererLimits config;
private final AssetReader assets;
private final Exchange exchange;
private final RendererAdmission admission;
////////////////////////////////////////////////////////////////////////////////////////////////
// whether the last verified answer came from a renderer that draws version 2 scenes. It only //
// saves the version question; every answer is still held to the version rule //
////////////////////////////////////////////////////////////////////////////////////////////////
private volatile boolean structured;
/*******************************************************************************
** Must check current actor, tenant and immutable retained-version access, then
** read at most maximumBytes. Never return a URL or storage credential.
@@ -130,6 +154,18 @@ public final class IsolatedRendererBridge implements GenerationPorts.IsolatedRen
}
}
/***************************************************************************
** This adapter renders a version 2 scene at the request's render target and
** refuses a target it cannot honour: `TARGET_REQUIRES_SCENE_2` for a version
** 1 scene or a PDF asked for another resolution than its stock's, and
** `RENDERER_TOO_OLD` when the worker cannot draw version 2.
***************************************************************************/
@Override
public boolean supportsRenderTarget()
{
return (true);
}
/*******************************************************************************
** Validate each supplied format with the same authorized offline asset snapshot.
*******************************************************************************/
@@ -147,7 +183,7 @@ public final class IsolatedRendererBridge implements GenerationPorts.IsolatedRen
if(source != null && !source.isBlank())
{
found = true;
invoke(UUID.randomUUID().toString(), "VALIDATE", format, revision, Map.of(), resolved, config.maximumBytes());
invoke(UUID.randomUUID().toString(), "VALIDATE", format, revision, Map.of(), resolved, config.maximumBytes(), null, false);
}
}
if(!found)
@@ -175,32 +211,9 @@ public final class IsolatedRendererBridge implements GenerationPorts.IsolatedRen
{
throw new IllegalArgumentException("OUTPUT_LIMIT");
}
JsonNode response = invoke(request.requestId(), "RENDER", request.format(), request.revision(), request.context(), resolve(request.actorId(), request.revision().assets()), maximum);
String encoded = RendererJson.text(response.get("base64"), 4 * ((maximum + 2) / 3));
byte[] bytes = Base64.getDecoder().decode(encoded);
if(bytes.length < 1 || bytes.length > maximum || RendererJson.integer(response.get("length"), 1, maximum) != bytes.length
|| !RendererJson.hash(bytes).equals(RendererJson.text(response.get("sha256"), 64)))
{
throw new IllegalArgumentException("OUTPUT_INTEGRITY");
}
int pages = RendererJson.integer(response.get("pageCount"), 1, config.maximumPages());
if(request.format() == GenerationPorts.Format.ZPL)
{
if(pages != 1 || !"application/vnd.zebra-zpl".equals(response.path("mediaType").asText()))
{
throw new IllegalArgumentException("ZPL_METADATA");
}
ZplOutputPolicy.validate(bytes, request.revision().stock());
}
else
{
if(!"application/pdf".equals(response.path("mediaType").asText()))
{
throw new IllegalArgumentException("PDF_METADATA");
}
pdfEnvelope(bytes);
}
return (new GenerationPorts.Content(bytes));
WorkerAnswer answer = invoke(request.requestId(), "RENDER", request.format(), request.revision(), request.context(), resolve(request.actorId(), request.revision().assets()), maximum,
request.targetDpi(), false);
return (new GenerationPorts.Content(output(answer, request.format(), maximum, at(request.revision().stock(), request.targetDpi()))));
}
catch(Exception failure)
{
@@ -208,11 +221,165 @@ public final class IsolatedRendererBridge implements GenerationPorts.IsolatedRen
}
}
/***************************************************************************
** The print path stopped before retention: the worker renders the same
** revision with the same context, the label passes the same integrity checks
** and the same output policy, and the page is decoded from those accepted
** bytes. The result holds a picture and numbers, never the label, and
** nothing is written, retained or logged. A refusal is not an exception
** here: the layout is reported as not printable with its diagnostics.
**
** A scene with a refused element has no label at all (the worker sends
** none), so there is nothing a host could print by mistake. Its page shows
** only where the refused elements are, hatched, from the boxes in their
** diagnostics; when no diagnostic has a box there is no page.
***************************************************************************/
@Override
@SuppressWarnings("try") // The admission slot is held for its scope only; its value is never read.
public GenerationPorts.Preview preview(GenerationPorts.PreviewRequest request) throws QException
{
if(request.format() != GenerationPorts.Format.ZPL)
{
throw new QException("Preview is available for labels only.");
}
try(var slot = admission.enter())
{
int maximum = request.maximumBytes();
if(maximum > config.maximumBytes())
{
throw new IllegalArgumentException("OUTPUT_LIMIT");
}
GenerationPorts.Stock printed = at(request.revision().stock(), request.targetDpi());
stock(printed);
int width = dots(printed.widthMicrons(), printed.dpi(), 12700);
int height = dots(printed.heightMicrons(), printed.dpi(), 12700);
if(!RESOLUTIONS.contains(printed.dpi()) || width > 9999 || height > 32000)
{
throw new IllegalArgumentException("INVALID_ZPL_STOCK");
}
try
{
if((long) width * height > ZplRaster.MAXIMUM_DOTS)
{
throw new GenerationPorts.RenderException(GenerationPorts.FailureCode.PREVIEW_TOO_LARGE, new Diagnostic("PREVIEW_TOO_LARGE", Diagnostic.Severity.ERROR, null, null,
Map.of("widthDots", width, "heightDots", height), Map.of("dots", (int) ZplRaster.MAXIMUM_DOTS)));
}
WorkerAnswer answer = invoke(UUID.randomUUID().toString(), "RENDER", request.format(), request.revision(), request.context(), resolve(request.actorId(), request.revision().assets()),
maximum, request.targetDpi(), true);
if(answer.refused())
{
return (refused(printed, answer.diagnostics()));
}
byte[] bytes = output(answer, request.format(), maximum, printed);
ZplRaster page = ZplRaster.page(bytes, printed);
List<Diagnostic> diagnostics = new ArrayList<>(answer.diagnostics());
if(!page.exact())
{
diagnostics.add(new Diagnostic("PRINTER_FONT_NOT_SHOWN", Diagnostic.Severity.WARNING, null, null, null, null));
}
return (new GenerationPorts.Preview(List.of(new GenerationPorts.PreviewPage(page.png(), page.width(), page.height())), page.exact(), true, diagnostics, (long) bytes.length,
RendererJson.hash(bytes)));
}
catch(GenerationPorts.RenderException refusal)
{
return (refused(printed, List.of(refusal.diagnostic() != null ? refusal.diagnostic() : new Diagnostic(refusal.code().name(), Diagnostic.Severity.ERROR, null, null, null, null))));
}
}
catch(Exception failure)
{
throw (failure(failure));
}
}
/***************************************************************************
** A preview of a layout that cannot print. There is no output, so its size
** is zero and its hash is the hash of no bytes. The page is drawn on the
** host from the diagnostics' boxes, which are in dots from the top left of
** the printable area: the stock less its margins, placed as the renderer
** places it (the left and top margins rounded up to whole dots and moved
** back only as far as keeps the area on the page).
***************************************************************************/
private static GenerationPorts.Preview refused(GenerationPorts.Stock printed, List<Diagnostic> diagnostics) throws Exception
{
List<List<Integer>> boxes = diagnostics.stream().filter(diagnostic -> diagnostic.severity() == Diagnostic.Severity.ERROR && diagnostic.box() != null).map(Diagnostic::box).toList();
List<GenerationPorts.PreviewPage> pages = List.of();
if(!boxes.isEmpty())
{
int dpi = printed.dpi();
int width = dots(printed.widthMicrons(), dpi, 12700);
int height = dots(printed.heightMicrons(), dpi, 12700);
int left = Math.min(dots(printed.leftMicrons(), dpi, 25399), width - dots(printed.widthMicrons() - printed.leftMicrons() - printed.rightMicrons(), dpi, 0));
int top = Math.min(dots(printed.topMicrons(), dpi, 25399), height - dots(printed.heightMicrons() - printed.topMicrons() - printed.bottomMicrons(), dpi, 0));
ZplRaster page = ZplRaster.refused(width, height, left, top, boxes);
pages = List.of(new GenerationPorts.PreviewPage(page.png(), page.width(), page.height()));
}
return (new GenerationPorts.Preview(pages, false, false, diagnostics, 0L, RendererJson.hash(new byte[0])));
}
/***************************************************************************
** The document of an accepted answer, checked exactly as for printing: its
** decoded size and hash, its metadata, and for a label the output policy for
** the stock at the resolution it was rendered for.
***************************************************************************/
private byte[] output(WorkerAnswer answer, GenerationPorts.Format format, int maximum, GenerationPorts.Stock printed) throws Exception
{
JsonNode response = answer.fields();
String encoded = RendererJson.text(response.get("base64"), 4 * ((maximum + 2) / 3));
byte[] bytes = Base64.getDecoder().decode(encoded);
if(bytes.length < 1 || bytes.length > maximum || RendererJson.integer(response.get("length"), 1, maximum) != bytes.length
|| !RendererJson.hash(bytes).equals(RendererJson.text(response.get("sha256"), 64)))
{
throw new IllegalArgumentException("OUTPUT_INTEGRITY");
}
int pages = RendererJson.integer(response.get("pageCount"), 1, config.maximumPages());
if(format == GenerationPorts.Format.ZPL)
{
if(pages != 1 || !"application/vnd.zebra-zpl".equals(response.path("mediaType").asText()))
{
throw new IllegalArgumentException("ZPL_METADATA");
}
ZplOutputPolicy.validate(bytes, printed);
}
else
{
if(!"application/pdf".equals(response.path("mediaType").asText()))
{
throw new IllegalArgumentException("PDF_METADATA");
}
pdfEnvelope(bytes);
}
return (bytes);
}
/***************************************************************************
** The stock at the resolution a label is rendered for: its own, or the
** render target.
***************************************************************************/
private static GenerationPorts.Stock at(GenerationPorts.Stock stock, Integer targetDpi)
{
return (targetDpi == null ? stock : new GenerationPorts.Stock(stock.widthMicrons(), stock.heightMicrons(), stock.topMicrons(), stock.rightMicrons(), stock.bottomMicrons(),
stock.leftMicrons(), targetDpi));
}
/***************************************************************************
** Micrometres to dots. The addend chooses the rounding: half an inch of
** micrometres for the nearest dot (a page side, as the output policy
** computes it), one less than an inch to round up and nothing to round down.
***************************************************************************/
private static int dots(int micrometres, int dpi, int addend)
{
return (Math.toIntExact(((long) micrometres * dpi + addend) / 25400));
}
/*******************************************************************************
** Encode pure data only; host objects are rejected before Jackson can reflect.
** The job is framed as renderer 0.1.0 reads it unless it needs more: a render
** target is sent only for a version 2 scene, and collected diagnostics only
** for a preview. A version 1 scene or a PDF asked for another resolution than
** its stock's is refused here, because a renderer would ignore the target.
*******************************************************************************/
private JsonNode invoke(String id, String operation, GenerationPorts.Format format, GenerationPorts.Revision revision,
Map<String, Object> context, List<Map<String, Object>> resolved, int maximum) throws Exception
private WorkerAnswer invoke(String id, String operation, GenerationPorts.Format format, GenerationPorts.Revision revision,
Map<String, Object> context, List<Map<String, Object>> resolved, int maximum, Integer targetDpi, boolean collect) throws Exception
{
if(id == null || !id.matches("[A-Za-z0-9._:-]{1,128}") || format == null)
{
@@ -223,61 +390,78 @@ public final class IsolatedRendererBridge implements GenerationPorts.IsolatedRen
{
throw new IllegalArgumentException("SOURCE_LIMIT");
}
SceneFacts facts = SceneFacts.of(format, source);
if(targetDpi != null && !facts.version2() && !targetDpi.equals(revision.stock().dpi()))
{
throw new GenerationPorts.RenderException(GenerationPorts.FailureCode.TARGET_REQUIRES_SCENE_2, new Diagnostic("TARGET_REQUIRES_SCENE_2", Diagnostic.Severity.ERROR, null, null,
Map.of("dpi", targetDpi), Map.of("dpi", revision.stock().dpi())));
}
boolean current = facts.version2() || collect;
Map<String, Object> request = request(id, operation, format, source, revision.stock(), new Snapshot().copy(context, 0), resolved, maximum);
if(targetDpi != null && facts.version2())
{
request.put("targetDpi", targetDpi);
}
if(collect)
{
request.put("diagnostics", "COLLECT");
}
byte[] input = (RendererJson.JSON.writeValueAsString(request) + "\n").getBytes(StandardCharsets.UTF_8);
if(input.length > 16 * 1024 * 1024)
{
throw new IllegalArgumentException("FRAME_LIMIT");
}
if(current && !structured)
{
probe();
}
////////////////////////////////////////////////////////////////////////////////////////////////////
// an answer of renderer 0.2.0 to such a job also carries diagnostics. They get their own bounded //
// room, and the whole frame never passes what the deployment's transport was sized for: the //
// frame of the largest document this adapter may ask for //
////////////////////////////////////////////////////////////////////////////////////////////////////
long room = (operation.equals("VALIDATE") ? 0 : 4L * ((maximum + 2) / 3)) + ENVELOPE_BYTES + (current ? WorkerAnswer.DIAGNOSTICS_BYTES : 0);
int maximumFrame = (int) Math.min(room, 4L * ((config.maximumBytes() + 2) / 3) + ENVELOPE_BYTES);
WorkerAnswer answer = WorkerAnswer.read(exchange.invoke(id, input, maximumFrame), maximumFrame, id, facts);
structured = answer.version().structured();
return (answer.settle(operation, collect, current));
}
/***************************************************************************
** Ask the worker its version before a job only renderer 0.2.0 can do, so
** that nothing of a version 2 scene or its record reaches a renderer that
** cannot draw it. The question is a constant.
***************************************************************************/
private void probe() throws Exception
{
String id = UUID.randomUUID().toString();
byte[] input = (RendererJson.JSON.writeValueAsString(request(id, "VALIDATE", GenerationPorts.Format.ZPL, PROBE_SCENE, PROBE_STOCK, Map.of(), List.of(), ENVELOPE_BYTES)) + "\n")
.getBytes(StandardCharsets.UTF_8);
WorkerAnswer answer = WorkerAnswer.read(exchange.invoke(id, input, ENVELOPE_BYTES), ENVELOPE_BYTES, id, SceneFacts.of(GenerationPorts.Format.ZPL, PROBE_SCENE));
structured = answer.settle("VALIDATE", false, false).version().structured();
if(!structured)
{
throw new GenerationPorts.RenderException(GenerationPorts.FailureCode.RENDERER_TOO_OLD);
}
}
/***************************************************************************
** The fields every job has, in the order every released renderer was sent.
***************************************************************************/
private static Map<String, Object> request(String id, String operation, GenerationPorts.Format format, String source, GenerationPorts.Stock stock, Object context,
List<Map<String, Object>> resolved, int maximum)
{
Map<String, Object> request = new LinkedHashMap<>();
request.put("protocol", RendererJson.PROTOCOL);
request.put("requestId", id);
request.put("operation", operation);
request.put("format", format.name());
request.put("source", source);
request.put("stock", stock(revision.stock()));
request.put("context", new Snapshot().copy(context, 0));
request.put("stock", stock(stock));
request.put("context", context);
request.put("assets", resolved);
request.put("maximumBytes", maximum);
byte[] input = (RendererJson.JSON.writeValueAsString(request) + "\n").getBytes(StandardCharsets.UTF_8);
if(input.length > 16 * 1024 * 1024)
{
throw new IllegalArgumentException("FRAME_LIMIT");
}
int maximumFrame = operation.equals("VALIDATE") ? 4096 : 4 * ((maximum + 2) / 3) + 4096;
byte[] output = exchange.invoke(id, input, maximumFrame);
if(output.length == 0 || output[output.length - 1] != '\n')
{
throw new IllegalArgumentException("FRAME_TRUNCATED");
}
for(int i = 0; i < output.length - 1; i++)
{
if(output[i] == '\n' || output[i] == '\r')
{
throw new IllegalArgumentException("EXTRA_FRAME");
}
}
JsonNode result = RendererJson.response(output, maximumFrame);
if("ERROR".equals(result.path("outcome").asText()))
{
if(result.size() != 6 || !RendererJson.PROTOCOL.equals(result.path("protocol").asText()) || !id.equals(result.path("requestId").asText())
|| !"qqq-renderer-0.1.0".equals(result.path("rendererVersion").asText()) || !"qqq-barcodes-9".equals(result.path("catalogVersion").asText()))
{
throw new IllegalArgumentException("WORKER_ERROR_REJECTED");
}
GenerationPorts.FailureCode code;
try
{
code = GenerationPorts.FailureCode.valueOf(RendererJson.text(result.get("code"), 64));
}
catch(IllegalArgumentException unknown)
{
throw new IllegalArgumentException("WORKER_ERROR_REJECTED");
}
throw new GenerationPorts.RenderException(code);
}
int expectedFields = operation.equals("VALIDATE") ? 5 : 10;
if(result.size() != expectedFields || !RendererJson.PROTOCOL.equals(result.path("protocol").asText()) || !id.equals(result.path("requestId").asText())
|| !"OK".equals(result.path("outcome").asText()) || !"qqq-renderer-0.1.0".equals(result.path("rendererVersion").asText())
|| !"qqq-barcodes-9".equals(result.path("catalogVersion").asText()))
{
throw new IllegalArgumentException("WORKER_RESPONSE_REJECTED");
}
return (result);
return (request);
}
/*******************************************************************************
@@ -21,22 +21,17 @@
package com.kingsrook.qbits.documentgeneration.renderer;
import java.io.ByteArrayInputStream;
import java.io.InputStreamReader;
import java.nio.ByteBuffer;
import java.nio.charset.CodingErrorAction;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.util.HexFormat;
import java.util.Set;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.core.StreamReadConstraints;
import com.fasterxml.jackson.core.StreamReadFeature;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
/*******************************************************************************
@@ -77,65 +72,6 @@ final class RendererJson
}
/*******************************************************************************
** Worker success/error responses have known scalar fields, not arbitrary trees.
** Reject unknown/nested values before allocating an attacker-shaped graph.
*******************************************************************************/
static JsonNode response(byte[] bytes, int maximum) throws Exception
{
if(bytes.length > maximum)
{
throw new IllegalArgumentException("RESPONSE_BYTE_LIMIT");
}
Set<String> textFields = Set.of("protocol", "requestId", "outcome", "rendererVersion", "catalogVersion", "mediaType", "base64", "sha256", "code");
ObjectNode result = JSON.createObjectNode();
var decoder = StandardCharsets.UTF_8.newDecoder().onMalformedInput(CodingErrorAction.REPORT).onUnmappableCharacter(CodingErrorAction.REPORT);
try(var reader = new InputStreamReader(new ByteArrayInputStream(bytes), decoder); var parser = JSON.getFactory().createParser(reader))
{
if(parser.nextToken() != JsonToken.START_OBJECT)
{
throw new IllegalArgumentException("RESPONSE_OBJECT_REQUIRED");
}
while(parser.nextToken() != JsonToken.END_OBJECT)
{
if(parser.currentToken() != JsonToken.FIELD_NAME)
{
throw new IllegalArgumentException("RESPONSE_FIELD_REQUIRED");
}
String field = parser.currentName();
boolean text = textFields.contains(field);
if(!text && !field.equals("length") && !field.equals("pageCount"))
{
throw new IllegalArgumentException("UNKNOWN_RESPONSE_FIELD");
}
JsonToken token = parser.nextToken();
if(text && token == JsonToken.VALUE_STRING)
{
String value = parser.getText();
if(value.length() > (field.equals("base64") ? maximum : 128))
{
throw new IllegalArgumentException("RESPONSE_TEXT_LIMIT");
}
result.put(field, value);
}
else if(!text && token == JsonToken.VALUE_NUMBER_INT)
{
result.put(field, parser.getIntValue());
}
else
{
throw new IllegalArgumentException("RESPONSE_SCALAR_REQUIRED");
}
}
if(parser.nextToken() != null)
{
throw new IllegalArgumentException("RESPONSE_TRAILING_VALUE");
}
}
return (result);
}
/*******************************************************************************
** Identity is calculated locally from exact bytes, never trusted from worker.
*******************************************************************************/
@@ -0,0 +1,113 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.util.Set;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.FailureCode;
/*******************************************************************************
** The version rule: the renderers this bridge accepts, and for each one what
** its answers hold and which refusals it may name. Anything else a worker says
** its version is, is rejected.
**
** | Renderer | Answers | Refusals it may name | Version 2 scene, render target, preview |
** |----------|--------------------------------------------|-------------------------------|-----------------------------------------|
** | 0.1.0 | the released fields only | the 13 released codes | refused: `RENDERER_TOO_OLD` |
** | 0.2.0 | the same, with `diagnostics` (and `detail`) | those and the 15 scene codes | rendered |
**
** Each set is written out. A range of the enum would take in whatever is added
** between its ends, and a worker would gain a refusal nobody decided it has.
*******************************************************************************/
enum RendererVersion
{
RELEASED("qqq-renderer-0.1.0", false, Set.of(
FailureCode.BARCODE_FIT_TOO_SMALL, FailureCode.BARCODE_FIT_UNSUPPORTED, FailureCode.BARCODE_FIT_BOX_OUTSIDE_STOCK, FailureCode.BARCODE_FIT_GEOMETRY_MISMATCH,
FailureCode.INVALID_BARCODE_FIT_PROFILE, FailureCode.INVALID_BARCODE_FIT_REQUEST, FailureCode.BARCODE_SYMBOLOGY_NOT_ALLOWED, FailureCode.SYMBOLOGY_ALLOWLIST_REQUIRED,
FailureCode.SCANNER_BARCODE_PROFILE_UNSUPPORTED, FailureCode.SCANNER_BARCODE_PAYLOAD_UNSUPPORTED, FailureCode.SCANNER_BARCODE_CHECKSUM_REQUIRED,
FailureCode.SCANNER_BARCODE_CHECKSUM_MISMATCH, FailureCode.UNSUPPORTED_BARCODE_OPTION)),
CURRENT("qqq-renderer-0.2.0", true, Set.of(
FailureCode.BARCODE_FIT_TOO_SMALL, FailureCode.BARCODE_FIT_UNSUPPORTED, FailureCode.BARCODE_FIT_BOX_OUTSIDE_STOCK, FailureCode.BARCODE_FIT_GEOMETRY_MISMATCH,
FailureCode.INVALID_BARCODE_FIT_PROFILE, FailureCode.INVALID_BARCODE_FIT_REQUEST, FailureCode.BARCODE_SYMBOLOGY_NOT_ALLOWED, FailureCode.SYMBOLOGY_ALLOWLIST_REQUIRED,
FailureCode.SCANNER_BARCODE_PROFILE_UNSUPPORTED, FailureCode.SCANNER_BARCODE_PAYLOAD_UNSUPPORTED, FailureCode.SCANNER_BARCODE_CHECKSUM_REQUIRED,
FailureCode.SCANNER_BARCODE_CHECKSUM_MISMATCH, FailureCode.UNSUPPORTED_BARCODE_OPTION,
FailureCode.SCENE_INVALID, FailureCode.STOCK_MISMATCH, FailureCode.TARGET_REQUIRES_SCENE_2, FailureCode.ELEMENT_OUTSIDE_PRINTABLE_AREA, FailureCode.TEXT_DOES_NOT_FIT,
FailureCode.VALUE_MISSING, FailureCode.VALUE_TOO_LONG, FailureCode.FONT_UNKNOWN, FailureCode.FONT_MISSING_GLYPH, FailureCode.RESERVED_FONT_NAME,
FailureCode.BARCODE_DOES_NOT_FIT, FailureCode.GS1_INVALID, FailureCode.ASSET_UNKNOWN, FailureCode.PREVIEW_TOO_LARGE, FailureCode.RENDERER_TOO_OLD));
private final String wire;
private final boolean structured;
private final Set<FailureCode> refusals;
/***************************************************************************
** One accepted renderer.
***************************************************************************/
RendererVersion(String wire, boolean structured, Set<FailureCode> refusals)
{
this.wire = wire;
this.structured = structured;
this.refusals = refusals;
}
/***************************************************************************
** The accepted renderer an answer names, or null: a version this bridge was
** not built for is never guessed at.
***************************************************************************/
static RendererVersion of(String rendererVersion)
{
for(RendererVersion version : values())
{
if(version.wire.equals(rendererVersion))
{
return (version);
}
}
return (null);
}
/***************************************************************************
** Whether this renderer's answers carry `diagnostics` and `detail`, and so
** whether it renders a version 2 scene, a render target and a preview.
***************************************************************************/
boolean structured()
{
return (structured);
}
/***************************************************************************
** Whether this renderer may name a refusal. A code outside its set is
** rejected like any unknown text.
***************************************************************************/
boolean names(FailureCode code)
{
return (refusals.contains(code));
}
}
@@ -0,0 +1,228 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.io.IOException;
import java.util.HashSet;
import java.util.Set;
import java.util.regex.Pattern;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.core.StreamReadConstraints;
import com.fasterxml.jackson.core.StreamReadFeature;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
/*******************************************************************************
** What the host reads from a label source it is about to send, and nothing
** more: whether it says it is a version 2 scene, and the element ids it
** declares. The host does not lay out, validate or draw a scene; the worker
** does. These two facts are what the version rule and the check of a worker's
** diagnostics need: a diagnostic may name only an element this scene declares
** and point only through array indexes, property names of the version 2 schema
** and declared ids.
**
** A source the host cannot read is not a version 2 scene to the host and
** declares nothing. If the worker reads it differently, every disagreement
** fails closed: its diagnostics name ids the host does not know and are
** rejected, and no render target was sent for it.
*******************************************************************************/
final class SceneFacts
{
static final String SCHEMA = "qqq-zpl-scene/2";
///////////////////////////////////////////////////////////////////////////////////////////////
// every property name `renderer/schema/zpl-scene-2.schema.json` declares; a test holds the //
// two equal, so a property added to the schema is added here in the same change //
///////////////////////////////////////////////////////////////////////////////////////////////
static final Set<String> VOCABULARY = Set.of("schema", "design", "defaults", "samples", "elements", "overrides", "when", "dpi", "set", "children",
"id", "type", "anchor", "x", "y", "width", "height", "align", "valign",
"thickness", "fill",
"value", "valuePath", "font", "size", "lineHeight", "fit", "maxLines", "shrinkTo", "overflow", "maxLength", "threshold", "reverse", "rotation",
"symbology", "symbologyPath", "allowedSymbologies", "minModule", "maxModule", "quiet", "gs1", "hri", "scannerSymbologyPath", "aimIdentifierPath",
"asset", "mode");
private static final SceneFacts NONE = new SceneFacts(false, Set.of());
private static final Pattern ID = Pattern.compile("[A-Za-z][A-Za-z0-9_-]{0,31}");
private static final Pattern INDEX = Pattern.compile("0|[1-9][0-9]{0,3}");
private static final int MAXIMUM_IDS = 1000;
///////////////////////////////////////////////////////////////////////////////////////////////
// the worker's own reading limits, so the host and the worker read the same sources //
///////////////////////////////////////////////////////////////////////////////////////////////
private static final JsonFactory JSON = JsonFactory.builder().streamReadConstraints(StreamReadConstraints.builder().maxNestingDepth(24).maxNumberLength(32).build())
.enable(StreamReadFeature.STRICT_DUPLICATE_DETECTION).build();
private final boolean version2;
private final Set<String> ids;
/***************************************************************************
** The facts of one source.
***************************************************************************/
private SceneFacts(boolean version2, Set<String> ids)
{
this.version2 = version2;
this.ids = ids;
}
/***************************************************************************
** Read the facts of the source a job will send. Only a label can be a scene.
***************************************************************************/
static SceneFacts of(GenerationPorts.Format format, String source)
{
if(format != GenerationPorts.Format.ZPL)
{
return (NONE);
}
Set<String> ids = new HashSet<>();
boolean version2 = false;
try(JsonParser parser = JSON.createParser(source))
{
if(parser.nextToken() != JsonToken.START_OBJECT)
{
return (NONE);
}
while(parser.nextToken() == JsonToken.FIELD_NAME)
{
String name = parser.currentName();
JsonToken value = parser.nextToken();
if(name.equals("schema"))
{
version2 = value == JsonToken.VALUE_STRING && SCHEMA.equals(parser.getText());
}
if(name.equals("elements") && value == JsonToken.START_ARRAY)
{
elements(parser, ids);
}
else
{
parser.skipChildren();
}
}
///////////////////////////////////////////////////////////////////////////////////////
// read to the end, as the worker does: text after the scene makes it no scene //
///////////////////////////////////////////////////////////////////////////////////////
if(parser.currentToken() != JsonToken.END_OBJECT || parser.nextToken() != null)
{
return (NONE);
}
}
catch(IOException | IllegalArgumentException unreadable)
{
return (NONE);
}
return (version2 ? new SceneFacts(true, Set.copyOf(ids)) : NONE);
}
/***************************************************************************
** The ids of a list of elements and of the children of each, where the
** worker's parser looks for them and nowhere else: a sample or an override
** cannot declare one.
***************************************************************************/
private static void elements(JsonParser parser, Set<String> ids) throws IOException
{
while(parser.nextToken() != JsonToken.END_ARRAY)
{
if(parser.currentToken() != JsonToken.START_OBJECT)
{
parser.skipChildren();
continue;
}
while(parser.nextToken() == JsonToken.FIELD_NAME)
{
String name = parser.currentName();
JsonToken value = parser.nextToken();
if(name.equals("id") && value == JsonToken.VALUE_STRING && ID.matcher(parser.getText()).matches())
{
ids.add(parser.getText());
if(ids.size() > MAXIMUM_IDS)
{
throw new IllegalArgumentException("SCENE_ELEMENT_LIMIT");
}
}
if(name.equals("children") && value == JsonToken.START_ARRAY)
{
elements(parser, ids);
}
else
{
parser.skipChildren();
}
}
}
}
/***************************************************************************
** Whether the source says it is a version 2 scene, which only renderer 0.2.0
** and later can draw.
***************************************************************************/
boolean version2()
{
return (version2);
}
/***************************************************************************
** Whether the scene declares an element with this id.
***************************************************************************/
boolean declares(String id)
{
return (ids.contains(id));
}
/***************************************************************************
** Whether a diagnostic's pointer could have been made from this scene: the
** empty pointer (the whole scene), or segments that are each an array index,
** a property name of the schema or a declared id.
***************************************************************************/
boolean points(String pointer)
{
if(pointer.isEmpty())
{
return (true);
}
if(!pointer.startsWith("/"))
{
return (false);
}
for(String segment : pointer.substring(1).split("/", -1))
{
if(!(INDEX.matcher(segment).matches() || VOCABULARY.contains(segment) || ids.contains(segment)))
{
return (false);
}
}
return (true);
}
}
@@ -0,0 +1,406 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.CodingErrorAction;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.Diagnostic;
/*******************************************************************************
** One answer of the worker, read as untrusted bytes. Nothing in it is believed
** until it has been held to the request it answers, to the version rule and,
** for a diagnostic, to the scene the host sent: a diagnostic is a code of the
** closed vocabulary, numbers, an element id that scene declares and a pointer
** made of array indexes, schema property names and declared ids. A worker
** cannot put a sentence, a record value or a made-up name into one.
**
** Reading has two steps. `read` takes the frame apart and checks everything
** that does not depend on what was asked: the frame, the field shapes, the
** protocol, the request id, the catalog and a renderer version this bridge
** accepts. `settle` then holds the answer to the question: a refusal becomes
** the typed exception, anything out of place is rejected by name.
*******************************************************************************/
final class WorkerAnswer
{
static final String CATALOG = "qqq-barcodes-9";
///////////////////////////////////////////////////////////////////////////////////////////////////
// what one answer may hold beyond its label. A scene has at most 1000 elements; each can be //
// refused once and warned about a few times. 2048 findings in one megabyte is far more than a //
// real label makes and bounds what a hostile worker can make the host read and keep //
///////////////////////////////////////////////////////////////////////////////////////////////////
static final int MAXIMUM_DIAGNOSTICS = 2048;
static final int DIAGNOSTICS_BYTES = 1024 * 1024;
private static final Set<String> TEXT = Set.of("protocol", "requestId", "outcome", "rendererVersion", "catalogVersion", "mediaType", "base64", "sha256", "code");
private static final Set<String> NUMBERS = Set.of("length", "pageCount");
private static final int MAXIMUM_BOX = 1_000_000;
private final ObjectNode fields;
private final RendererVersion version;
private final List<Diagnostic> diagnostics;
private final Diagnostic detail;
private final boolean detailed;
/***************************************************************************
** An answer whose parts have been read and whose envelope has been checked.
***************************************************************************/
private WorkerAnswer(ObjectNode fields, RendererVersion version, List<Diagnostic> diagnostics, Diagnostic detail, boolean detailed)
{
this.fields = fields;
this.version = version;
this.diagnostics = diagnostics;
this.detail = detail;
this.detailed = detailed;
}
/***************************************************************************
** Read one frame: exactly one line of strict JSON whose fields are the known
** ones in their known shapes, from an accepted renderer, for this request.
***************************************************************************/
static WorkerAnswer read(byte[] output, int maximumFrame, String requestId, SceneFacts facts) throws IOException
{
if(output.length > maximumFrame)
{
throw new IllegalArgumentException("RESPONSE_BYTE_LIMIT");
}
if(output.length == 0 || output[output.length - 1] != '\n')
{
throw new IllegalArgumentException("FRAME_TRUNCATED");
}
for(int index = 0; index < output.length - 1; index++)
{
if(output[index] == '\n' || output[index] == '\r')
{
throw new IllegalArgumentException("EXTRA_FRAME");
}
}
ObjectNode fields = RendererJson.JSON.createObjectNode();
List<Diagnostic> diagnostics = null;
Diagnostic detail = null;
boolean detailed = false;
var decoder = StandardCharsets.UTF_8.newDecoder().onMalformedInput(CodingErrorAction.REPORT).onUnmappableCharacter(CodingErrorAction.REPORT);
try(var reader = new InputStreamReader(new ByteArrayInputStream(output), decoder); JsonParser parser = RendererJson.JSON.getFactory().createParser(reader))
{
if(parser.nextToken() != JsonToken.START_OBJECT)
{
throw new IllegalArgumentException("RESPONSE_OBJECT_REQUIRED");
}
while(parser.nextToken() != JsonToken.END_OBJECT)
{
String field = parser.currentName();
JsonToken token = parser.nextToken();
if(TEXT.contains(field) && token == JsonToken.VALUE_STRING)
{
fields.put(field, text(parser, field.equals("base64") ? maximumFrame : 128));
}
else if(NUMBERS.contains(field) && token == JsonToken.VALUE_NUMBER_INT)
{
fields.put(field, parser.getIntValue());
}
else if(field.equals("diagnostics") && token == JsonToken.START_ARRAY)
{
diagnostics = new ArrayList<>();
while(parser.nextToken() != JsonToken.END_ARRAY)
{
if(diagnostics.size() == MAXIMUM_DIAGNOSTICS)
{
throw new IllegalArgumentException("DIAGNOSTIC_LIMIT");
}
diagnostics.add(diagnostic(parser, facts));
}
}
else if(field.equals("detail") && token == JsonToken.START_OBJECT)
{
detail = diagnostic(parser, facts);
detailed = true;
}
else
{
throw new IllegalArgumentException("RESPONSE_FIELD_REJECTED");
}
}
if(parser.nextToken() != null)
{
throw new IllegalArgumentException("RESPONSE_TRAILING_VALUE");
}
}
RendererVersion version = RendererVersion.of(fields.path("rendererVersion").textValue());
if(version == null || !RendererJson.PROTOCOL.equals(fields.path("protocol").textValue()) || !requestId.equals(fields.path("requestId").textValue())
|| !CATALOG.equals(fields.path("catalogVersion").textValue()) || !Set.of("OK", "REFUSED", "ERROR").contains(fields.path("outcome").asText()))
{
throw new IllegalArgumentException("WORKER_RESPONSE_REJECTED");
}
return (new WorkerAnswer(fields, version, diagnostics == null ? null : List.copyOf(diagnostics), detail, detailed));
}
/***************************************************************************
** Hold the answer to what was asked. `current` says the job needs renderer
** 0.2.0 (a version 2 scene, or collected diagnostics); `collect` says the
** job asked for every diagnostic, which is the only way an answer may be
** `REFUSED`. A refusal the renderer may name leaves as the typed exception
** with its diagnostic; an answer that is returned is `OK` or `REFUSED` and
** has exactly the fields its outcome and renderer allow.
***************************************************************************/
WorkerAnswer settle(String operation, boolean collect, boolean current) throws GenerationPorts.RenderException
{
if(current && !version.structured())
{
////////////////////////////////////////////////////////////////////////////////////////
// whatever an old renderer said about a job it cannot do, it did not do the job //
////////////////////////////////////////////////////////////////////////////////////////
throw new GenerationPorts.RenderException(GenerationPorts.FailureCode.RENDERER_TOO_OLD);
}
String outcome = fields.path("outcome").textValue();
if(outcome.equals("ERROR"))
{
throw refusal();
}
boolean refused = outcome.equals("REFUSED");
int expected = refused || operation.equals("VALIDATE") ? 5 : 10;
boolean errors = diagnostics != null && diagnostics.stream().anyMatch(WorkerAnswer::error);
if(fields.size() != expected || detailed || (diagnostics != null) != version.structured() || (refused && !(collect && errors)) || (!refused && errors))
{
throw new IllegalArgumentException("WORKER_RESPONSE_REJECTED");
}
return (this);
}
/***************************************************************************
** The typed refusal of an error answer, or the rejection of one that is not
** exactly an error answer of its renderer.
***************************************************************************/
private GenerationPorts.RenderException refusal()
{
GenerationPorts.FailureCode code;
try
{
code = GenerationPorts.FailureCode.valueOf(RendererJson.text(fields.get("code"), 64));
}
catch(IllegalArgumentException unknown)
{
throw new IllegalArgumentException("WORKER_ERROR_REJECTED");
}
if(fields.size() != 6 || diagnostics != null || (detailed && !version.structured()) || !version.names(code)
|| (detailed && !(error(detail) && detail.code().equals(code.name()))))
{
throw new IllegalArgumentException("WORKER_ERROR_REJECTED");
}
return (new GenerationPorts.RenderException(code, detail));
}
/***************************************************************************
** The renderer that answered.
***************************************************************************/
RendererVersion version()
{
return (version);
}
/***************************************************************************
** Whether the renderer collected at least one error and so sent no label.
***************************************************************************/
boolean refused()
{
return ("REFUSED".equals(fields.path("outcome").textValue()));
}
/***************************************************************************
** The scalar fields of the answer.
***************************************************************************/
JsonNode fields()
{
return (fields);
}
/***************************************************************************
** The findings of the answer, in the order the renderer found them; none
** for a renderer that has none.
***************************************************************************/
List<Diagnostic> diagnostics()
{
return (diagnostics == null ? List.of() : diagnostics);
}
/***************************************************************************
** Whether a finding stops printing.
***************************************************************************/
private static boolean error(Diagnostic diagnostic)
{
return (diagnostic.severity() == Diagnostic.Severity.ERROR);
}
/***************************************************************************
** One diagnostic object, field by field. The record admits only the closed
** vocabulary and number shapes; the scene admits only its own ids and
** pointers.
***************************************************************************/
private static Diagnostic diagnostic(JsonParser parser, SceneFacts facts) throws IOException
{
if(parser.currentToken() != JsonToken.START_OBJECT)
{
throw new IllegalArgumentException("DIAGNOSTIC_OBJECT_REQUIRED");
}
Map<String, String> words = new LinkedHashMap<>();
List<Integer> box = null;
Map<String, Integer> measured = null;
Map<String, Integer> limit = null;
while(parser.nextToken() != JsonToken.END_OBJECT)
{
String field = parser.currentName();
JsonToken token = parser.nextToken();
if(Set.of("code", "severity", "element").contains(field) && token == JsonToken.VALUE_STRING)
{
words.put(field, text(parser, 64));
}
else if(field.equals("pointer") && token == JsonToken.VALUE_STRING)
{
words.put(field, text(parser, 16 * 33));
}
else if(field.equals("box") && token == JsonToken.START_ARRAY)
{
box = new ArrayList<>();
while(parser.nextToken() != JsonToken.END_ARRAY)
{
int value = integer(parser);
if(box.size() == 4 || Math.abs((long) value) > MAXIMUM_BOX)
{
throw new IllegalArgumentException("DIAGNOSTIC_BOX");
}
box.add(value);
}
}
else if(field.equals("measured") && token == JsonToken.START_OBJECT)
{
measured = numbers(parser);
}
else if(field.equals("limit") && token == JsonToken.START_OBJECT)
{
limit = numbers(parser);
}
else
{
throw new IllegalArgumentException("DIAGNOSTIC_FIELD_REJECTED");
}
}
Diagnostic diagnostic;
try
{
diagnostic = new Diagnostic(words.get("code"), Diagnostic.Severity.valueOf(String.valueOf(words.get("severity"))), words.get("element"), box, measured, limit, words.get("pointer"));
}
catch(IllegalArgumentException outside)
{
/////////////////////////////////////////////////////////////////////////////////////////
// the record's own messages are sentences for a developer; one name is enough here //
/////////////////////////////////////////////////////////////////////////////////////////
throw new IllegalArgumentException("DIAGNOSTIC_OUTSIDE_VOCABULARY");
}
if((diagnostic.element() != null && !facts.declares(diagnostic.element())) || (diagnostic.pointer() != null && !facts.points(diagnostic.pointer())))
{
throw new IllegalArgumentException("DIAGNOSTIC_NOT_OF_THIS_SCENE");
}
return (diagnostic);
}
/***************************************************************************
** At most eight named integers. The record checks the names.
***************************************************************************/
private static Map<String, Integer> numbers(JsonParser parser) throws IOException
{
Map<String, Integer> numbers = new LinkedHashMap<>();
while(parser.nextToken() != JsonToken.END_OBJECT)
{
String name = parser.currentName();
parser.nextToken();
if(numbers.size() == 8 || name.length() > 32)
{
throw new IllegalArgumentException("DIAGNOSTIC_NUMBERS");
}
numbers.put(name, integer(parser));
}
return (numbers);
}
/***************************************************************************
** A whole number that fits an int; nothing is coerced into one.
***************************************************************************/
private static int integer(JsonParser parser) throws IOException
{
if(parser.currentToken() != JsonToken.VALUE_NUMBER_INT)
{
throw new IllegalArgumentException("DIAGNOSTIC_INTEGER");
}
return (parser.getIntValue());
}
/***************************************************************************
** A string no longer than its field allows.
***************************************************************************/
private static String text(JsonParser parser, int maximum) throws IOException
{
if(parser.getTextLength() > maximum)
{
throw new IllegalArgumentException("RESPONSE_TEXT_LIMIT");
}
return (parser.getText());
}
}
@@ -0,0 +1,537 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.io.ByteArrayOutputStream;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.zip.CRC32;
import java.util.zip.Deflater;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
/*******************************************************************************
** The page a printer would draw, decoded on the host from the label bytes the
** host would send it. There is no second renderer: the picture is made from
** the printer commands themselves, after the output policy has accepted them,
** so a preview cannot show something other than what prints.
**
** The reader is its own strict parser of the policy's grammar and trusts
** nothing it is handed: a byte that is not the next byte of that grammar, a
** number that is not canonical, a field that leaves the page or a page too
** large to draw is refused by name. Graphic fields (`^GFA`) and boxes (`^GB`)
** are painted exactly. Printer font text (`^A0N`), which only a version 1
** scene emits, cannot be drawn without the printer's font: its estimated area
** is hatched and the page says it is not exact.
**
** No image or font is decoded here. The only image work is writing this
** class's own one-bit bitmap as a PNG.
*******************************************************************************/
final class ZplRaster
{
///////////////////////////////////////////////////////////////////////////////////////////////
// a 4 x 6 in label at 600 dpi is 8.6 million dots; twice that is the most a preview draws //
///////////////////////////////////////////////////////////////////////////////////////////////
static final long MAXIMUM_DOTS = 16_000_000L;
private static final int HATCH = 6;
private static final byte[] SIGNATURE = {(byte) 0x89, 'P', 'N', 'G', 13, 10, 26, 10};
private final int width;
private final int height;
private final int stride;
private final byte[] ink;
private boolean exact = true;
/***************************************************************************
** A blank page of whole dots, within what a printer can address and a
** preview may draw.
***************************************************************************/
private ZplRaster(int width, int height)
{
if(width < 1 || width > 9999 || height < 1 || height > 32000)
{
throw new IllegalArgumentException("RASTER_PAGE");
}
if((long) width * height > MAXIMUM_DOTS)
{
throw new IllegalArgumentException("PREVIEW_TOO_LARGE");
}
this.width = width;
this.height = height;
stride = (width + 7) / 8;
ink = new byte[stride * height];
}
/***************************************************************************
** The page of a label for its stock. The output policy runs first, here, so
** no caller can draw bytes it did not accept.
***************************************************************************/
static ZplRaster page(byte[] zpl, GenerationPorts.Stock stock) throws Exception
{
ZplOutputPolicy.validate(zpl, stock);
return (decode(zpl));
}
/***************************************************************************
** Read a label and paint its fields. Fields are combined as a printer
** combines them: ink over ink is ink.
***************************************************************************/
static ZplRaster decode(byte[] zpl)
{
Reader reader = new Reader(zpl);
reader.literal("^XA^PW");
int pageWidth = reader.number();
reader.literal("^LL");
ZplRaster page = new ZplRaster(pageWidth, reader.number());
reader.literal("^LH0,0^CI28\n");
while(!reader.peek("^XZ\n"))
{
reader.literal("^FO");
int x = reader.number();
reader.literal(",");
int y = reader.number();
if(reader.peek("^A0N,"))
{
page.text(reader, x, y);
}
else if(reader.peek("^GB"))
{
page.box(reader, x, y);
}
else
{
page.graphic(reader, x, y);
}
}
reader.literal("^XZ\n");
reader.end();
return (page);
}
/***************************************************************************
** A page that shows only where elements were refused: each box, given in
** dots from the printable area's top left as a diagnostic gives it, hatched
** at its place on the page and cut to the page. It is drawn from numbers
** alone. No label exists for it, so nothing of it can be printed.
***************************************************************************/
static ZplRaster refused(int width, int height, int originX, int originY, List<List<Integer>> boxes)
{
ZplRaster page = new ZplRaster(width, height);
page.exact = false;
for(List<Integer> box : boxes)
{
long left = Math.max(0L, (long) originX + box.get(0));
long top = Math.max(0L, (long) originY + box.get(1));
long right = Math.min(width, (long) originX + box.get(0) + box.get(2));
long bottom = Math.min(height, (long) originY + box.get(1) + box.get(3));
if(left < right && top < bottom)
{
page.hatch((int) left, (int) top, (int) (right - left), (int) (bottom - top));
}
}
return (page);
}
/***************************************************************************
** The page width in dots.
***************************************************************************/
int width()
{
return (width);
}
/***************************************************************************
** The page height in dots.
***************************************************************************/
int height()
{
return (height);
}
/***************************************************************************
** Whether every dot is what a printer draws. False when the label holds
** printer font text, or the page shows refused elements instead of a label.
***************************************************************************/
boolean exact()
{
return (exact);
}
/***************************************************************************
** Whether a dot of the page is inked.
***************************************************************************/
boolean ink(int x, int y)
{
return ((ink[y * stride + x / 8] & (128 >> x % 8)) != 0);
}
/***************************************************************************
** The page as a one-bit greyscale PNG: one pixel for each dot, ink black.
***************************************************************************/
byte[] png()
{
byte[] lines = new byte[(stride + 1) * height];
for(int row = 0; row < height; row++)
{
for(int index = 0; index < stride; index++)
{
lines[row * (stride + 1) + 1 + index] = (byte) ~ink[row * stride + index];
}
}
Deflater deflater = new Deflater();
ByteArrayOutputStream data = new ByteArrayOutputStream();
try
{
deflater.setInput(lines);
deflater.finish();
byte[] buffer = new byte[65536];
while(!deflater.finished())
{
data.write(buffer, 0, deflater.deflate(buffer));
}
}
finally
{
deflater.end();
}
ByteArrayOutputStream png = new ByteArrayOutputStream();
png.writeBytes(SIGNATURE);
byte[] header = new byte[13];
number(header, 0, width);
number(header, 4, height);
header[8] = 1;
chunk(png, "IHDR", header);
chunk(png, "IDAT", data.toByteArray());
chunk(png, "IEND", new byte[0]);
return (png.toByteArray());
}
/***************************************************************************
** One PNG chunk: length, type, data and the checksum of type and data.
***************************************************************************/
private static void chunk(ByteArrayOutputStream png, String type, byte[] data)
{
byte[] name = type.getBytes(StandardCharsets.US_ASCII);
byte[] word = new byte[4];
number(word, 0, data.length);
png.writeBytes(word);
png.writeBytes(name);
png.writeBytes(data);
CRC32 checksum = new CRC32();
checksum.update(name);
checksum.update(data);
number(word, 0, (int) checksum.getValue());
png.writeBytes(word);
}
/***************************************************************************
** A big-endian 32-bit number.
***************************************************************************/
private static void number(byte[] target, int at, int value)
{
target[at] = (byte) (value >>> 24);
target[at + 1] = (byte) (value >>> 16);
target[at + 2] = (byte) (value >>> 8);
target[at + 3] = (byte) value;
}
/***************************************************************************
** Printer font text: the area the policy holds it to (one cell of the font
** width for each character, one line of the font height), hatched.
***************************************************************************/
private void text(Reader reader, int x, int y)
{
reader.literal("^A0N,");
int fontHeight = reader.number();
reader.literal(",");
int fontWidth = reader.number();
reader.literal("^FH_^FD");
int characters = 0;
while(reader.peek("_"))
{
reader.literal("_");
int value = reader.hex() * 16 + reader.hex();
characters += (value & 0xC0) == 0x80 ? 0 : 1;
}
reader.literal("^FS\n");
long cells = (long) fontWidth * characters;
inside(x, y, cells, fontHeight);
hatch(x, y, (int) cells, fontHeight);
exact = false;
}
/***************************************************************************
** A box as the printer draws it: a border of the stated thickness inside
** the stated size, which is solid when the border meets itself.
***************************************************************************/
private void box(Reader reader, int x, int y)
{
reader.literal("^GB");
int boxWidth = reader.number();
reader.literal(",");
int boxHeight = reader.number();
reader.literal(",");
int thickness = reader.number();
reader.literal("^FS\n");
inside(x, y, boxWidth, boxHeight);
if(thickness < 1 || thickness > Math.min(boxWidth, boxHeight))
{
throw new IllegalArgumentException("RASTER_FIELD");
}
for(int row = 0; row < boxHeight; row++)
{
boolean border = row < thickness || row >= boxHeight - thickness;
for(int column = 0; column < boxWidth; column++)
{
if(border || column < thickness || column >= boxWidth - thickness)
{
set(x + column, y + row);
}
}
}
}
/***************************************************************************
** An uncompressed graphic field: rows of whole bytes, most significant bit
** first. Bits that pad the last byte of a row past the page edge must be
** white, as the policy requires.
***************************************************************************/
private void graphic(Reader reader, int x, int y)
{
reader.literal("^GFA,");
int transmitted = reader.number();
reader.literal(",");
int total = reader.number();
reader.literal(",");
int rowBytes = reader.number();
reader.literal(",");
if(total < 1 || total > 99999 || transmitted != total || rowBytes < 1 || rowBytes > 1250 || total % rowBytes != 0)
{
throw new IllegalArgumentException("RASTER_FIELD");
}
inside(x, y, 1, total / rowBytes);
for(int index = 0; index < total; index++)
{
int value = reader.hex() * 16 + reader.hex();
for(int bit = 0; bit < 8; bit++)
{
if((value & (128 >> bit)) != 0)
{
int column = x + index % rowBytes * 8 + bit;
if(column >= width)
{
throw new IllegalArgumentException("RASTER_FIELD");
}
set(column, y + index / rowBytes);
}
}
}
reader.literal("^FS\n");
}
/***************************************************************************
** Refuse a field that is not wholly on the page.
***************************************************************************/
private void inside(int x, int y, long fieldWidth, long fieldHeight)
{
if(fieldWidth < 1 || fieldHeight < 1 || x + fieldWidth > width || y + fieldHeight > height)
{
throw new IllegalArgumentException("RASTER_FIELD");
}
}
/***************************************************************************
** An outline with diagonal lines across it: plainly a placeholder, never
** mistaken for ink the label holds.
***************************************************************************/
private void hatch(int x, int y, int areaWidth, int areaHeight)
{
for(int row = 0; row < areaHeight; row++)
{
for(int column = 0; column < areaWidth; column++)
{
if(row == 0 || column == 0 || row == areaHeight - 1 || column == areaWidth - 1 || (row + column) % HATCH == 0)
{
set(x + column, y + row);
}
}
}
}
/***************************************************************************
** Ink one dot that is known to be on the page.
***************************************************************************/
private void set(int x, int y)
{
ink[y * stride + x / 8] |= (byte) (128 >> x % 8);
}
/***************************************************************************
** The bytes of a label and a place in them. Every read is bounded and every
** mismatch ends the reading: nothing is skipped or repaired.
***************************************************************************/
private static final class Reader
{
private final byte[] bytes;
private int position;
/************************************************************************
** Start at the first byte.
************************************************************************/
private Reader(byte[] bytes)
{
if(bytes == null)
{
throw new IllegalArgumentException("RASTER_GRAMMAR");
}
this.bytes = bytes;
}
/************************************************************************
** Whether the next bytes are these.
************************************************************************/
private boolean peek(String literal)
{
if(position + literal.length() > bytes.length)
{
return (false);
}
for(int index = 0; index < literal.length(); index++)
{
if(bytes[position + index] != literal.charAt(index))
{
return (false);
}
}
return (true);
}
/************************************************************************
** Pass these bytes or refuse.
************************************************************************/
private void literal(String literal)
{
if(!peek(literal))
{
throw new IllegalArgumentException("RASTER_GRAMMAR");
}
position += literal.length();
}
/************************************************************************
** An unsigned decimal number without a leading zero, of at most six
** digits: more than any size, place or length a label can state.
************************************************************************/
private int number()
{
int start = position;
int value = 0;
while(position < bytes.length && bytes[position] >= '0' && bytes[position] <= '9' && position - start < 7)
{
value = value * 10 + bytes[position++] - '0';
}
if(position == start || position - start > 6 || (position - start > 1 && bytes[start] == '0'))
{
throw new IllegalArgumentException("RASTER_NUMBER");
}
return (value);
}
/************************************************************************
** One uppercase hexadecimal digit.
************************************************************************/
private int hex()
{
int value = position < bytes.length ? bytes[position] : -1;
position++;
if(value >= '0' && value <= '9')
{
return (value - '0');
}
if(value >= 'A' && value <= 'F')
{
return (value - 'A' + 10);
}
throw new IllegalArgumentException("RASTER_HEX");
}
/************************************************************************
** Nothing may follow the end of the label.
************************************************************************/
private void end()
{
if(position != bytes.length)
{
throw new IllegalArgumentException("RASTER_GRAMMAR");
}
}
}
}
@@ -183,13 +183,25 @@ class BridgeTest
@Test
void exactWorkerErrorsPreserveClosedFailureCodes() throws Exception
{
assertEquals(13, GenerationPorts.FailureCode.values().length);
var released = java.util.EnumSet.range(GenerationPorts.FailureCode.BARCODE_FIT_TOO_SMALL, GenerationPorts.FailureCode.UNSUPPORTED_BARCODE_OPTION);
assertEquals(13, released.size());
assertEquals(28, GenerationPorts.FailureCode.values().length);
for(var code : GenerationPorts.FailureCode.values())
{
var bridge = new IsolatedRendererBridge(config(directory), (actor, asset, maximum) -> new byte[0], (id, input, maximum) ->
(RendererJson.JSON.writeValueAsString(Map.of("protocol", RendererJson.PROTOCOL, "requestId", id, "outcome", "ERROR",
"rendererVersion", "qqq-renderer-0.1.0", "catalogVersion", "qqq-barcodes-9", "code", code.name())) + "\n").getBytes(StandardCharsets.UTF_8));
var request = request(Map.of(), List.of());
if(!released.contains(code))
{
// A version 2 scene refusal named by a 0.1.0 worker stays as unknown as it was before the vocabulary grew.
for(var generic : List.of(assertThrows(QException.class, () -> bridge.render(request)), assertThrows(QException.class, () -> bridge.validate("actor-1", request.revision()))))
{
assertEquals(QException.class, generic.getClass(), code.name());
assertEquals("Isolated renderer rejected or could not complete the request.", generic.getMessage());
}
continue;
}
var failure = assertThrows(GenerationPorts.RenderException.class, () -> bridge.render(request));
assertEquals(code, failure.code());
assertEquals(code.name(), failure.getMessage());
@@ -381,9 +393,10 @@ class BridgeTest
{
for(String malformed : List.of("{\"base64\":[]}", "{\"base64\":{\"nested\":1}}", "{\"unknown\":1}", "{\"length\":1,\"length\":2}", "{\"length\":2147483648}", "{\"length\":1} {}"))
{
assertThrows(Exception.class, () -> RendererJson.response(malformed.getBytes(StandardCharsets.UTF_8), 4096));
assertThrows(Exception.class, () -> WorkerAnswer.read((malformed + "\n").getBytes(StandardCharsets.UTF_8), 4096, "request-1", SceneFacts.of(GenerationPorts.Format.ZPL, "{}")));
}
assertThrows(Exception.class, () -> RendererJson.response(new byte[] { '{', '"', 'b', 'a', 's', 'e', '6', '4', '"', ':', '"', (byte) 0xff, '"', '}' }, 4096));
assertThrows(Exception.class, () -> WorkerAnswer.read(new byte[] { '{', '"', 'b', 'a', 's', 'e', '6', '4', '"', ':', '"', (byte) 0xff, '"', '}', '\n' }, 4096, "request-1",
SceneFacts.of(GenerationPorts.Format.ZPL, "{}")));
}
/*******************************************************************************
@@ -0,0 +1,272 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Base64;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
/*******************************************************************************
** A stand-in for the worker, for tests of the host side: it keeps every frame
** the bridge sends and answers as a renderer of a stated version would, or as
** a test tells it to. It answers the bridge's version question by itself, so a
** test writes only the answer to the job it is about. No renderer code runs.
*******************************************************************************/
final class FakeWorker implements IsolatedRendererBridge.Exchange
{
static final String RELEASED = "qqq-renderer-0.1.0";
static final String CURRENT = "qqq-renderer-0.2.0";
static final Path SCENES = Path.of("..", "..", "renderer", "src", "test", "resources", "scene2");
static final String VERSION_ONE_SCENE = "{\"schema\":\"qqq-zpl-scene/1\",\"elements\":[{\"type\":\"box\",\"x\":2,\"y\":40,\"width\":20,\"height\":10,\"thickness\":1}]}";
final List<JsonNode> jobs = new ArrayList<>();
final List<JsonNode> questions = new ArrayList<>();
final List<Integer> frameLimits = new ArrayList<>();
private final String version;
private final Answer answer;
/***************************************************************************
** What the worker says to one job.
***************************************************************************/
@FunctionalInterface
interface Answer
{
/************************************************************************
** The fields of the answer frame for a job the bridge sent.
************************************************************************/
Map<String, Object> to(JsonNode job) throws Exception;
}
/***************************************************************************
** A worker of a version that answers every job the same way.
***************************************************************************/
FakeWorker(String version, Answer answer)
{
this.version = version;
this.answer = answer;
}
/***************************************************************************
** Keep the frame; answer the version question as this renderer would, and a
** job as the test says.
***************************************************************************/
@Override
public byte[] invoke(String requestId, byte[] input, int maximumOutput) throws Exception
{
JsonNode job = RendererJson.parse(input, 16 * 1024 * 1024);
if(IsolatedRendererBridge.PROBE_SCENE.equals(job.path("source").textValue()))
{
questions.add(job);
return (frame(validated(requestId, version)));
}
jobs.add(job);
frameLimits.add(maximumOutput);
return (frame(answer.to(job)));
}
/***************************************************************************
** A bridge over this exchange whose deployment admits documents of four
** megabytes, with no assets to read.
***************************************************************************/
static IsolatedRendererBridge bridge(Path directory, IsolatedRendererBridge.Exchange exchange)
{
RendererConfiguration base = BridgeTest.config(directory);
return (new IsolatedRendererBridge(new RendererConfiguration(base.dockerExecutable(), base.image(), base.imageId(), base.qualificationId(), base.requiredQualificationId(), base.ownerId(),
directory, base.renderDeadline(), 4 * 1024 * 1024, 20), (actor, asset, maximum) -> new byte[0], exchange));
}
/***************************************************************************
** One answer frame.
***************************************************************************/
static byte[] frame(Map<String, Object> fields) throws Exception
{
return ((RendererJson.JSON.writeValueAsString(fields) + "\n").getBytes(StandardCharsets.UTF_8));
}
/***************************************************************************
** The fields every answer has.
***************************************************************************/
static Map<String, Object> envelope(String requestId, String version, String outcome)
{
Map<String, Object> fields = new LinkedHashMap<>();
fields.put("protocol", RendererJson.PROTOCOL);
fields.put("requestId", requestId);
fields.put("outcome", outcome);
fields.put("rendererVersion", version);
fields.put("catalogVersion", WorkerAnswer.CATALOG);
return (fields);
}
/***************************************************************************
** A successful validation, as a renderer of this version answers it.
***************************************************************************/
static Map<String, Object> validated(String requestId, String version)
{
Map<String, Object> fields = envelope(requestId, version, "OK");
if(CURRENT.equals(version))
{
fields.put("diagnostics", List.of());
}
return (fields);
}
/***************************************************************************
** A rendered label, as a renderer of this version answers it; renderer
** 0.2.0 adds the diagnostics.
***************************************************************************/
static Map<String, Object> rendered(String requestId, String version, byte[] label, List<Map<String, Object>> diagnostics) throws Exception
{
Map<String, Object> fields = envelope(requestId, version, "OK");
fields.put("mediaType", "application/vnd.zebra-zpl");
fields.put("base64", Base64.getEncoder().encodeToString(label));
fields.put("sha256", RendererJson.hash(label));
fields.put("length", label.length);
fields.put("pageCount", 1);
if(CURRENT.equals(version))
{
fields.put("diagnostics", diagnostics);
}
return (fields);
}
/***************************************************************************
** A scene whose diagnostics were collected and hold an error: no label.
***************************************************************************/
static Map<String, Object> refused(String requestId, List<Map<String, Object>> diagnostics)
{
Map<String, Object> fields = envelope(requestId, CURRENT, "REFUSED");
fields.put("diagnostics", diagnostics);
return (fields);
}
/***************************************************************************
** An error answer, with its one diagnostic when there is one.
***************************************************************************/
static Map<String, Object> error(String requestId, String version, String code, Map<String, Object> detail)
{
Map<String, Object> fields = envelope(requestId, version, "ERROR");
fields.put("code", code);
if(detail != null)
{
fields.put("detail", detail);
}
return (fields);
}
/***************************************************************************
** One diagnostic as the wire carries it: a code, a severity and, in pairs,
** any of its other parts.
***************************************************************************/
static Map<String, Object> diagnostic(String code, String severity, Object... parts)
{
Map<String, Object> wire = new LinkedHashMap<>();
wire.put("code", code);
wire.put("severity", severity);
for(int index = 0; index < parts.length; index += 2)
{
wire.put((String) parts[index], parts[index + 1]);
}
return (wire);
}
/***************************************************************************
** The source of one of the renderer's version 2 layout cases.
***************************************************************************/
static String scene(String name) throws Exception
{
return (RendererJson.JSON.writeValueAsString(definition(name).path("scene")));
}
/***************************************************************************
** The stock of one of those cases.
***************************************************************************/
static GenerationPorts.Stock stock(String name) throws Exception
{
JsonNode stock = definition(name).path("stock");
return (new GenerationPorts.Stock(stock.path("widthMicrons").intValue(), stock.path("heightMicrons").intValue(), stock.path("topMicrons").intValue(),
stock.path("rightMicrons").intValue(), stock.path("bottomMicrons").intValue(), stock.path("leftMicrons").intValue(), stock.path("dpi").intValue()));
}
/***************************************************************************
** The golden label of a case at a resolution, as the renderer emits it.
***************************************************************************/
static byte[] golden(String name, int dpi) throws Exception
{
return (Files.readAllBytes(SCENES.resolve("golden").resolve(name + "-" + dpi + ".zpl")));
}
/***************************************************************************
** A revision whose label source is this scene on this stock.
***************************************************************************/
static GenerationPorts.Revision revision(String zplSource, GenerationPorts.Stock stock)
{
return (new GenerationPorts.Revision(1, 1, "orders", stock, null, zplSource, null, List.of()));
}
/***************************************************************************
** One case file.
***************************************************************************/
private static JsonNode definition(String name) throws Exception
{
return (RendererJson.JSON.readTree(Files.readAllBytes(SCENES.resolve("cases").resolve(name + ".json"))));
}
}
@@ -0,0 +1,218 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.SplittableRandom;
import java.util.function.Predicate;
/*******************************************************************************
** Seeded, bounded mutation campaign for a parser of untrusted input. A seed, an
** iteration number, the corpus and the dictionary fully determine every input:
** there is no clock and no unseeded randomness, so a finding replays exactly.
** Targets, limits and the replay command are in `docs/security/fuzzing.md`. The
** same class is kept in the test tree of `renderer`.
*******************************************************************************/
final class MutationCampaign
{
static final int MAXIMUM_ITERATIONS = 100_000;
static final int MAXIMUM_INPUT_BYTES = 1024 * 1024;
private static final byte[] INTERESTING = {0, 9, 10, 13, ' ', '"', '\\', '^', '~', '_', ',', '{', '}', '[', ']', '0', '9', '-', (byte) 0x7F, (byte) 0x80, (byte) 0xC0, (byte) 0xFF};
private final List<byte[]> corpus;
private final List<byte[]> dictionary;
/***************************************************************************
** The parser under test. Returning normally means the input was accepted; a
** target asserts its own property on what it accepts.
***************************************************************************/
@FunctionalInterface
interface Target
{
/************************************************************************
** Parse one generated input.
************************************************************************/
void accept(byte[] input) throws Exception;
}
/***************************************************************************
** An input that was neither accepted nor refused in the declared way, with
** the coordinates that regenerate it: `input(seed, iteration)`.
***************************************************************************/
record Finding(long seed, int iteration, String failure)
{
}
/***************************************************************************
** What a campaign saw. A campaign that accepted or refused nothing has not
** exercised both sides of the parser, so callers assert on the counts too.
***************************************************************************/
record Result(int accepted, int refused, List<Finding> findings)
{
}
/***************************************************************************
** Valid inputs to start from, and tokens of the format to splice in.
***************************************************************************/
MutationCampaign(List<byte[]> corpus, List<String> dictionary)
{
if(corpus.isEmpty() || corpus.stream().anyMatch(seedInput -> seedInput.length > MAXIMUM_INPUT_BYTES))
{
throw new IllegalArgumentException("A campaign needs a corpus of inputs within the input limit.");
}
this.corpus = corpus.stream().map(byte[]::clone).toList();
this.dictionary = dictionary.stream().map(token -> token.getBytes(StandardCharsets.UTF_8)).toList();
}
/***************************************************************************
** The seeds for this run: the fixed ones, or only `-Dfuzz.seed=<n>` when a
** finding is replayed or a longer campaign is run by hand.
***************************************************************************/
static long[] seeds(long... fixed)
{
Long replay = Long.getLong("fuzz.seed");
return (replay == null ? fixed : new long[] {replay});
}
/***************************************************************************
** The iteration count for this run: `-Dfuzz.iterations=<n>`, never unbounded.
***************************************************************************/
static int iterations(int fallback)
{
int iterations = Integer.getInteger("fuzz.iterations", fallback);
if(iterations < 1 || iterations > MAXIMUM_ITERATIONS)
{
throw new IllegalArgumentException("fuzz.iterations must be between 1 and " + MAXIMUM_ITERATIONS);
}
return (iterations);
}
/***************************************************************************
** The input of one iteration: a corpus entry with one to four mutations.
***************************************************************************/
byte[] input(long seed, int iteration)
{
SplittableRandom random = new SplittableRandom(seed + 0x9E3779B97F4A7C15L * (iteration + 1L));
byte[] value = corpus.get(random.nextInt(corpus.size())).clone();
int steps = 1 + random.nextInt(4);
for(int step = 0; step < steps; step++)
{
value = mutate(value, random);
}
return (value.length > MAXIMUM_INPUT_BYTES ? Arrays.copyOf(value, MAXIMUM_INPUT_BYTES) : value);
}
/***************************************************************************
** Run iterations 0 to `iterations - 1`. A thrown failure that `refusal`
** recognises is the parser saying no; any other, including a failed assertion
** in the target and a stack overflow, is a finding.
***************************************************************************/
Result run(long seed, int iterations, Target target, Predicate<Throwable> refusal)
{
if(iterations < 1 || iterations > MAXIMUM_ITERATIONS)
{
throw new IllegalArgumentException("A campaign runs between 1 and " + MAXIMUM_ITERATIONS + " iterations.");
}
int accepted = 0;
int refused = 0;
List<Finding> findings = new ArrayList<>();
for(int iteration = 0; iteration < iterations; iteration++)
{
try
{
target.accept(input(seed, iteration));
accepted++;
}
catch(Exception | AssertionError | StackOverflowError failure)
{
if(refusal.test(failure))
{
refused++;
}
else
{
findings.add(new Finding(seed, iteration, failure.toString()));
}
}
}
return (new Result(accepted, refused, List.copyOf(findings)));
}
/***************************************************************************
** One structural or byte-level change at a random position.
***************************************************************************/
private byte[] mutate(byte[] value, SplittableRandom random)
{
int at = value.length == 0 ? 0 : random.nextInt(value.length);
int span = value.length == 0 ? 0 : 1 + random.nextInt(Math.min(16, value.length - at));
byte[] noise = new byte[1 + random.nextInt(8)];
random.nextBytes(noise);
return (switch(random.nextInt(8))
{
case 0 -> splice(value, at, span, new byte[0]);
case 1 -> splice(value, at, 0, Arrays.copyOfRange(value, at, at + span));
case 2 -> Arrays.copyOf(value, at);
case 3 -> splice(value, at, 0, dictionary.isEmpty() ? noise : dictionary.get(random.nextInt(dictionary.size())));
case 4 -> splice(value, at, 0, noise);
case 5 -> splice(value, at, Math.min(1, value.length), new byte[] {INTERESTING[random.nextInt(INTERESTING.length)]});
case 6 -> splice(value, at, Math.min(1, value.length), new byte[] {noise[0]});
default -> splice(value, at, Math.min(1, value.length), value.length == 0 ? noise : new byte[] {(byte) (value[at] ^ (1 << random.nextInt(8)))});
});
}
/***************************************************************************
** Replace `removed` bytes at `at` with `inserted`.
***************************************************************************/
private static byte[] splice(byte[] value, int at, int removed, byte[] inserted)
{
byte[] result = new byte[value.length - removed + inserted.length];
System.arraycopy(value, 0, result, 0, at);
System.arraycopy(inserted, 0, result, at, inserted.length);
System.arraycopy(value, at + removed, result, at + inserted.length, value.length - at - removed);
return (result);
}
}
@@ -0,0 +1,404 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.nio.charset.CharacterCodingException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.HexFormat;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
/*******************************************************************************
** The mutation harness is deterministic and reports what it should, and three
** bounded campaigns run in the normal test phase over what the host reads from
** the worker: the printer gate, the page decoder behind it, and the answer
** frames with their diagnostics. Seeds, limits and the replay command:
** `docs/security/fuzzing.md`.
*******************************************************************************/
class MutationCampaignTest
{
private static final long[] SEEDS = {20261111L, 7919L};
private static final int ITERATIONS = 20_000;
private static final Path CORPUS = Path.of("..", "..", "renderer", "src", "test", "resources", "compat-v1", "zpl");
private static final GenerationPorts.Stock STOCK = new GenerationPorts.Stock(76200, 50800, 0, 0, 0, 0, 203);
private static final Set<String> COMMANDS = Set.of("XA", "XZ", "PW", "LL", "LH", "CI", "FO", "A0", "FH", "FD", "FS", "GB", "GF");
private static final List<String> RELEASED = List.of("box-203", "text-font0-203", "image-203", "barcode-scale-203", "raster-text-rotation-203");
private static final List<String> TOKENS = List.of("^XA", "^XZ\n", "^FO", "^GFA,", "^GB", "^FS\n", "^A0N,", "^FH_^FD", "^PW", "^LL", "^LH0,0", "^CI28\n",
"~DG", "~JR", "^XG", "^DF", "^JU", "^FX", "^FB", "99999", "0", ",", "\n", "_5E", "_7E");
private static final Pattern FIELD = Pattern.compile("\\^FO([0-9]+),([0-9]+)\\^(?:GFA,[0-9]+,[0-9]+,([0-9]+),([0-9A-F]*)|GB([0-9]+),([0-9]+),([0-9]+))\\^FS\n");
private static final String REQUEST = "request-1";
private static final List<String> DECLARED = List.of("top-left", "top-center", "top-right", "middle-left", "center", "left-of-center", "middle-right", "bottom-left", "bottom-center",
"bottom-right");
/***************************************************************************
** A seed and an iteration name one input, on every run and every machine.
***************************************************************************/
@Test
void aSeedAndAnIterationAlwaysGiveTheSameInput()
{
MutationCampaign campaign = new MutationCampaign(List.of("^XA^FO10,20^GB30,40,2^FS^XZ".getBytes(StandardCharsets.US_ASCII)), List.of("^FO", "^GB"));
MutationCampaign again = new MutationCampaign(List.of("^XA^FO10,20^GB30,40,2^FS^XZ".getBytes(StandardCharsets.US_ASCII)), List.of("^FO", "^GB"));
Set<String> distinct = new HashSet<>();
for(int iteration = 0; iteration < 200; iteration++)
{
byte[] input = campaign.input(42L, iteration);
assertArrayEquals(input, again.input(42L, iteration));
assertTrue(input.length <= MutationCampaign.MAXIMUM_INPUT_BYTES);
distinct.add(HexFormat.of().formatHex(input));
}
assertTrue(distinct.size() > 100, "mutations should rarely repeat: " + distinct.size());
assertNotEquals(HexFormat.of().formatHex(campaign.input(42L, 0)), HexFormat.of().formatHex(campaign.input(43L, 0)));
}
/***************************************************************************
** The harness fails when it should: a crash and an unsafe acceptance are both
** findings, each carrying the coordinates that regenerate its input.
***************************************************************************/
@Test
void aCrashAndAnUnsafeAcceptanceAreFindingsThatReplay()
{
MutationCampaign campaign = new MutationCampaign(List.of("0123456789".getBytes(StandardCharsets.US_ASCII)), List.of());
MutationCampaign.Result result = campaign.run(42L, 300, input ->
{
if(input.length % 3 == 0)
{
throw new IllegalArgumentException("REFUSED");
}
if(input.length % 3 == 1)
{
throw new IllegalStateException("crash");
}
assertTrue(input.length < 11, "accepted an input it should have refused");
}, IllegalArgumentException.class::isInstance);
assertEquals(300, result.accepted() + result.refused() + result.findings().size());
assertTrue(result.accepted() > 0 && result.refused() > 0);
assertTrue(result.findings().stream().anyMatch(finding -> finding.failure().startsWith("java.lang.IllegalStateException")));
assertTrue(result.findings().stream().anyMatch(finding -> finding.failure().contains("AssertionFailedError")));
for(MutationCampaign.Finding finding : result.findings())
{
int length = campaign.input(finding.seed(), finding.iteration()).length;
assertTrue(length % 3 == 1 || (length % 3 == 2 && length >= 11), finding.toString());
}
}
/***************************************************************************
** A campaign is always bounded and always has something to mutate.
***************************************************************************/
@Test
void campaignsAreBounded()
{
MutationCampaign campaign = new MutationCampaign(List.of(new byte[0]), List.of());
assertThrows(IllegalArgumentException.class, () -> campaign.run(1L, 0, input -> {}, failure -> true));
assertThrows(IllegalArgumentException.class, () -> campaign.run(1L, MutationCampaign.MAXIMUM_ITERATIONS + 1, input -> {}, failure -> true));
assertThrows(IllegalArgumentException.class, () -> new MutationCampaign(List.of(), List.of()));
assertThrows(IllegalArgumentException.class, () -> new MutationCampaign(List.of(new byte[MutationCampaign.MAXIMUM_INPUT_BYTES + 1]), List.of()));
assertEquals(50, campaign.run(1L, 50, input -> {}, failure -> false).accepted());
}
/***************************************************************************
** Property: whatever the host printer gate accepts holds only the commands
** the renderer may emit, and no tilde command. Every other input is refused
** with the gate's own IllegalArgumentException, or with the strict decoder's
** CharacterCodingException for field text that is not UTF-8; any other
** failure is a finding.
***************************************************************************/
@Test
void theHostPrinterGateAcceptsOnlyTheRendererCommandSet() throws Exception
{
MutationCampaign campaign = new MutationCampaign(released(), TOKENS);
int iterations = MutationCampaign.iterations(ITERATIONS);
for(long seed : MutationCampaign.seeds(SEEDS))
{
MutationCampaign.Result result = campaign.run(seed, iterations, MutationCampaignTest::gate,
failure -> failure instanceof IllegalArgumentException || failure instanceof CharacterCodingException);
assertEquals(List.of(), result.findings(), "replay with -Dfuzz.seed=" + seed + " -Dfuzz.iterations=" + iterations);
assertFalse(result.accepted() == 0 || result.refused() == 0, "the campaign must reach both acceptance and refusal: " + result);
}
}
/***************************************************************************
** The released labels the printer campaigns mutate, each accepted by the
** gate for the stock it was rendered for.
***************************************************************************/
private static List<byte[]> released() throws Exception
{
List<byte[]> corpus = new ArrayList<>();
for(String name : RELEASED)
{
byte[] released = Files.readAllBytes(CORPUS.resolve(name + ".zpl"));
ZplOutputPolicy.validate(released, STOCK);
corpus.add(released);
}
return (corpus);
}
/***************************************************************************
** Property: the page decoder never fails on a label the printer gate
** accepts, and what it draws for one is exactly the label's graphic fields
** and boxes as a second, independent reading draws them. Handed bytes the
** gate refuses, as it never is in production, it draws or refuses by its
** own IllegalArgumentException and does nothing else. Any other failure is
** a finding.
***************************************************************************/
@Test
void thePageDecoderDrawsExactlyWhatThePrinterGateAccepts() throws Exception
{
MutationCampaign campaign = new MutationCampaign(released(), TOKENS);
int iterations = MutationCampaign.iterations(ITERATIONS);
for(long seed : MutationCampaign.seeds(SEEDS))
{
MutationCampaign.Result result = campaign.run(seed, iterations, MutationCampaignTest::page,
failure -> failure instanceof IllegalArgumentException || failure instanceof CharacterCodingException);
assertEquals(List.of(), result.findings(), "replay with -Dfuzz.seed=" + seed + " -Dfuzz.iterations=" + iterations);
assertFalse(result.accepted() == 0 || result.refused() == 0, "the campaign must reach both acceptance and refusal: " + result);
}
}
/***************************************************************************
** The decoder beside the gate, and an independent drawing of what the gate
** let through.
***************************************************************************/
private static void page(byte[] zpl) throws Exception
{
try
{
ZplOutputPolicy.validate(zpl, STOCK);
}
catch(IllegalArgumentException | CharacterCodingException refused)
{
try
{
ZplRaster page = ZplRaster.decode(zpl);
assertTrue((long) page.width() * page.height() <= ZplRaster.MAXIMUM_DOTS, "drew a page past the limit");
}
catch(IllegalArgumentException alsoRefused)
{
// The decoder's own refusal of bytes the gate refused.
}
throw refused;
}
ZplRaster page;
try
{
page = ZplRaster.decode(zpl);
}
catch(IllegalArgumentException refused)
{
throw new AssertionError("the decoder refused a label the gate accepts: " + refused.getMessage());
}
assertEquals(609, page.width());
assertEquals(406, page.height());
String text = new String(zpl, StandardCharsets.US_ASCII);
assertEquals(!text.contains("^A0N,"), page.exact());
if(page.exact())
{
boolean[][] expected = new boolean[406][609];
Matcher field = FIELD.matcher(text);
while(field.find())
{
int x = Integer.parseInt(field.group(1));
int y = Integer.parseInt(field.group(2));
if(field.group(3) != null)
{
int stride = Integer.parseInt(field.group(3));
byte[] raster = HexFormat.of().parseHex(field.group(4));
for(int index = 0; index < raster.length * 8; index++)
{
if((raster[index / 8] & (128 >> index % 8)) != 0)
{
expected[y + index / 8 / stride][x + index / 8 % stride * 8 + index % 8] = true;
}
}
}
else
{
int width = Integer.parseInt(field.group(5));
int height = Integer.parseInt(field.group(6));
int thickness = Integer.parseInt(field.group(7));
for(int row = 0; row < height; row++)
{
for(int column = 0; column < width; column++)
{
expected[y + row][x + column] |= row < thickness || column < thickness || row >= height - thickness || column >= width - thickness;
}
}
}
}
for(int y = 0; y < 406; y++)
{
for(int x = 0; x < 609; x++)
{
if(expected[y][x] != page.ink(x, y))
{
throw new AssertionError("the decoder and the independent drawing differ at dot " + x + ", " + y);
}
}
}
}
}
/***************************************************************************
** Property: whatever the answer reader accepts for a collected render of a
** version 2 scene is an answer of renderer 0.2.0 that is either a label with
** no error or a refusal with no label, and every diagnostic it carries names
** only an element the scene declares and points only through array indexes,
** schema property names and declared ids, as a second and plain JSON reader
** sees it. A typed refusal is held to the same rule. Everything else is
** rejected with the reader's IllegalArgumentException or the JSON reader's
** IOException; any other failure is a finding.
***************************************************************************/
@Test
void theAnswerReaderBelievesOnlyDiagnosticsOfTheSceneThatWasSent() throws Exception
{
byte[] label = "^XA^PW406^LL203^LH0,0^CI28\n^FO2,40^GFA,2,2,1,AA80^FS\n^XZ\n".getBytes(StandardCharsets.US_ASCII);
Map<String, Object> error = FakeWorker.diagnostic("RENDERER_TOO_OLD", "ERROR", "element", "center", "pointer", "/elements/4", "box", List.of(171, 68, 47, 23));
Map<String, Object> warning = FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING", "element", "top-left", "pointer", "/overrides/0/set/top-left/x", "measured", Map.of("widthDots", 902, "lines", 2),
"limit", Map.of("widthDots", 764));
List<byte[]> corpus = List.of(FakeWorker.frame(FakeWorker.rendered(REQUEST, FakeWorker.CURRENT, label, List.of(warning))), FakeWorker.frame(FakeWorker.refused(REQUEST, List.of(warning, error))),
FakeWorker.frame(FakeWorker.error(REQUEST, FakeWorker.CURRENT, "RENDERER_TOO_OLD", error)), FakeWorker.frame(FakeWorker.rendered(REQUEST, FakeWorker.CURRENT, label, List.of())),
FakeWorker.frame(FakeWorker.rendered(REQUEST, FakeWorker.RELEASED, label, List.of())), FakeWorker.frame(FakeWorker.error(REQUEST, FakeWorker.RELEASED, "BARCODE_FIT_TOO_SMALL", null)));
MutationCampaign campaign = new MutationCampaign(corpus, List.of("\"diagnostics\":", "\"detail\":", "\"REFUSED\"", "\"OK\"", "\"ERROR\"", "\"WARNING\"", "\"element\":\"", "\"pointer\":\"/",
"/elements/0", "/set/", "\"box\":[", "\"measured\":{", "\"limit\":{", "\"base64\":\"", "\"code\":\"", "\"severity\":\"", "top-left", "center", "undeclared", "secret", "qqq-renderer-0.1.0",
"qqq-renderer-0.2.0", "RENDER_FAILED", "TEXT_DOES_NOT_FIT", "SCENE_INVALID", "[", "]", "{", "}", ",", ":", "\"", "\n", "0", "-1", "2147483648"));
SceneFacts facts = SceneFacts.of(GenerationPorts.Format.ZPL, FakeWorker.scene("anchors"));
DECLARED.forEach(id -> assertTrue(facts.declares(id), id));
int iterations = MutationCampaign.iterations(ITERATIONS);
for(long seed : MutationCampaign.seeds(SEEDS))
{
MutationCampaign.Result result = campaign.run(seed, iterations, input -> answer(input, facts),
failure -> failure instanceof IllegalArgumentException || failure instanceof java.io.IOException || failure instanceof GenerationPorts.RenderException);
assertEquals(List.of(), result.findings(), "replay with -Dfuzz.seed=" + seed + " -Dfuzz.iterations=" + iterations);
assertFalse(result.accepted() == 0 || result.refused() == 0, "the campaign must reach both acceptance and refusal: " + result);
}
}
/***************************************************************************
** The reader, and an independent reading of what it let through.
***************************************************************************/
private static void answer(byte[] frame, SceneFacts facts) throws Exception
{
WorkerAnswer answer;
try
{
answer = WorkerAnswer.read(frame, 65536, REQUEST, facts).settle("RENDER", true, true);
}
catch(GenerationPorts.RenderException refusal)
{
if(refusal.diagnostic() != null)
{
ofTheScene(refusal.diagnostic().element(), refusal.diagnostic().pointer());
}
throw refusal;
}
JsonNode tree = new ObjectMapper().readTree(frame);
assertEquals("qqq-renderer-0.2.0", tree.path("rendererVersion").textValue(), "accepted an answer of another renderer");
boolean refused = tree.path("outcome").textValue().equals("REFUSED");
assertTrue(refused || tree.path("outcome").textValue().equals("OK"), "accepted an outcome it does not know");
assertEquals(refused, answer.refused());
boolean errors = false;
for(JsonNode diagnostic : tree.path("diagnostics"))
{
errors |= diagnostic.path("severity").textValue().equals("ERROR");
diagnostic.fieldNames().forEachRemaining(name -> assertTrue(Set.of("code", "severity", "element", "pointer", "box", "measured", "limit").contains(name), "accepted a diagnostic field: " + name));
ofTheScene(diagnostic.path("element").textValue(), diagnostic.path("pointer").textValue());
}
assertEquals(refused, errors, "an answer is refused exactly when it holds an error");
for(String part : List.of("mediaType", "base64", "sha256", "length", "pageCount"))
{
assertEquals(!refused, tree.has(part), "a refused answer carries no label and a label is whole: " + part);
}
assertEquals(tree.path("diagnostics").size(), answer.diagnostics().size());
}
/***************************************************************************
** An element is one the scene declares, and a pointer is made of array
** indexes, property names of the schema and declared ids.
***************************************************************************/
private static void ofTheScene(String element, String pointer)
{
assertTrue(element == null || DECLARED.contains(element), "accepted an element the scene does not declare: " + element);
if(pointer != null && !pointer.isEmpty())
{
assertTrue(pointer.startsWith("/"), pointer);
for(String segment : pointer.substring(1).split("/", -1))
{
assertTrue(segment.matches("0|[1-9][0-9]{0,3}") || SceneFacts.VOCABULARY.contains(segment) || DECLARED.contains(segment), "accepted a pointer segment: " + segment);
}
}
}
/***************************************************************************
** The target, and an independent reading of what it let through.
***************************************************************************/
private static void gate(byte[] zpl) throws Exception
{
ZplOutputPolicy.validate(zpl, STOCK);
for(int index = 0; index < zpl.length; index++)
{
assertNotEquals('~', (char) zpl[index], "accepted a tilde command");
if(zpl[index] == '^')
{
assertTrue(index + 2 < zpl.length && COMMANDS.contains(new String(zpl, index + 1, 2, StandardCharsets.US_ASCII)), "accepted a command outside the renderer set");
}
}
}
}
@@ -0,0 +1,379 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.Diagnostic;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
/*******************************************************************************
** The preview is the print path stopped before retention: the same job, the
** same checks on the label, and a picture decoded from the accepted bytes. A
** layout that cannot print comes back as diagnostics, with a page drawn from
** their boxes and no output at all.
*******************************************************************************/
class PreviewTest
{
private static final String SECRET = "a-record-value-that-must-not-travel";
private static final String NOTHING = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855";
private static final int MAXIMUM = 1024 * 1024;
@TempDir
Path directory;
/***************************************************************************
** A preview job for a case of the renderer's version 2 goldens.
***************************************************************************/
private static GenerationPorts.PreviewRequest preview(String name, Integer targetDpi) throws Exception
{
return (new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.scene(name), FakeWorker.stock(name)), Map.of("name", SECRET), targetDpi,
MAXIMUM));
}
/***************************************************************************
** A worker of renderer 0.2.0 that answers every job with these fields.
***************************************************************************/
private static FakeWorker answering(FakeWorker.Answer answer)
{
return (new FakeWorker(FakeWorker.CURRENT, answer));
}
/***************************************************************************
** The files under the adapter's state directory.
***************************************************************************/
private List<Path> files() throws Exception
{
try(Stream<Path> files = Files.walk(directory))
{
return (files.filter(Files::isRegularFile).toList());
}
}
/***************************************************************************
** At each resolution the preview of a layout that prints is the golden
** picture, dot for dot, with the size and hash of exactly the bytes the
** print path returns for the same job. The two jobs differ only in their
** request id and in asking for collected diagnostics. Nothing is written.
***************************************************************************/
@ParameterizedTest
@ValueSource(ints = {203, 300, 600})
void aPreviewIsThePrintPathStoppedBeforeRetention(int dpi) throws Exception
{
Map<String, Object> warning = FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING", "element", "side", "pointer", "/elements/4/x");
FakeWorker worker = answering(job -> FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.CURRENT, FakeWorker.golden("margins", dpi),
job.has("diagnostics") ? List.of(warning) : List.of()));
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, worker);
GenerationPorts.PreviewRequest request = preview("margins", dpi);
GenerationPorts.Preview preview = bridge.preview(request);
GenerationPorts.Content printed = bridge.render(new GenerationPorts.RenderRequest("request-1", request.actorId(), new GenerationPorts.Source("orders", "1"), request.format(), request.revision(),
request.context(), request.maximumBytes(), request.targetDpi()));
assertTrue(preview.printable());
assertTrue(preview.exact());
assertEquals(List.of(new Diagnostic("DEVICE_UNIT_USED", Diagnostic.Severity.WARNING, "side", null, null, null, "/elements/4/x")), preview.diagnostics());
assertArrayEquals(FakeWorker.golden("margins", dpi), printed.bytes());
assertEquals((long) printed.bytes().length, preview.outputBytes());
assertEquals(RendererJson.hash(printed.bytes()), preview.outputSha256());
BufferedImage golden = ImageIO.read(FakeWorker.SCENES.resolve("golden").resolve("margins-" + dpi + ".png").toFile());
assertEquals(1, preview.pages().size());
assertEquals(golden.getWidth(), preview.pages().get(0).widthDots());
assertEquals(golden.getHeight(), preview.pages().get(0).heightDots());
BufferedImage page = ImageIO.read(new ByteArrayInputStream(preview.pages().get(0).png()));
for(int y = 0; y < golden.getHeight(); y++)
{
for(int x = 0; x < golden.getWidth(); x++)
{
assertEquals(golden.getRGB(x, y) & 0xFFFFFF, page.getRGB(x, y) & 0xFFFFFF);
}
}
assertEquals(2, worker.jobs.size());
ObjectNode previewed = (ObjectNode) worker.jobs.get(0);
ObjectNode rendered = (ObjectNode) worker.jobs.get(1);
assertEquals("COLLECT", previewed.remove("diagnostics").textValue());
assertTrue(previewed.remove("requestId").textValue().matches("[0-9a-f-]{36}"));
assertEquals("request-1", rendered.remove("requestId").textValue());
assertEquals(rendered, previewed);
assertEquals("RENDER", previewed.path("operation").textValue());
assertEquals(dpi, previewed.path("targetDpi").intValue());
assertEquals(SECRET, previewed.path("context").path("name").textValue());
assertEquals(List.of(), files());
}
/***************************************************************************
** A scene with a refused element has no label: the worker sends none and
** the preview has no output. Its page is drawn on the host from the boxes of
** the error diagnostics alone, placed from the printable area's corner as
** the renderer places it (the corner of the golden label at each
** resolution), cut to the page and hatched.
***************************************************************************/
@ParameterizedTest
@ValueSource(ints = {203, 300, 600})
void aRefusedSceneIsDrawnFromItsDiagnosticsAndHasNoOutput(int dpi) throws Exception
{
Matcher corner = Pattern.compile("\\^FO([0-9]+),([0-9]+)\\^GFA").matcher(new String(FakeWorker.golden("margins", dpi), StandardCharsets.US_ASCII));
assertTrue(corner.find());
int left = Integer.parseInt(corner.group(1));
int top = Integer.parseInt(corner.group(2));
List<Map<String, Object>> diagnostics = List.of(
FakeWorker.diagnostic("RENDERER_TOO_OLD", "ERROR", "element", "first", "box", List.of(0, 0, 16, 12)),
FakeWorker.diagnostic("ELEMENT_OUTSIDE_PRINTABLE_AREA", "ERROR", "element", "last", "box", List.of(-100, 30, 120, 100_000)),
FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING", "element", "side", "box", List.of(100, 0, 50, 50)),
FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "element", "middle", "pointer", "/elements/3/thickness"));
FakeWorker worker = answering(job -> FakeWorker.refused(job.path("requestId").textValue(), diagnostics));
GenerationPorts.Preview preview = FakeWorker.bridge(directory, worker).preview(preview("margins", dpi));
assertFalse(preview.printable());
assertFalse(preview.exact());
assertEquals(0L, preview.outputBytes());
assertEquals(NOTHING, preview.outputSha256());
assertEquals(4, preview.diagnostics().size());
assertEquals(new Diagnostic("RENDERER_TOO_OLD", Diagnostic.Severity.ERROR, "first", List.of(0, 0, 16, 12), null, null), preview.diagnostics().get(0));
assertEquals(1, preview.pages().size());
BufferedImage golden = ImageIO.read(FakeWorker.SCENES.resolve("golden").resolve("margins-" + dpi + ".png").toFile());
BufferedImage page = ImageIO.read(new ByteArrayInputStream(preview.pages().get(0).png()));
assertEquals(golden.getWidth(), page.getWidth());
assertEquals(golden.getHeight(), page.getHeight());
for(int y = 0; y < page.getHeight(); y++)
{
for(int x = 0; x < page.getWidth(); x++)
{
boolean first = hatched(x - left, y - top, 16, 12);
boolean last = hatched(x, y - top - 30, left + 20, page.getHeight() - top - 30);
assertEquals(first || last, (page.getRGB(x, y) & 0xFFFFFF) == 0, x + ", " + y);
}
}
assertEquals("COLLECT", worker.jobs.get(0).path("diagnostics").textValue());
assertEquals(List.of(), files());
}
/***************************************************************************
** Whether a dot is ink in a hatched area of this size whose corner is the
** origin of `column` and `row`.
***************************************************************************/
private static boolean hatched(int column, int row, int width, int height)
{
return (column >= 0 && column < width && row >= 0 && row < height && (column == 0 || row == 0 || column == width - 1 || row == height - 1 || (column + row) % 6 == 0));
}
/***************************************************************************
** A refusal is a result of a preview, not an exception: whatever the print
** path would refuse by name comes back as the diagnostic, not printable,
** with no output, and with no page when no diagnostic has a box.
***************************************************************************/
@Test
void aRefusalComesBackAsADiagnostic() throws Exception
{
FakeWorker invalid = answering(job -> FakeWorker.error(job.path("requestId").textValue(), FakeWorker.CURRENT, "SCENE_INVALID", FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "pointer", "/design")));
GenerationPorts.Preview refused = FakeWorker.bridge(directory, invalid).preview(preview("anchors", null));
assertFalse(refused.printable());
assertEquals(List.of(new Diagnostic("SCENE_INVALID", Diagnostic.Severity.ERROR, null, null, null, null, "/design")), refused.diagnostics());
assertEquals(List.of(), refused.pages());
assertEquals(0L, refused.outputBytes());
assertEquals(NOTHING, refused.outputSha256());
FakeWorker fit = answering(job -> FakeWorker.error(job.path("requestId").textValue(), FakeWorker.CURRENT, "BARCODE_FIT_TOO_SMALL", null));
var versionOne = new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.VERSION_ONE_SCENE, FakeWorker.stock("anchors")), Map.of(), null, MAXIMUM);
assertEquals(List.of(new Diagnostic("BARCODE_FIT_TOO_SMALL", Diagnostic.Severity.ERROR, null, null, null, null)), FakeWorker.bridge(directory, fit).preview(versionOne).diagnostics());
///////////////////////////////////////////////////////////////////////////////////////////
// a version 1 scene previews only at its stock's resolution; no worker is contacted //
///////////////////////////////////////////////////////////////////////////////////////////
var elsewhere = new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, versionOne.revision(), Map.of(), 300, MAXIMUM);
GenerationPorts.Preview target = FakeWorker.bridge(directory, fit).preview(elsewhere);
assertEquals(List.of(new Diagnostic("TARGET_REQUIRES_SCENE_2", Diagnostic.Severity.ERROR, null, null, Map.of("dpi", 300), Map.of("dpi", 203))), target.diagnostics());
assertFalse(target.printable());
assertEquals(1, fit.jobs.size());
///////////////////////////////////////////////////////////////////////////////////////////
// a refused scene whose diagnostics have no box has no page //
///////////////////////////////////////////////////////////////////////////////////////////
FakeWorker whole = answering(job -> FakeWorker.refused(job.path("requestId").textValue(), List.of(FakeWorker.diagnostic("STOCK_MISMATCH", "ERROR", "pointer", "/design"))));
assertEquals(List.of(), FakeWorker.bridge(directory, whole).preview(preview("anchors", null)).pages());
}
/***************************************************************************
** An old image cannot preview: the answer is `RENDERER_TOO_OLD`, and the
** worker was asked its version and sent nothing else, for a version 2 scene
** and for a version 1 scene alike.
***************************************************************************/
@Test
void anOldRendererCannotPreviewAndIsSentNothing() throws Exception
{
FakeWorker old = new FakeWorker(FakeWorker.RELEASED, job -> FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.RELEASED, FakeWorker.golden("anchors", 203), List.of()));
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, old);
var versionOne = new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.VERSION_ONE_SCENE, FakeWorker.stock("anchors")), Map.of("name", SECRET),
null, MAXIMUM);
for(GenerationPorts.PreviewRequest request : List.of(preview("anchors", null), preview("anchors", 300), versionOne))
{
GenerationPorts.Preview preview = bridge.preview(request);
assertFalse(preview.printable());
assertEquals(List.of(new Diagnostic("RENDERER_TOO_OLD", Diagnostic.Severity.ERROR, null, null, null, null)), preview.diagnostics());
assertEquals(List.of(), preview.pages());
}
assertEquals(List.of(), old.jobs);
assertEquals(3, old.questions.size());
assertFalse(old.questions.toString().contains(SECRET));
}
/***************************************************************************
** A page of more than sixteen million dots is refused before any worker is
** contacted, with its size and the limit.
***************************************************************************/
@Test
void aPreviewTooLargeToDrawIsRefusedBeforeRendering() throws Exception
{
FakeWorker worker = answering(job -> FakeWorker.validated(job.path("requestId").textValue(), FakeWorker.CURRENT));
var large = new GenerationPorts.Stock(203200, 304800, 0, 0, 0, 0, 203);
var request = new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.scene("anchors"), large), Map.of(), 600, MAXIMUM);
GenerationPorts.Preview preview = FakeWorker.bridge(directory, worker).preview(request);
assertFalse(preview.printable());
assertEquals(List.of(new Diagnostic("PREVIEW_TOO_LARGE", Diagnostic.Severity.ERROR, null, null, Map.of("widthDots", 4800, "heightDots", 7200), Map.of("dots", 16_000_000))), preview.diagnostics());
assertEquals(List.of(), preview.pages());
assertEquals(List.of(), worker.jobs);
assertEquals(List.of(), worker.questions);
}
/***************************************************************************
** A version 1 label previews with its graphics and boxes exact and each
** printer font field as a placeholder: the page is not exact and says why.
***************************************************************************/
@Test
void aVersionOneLabelIsPreviewedWithPlaceholdersForPrinterFontText() throws Exception
{
byte[] label = BridgeTest.LABEL.getBytes(StandardCharsets.US_ASCII);
FakeWorker worker = answering(job -> FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.CURRENT, label, List.of()));
var request = new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.VERSION_ONE_SCENE, BridgeTest.STOCK), Map.of(), null, MAXIMUM);
GenerationPorts.Preview preview = FakeWorker.bridge(directory, worker).preview(request);
assertTrue(preview.printable());
assertFalse(preview.exact());
assertEquals(List.of(new Diagnostic("PRINTER_FONT_NOT_SHOWN", Diagnostic.Severity.WARNING, null, null, null, null)), preview.diagnostics());
assertEquals(812, preview.pages().get(0).widthDots());
assertEquals(1218, preview.pages().get(0).heightDots());
assertEquals(RendererJson.hash(label), preview.outputSha256());
assertFalse(worker.jobs.get(0).has("targetDpi"));
}
/***************************************************************************
** Only a label that passed every check of the print path is drawn. An answer
** that is not what the version rule allows, a label the output policy
** refuses, an opaque failure and a job outside the adapter's limits are all
** the same generic refusal, never a picture.
***************************************************************************/
@Test
void onlyAnAcceptedLabelBecomesAPicture() throws Exception
{
byte[] golden = FakeWorker.golden("anchors", 203);
Map<String, Object> error = FakeWorker.diagnostic("RENDERER_TOO_OLD", "ERROR", "element", "center", "box", List.of(0, 0, 10, 10));
List<FakeWorker.Answer> answers = List.of(
job ->
{
Map<String, Object> partial = FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.CURRENT, golden, List.of(error));
partial.put("outcome", "REFUSED");
return (partial);
},
job -> FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.CURRENT, golden, List.of(error)),
job -> FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.CURRENT, (new String(golden, StandardCharsets.US_ASCII) + "~JR").getBytes(StandardCharsets.US_ASCII), List.of()),
job -> FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.CURRENT, FakeWorker.golden("anchors", 300), List.of()),
job -> FakeWorker.error(job.path("requestId").textValue(), FakeWorker.CURRENT, "RENDER_FAILED", null),
job -> FakeWorker.refused(job.path("requestId").textValue(), List.of(FakeWorker.diagnostic("RENDERER_TOO_OLD", "ERROR", "element", "undeclared", "box", List.of(0, 0, 10, 10)))),
job -> FakeWorker.validated(job.path("requestId").textValue(), FakeWorker.CURRENT));
for(FakeWorker.Answer answer : answers)
{
QException failure = assertThrows(QException.class, () -> FakeWorker.bridge(directory, answering(answer)).preview(preview("anchors", null)));
assertEquals(QException.class, failure.getClass());
assertEquals("Isolated renderer rejected or could not complete the request.", failure.getMessage());
}
///////////////////////////////////////////////////////////////////////////////////////////
// the print path, which never collects, rejects a refused answer outright //
///////////////////////////////////////////////////////////////////////////////////////////
IsolatedRendererBridge printing = FakeWorker.bridge(directory, answering(job -> FakeWorker.refused(job.path("requestId").textValue(), List.of(error))));
var render = new GenerationPorts.RenderRequest("request-1", "actor-1", new GenerationPorts.Source("orders", "1"), GenerationPorts.Format.ZPL, preview("anchors", null).revision(), Map.of(), MAXIMUM);
assertEquals(QException.class, assertThrows(QException.class, () -> printing.render(render)).getClass());
FakeWorker unused = answering(job -> FakeWorker.validated(job.path("requestId").textValue(), FakeWorker.CURRENT));
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, unused);
var revision = preview("anchors", null).revision();
var page = new GenerationPorts.Revision(1, 1, "orders", revision.stock(), "<p>a page</p>", null, null, List.of());
assertEquals("Preview is available for labels only.",
assertThrows(QException.class, () -> bridge.preview(new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.PDF, page, Map.of(), null, MAXIMUM))).getMessage());
var coarse = new GenerationPorts.Stock(50800, 25400, 0, 0, 0, 0, 150);
var tall = new GenerationPorts.Stock(25400, 1600000, 0, 0, 0, 0, 203);
var negative = new GenerationPorts.Stock(50800, 25400, -1, 0, 0, 0, 203);
for(GenerationPorts.PreviewRequest outside : List.of(
new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, revision, Map.of(), null, 4 * 1024 * 1024 + 1),
new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.scene("anchors"), coarse), Map.of(), null, MAXIMUM),
new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.scene("anchors"), tall), Map.of(), 600, MAXIMUM),
new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.scene("anchors"), negative), Map.of(), null, MAXIMUM),
new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, FakeWorker.revision(FakeWorker.scene("anchors"), revision.stock()), Map.of("object", Path.of("private")), null, MAXIMUM)))
{
assertEquals("Isolated renderer rejected or could not complete the request.", assertThrows(QException.class, () -> bridge.preview(outside)).getMessage());
}
assertEquals(List.of(), unused.jobs);
assertEquals(List.of(), unused.questions);
}
}
@@ -0,0 +1,177 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.FailureCode;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertTrue;
/*******************************************************************************
** What the host reads from a label source (its version and the ids it
** declares), and the version rule's two written-out sets of refusals.
*******************************************************************************/
class SceneFactsTest
{
private static final String SCENE = "{\"design\":{\"width\":\"4in\",\"height\":\"1in\"},\"samples\":{\"default\":{\"id\":\"sampled\",\"elements\":[{\"id\":\"nested\"}]}},"
+ "\"elements\":[7,{\"id\":\"caption\",\"type\":\"text\",\"fit\":{\"id\":\"inside\"}},{\"id\":\"panel\",\"type\":\"group\",\"children\":[{\"id\":\"inner\",\"type\":\"box\"},[]]},"
+ "{\"id\":7},{\"id\":\"not an id\"},{\"children\":\"none\"}],\"overrides\":[{\"when\":{\"dpi\":[203]},\"set\":{\"overridden\":{\"id\":\"renamed\"}}}],\"schema\":\"qqq-zpl-scene/2\"}";
/***************************************************************************
** The property names the host admits in a pointer are exactly the names the
** version 2 schema declares, wherever in the schema they are declared.
***************************************************************************/
@Test
void theVocabularyIsThePropertyNamesOfTheSchema() throws Exception
{
Set<String> declared = new TreeSet<>();
names(RendererJson.JSON.readTree(Files.readAllBytes(Path.of("..", "..", "renderer", "schema", "zpl-scene-2.schema.json"))), declared);
assertEquals(declared, new TreeSet<>(SceneFacts.VOCABULARY));
assertEquals(46, SceneFacts.VOCABULARY.size());
}
/***************************************************************************
** Every key of every `properties` object in a schema.
***************************************************************************/
private static void names(JsonNode node, Set<String> names)
{
for(Map.Entry<String, JsonNode> property : node.properties())
{
if(property.getKey().equals("properties") && property.getValue().isObject())
{
property.getValue().fieldNames().forEachRemaining(names::add);
}
names(property.getValue(), names);
}
if(node.isArray())
{
node.forEach(item -> names(item, names));
}
}
/***************************************************************************
** A version 2 scene declares the ids of its elements and of their children,
** and nothing else: not a sample's, an override's or a property's `id`, not
** an id of the wrong shape.
***************************************************************************/
@Test
void aSceneDeclaresTheIdsOfItsElementsAndTheirChildrenOnly()
{
SceneFacts facts = SceneFacts.of(GenerationPorts.Format.ZPL, SCENE);
assertTrue(facts.version2());
for(String id : List.of("caption", "panel", "inner"))
{
assertTrue(facts.declares(id), id);
}
for(String id : List.of("sampled", "nested", "inside", "overridden", "renamed", "7", "not an id", "Caption", ""))
{
assertFalse(facts.declares(id), id);
}
assertTrue(facts.points(""));
assertTrue(facts.points("/elements/2/children/0/width"));
assertTrue(facts.points("/overrides/0/set/caption/size"));
assertTrue(facts.points("/elements/9999"));
for(String pointer : List.of("elements", "/elements/sampled", "/elements/0/", "//", "/elements/10000", "/elements/0/Width", "/elements/-1"))
{
assertFalse(facts.points(pointer), pointer);
}
}
/***************************************************************************
** Anything the host cannot read as a version 2 scene is not one to the host
** and declares nothing: another schema, a PDF, text that is not one JSON
** object, a repeated property, too deep a nesting, too many elements.
***************************************************************************/
@Test
void aSourceThatIsNotAReadableVersionTwoSceneDeclaresNothing()
{
StringBuilder crowded = new StringBuilder("{\"schema\":\"qqq-zpl-scene/2\",\"elements\":[");
for(int index = 0; index < 1001; index++)
{
crowded.append(index == 0 ? "" : ",").append("{\"id\":\"e").append(index).append("\"}");
}
String full = crowded + "]}";
for(String source : List.of(SCENE.replace("qqq-zpl-scene/2", "qqq-zpl-scene/1"), SCENE.replace("\"qqq-zpl-scene/2\"", "2"), "{\"elements\":[{\"id\":\"caption\"}]}", "{}", "[]", "",
"not json", SCENE + "{}", SCENE.substring(0, SCENE.length() - 1), SCENE.replace("\"schema\"", "\"design\""), "{\"schema\":\"qqq-zpl-scene/2\",\"elements\":" + "[".repeat(30) + "]".repeat(30) + "}",
full))
{
SceneFacts facts = SceneFacts.of(GenerationPorts.Format.ZPL, source);
assertFalse(facts.version2(), source);
assertFalse(facts.declares("caption"), source);
assertFalse(facts.declares("e1"), source);
}
assertFalse(SceneFacts.of(GenerationPorts.Format.PDF, SCENE).version2());
assertTrue(SceneFacts.of(GenerationPorts.Format.ZPL, full.replace(",{\"id\":\"e1000\"}", "")).declares("e999"));
assertTrue(SceneFacts.of(GenerationPorts.Format.ZPL, "{\"schema\":\"qqq-zpl-scene/2\"}").version2());
}
/***************************************************************************
** The version rule's sets are written out: the released renderer names the
** thirteen codes it shipped with, the current one those and every scene
** refusal. A code added to the port later is in neither until someone
** decides which renderer may name it, and this test says so.
***************************************************************************/
@Test
void eachRendererNamesExactlyItsOwnRefusals()
{
List<String> released = List.of("BARCODE_FIT_TOO_SMALL", "BARCODE_FIT_UNSUPPORTED", "BARCODE_FIT_BOX_OUTSIDE_STOCK", "BARCODE_FIT_GEOMETRY_MISMATCH", "INVALID_BARCODE_FIT_PROFILE",
"INVALID_BARCODE_FIT_REQUEST", "BARCODE_SYMBOLOGY_NOT_ALLOWED", "SYMBOLOGY_ALLOWLIST_REQUIRED", "SCANNER_BARCODE_PROFILE_UNSUPPORTED", "SCANNER_BARCODE_PAYLOAD_UNSUPPORTED",
"SCANNER_BARCODE_CHECKSUM_REQUIRED", "SCANNER_BARCODE_CHECKSUM_MISMATCH", "UNSUPPORTED_BARCODE_OPTION");
assertEquals(13, released.size());
for(FailureCode code : FailureCode.values())
{
assertEquals(released.contains(code.name()), RendererVersion.RELEASED.names(code), code.name());
assertTrue(RendererVersion.CURRENT.names(code), code.name());
}
assertSame(RendererVersion.RELEASED, RendererVersion.of("qqq-renderer-0.1.0"));
assertSame(RendererVersion.CURRENT, RendererVersion.of("qqq-renderer-0.2.0"));
assertFalse(RendererVersion.RELEASED.structured());
assertTrue(RendererVersion.CURRENT.structured());
for(String other : List.of("qqq-renderer-0.3.0", "qqq-renderer-0.2.0 ", "qqq-renderer-0.1", "0.2.0", ""))
{
assertNull(RendererVersion.of(other), other);
}
assertNull(RendererVersion.of(null));
}
}
@@ -0,0 +1,354 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.Diagnostic;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.FailureCode;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
/*******************************************************************************
** The version rule and the render target, through the bridge: renderer 0.1.0
** and 0.2.0 against version 1 and version 2 scenes, what is sent to each, and
** that no job asked for one resolution is ever answered with another.
*******************************************************************************/
class VersionRuleTest
{
private static final String SECRET = "a-record-value-that-must-not-travel";
private static final byte[] VERSION_ONE_LABEL = "^XA^PW406^LL203^LH0,0^CI28\n^FO2,40^GB20,10,1^FS\n^XZ\n".getBytes(StandardCharsets.US_ASCII);
private static final int MAXIMUM = 1024 * 1024;
private static final int LABEL_FRAME = 4 * ((MAXIMUM + 2) / 3) + 4096;
@TempDir
Path directory;
/***************************************************************************
** A render job for a scene on the stock of the `anchors` case (2 x 1 in at
** 203 dpi), with a record value in its context.
***************************************************************************/
private static GenerationPorts.RenderRequest job(String scene, Integer targetDpi) throws Exception
{
return (new GenerationPorts.RenderRequest("request-1", "actor-1", new GenerationPorts.Source("orders", "1"), GenerationPorts.Format.ZPL,
FakeWorker.revision(scene, FakeWorker.stock("anchors")), Map.of("name", SECRET), MAXIMUM, targetDpi));
}
/***************************************************************************
** A worker of a version that renders the right label for whatever it is
** asked: the golden of the `anchors` case at the job's resolution for a
** version 2 scene, the fixed label for a version 1 scene.
***************************************************************************/
private static FakeWorker renderer(String version)
{
return (new FakeWorker(version, job ->
{
String id = job.path("requestId").textValue();
if(job.path("operation").textValue().equals("VALIDATE"))
{
return (FakeWorker.validated(id, version));
}
boolean version2 = job.path("source").textValue().contains("qqq-zpl-scene/2");
int dpi = job.has("targetDpi") ? job.path("targetDpi").intValue() : job.path("stock").path("dpi").intValue();
return (FakeWorker.rendered(id, version, version2 ? FakeWorker.golden("anchors", dpi) : VERSION_ONE_LABEL, List.of()));
}));
}
/***************************************************************************
** The names of the fields of a frame.
***************************************************************************/
private static Set<String> names(JsonNode frame)
{
Set<String> names = new TreeSet<>();
frame.fieldNames().forEachRemaining(names::add);
return (names);
}
/***************************************************************************
** Renderer 0.1.0 with a version 1 scene: printing continues exactly as
** released. The job has the released fields and nothing else, no version
** question is asked, and the frame bound is the released one.
***************************************************************************/
@Test
void theReleasedRendererStillPrintsVersionOne() throws Exception
{
FakeWorker worker = renderer(FakeWorker.RELEASED);
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, worker);
assertArrayEquals(VERSION_ONE_LABEL, bridge.render(job(FakeWorker.VERSION_ONE_SCENE, null)).bytes());
bridge.validate("actor-1", job(FakeWorker.VERSION_ONE_SCENE, null).revision());
assertEquals(List.of(), worker.questions);
assertEquals(2, worker.jobs.size());
assertEquals(Set.of("protocol", "requestId", "operation", "format", "source", "stock", "context", "assets", "maximumBytes"), names(worker.jobs.get(0)));
assertEquals(List.of(LABEL_FRAME, 4096), worker.frameLimits);
}
/***************************************************************************
** Renderer 0.2.0 with a version 1 scene: the same job, and the answer with
** its (empty) diagnostics is accepted.
***************************************************************************/
@Test
void theCurrentRendererPrintsVersionOne() throws Exception
{
FakeWorker worker = renderer(FakeWorker.CURRENT);
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, worker);
assertArrayEquals(VERSION_ONE_LABEL, bridge.render(job(FakeWorker.VERSION_ONE_SCENE, null)).bytes());
bridge.validate("actor-1", job(FakeWorker.VERSION_ONE_SCENE, null).revision());
assertEquals(List.of(), worker.questions);
assertEquals(Set.of("protocol", "requestId", "operation", "format", "source", "stock", "context", "assets", "maximumBytes"), names(worker.jobs.get(0)));
assertEquals(List.of(LABEL_FRAME, 4096), worker.frameLimits);
}
/***************************************************************************
** Renderer 0.1.0 with a version 2 scene: refused as `RENDERER_TOO_OLD`
** before anything of the scene or the record is sent. All the worker ever
** receives is the version question, which is a constant.
***************************************************************************/
@Test
void theReleasedRendererIsNeverSentAVersionTwoScene() throws Exception
{
FakeWorker worker = renderer(FakeWorker.RELEASED);
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, worker);
String scene = FakeWorker.scene("anchors");
var refusal = assertThrows(GenerationPorts.RenderException.class, () -> bridge.render(job(scene, null)));
assertEquals(FailureCode.RENDERER_TOO_OLD, refusal.code());
assertEquals(FailureCode.RENDERER_TOO_OLD, assertThrows(GenerationPorts.RenderException.class, () -> bridge.render(job(scene, 300))).code());
assertEquals(FailureCode.RENDERER_TOO_OLD, assertThrows(GenerationPorts.RenderException.class, () -> bridge.validate("actor-1", job(scene, null).revision())).code());
assertEquals(List.of(), worker.jobs);
assertEquals(3, worker.questions.size());
for(JsonNode question : worker.questions)
{
assertEquals(IsolatedRendererBridge.PROBE_SCENE, question.path("source").textValue());
assertEquals("VALIDATE", question.path("operation").textValue());
assertEquals("{}", question.path("context").toString());
assertEquals("[]", question.path("assets").toString());
assertEquals(Set.of("protocol", "requestId", "operation", "format", "source", "stock", "context", "assets", "maximumBytes"), names(question));
assertFalse(question.toString().contains(SECRET) || question.toString().contains("qqq-zpl-scene/2") || question.toString().contains("top-left"));
}
///////////////////////////////////////////////////////////////////////////////////////////
// version 1 printing goes on beside it, on the same adapter //
///////////////////////////////////////////////////////////////////////////////////////////
assertArrayEquals(VERSION_ONE_LABEL, bridge.render(job(FakeWorker.VERSION_ONE_SCENE, null)).bytes());
}
/***************************************************************************
** Renderer 0.2.0 with a version 2 scene: rendered. The version question is
** asked once; after a verified answer of 0.2.0 it is not asked again.
***************************************************************************/
@Test
void theCurrentRendererPrintsVersionTwo() throws Exception
{
FakeWorker worker = renderer(FakeWorker.CURRENT);
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, worker);
String scene = FakeWorker.scene("anchors");
assertArrayEquals(FakeWorker.golden("anchors", 203), bridge.render(job(scene, null)).bytes());
assertArrayEquals(FakeWorker.golden("anchors", 203), bridge.render(job(scene, null)).bytes());
bridge.validate("actor-1", job(scene, null).revision());
assertEquals(1, worker.questions.size());
assertEquals(3, worker.jobs.size());
assertEquals(scene, worker.jobs.get(0).path("source").textValue());
assertEquals(SECRET, worker.jobs.get(0).path("context").path("name").textValue());
assertEquals(Set.of("protocol", "requestId", "operation", "format", "source", "stock", "context", "assets", "maximumBytes"), names(worker.jobs.get(0)));
///////////////////////////////////////////////////////////////////////////////////////////
// the answers to a version 2 job have room for diagnostics, which is bounded //
///////////////////////////////////////////////////////////////////////////////////////////
assertEquals(List.of(LABEL_FRAME + WorkerAnswer.DIAGNOSTICS_BYTES, LABEL_FRAME + WorkerAnswer.DIAGNOSTICS_BYTES, 4096 + WorkerAnswer.DIAGNOSTICS_BYTES), worker.frameLimits);
}
/***************************************************************************
** A renderer that is replaced by an older one is noticed on its first
** answer: that answer is refused whatever it says, and the next job asks
** the version again and sends nothing.
***************************************************************************/
@Test
void aRendererReplacedByAnOlderOneIsRefused() throws Exception
{
String scene = FakeWorker.scene("anchors");
List<String> versions = new ArrayList<>(List.of(FakeWorker.CURRENT, FakeWorker.CURRENT, FakeWorker.RELEASED, FakeWorker.RELEASED));
List<String> sent = new ArrayList<>();
IsolatedRendererBridge changing = FakeWorker.bridge(directory, (id, input, maximum) ->
{
JsonNode job = RendererJson.parse(input, 16 * 1024 * 1024);
String version = versions.remove(0);
sent.add(job.path("source").textValue().equals(IsolatedRendererBridge.PROBE_SCENE) ? "question" : "job");
return (FakeWorker.frame(job.path("operation").textValue().equals("VALIDATE") ? FakeWorker.validated(id, version) : FakeWorker.rendered(id, version, FakeWorker.golden("anchors", 203), List.of())));
});
assertArrayEquals(FakeWorker.golden("anchors", 203), changing.render(job(scene, null)).bytes());
assertEquals(FailureCode.RENDERER_TOO_OLD, assertThrows(GenerationPorts.RenderException.class, () -> changing.render(job(scene, null))).code());
assertEquals(FailureCode.RENDERER_TOO_OLD, assertThrows(GenerationPorts.RenderException.class, () -> changing.render(job(scene, null))).code());
assertEquals(List.of("question", "job", "job", "question"), sent);
}
/***************************************************************************
** A renderer of a version this bridge was not built for is rejected, and so
** is a refusal a renderer may not name; a refusal renderer 0.2.0 may name
** arrives typed, with its diagnostic.
***************************************************************************/
@Test
void onlyAcceptedRenderersAndTheirOwnRefusalsAreBelieved() throws Exception
{
IsolatedRendererBridge unknown = FakeWorker.bridge(directory, renderer("qqq-renderer-0.3.0"));
assertEquals(QException.class, assertThrows(QException.class, () -> unknown.render(job(FakeWorker.VERSION_ONE_SCENE, null))).getClass());
IsolatedRendererBridge early = FakeWorker.bridge(directory, new FakeWorker(FakeWorker.RELEASED, job -> FakeWorker.error(job.path("requestId").textValue(), FakeWorker.RELEASED, "SCENE_INVALID", null)));
assertEquals(QException.class, assertThrows(QException.class, () -> early.render(job(FakeWorker.VERSION_ONE_SCENE, null))).getClass());
IsolatedRendererBridge current = FakeWorker.bridge(directory, new FakeWorker(FakeWorker.CURRENT, job -> FakeWorker.error(job.path("requestId").textValue(), FakeWorker.CURRENT, "SCENE_INVALID",
FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "element", "center", "pointer", "/elements/4/fill"))));
var refusal = assertThrows(GenerationPorts.RenderException.class, () -> current.render(job(FakeWorker.scene("anchors"), null)));
assertEquals(FailureCode.SCENE_INVALID, refusal.code());
assertEquals(new Diagnostic("SCENE_INVALID", Diagnostic.Severity.ERROR, "center", null, null, null, "/elements/4/fill"), refusal.diagnostic());
assertEquals(FailureCode.SCENE_INVALID, assertThrows(GenerationPorts.RenderException.class, () -> current.validate("actor-1", job(FakeWorker.scene("anchors"), null).revision())).code());
///////////////////////////////////////////////////////////////////////////////////////////
// the same diagnostic about a scene that does not declare `center` is not believed //
///////////////////////////////////////////////////////////////////////////////////////////
assertEquals(QException.class, assertThrows(QException.class, () -> current.render(job(FakeWorker.scene("rules"), null))).getClass());
}
/***************************************************************************
** A render target is sent with a version 2 scene, and the label that comes
** back is held to the page at that resolution. A worker that renders at
** another resolution than it was asked for is refused, in either direction.
***************************************************************************/
@Test
void aVersionTwoSceneIsRenderedAtItsTargetOrNotAtAll() throws Exception
{
FakeWorker worker = renderer(FakeWorker.CURRENT);
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, worker);
String scene = FakeWorker.scene("anchors");
assertTrue(bridge.supportsRenderTarget());
for(int dpi : List.of(203, 300, 600))
{
assertArrayEquals(FakeWorker.golden("anchors", dpi), bridge.render(job(scene, dpi)).bytes());
assertEquals(dpi, worker.jobs.getLast().path("targetDpi").intValue());
assertEquals(203, worker.jobs.getLast().path("stock").path("dpi").intValue());
}
assertArrayEquals(FakeWorker.golden("anchors", 203), bridge.render(job(scene, null)).bytes());
assertFalse(worker.jobs.getLast().has("targetDpi"));
IsolatedRendererBridge ignoring = FakeWorker.bridge(directory, new FakeWorker(FakeWorker.CURRENT,
job -> FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.CURRENT, FakeWorker.golden("anchors", 203), List.of())));
assertArrayEquals(FakeWorker.golden("anchors", 203), ignoring.render(job(scene, null)).bytes());
assertEquals(QException.class, assertThrows(QException.class, () -> ignoring.render(job(scene, 300))).getClass());
IsolatedRendererBridge eager = FakeWorker.bridge(directory, new FakeWorker(FakeWorker.CURRENT,
job -> FakeWorker.rendered(job.path("requestId").textValue(), FakeWorker.CURRENT, FakeWorker.golden("anchors", 300), List.of())));
assertEquals(QException.class, assertThrows(QException.class, () -> eager.render(job(scene, null))).getClass());
assertEquals(QException.class, assertThrows(QException.class, () -> eager.render(job(scene, 600))).getClass());
}
/***************************************************************************
** A version 1 scene and a PDF have one resolution, their stock's. Asked for
** another they are refused by name before any worker is contacted, because
** a renderer would ignore the target; asked for their own they are rendered
** as they always were, with no target on the wire.
***************************************************************************/
@Test
void aVersionOneSceneOrAPdfIsNeverRenderedForAnotherResolution() throws Exception
{
for(String version : List.of(FakeWorker.RELEASED, FakeWorker.CURRENT))
{
FakeWorker worker = renderer(version);
IsolatedRendererBridge bridge = FakeWorker.bridge(directory, worker);
for(int dpi : List.of(300, 600))
{
var refusal = assertThrows(GenerationPorts.RenderException.class, () -> bridge.render(job(FakeWorker.VERSION_ONE_SCENE, dpi)));
assertEquals(FailureCode.TARGET_REQUIRES_SCENE_2, refusal.code());
assertEquals(new Diagnostic("TARGET_REQUIRES_SCENE_2", Diagnostic.Severity.ERROR, null, null, Map.of("dpi", dpi), Map.of("dpi", 203)), refusal.diagnostic());
var zpl = job(FakeWorker.VERSION_ONE_SCENE, dpi);
var page = new GenerationPorts.Revision(1, 1, "orders", zpl.revision().stock(), "<p>a page</p>", null, null, List.of());
var pdf = new GenerationPorts.RenderRequest(zpl.requestId(), zpl.actorId(), zpl.source(), GenerationPorts.Format.PDF, page, zpl.context(), zpl.maximumBytes(), dpi);
assertEquals(FailureCode.TARGET_REQUIRES_SCENE_2, assertThrows(GenerationPorts.RenderException.class, () -> bridge.render(pdf)).code());
////////////////////////////////////////////////////////////////////////////////////////
// text that is not a scene the host can read is treated the same way //
////////////////////////////////////////////////////////////////////////////////////////
assertEquals(FailureCode.TARGET_REQUIRES_SCENE_2, assertThrows(GenerationPorts.RenderException.class, () -> bridge.render(job("not a scene", dpi))).code());
}
assertEquals(List.of(), worker.jobs);
assertEquals(List.of(), worker.questions);
assertArrayEquals(VERSION_ONE_LABEL, bridge.render(job(FakeWorker.VERSION_ONE_SCENE, 203)).bytes());
assertFalse(worker.jobs.getLast().has("targetDpi"));
}
}
/***************************************************************************
** The frame of an answer never passes what the deployment was sized for,
** and an answer longer than its bound is rejected.
***************************************************************************/
@Test
void anAnswerIsBoundedByTheDeployment() throws Exception
{
FakeWorker worker = new FakeWorker(FakeWorker.CURRENT, job ->
{
List<Map<String, Object>> many = new ArrayList<>();
for(int index = 0; index < 150; index++)
{
many.add(FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING", "element", "center", "measured", Map.of("index", index)));
}
Map<String, Object> answer = FakeWorker.validated(job.path("requestId").textValue(), FakeWorker.CURRENT);
answer.put("diagnostics", many);
return (answer);
});
var revision = job(FakeWorker.scene("anchors"), null).revision();
FakeWorker.bridge(directory, worker).validate("actor-1", revision);
///////////////////////////////////////////////////////////////////////////////////////////
// a deployment that admits documents of 4096 bytes has frames of 9560 bytes at most //
///////////////////////////////////////////////////////////////////////////////////////////
IsolatedRendererBridge small = new IsolatedRendererBridge(BridgeTest.config(directory), (actor, asset, maximum) -> new byte[0], worker);
assertEquals(QException.class, assertThrows(QException.class, () -> small.validate("actor-1", revision)).getClass());
assertEquals(List.of(4096 + WorkerAnswer.DIAGNOSTICS_BYTES, 4 * ((4096 + 2) / 3) + 4096), worker.frameLimits);
}
}
@@ -0,0 +1,420 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.Diagnostic;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.FailureCode;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
/*******************************************************************************
** The worker's answer is untrusted. These are the answers a compromised or
** defective worker could send, each held to the name it is rejected by, beside
** the answers that are accepted and what they become.
*******************************************************************************/
class WorkerAnswerTest
{
private static final String ID = "request-1";
private static final String SCENE = "{\"schema\":\"qqq-zpl-scene/2\",\"design\":{\"width\":\"4in\",\"height\":\"1in\"},\"samples\":{\"default\":{\"id\":\"sampled\"}},"
+ "\"elements\":[{\"id\":\"caption\",\"type\":\"text\"},{\"id\":\"panel\",\"type\":\"group\",\"children\":[{\"id\":\"inner\",\"type\":\"box\"}]}],"
+ "\"overrides\":[{\"when\":{\"dpi\":[203]},\"set\":{\"caption\":{\"size\":\"7pt\"}}}]}";
private static final SceneFacts FACTS = SceneFacts.of(GenerationPorts.Format.ZPL, SCENE);
private static final byte[] LABEL = "^XA^PW812^LL203^LH0,0^CI28\n^XZ\n".getBytes(StandardCharsets.US_ASCII);
private static final int FRAME = 4 * 1024 * 1024;
/***************************************************************************
** Read a frame for the scene above.
***************************************************************************/
private static WorkerAnswer read(Map<String, Object> fields) throws Exception
{
return (WorkerAnswer.read(FakeWorker.frame(fields), FRAME, ID, FACTS));
}
/***************************************************************************
** The name an answer is rejected by, when reading it or when holding it to a
** render that collected diagnostics for a version 2 scene.
***************************************************************************/
private static String rejection(Map<String, Object> fields)
{
return (assertThrows(IllegalArgumentException.class, () -> read(fields).settle("RENDER", true, true)).getMessage());
}
/***************************************************************************
** A refused answer holding these diagnostics.
***************************************************************************/
private static Map<String, Object> refused(Map<String, Object> diagnostic)
{
return (FakeWorker.refused(ID, List.of(diagnostic)));
}
/***************************************************************************
** A full diagnostic is read into the port's record, part for part, and a
** refused answer gives them in the worker's order.
***************************************************************************/
@Test
void aDiagnosticOfTheSceneIsReadPartForPart() throws Exception
{
Map<String, Object> error = FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "element", "caption", "pointer", "/elements/0/fit", "box", List.of(24, -3, 764, 56),
"measured", Map.of("widthDots", 902, "lines", 2), "limit", Map.of("widthDots", 764));
Map<String, Object> warning = FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING", "element", "inner", "pointer", "/elements/1/children/0/width");
Map<String, Object> override = FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "element", "caption", "pointer", "/overrides/0/set/caption/size");
Map<String, Object> whole = FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "pointer", "");
WorkerAnswer answer = read(FakeWorker.refused(ID, List.of(error, warning, override, whole))).settle("RENDER", true, true);
assertTrue(answer.refused());
assertSame(RendererVersion.CURRENT, answer.version());
assertEquals(List.of(
new Diagnostic("TEXT_DOES_NOT_FIT", Diagnostic.Severity.ERROR, "caption", List.of(24, -3, 764, 56), Map.of("widthDots", 902, "lines", 2), Map.of("widthDots", 764), "/elements/0/fit"),
new Diagnostic("DEVICE_UNIT_USED", Diagnostic.Severity.WARNING, "inner", null, null, null, "/elements/1/children/0/width"),
new Diagnostic("SCENE_INVALID", Diagnostic.Severity.ERROR, "caption", null, null, null, "/overrides/0/set/caption/size"),
new Diagnostic("SCENE_INVALID", Diagnostic.Severity.ERROR, null, null, null, null, "")), answer.diagnostics());
assertNull(answer.fields().get("base64"));
}
/***************************************************************************
** A pointer may hold only array indexes, property names of the schema and
** ids the scene declares; an element must be declared by the scene. An id
** that appears only in a sample, a record-like value, a path upward or an
** empty segment is not one of those.
***************************************************************************/
@Test
void aDiagnosticThatIsNotOfTheSceneTheHostSentIsRejected()
{
for(String pointer : List.of("/elements/0/secret", "/overrides/0/set/undeclared", "/elements/0/sampled", "/elements/0/ACME-12345"))
{
assertEquals("DIAGNOSTIC_NOT_OF_THIS_SCENE", rejection(refused(FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "pointer", pointer))), pointer);
}
for(String pointer : List.of("elements/0", "/elements//0", "/elements/0/", "/elements/..", "/elements/0/a b", "/elements/0/caf%", "/elements/10000", "/elements/01", "/" + "a/".repeat(16) + "a"))
{
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "pointer", pointer))), pointer);
}
for(String element : List.of("undeclared", "sampled", "Caption"))
{
assertEquals("DIAGNOSTIC_NOT_OF_THIS_SCENE", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "element", element))), element);
}
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "element", "a customer's name"))));
///////////////////////////////////////////////////////////////////////////////////////////
// a source the host cannot read as version 2 declares nothing, so nothing can be named //
///////////////////////////////////////////////////////////////////////////////////////////
SceneFacts none = SceneFacts.of(GenerationPorts.Format.ZPL, "{}");
assertEquals("DIAGNOSTIC_NOT_OF_THIS_SCENE", assertThrows(IllegalArgumentException.class,
() -> WorkerAnswer.read(FakeWorker.frame(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "element", "caption"))), FRAME, ID, none)).getMessage());
}
/***************************************************************************
** A diagnostic is its closed vocabulary and bounded numbers: an unknown code
** or severity, a sentence, a wrong shape or a number that is not a whole
** int is rejected.
***************************************************************************/
@Test
void aDiagnosticOutsideItsShapeIsRejected()
{
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(FakeWorker.diagnostic("RENDER_FAILED", "ERROR"))));
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(FakeWorker.diagnostic("TEXT_SHRUNK", "ERROR"))));
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "FATAL"))));
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(Map.of("code", "TEXT_DOES_NOT_FIT"))));
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(Map.of("severity", "ERROR"))));
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "box", List.of(1, 2, 3)))));
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "box", List.of(1, 2, -3, 4)))));
assertEquals("DIAGNOSTIC_OUTSIDE_VOCABULARY", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "measured", Map.of("Order number", 1)))));
assertEquals("DIAGNOSTIC_BOX", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "box", List.of(1, 2, 3, 4, 5)))));
assertEquals("DIAGNOSTIC_BOX", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "box", List.of(1, 2, 3, 1_000_001)))));
assertEquals("DIAGNOSTIC_BOX", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "box", List.of(-1_000_001, 2, 3, 4)))));
assertEquals("DIAGNOSTIC_INTEGER", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "box", List.of(1, 2, 3, "4")))));
assertEquals("DIAGNOSTIC_INTEGER", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "measured", Map.of("widthDots", 1.5)))));
assertEquals("DIAGNOSTIC_INTEGER", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "limit", Map.of("widthDots", "wide")))));
assertEquals("DIAGNOSTIC_INTEGER", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "limit", Map.of("widthDots", List.of(1))))));
assertEquals("DIAGNOSTIC_NUMBERS", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "measured", Map.of("n" + "a".repeat(32), 1)))));
Map<String, Object> nine = new LinkedHashMap<>();
for(int index = 0; index < 9; index++)
{
nine.put("n" + index, index);
}
assertEquals("DIAGNOSTIC_NUMBERS", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "limit", nine))));
for(Map<String, Object> shape : List.of(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "message", "free text"), FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "element", 7),
FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "pointer", List.of()), FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "box", "1,2,3,4"),
FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "measured", List.of()), FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "limit", 4), Map.<String, Object>of("code", "TEXT_DOES_NOT_FIT", "severity", 1)))
{
assertEquals("DIAGNOSTIC_FIELD_REJECTED", rejection(refused(shape)), shape.toString());
}
assertEquals("RESPONSE_TEXT_LIMIT", rejection(refused(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "element", "a".repeat(65)))));
assertEquals("RESPONSE_TEXT_LIMIT", rejection(refused(FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "pointer", "/a".repeat(265)))));
Map<String, Object> list = FakeWorker.envelope(ID, FakeWorker.CURRENT, "REFUSED");
list.put("diagnostics", List.of("TEXT_DOES_NOT_FIT"));
assertEquals("DIAGNOSTIC_OBJECT_REQUIRED", rejection(list));
}
/***************************************************************************
** An answer is bounded: its frame, its texts and how many diagnostics it
** holds.
***************************************************************************/
@Test
void anOversizedAnswerIsRejected() throws Exception
{
List<Map<String, Object>> many = new ArrayList<>();
for(int index = 0; index < WorkerAnswer.MAXIMUM_DIAGNOSTICS; index++)
{
many.add(FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING", "element", "caption", "measured", Map.of("index", index)));
}
many.add(FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "element", "caption"));
assertEquals("DIAGNOSTIC_LIMIT", rejection(FakeWorker.refused(ID, many)));
many.remove(0);
assertEquals(WorkerAnswer.MAXIMUM_DIAGNOSTICS, read(FakeWorker.refused(ID, many)).settle("RENDER", true, true).diagnostics().size());
byte[] frame = FakeWorker.frame(FakeWorker.refused(ID, many));
assertEquals("RESPONSE_BYTE_LIMIT", assertThrows(IllegalArgumentException.class, () -> WorkerAnswer.read(frame, frame.length - 1, ID, FACTS)).getMessage());
assertEquals(WorkerAnswer.MAXIMUM_DIAGNOSTICS, WorkerAnswer.read(frame, frame.length, ID, FACTS).diagnostics().size());
Map<String, Object> text = FakeWorker.envelope(ID, FakeWorker.CURRENT, "OK");
text.put("mediaType", "x".repeat(129));
assertEquals("RESPONSE_TEXT_LIMIT", rejection(text));
Map<String, Object> number = FakeWorker.rendered(ID, FakeWorker.CURRENT, LABEL, List.of());
number.put("length", 2147483648L);
assertThrows(java.io.IOException.class, () -> read(number));
}
/***************************************************************************
** One frame is one line of strict JSON whose fields are the known ones.
***************************************************************************/
@Test
void aMalformedFrameIsRejected() throws Exception
{
String valid = new String(FakeWorker.frame(FakeWorker.validated(ID, FakeWorker.CURRENT)), StandardCharsets.UTF_8);
for(Map.Entry<String, String> malformed : Map.of("", "FRAME_TRUNCATED", valid.strip(), "FRAME_TRUNCATED", valid + valid, "EXTRA_FRAME", valid.replace(",", ",\r"), "EXTRA_FRAME",
"[]\n", "RESPONSE_OBJECT_REQUIRED", valid.strip() + " {}\n", "RESPONSE_TRAILING_VALUE", valid.replace("\"diagnostics\":[]", "\"diagnostics\":{}"), "RESPONSE_FIELD_REJECTED",
valid.replace("\"diagnostics\":[]", "\"detail\":[]"), "RESPONSE_FIELD_REJECTED", valid.replace("\"diagnostics\":[]", "\"unknown\":1"), "RESPONSE_FIELD_REJECTED",
valid.replace("\"OK\"", "7"), "RESPONSE_FIELD_REJECTED").entrySet())
{
assertEquals(malformed.getValue(), assertThrows(IllegalArgumentException.class,
() -> WorkerAnswer.read(malformed.getKey().getBytes(StandardCharsets.UTF_8), FRAME, ID, FACTS)).getMessage(), malformed.getKey());
}
for(String broken : List.of(valid.replace("\"diagnostics\":[]", "\"outcome\":\"OK\""), valid.replace("}", "")))
{
assertThrows(java.io.IOException.class, () -> WorkerAnswer.read(broken.getBytes(StandardCharsets.UTF_8), FRAME, ID, FACTS), broken);
}
byte[] bytes = valid.getBytes(StandardCharsets.UTF_8);
bytes[10] = (byte) 0xFF;
assertThrows(java.io.IOException.class, () -> WorkerAnswer.read(bytes, FRAME, ID, FACTS));
}
/***************************************************************************
** An answer is for this request, this protocol and catalog, from a renderer
** this bridge accepts, with an outcome it knows.
***************************************************************************/
@Test
void anAnswerOutsideItsEnvelopeIsRejected() throws Exception
{
for(String field : List.of("protocol", "requestId", "rendererVersion", "catalogVersion", "outcome"))
{
Map<String, Object> changed = FakeWorker.validated(ID, FakeWorker.CURRENT);
changed.put(field, "qqq-renderer-0.3.0");
assertEquals("WORKER_RESPONSE_REJECTED", rejection(changed), field);
Map<String, Object> missing = FakeWorker.validated(ID, FakeWorker.CURRENT);
missing.remove(field);
assertEquals("WORKER_RESPONSE_REJECTED", rejection(missing), field);
}
assertSame(RendererVersion.RELEASED, read(FakeWorker.validated(ID, FakeWorker.RELEASED)).version());
}
/***************************************************************************
** A refused answer carries no label. One that does, in any of its parts, is
** rejected, so nothing downstream can find bytes of a label with elements
** missing. An answer is refused only when diagnostics were collected and one
** of them is an error; an accepted answer has no error.
***************************************************************************/
@Test
void aRefusedAnswerThatCarriesLabelBytesIsRejected() throws Exception
{
Map<String, Object> error = FakeWorker.diagnostic("TEXT_DOES_NOT_FIT", "ERROR", "element", "caption");
Map<String, Object> label = FakeWorker.rendered(ID, FakeWorker.CURRENT, LABEL, List.of(error));
label.put("outcome", "REFUSED");
assertEquals("WORKER_RESPONSE_REJECTED", rejection(label));
for(String part : List.of("mediaType", "base64", "sha256", "length", "pageCount"))
{
Map<String, Object> partial = refused(error);
partial.put(part, label.get(part));
assertEquals("WORKER_RESPONSE_REJECTED", rejection(partial), part);
}
assertEquals("WORKER_RESPONSE_REJECTED", rejection(FakeWorker.refused(ID, List.of())));
assertEquals("WORKER_RESPONSE_REJECTED", rejection(refused(FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING"))));
Map<String, Object> bare = FakeWorker.envelope(ID, FakeWorker.CURRENT, "REFUSED");
assertEquals("WORKER_RESPONSE_REJECTED", rejection(bare));
Map<String, Object> detailed = refused(error);
detailed.put("detail", error);
assertEquals("WORKER_RESPONSE_REJECTED", rejection(detailed));
///////////////////////////////////////////////////////////////////////////////////////////
// the print path never collects, so to it a refused answer is always a rejected answer //
///////////////////////////////////////////////////////////////////////////////////////////
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(refused(error)).settle("RENDER", false, true)).getMessage());
assertEquals("WORKER_RESPONSE_REJECTED", rejection(FakeWorker.rendered(ID, FakeWorker.CURRENT, LABEL, List.of(error))));
assertFalse(read(FakeWorker.rendered(ID, FakeWorker.CURRENT, LABEL, List.of(FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING")))).settle("RENDER", true, true).refused());
}
/***************************************************************************
** An answer has exactly the fields of its operation, outcome and renderer:
** none missing, none added, and diagnostics only from the renderer that has
** them.
***************************************************************************/
@Test
void aWrongNumberOfFieldsIsRejected() throws Exception
{
for(String version : List.of(FakeWorker.RELEASED, FakeWorker.CURRENT))
{
assertEquals(List.of(), read(FakeWorker.rendered(ID, version, LABEL, List.of())).settle("RENDER", false, false).diagnostics());
read(FakeWorker.validated(ID, version)).settle("VALIDATE", false, false);
for(String part : List.of("mediaType", "base64", "sha256", "length", "pageCount"))
{
Map<String, Object> missing = FakeWorker.rendered(ID, version, LABEL, List.of());
missing.remove(part);
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(missing).settle("RENDER", false, false)).getMessage(), part);
}
Map<String, Object> coded = FakeWorker.rendered(ID, version, LABEL, List.of());
coded.put("code", "BARCODE_FIT_TOO_SMALL");
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(coded).settle("RENDER", false, false)).getMessage());
Map<String, Object> label = FakeWorker.rendered(ID, version, LABEL, List.of());
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(label).settle("VALIDATE", false, false)).getMessage());
Map<String, Object> none = FakeWorker.validated(ID, version);
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(none).settle("RENDER", false, false)).getMessage());
}
Map<String, Object> early = FakeWorker.validated(ID, FakeWorker.RELEASED);
early.put("diagnostics", List.of());
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(early).settle("VALIDATE", false, false)).getMessage());
Map<String, Object> late = FakeWorker.validated(ID, FakeWorker.CURRENT);
late.remove("diagnostics");
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(late).settle("VALIDATE", false, false)).getMessage());
Map<String, Object> detailed = FakeWorker.validated(ID, FakeWorker.CURRENT);
detailed.put("detail", FakeWorker.diagnostic("SCENE_INVALID", "ERROR"));
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(detailed).settle("VALIDATE", false, false)).getMessage());
}
/***************************************************************************
** An error answer becomes the typed refusal with its diagnostic. The code
** must be one its renderer may name, the detail must be that same error,
** and an error answer has no other parts.
***************************************************************************/
@Test
void anErrorAnswerIsTheTypedRefusalOrIsRejected() throws Exception
{
Map<String, Object> detail = FakeWorker.diagnostic("SCENE_INVALID", "ERROR", "element", "caption", "pointer", "/elements/0/fit");
var refusal = assertThrows(GenerationPorts.RenderException.class, () -> read(FakeWorker.error(ID, FakeWorker.CURRENT, "SCENE_INVALID", detail)).settle("RENDER", false, true));
assertEquals(FailureCode.SCENE_INVALID, refusal.code());
assertEquals(new Diagnostic("SCENE_INVALID", Diagnostic.Severity.ERROR, "caption", null, null, null, "/elements/0/fit"), refusal.diagnostic());
var bare = assertThrows(GenerationPorts.RenderException.class, () -> read(FakeWorker.error(ID, FakeWorker.CURRENT, "STOCK_MISMATCH", null)).settle("VALIDATE", false, true));
assertEquals(FailureCode.STOCK_MISMATCH, bare.code());
assertNull(bare.diagnostic());
assertEquals(FailureCode.BARCODE_FIT_TOO_SMALL, assertThrows(GenerationPorts.RenderException.class,
() -> read(FakeWorker.error(ID, FakeWorker.RELEASED, "BARCODE_FIT_TOO_SMALL", null)).settle("RENDER", false, false)).code());
List<Map<String, Object>> rejected = new ArrayList<>();
rejected.add(FakeWorker.error(ID, FakeWorker.CURRENT, "RENDER_FAILED", null));
rejected.add(FakeWorker.error(ID, FakeWorker.CURRENT, "A sentence about a customer.", null));
rejected.add(FakeWorker.error(ID, FakeWorker.RELEASED, "SCENE_INVALID", null));
rejected.add(FakeWorker.error(ID, FakeWorker.RELEASED, "BARCODE_FIT_TOO_SMALL", FakeWorker.diagnostic("BARCODE_FIT_TOO_SMALL", "ERROR")));
rejected.add(FakeWorker.error(ID, FakeWorker.CURRENT, "SCENE_INVALID", FakeWorker.diagnostic("STOCK_MISMATCH", "ERROR")));
rejected.add(FakeWorker.error(ID, FakeWorker.CURRENT, "SCENE_INVALID", FakeWorker.diagnostic("DEVICE_UNIT_USED", "WARNING")));
Map<String, Object> listed = FakeWorker.error(ID, FakeWorker.CURRENT, "SCENE_INVALID", null);
listed.put("diagnostics", List.of());
rejected.add(listed);
Map<String, Object> labelled = FakeWorker.error(ID, FakeWorker.CURRENT, "SCENE_INVALID", null);
labelled.put("mediaType", "application/vnd.zebra-zpl");
rejected.add(labelled);
Map<String, Object> uncoded = FakeWorker.envelope(ID, FakeWorker.CURRENT, "ERROR");
rejected.add(uncoded);
Map<String, Object> numbered = FakeWorker.envelope(ID, FakeWorker.CURRENT, "ERROR");
numbered.put("length", 1);
rejected.add(numbered);
for(Map<String, Object> answer : rejected)
{
assertEquals("WORKER_ERROR_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(answer).settle("RENDER", false, false)).getMessage(), answer.toString());
}
}
/***************************************************************************
** A job that needs renderer 0.2.0 was not done by an older renderer,
** whatever its answer says: success, a refusal or an unknown error.
***************************************************************************/
@Test
void anOlderRendererNeverAnswersAJobThatNeedsTheNewOne() throws Exception
{
for(Map<String, Object> answer : List.of(FakeWorker.rendered(ID, FakeWorker.RELEASED, LABEL, List.of()), FakeWorker.validated(ID, FakeWorker.RELEASED),
FakeWorker.error(ID, FakeWorker.RELEASED, "RENDER_FAILED", null), FakeWorker.error(ID, FakeWorker.RELEASED, "BARCODE_FIT_TOO_SMALL", null)))
{
for(boolean collect : List.of(true, false))
{
assertEquals(FailureCode.RENDERER_TOO_OLD, assertThrows(GenerationPorts.RenderException.class, () -> read(answer).settle("RENDER", collect, true)).code());
}
}
}
/***************************************************************************
** A refused answer may name only the errors its renderer may name. Every
** error code is one renderer 0.2.0 may name today, so the rule is shown on
** the released renderer, which has no refused answer at all.
***************************************************************************/
@Test
void aRefusedAnswerIsOnlyEverFromTheRendererThatCollects() throws Exception
{
Map<String, Object> old = FakeWorker.envelope(ID, FakeWorker.RELEASED, "REFUSED");
assertEquals("WORKER_RESPONSE_REJECTED", assertThrows(IllegalArgumentException.class, () -> read(old).settle("RENDER", true, false)).getMessage());
for(FailureCode code : FailureCode.values())
{
assertTrue(read(refused(FakeWorker.diagnostic(code.name(), "ERROR"))).settle("RENDER", true, true).refused(), code.name());
}
}
}
@@ -0,0 +1,355 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;
import java.util.stream.Stream;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
/*******************************************************************************
** The page decoded from label bytes is the page that was drawn: every golden
** label of the renderer's version 2 cases decodes, dot for dot, to the golden
** picture of the canvas it was emitted from, at 203, 300 and 600 dpi. Every
** released version 1 label decodes too. A label that is not exactly the
** policy's grammar, or is too large to draw, is refused by name.
*******************************************************************************/
class ZplRasterTest
{
private static final Path CORPUS = Path.of("..", "..", "renderer", "src", "test", "resources", "compat-v1");
private static final GenerationPorts.Stock STOCK = new GenerationPorts.Stock(25400, 12700, 0, 0, 0, 0, 203);
private static final String HEADER = "^XA^PW203^LL102^LH0,0^CI28\n";
/***************************************************************************
** The stored version 2 labels, named `<case>-<dpi>.zpl`.
***************************************************************************/
static List<String> goldens() throws Exception
{
return (ZplSceneTwoPolicyTest.labels());
}
/***************************************************************************
** The stored version 1 labels, by case name.
***************************************************************************/
static List<String> released() throws Exception
{
try(Stream<Path> files = Files.list(CORPUS.resolve("zpl")))
{
List<String> names = files.map(file -> file.getFileName().toString()).filter(name -> name.endsWith(".zpl")).map(name -> name.substring(0, name.length() - 4)).sorted().toList();
assertEquals(42, names.size());
return (names);
}
}
/***************************************************************************
** A small label on the one-inch stock of these tests.
***************************************************************************/
private static byte[] label(String fields)
{
return ((HEADER + fields + "^XZ\n").getBytes(StandardCharsets.US_ASCII));
}
/***************************************************************************
** The name a label is refused by.
***************************************************************************/
private static String refusal(String label)
{
return (assertThrows(IllegalArgumentException.class, () -> ZplRaster.decode(label.getBytes(StandardCharsets.US_ASCII))).getMessage());
}
/***************************************************************************
** A PNG read back with the platform's own decoder, never this class's.
***************************************************************************/
private static BufferedImage picture(byte[] png) throws Exception
{
return (ImageIO.read(new ByteArrayInputStream(png)));
}
/***************************************************************************
** The round trip: the picture decoded from the emitted label equals the
** golden picture of the canvas that was emitted, and the PNG this class
** writes holds exactly those dots.
***************************************************************************/
@ParameterizedTest(name = "{0}")
@MethodSource("goldens")
void aVersionTwoLabelDecodesToTheCanvasThatWasEmitted(String label) throws Exception
{
String name = label.substring(0, label.length() - 8);
int dpi = Integer.parseInt(label.substring(label.length() - 7, label.length() - 4));
GenerationPorts.Stock stock = FakeWorker.stock(name);
GenerationPorts.Stock printed = new GenerationPorts.Stock(stock.widthMicrons(), stock.heightMicrons(), stock.topMicrons(), stock.rightMicrons(), stock.bottomMicrons(), stock.leftMicrons(), dpi);
ZplRaster page = ZplRaster.page(FakeWorker.golden(name, dpi), printed);
BufferedImage golden = ImageIO.read(FakeWorker.SCENES.resolve("golden").resolve(name + "-" + dpi + ".png").toFile());
BufferedImage written = picture(page.png());
assertTrue(page.exact());
assertEquals(golden.getWidth(), page.width());
assertEquals(golden.getHeight(), page.height());
assertEquals(golden.getWidth(), written.getWidth());
assertEquals(golden.getHeight(), written.getHeight());
int inked = 0;
for(int y = 0; y < page.height(); y++)
{
for(int x = 0; x < page.width(); x++)
{
boolean ink = (golden.getRGB(x, y) & 0xFFFFFF) == 0;
inked += ink ? 1 : 0;
if(page.ink(x, y) != ink || ((written.getRGB(x, y) & 0xFFFFFF) == 0) != ink)
{
throw new AssertionError(label + " differs from its golden picture at dot " + x + ", " + y);
}
}
}
assertTrue(inked > 0, label);
}
/***************************************************************************
** Every released version 1 label decodes for the stock it was rendered for.
** It is exact unless it holds printer font text, and its PNG is its page.
***************************************************************************/
@ParameterizedTest(name = "{0}")
@MethodSource("released")
void aReleasedVersionOneLabelDecodes(String name) throws Exception
{
byte[] bytes = Files.readAllBytes(CORPUS.resolve("zpl").resolve(name + ".zpl"));
JsonNode stock = RendererJson.JSON.readTree(Files.readAllBytes(CORPUS.resolve("cases").resolve(name + ".json"))).path("stock");
ZplRaster page = ZplRaster.page(bytes, new GenerationPorts.Stock(stock.path("widthMicrons").intValue(), stock.path("heightMicrons").intValue(), stock.path("topMicrons").intValue(),
stock.path("rightMicrons").intValue(), stock.path("bottomMicrons").intValue(), stock.path("leftMicrons").intValue(), stock.path("dpi").intValue()));
String text = new String(bytes, StandardCharsets.US_ASCII);
assertEquals(!text.contains("^A0N,"), page.exact(), name);
BufferedImage written = picture(page.png());
assertEquals(page.width(), written.getWidth());
assertEquals(page.height(), written.getHeight());
int inked = 0;
for(int y = 0; y < page.height(); y++)
{
for(int x = 0; x < page.width(); x++)
{
inked += page.ink(x, y) ? 1 : 0;
assertEquals(page.ink(x, y), (written.getRGB(x, y) & 0xFFFFFF) == 0);
}
}
assertTrue(inked > 0, name);
}
/***************************************************************************
** A graphic field is its bits, most significant first, row after row; a box
** is a border inside its size, solid when the border meets itself; fields
** that overlap combine as ink.
***************************************************************************/
@Test
void graphicsAndBoxesArePaintedExactly()
{
ZplRaster page = ZplRaster.decode(label("^FO8,2^GFA,4,4,2,A0018001^FS\n^FO20,10^GB6,5,1^FS\n^FO40,10^GB6,5,3^FS\n^FO9,2^GB1,2,1^FS\n"));
assertTrue(page.exact());
assertEquals(203, page.width());
assertEquals(102, page.height());
Map<Integer, List<Integer>> expected = Map.of(2, List.of(8, 9, 10, 23), 3, List.of(8, 9, 23));
for(int y = 0; y < 9; y++)
{
for(int x = 0; x < 32; x++)
{
assertEquals(expected.getOrDefault(y, List.of()).contains(x), page.ink(x, y), x + ", " + y);
}
}
for(int y = 9; y < 16; y++)
{
for(int x = 19; x < 47; x++)
{
boolean outline = x >= 20 && x < 26 && y >= 10 && y < 15 && (x == 20 || x == 25 || y == 10 || y == 14);
boolean solid = x >= 40 && x < 46 && y >= 10 && y < 15;
assertEquals(outline || solid, page.ink(x, y), x + ", " + y);
}
}
}
/***************************************************************************
** Printer font text cannot be drawn on the host. Its area (one cell for each
** character, counted as characters and not as bytes) is outlined and
** hatched, and the page says it is not exact.
***************************************************************************/
@Test
void printerFontTextIsAHatchedPlaceholderAndThePageIsNotExact()
{
ZplRaster page = ZplRaster.decode(label("^FO10,20^A0N,12,7^FH_^FD_41_C3_A9_E2_82_AC^FS\n"));
assertFalse(page.exact());
for(int y = 18; y < 34; y++)
{
for(int x = 8; x < 34; x++)
{
int column = x - 10;
int row = y - 20;
boolean inside = column >= 0 && column < 21 && row >= 0 && row < 12;
assertEquals(inside && (column == 0 || row == 0 || column == 20 || row == 11 || (column + row) % 6 == 0), page.ink(x, y), x + ", " + y);
}
}
}
/***************************************************************************
** Strips whose lengths, digits or places are wrong, and anything that is not
** the next byte of the grammar, are refused: nothing is skipped or guessed.
***************************************************************************/
@Test
void malformedStripsAreRefused()
{
String strip = "^FO8,2^GFA,4,4,2,A0018001^FS\n";
assertEquals(4, ZplRaster.decode(label(strip)).width() - 199);
for(Map.Entry<String, String> malformed : Map.ofEntries(
Map.entry(strip.replace("A0018001", "A00180"), "RASTER_HEX"), Map.entry(strip.replace("A0018001", "A001800100"), "RASTER_GRAMMAR"),
Map.entry(strip.replace("A0018001", "a0018001"), "RASTER_HEX"), Map.entry(strip.replace("A0018001", "A001800G"), "RASTER_HEX"),
Map.entry(strip.replace("A0018001", "A001800"), "RASTER_HEX"), Map.entry(strip.replace(",4,4,2,", ",4,5,2,"), "RASTER_FIELD"),
Map.entry(strip.replace(",4,4,2,", ",3,3,2,"), "RASTER_FIELD"), Map.entry(strip.replace(",4,4,2,", ",0,0,1,"), "RASTER_FIELD"),
Map.entry(strip.replace(",4,4,2,", ",4,4,0,"), "RASTER_FIELD"), Map.entry(strip.replace(",4,4,2,", ",100000,100000,2,"), "RASTER_FIELD"),
Map.entry("^FO0,0^GFA,1251,1251,1251," + "00".repeat(1251) + "^FS\n", "RASTER_FIELD"), Map.entry(strip.replace("^FO8,2", "^FO8,101"), "RASTER_FIELD"),
Map.entry(strip.replace("^FO8,2", "^FO203,2"), "RASTER_FIELD"), Map.entry(strip.replace("^FO8,2", "^FO196,2"), "RASTER_FIELD"),
Map.entry(strip.replace("^FO8,2", "^FO999999,2"), "RASTER_FIELD"), Map.entry(strip.replace("^FO8,2", "^FO08,2"), "RASTER_NUMBER"),
Map.entry(strip.replace("^FO8,2", "^FO1000000,2"), "RASTER_NUMBER"), Map.entry(strip.replace("^FO8,2", "^FO,2"), "RASTER_NUMBER"),
Map.entry(strip.replace("^FO8,2", "^FO-8,2"), "RASTER_NUMBER"), Map.entry(strip.replace("^FS\n", "^FS"), "RASTER_GRAMMAR"),
Map.entry(strip.replace("^GFA", "^GFB"), "RASTER_GRAMMAR"), Map.entry(strip.replace("^GFA,4,4,2,A0018001", "^XGR:LOGO.GRF,1,1"), "RASTER_GRAMMAR"),
Map.entry(strip + "~JR", "RASTER_GRAMMAR"), Map.entry("^FO20,10^GB6,5,6^FS\n", "RASTER_FIELD"), Map.entry("^FO20,10^GB6,5,0^FS\n", "RASTER_FIELD"),
Map.entry("^FO200,10^GB6,5,1^FS\n", "RASTER_FIELD"), Map.entry("^FO20,100^GB6,5,1^FS\n", "RASTER_FIELD"), Map.entry("^FO20,10^GB0,5,1^FS\n", "RASTER_FIELD"),
Map.entry("^FO20,10^GB6,5^FS\n", "RASTER_GRAMMAR"), Map.entry("^FO10,20^A0N,12,7^FH_^FD^FS\n", "RASTER_FIELD"), Map.entry("^FO10,20^A0N,12,7^FH_^FD_4^FS\n", "RASTER_HEX"),
Map.entry("^FO10,20^A0N,12,70^FH_^FD_41_42_43^FS\n", "RASTER_FIELD"), Map.entry("^FO10,95^A0N,12,7^FH_^FD_41^FS\n", "RASTER_FIELD"),
Map.entry("^FO10,20^A0N,12,7^FDplain^FS\n", "RASTER_GRAMMAR"), Map.entry("^FO10,20^A0R,12,7^FH_^FD_41^FS\n", "RASTER_GRAMMAR")).entrySet())
{
assertEquals(malformed.getValue(), refusal(HEADER + malformed.getKey() + "^XZ\n"), malformed.getKey());
}
String valid = HEADER + strip + "^XZ\n";
for(Map.Entry<String, String> malformed : Map.of(valid + valid, "RASTER_GRAMMAR", valid + " ", "RASTER_GRAMMAR", valid.replace("^XZ\n", "^XZ"), "RASTER_GRAMMAR", "", "RASTER_GRAMMAR",
valid.replace("^XA", "^XA^MMT"), "RASTER_GRAMMAR", valid.replace("^LH0,0", "^LH1,0"), "RASTER_GRAMMAR", valid.replace("^PW203", "^PW"), "RASTER_NUMBER",
valid.substring(0, 48), "RASTER_HEX", valid.substring(0, 10), "RASTER_GRAMMAR").entrySet())
{
assertEquals(malformed.getValue(), refusal(malformed.getKey()), malformed.getKey());
}
assertEquals("RASTER_GRAMMAR", assertThrows(IllegalArgumentException.class, () -> ZplRaster.decode(null)).getMessage());
}
/***************************************************************************
** A preview draws at most sixteen million dots, and only a page a printer
** can address.
***************************************************************************/
@Test
void aPageTooLargeToDrawIsRefused()
{
assertEquals(4000, ZplRaster.decode("^XA^PW4000^LL4000^LH0,0^CI28\n^XZ\n".getBytes(StandardCharsets.US_ASCII)).height());
assertEquals("PREVIEW_TOO_LARGE", refusal("^XA^PW4000^LL4001^LH0,0^CI28\n^XZ\n"));
assertEquals("PREVIEW_TOO_LARGE", refusal("^XA^PW9999^LL32000^LH0,0^CI28\n^XZ\n"));
for(String page : List.of("^XA^PW0^LL100^LH0,0^CI28\n^XZ\n", "^XA^PW100^LL0^LH0,0^CI28\n^XZ\n", "^XA^PW10000^LL1^LH0,0^CI28\n^XZ\n", "^XA^PW1^LL32001^LH0,0^CI28\n^XZ\n"))
{
assertEquals("RASTER_PAGE", refusal(page), page);
}
}
/***************************************************************************
** Only bytes the output policy accepts are drawn: the policy runs first, and
** a label it refuses is refused with the policy's own name.
***************************************************************************/
@Test
void onlyALabelTheOutputPolicyAcceptsIsDrawn() throws Exception
{
byte[] accepted = label("^FO8,2^GFA,4,4,2,A0018001^FS\n");
assertTrue(ZplRaster.page(accepted, STOCK).ink(8, 2));
GenerationPorts.Stock other = new GenerationPorts.Stock(25400, 12700, 0, 0, 0, 0, 300);
assertEquals("ZPL_STOCK_MISMATCH", assertThrows(IllegalArgumentException.class, () -> ZplRaster.page(accepted, other)).getMessage());
///////////////////////////////////////////////////////////////////////////////////////////
// whole white bytes past the page edge draw nothing, but the policy does not allow them //
///////////////////////////////////////////////////////////////////////////////////////////
byte[] padded = label("^FO196,2^GFA,2,2,2,8000^FS\n");
assertTrue(ZplRaster.decode(padded).ink(196, 2));
assertEquals("ZPL_GRAPHIC_OUTSIDE_STOCK", assertThrows(IllegalArgumentException.class, () -> ZplRaster.page(padded, STOCK)).getMessage());
}
/***************************************************************************
** The page of a refused scene shows only where its refused elements are:
** each diagnostic box, moved from the printable area to the page, cut to the
** page and hatched. It is never exact, and a box off the page draws nothing.
***************************************************************************/
@Test
void theRefusedPageIsDrawnFromBoxesAlone()
{
ZplRaster page = ZplRaster.refused(60, 40, 10, 5, List.of(List.of(0, 0, 13, 7), List.of(45, 30, 20, 20), List.of(-20, -20, 22, 23), List.of(100, 0, 5, 5), List.of(0, -50, 5, 5),
List.of(20, 20, 0, 4)));
assertFalse(page.exact());
for(int y = 0; y < 40; y++)
{
for(int x = 0; x < 60; x++)
{
boolean first = hatched(x - 10, y - 5, 13, 7);
boolean cut = hatched(x - 55, y - 35, 5, 5);
boolean corner = hatched(x, y, 12, 8);
assertEquals(first || cut || corner, page.ink(x, y), x + ", " + y);
}
}
assertEquals("PREVIEW_TOO_LARGE", assertThrows(IllegalArgumentException.class, () -> ZplRaster.refused(4000, 4001, 0, 0, List.of())).getMessage());
}
/***************************************************************************
** Whether a dot is ink in a hatched area of this size whose corner is the
** origin of `column` and `row`.
***************************************************************************/
private static boolean hatched(int column, int row, int width, int height)
{
return (column >= 0 && column < width && row >= 0 && row < height && (column == 0 || row == 0 || column == width - 1 || row == height - 1 || (column + row) % 6 == 0));
}
}
@@ -0,0 +1,87 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.MessageDigest;
import java.util.HexFormat;
import java.util.List;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
/*******************************************************************************
** The released version 1 bytes, as the host receives them: each stored ZPL of
** the renderer's `compat-v1` corpus is exactly the bytes its manifest names and
** passes the unchanged host printer gate for the stock it was rendered for. The
** corpus has one copy, in the renderer module, so the two tests cannot drift.
*******************************************************************************/
class ZplSceneOneCompatibilityTest
{
private static final Path CORPUS = Path.of("..", "..", "renderer", "src", "test", "resources", "compat-v1");
///////////////////////////////////////////////////////////////////////////////////////////////
// the SHA-256 of `SHA256SUMS` itself, the same value the renderer's test pins, so the //
// outputs and their sums cannot be regenerated together and still pass //
///////////////////////////////////////////////////////////////////////////////////////////////
private static final String MANIFEST_SHA256 = "cb6ec01d084e9077f3b5f6c8f39ed2f1de1116d92697dbbf529557fc84da5b2a";
/***************************************************************************
** One manifest line per stored output: hash, two spaces, path.
***************************************************************************/
static List<String> outputs() throws Exception
{
assertEquals(MANIFEST_SHA256, HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(Files.readAllBytes(CORPUS.resolve("SHA256SUMS")))), "The corpus manifest was regenerated or edited");
List<String> lines = Files.readAllLines(CORPUS.resolve("SHA256SUMS"), StandardCharsets.US_ASCII);
assertFalse(lines.isEmpty());
return (lines);
}
/***************************************************************************
** A released label that the host gate refused could never have printed.
***************************************************************************/
@ParameterizedTest(name = "{0}")
@MethodSource("outputs")
void releasedBytesAreIntactAndPassTheHostPrinterGate(String line) throws Exception
{
assertTrue(line.matches("[0-9a-f]{64} zpl/[a-z0-9-]+\\.zpl"), line);
String name = line.substring(70, line.length() - 4);
byte[] bytes = Files.readAllBytes(CORPUS.resolve("zpl").resolve(name + ".zpl"));
assertEquals(line.substring(0, 64), HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(bytes)), name);
JsonNode stock = RendererJson.JSON.readTree(Files.readAllBytes(CORPUS.resolve("cases").resolve(name + ".json"))).path("stock");
GenerationPorts.Stock printed = new GenerationPorts.Stock(stock.path("widthMicrons").intValue(), stock.path("heightMicrons").intValue(), stock.path("topMicrons").intValue(),
stock.path("rightMicrons").intValue(), stock.path("bottomMicrons").intValue(), stock.path("leftMicrons").intValue(), stock.path("dpi").intValue());
assertDoesNotThrow(() -> ZplOutputPolicy.validate(bytes, printed), name);
}
}
@@ -0,0 +1,105 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration.renderer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.stream.Stream;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.documentgeneration.GenerationPorts;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
/*******************************************************************************
** A version 2 label, as the host receives it: each golden label of the
** renderer's `scene2` cases passes the unchanged host printer gate for its
** stock at the resolution it was rendered for. A version 2 label is graphic
** fields only, which the gate has always admitted. The goldens have one copy,
** in the renderer module, where the renderer's own test proves this build
** still emits them byte for byte.
*******************************************************************************/
class ZplSceneTwoPolicyTest
{
private static final Path SCENES = Path.of("..", "..", "renderer", "src", "test", "resources", "scene2");
/***************************************************************************
** The stored labels, named `<case>-<dpi>.zpl`.
***************************************************************************/
static List<String> labels() throws Exception
{
try(Stream<Path> files = Files.list(SCENES.resolve("golden")))
{
List<String> labels = files.map(file -> file.getFileName().toString()).filter(name -> name.endsWith(".zpl")).sorted().toList();
assertFalse(labels.isEmpty());
return (labels);
}
}
/***************************************************************************
** The gate accepts the label for the stock at its render target, and for no
** other resolution: the page size in the label is the target's.
***************************************************************************/
@ParameterizedTest(name = "{0}")
@MethodSource("labels")
void aVersionTwoLabelPassesTheUnchangedHostPrinterGate(String label) throws Exception
{
assertTrue(label.matches("[a-z0-9-]+-(203|300|600)\\.zpl"), label);
String name = label.substring(0, label.length() - 8);
int dpi = Integer.parseInt(label.substring(label.length() - 7, label.length() - 4));
byte[] bytes = Files.readAllBytes(SCENES.resolve("golden").resolve(label));
JsonNode stock = RendererJson.JSON.readTree(Files.readAllBytes(SCENES.resolve("cases").resolve(name + ".json"))).path("stock");
assertDoesNotThrow(() -> ZplOutputPolicy.validate(bytes, stock(stock, dpi)), label);
for(int other : List.of(203, 300, 600))
{
if(other != dpi)
{
assertEquals("ZPL_STOCK_MISMATCH", assertThrows(IllegalArgumentException.class, () -> ZplOutputPolicy.validate(bytes, stock(stock, other))).getMessage());
}
}
String text = new String(bytes, StandardCharsets.US_ASCII);
assertTrue(text.contains("^GFA,"), label);
assertFalse(text.contains("^GB") || text.contains("^A0") || text.contains("~"), label);
}
/***************************************************************************
** The case's stock at a render target.
***************************************************************************/
private static GenerationPorts.Stock stock(JsonNode stock, int dpi)
{
return (new GenerationPorts.Stock(stock.path("widthMicrons").intValue(), stock.path("heightMicrons").intValue(), stock.path("topMicrons").intValue(),
stock.path("rightMicrons").intValue(), stock.path("bottomMicrons").intValue(), stock.path("leftMicrons").intValue(), dpi));
}
}
+1 -1
View File
@@ -5,7 +5,7 @@
<groupId>com.kingsrook.qbits</groupId><artifactId>qbit-document-generation-scripting</artifactId><version>${revision}</version>
<name>Document Generation Scripting Bridge</name>
<licenses><license><name>GNU Affero General Public License v3.0</name><url>https://www.gnu.org/licenses/agpl-3.0-standalone.html</url><distribution>repo</distribution></license></licenses>
<properties><qqq.version>4.1.0-RC.22</qqq.version><!-- Released sibling QBit coordinates from the Gitea Maven registry --><qbit-scripting.version>1.0.0</qbit-scripting.version><maven.compiler.release>21</maven.compiler.release><maven.compiler.proc>none</maven.compiler.proc><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><enforcer.skip>true</enforcer.skip></properties>
<properties><qqq.version>4.1.0-RC.26</qqq.version><!-- Released sibling QBit coordinates from the Gitea Maven registry --><qbit-scripting.version>1.1.0-RC.3</qbit-scripting.version><maven.compiler.release>21</maven.compiler.release><maven.compiler.proc>none</maven.compiler.proc><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><enforcer.skip>true</enforcer.skip></properties>
<dependencyManagement><dependencies>
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-backend-core</artifactId><version>${qqq.version}</version></dependency>
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-backend-module-rdbms</artifactId><version>${qqq.version}</version></dependency>
+1 -1
View File
@@ -26,7 +26,7 @@ Submitted records provide only IDs. The source body is always fetched afresh thr
## Database/deployment constraints
The durable queue supports file-backed H2 with configured and actual WRITE_DELAY=0, or native MySQL 8.4 under the live checks in [MYSQL.md](MYSQL.md), or native PostgreSQL 17 under the equivalent live checks in `GenerationPostgres`. Both require fresh independent writable connections and the owned tables on one backend. Ambient QQQ transactions are refused. Native mapping drift and unqualified physical targets are denied. Owned statements have five-second JDBC deadlines; MySQL row/metadata lock waits must each be 1–5 seconds. H2 tests pin 2.5.252 and close all connection providers before a cold reopen. Actual pinned MySQL 8.4.13 tests cover concurrent claims/edits, physical pooled isolation restoration, weakened durability/settings, index/engine/mapping drift, bounded lock contention and server restart. PostgreSQL/Aurora are not implicitly supported. Schema changes are operator migrations; metadata registration does not execute DDL. Host power-loss and volume/backup restoration remain deployment acceptance work.
The durable queue supports file-backed H2 with configured and actual WRITE_DELAY=0, or native MySQL 8.4 under the live checks in [MYSQL.md](MYSQL.md), or native PostgreSQL 17 under the equivalent live checks in `GenerationPostgres`. Both require fresh independent writable connections and the owned tables on one backend. Ambient QQQ transactions are refused. Native mapping drift and unqualified physical targets are denied. Owned statements have five-second JDBC deadlines; MySQL row/metadata lock waits must each be 1–5 seconds. H2 tests pin 2.5.252 and close all connection providers before a cold reopen. Actual pinned MySQL 8.4.13 tests cover concurrent claims/edits, physical pooled isolation restoration, weakened durability/settings, index/engine/mapping drift, bounded lock contention and server restart. Amazon Aurora PostgreSQL 17 passes through the same PostgreSQL checks with one difference: Aurora always runs with `full_page_writes` off and has no parameter to change it, because its storage layer does not write torn pages, so `GenerationPostgres` accepts that value when the server resolves `aurora_version()` (`to_regprocedure('aurora_version()') IS NOT NULL`, evaluated in the settings query). Stock PostgreSQL must still report `full_page_writes` on, and `fsync`, `synchronous_commit` and every other check are unchanged on Aurora. The test for this rule runs on a real `postgres:17` engine with a simulated `aurora_version()` function; no test in this repository runs on Aurora itself. Aurora MySQL is not qualified (see [MYSQL.md](MYSQL.md)). Schema changes are operator migrations; metadata registration does not execute DDL. Host power-loss and volume/backup restoration remain deployment acceptance work.
No queue/render/file/script code is executed through a trusted host JavaScript VM. The renderer and scripting integrations continue to require qualified Linux/runsc; this workstation has no runsc runtime, so hostile execution remains unavailable. The queue does not weaken those gates.
+31
View File
@@ -102,6 +102,37 @@ test uses an explicitly capable fixture; the actual legacy Printing bridge is
separately tested to refuse selected media. No real-owner selected-media support,
new renderer image, device observation or physical output is claimed by this gate.
## Render target: 2026-11-12
`DocumentGenerationService.Request` gains a trailing `Integer targetDpi`: the resolution a label is rendered at.
It is absent (the stock's own resolution, as before) or 203, 300 or 600; any other value throws
`IllegalArgumentException("A render target is 203, 300 or 600 dpi.")` when the request is built. Every earlier
constructor stays and means no target. `GenerationPorts.RenderRequest.targetDpi` carries it to the renderer.
- **Persistence.** One nullable `target_dpi` column on `document_generation_request`. A host applies exactly
one statement before adopting this version, from the shipped script for its database:
`20261112-render-target-dpi-h2.sql`, `20261112-render-target-dpi-mysql.sql` or
`20261112-render-target-dpi-postgres.sql`
(`ALTER TABLE document_generation_request ADD COLUMN target_dpi INTEGER NULL`). Earlier rows stay null and
read as no target. Nothing else in the schema changes; the bootstrap scripts of `DocumentGenerationSchema`
include the column for a new database.
- **Idempotent retry and lookup.** The stored target is compared with the request's in the same check as
destination, media and copies, so the same request key with another target, or with none, is refused as a
different generation intent, for `generate` and `lookupAcceptedPrint`.
- **Digest.** A request with no target (including every earlier row) keeps the exact earlier intent digest; a
stated target adds a framed `target-dpi/v1` domain after `copies/v1`, also when it equals the stock's
resolution.
- **Refusals before any row, render or submit.** A target for a PDF is refused ("A render target applies to
ZPL output only."). A target is refused with `RENDER_TARGET_UNSUPPORTED` unless the configured renderer
declares `IsolatedRenderer.supportsRenderTarget()`, which defaults to false: an adapter that does not read
the field would print at another resolution than was asked for. The renderer bridge declares it.
- **Refusals by the renderer.** The bridge refuses a version 1 scene asked for another resolution than its
stock's as `TARGET_REQUIRES_SCENE_2`, and a version 2 scene on an old image as `RENDERER_TOO_OLD`. Both are
typed: the request is `INCOMPLETE` with that `errorCode` and a retry throws it again without rendering.
- **Not changed.** Reprints reuse retained bytes and carry no target. Queued and batch generation render at the
stock's resolution. The draft preview that retains its output (`preview(Request, fingerprint)`) refuses a
target. The request status process shows the stored `targetDpi`, and the generate process form offers it.
## Copies per print: source candidate, 2026-11-02
An owner-handoff source candidate, not a deployed or public API release. Nothing here
File diff suppressed because it is too large. Load diff
+124
View File
@@ -0,0 +1,124 @@
# Parser fuzzing
## Scope and properties
K22-TEST-25 applies: this repository parses untrusted input at two boundaries. Templates are written by users,
and the isolated renderer is treated as compromisable, so its output is untrusted to the host.
| Target | Module | Input | Campaign |
|---|---|---|---|
| Version 1 scene parser, `ZplRenderer.validate` | `renderer` | A `qqq-zpl-scene/1` source | `MutationCampaignTest.theVersionOneSceneParserAcceptsOnlyVersionOneScenes` |
| Version 2 scene parser, canvas and emitter behind the worker's routing, `RendererMain.process` with `VALIDATE` and, for about one input in four, `RENDER` | `renderer` | A `qqq-zpl-scene/2` source | `MutationCampaignTest.theVersionTwoSceneParserAcceptsOnlyVersionTwoScenes` |
| Host printer gate, `ZplOutputPolicy.validate` | `bridges/renderer` | ZPL bytes returned by the worker | `MutationCampaignTest.theHostPrinterGateAcceptsOnlyTheRendererCommandSet` |
| Page decoder for previews, `ZplRaster.decode` | `bridges/renderer` | ZPL bytes returned by the worker | `MutationCampaignTest.thePageDecoderDrawsExactlyWhatThePrinterGateAccepts` |
| Answer reader, `WorkerAnswer.read` and `settle` | `bridges/renderer` | The worker's answer frame, with its diagnostics | `MutationCampaignTest.theAnswerReaderBelievesOnlyDiagnosticsOfTheSceneThatWasSent` |
The harness is `MutationCampaign`, one copy in each module's test tree (the modules share no test code). It
mutates valid inputs from the version 1 compatibility corpus (`renderer/src/test/resources/compat-v1`) and the
version 2 layout cases (`renderer/src/test/resources/scene2/cases`): bit flips, byte and range edits,
truncation, duplication and tokens of the format spliced in. Each campaign checks unsafe acceptance, not only
crashes:
- **Version 1 scene parser.** An accepted input, read again by a second and differently configured JSON parser,
is a version 1 scene of known element types within the element limit. A refusal is the parser's
`IllegalArgumentException` or exactly one of the JSON reader's exceptions for text that is not one JSON value
(`JsonParseException`, `JsonEOFException`, `MismatchedInputException`, `StreamConstraintsException`). Any
other exception (a `NullPointerException`, an index out of bounds), a stack overflow or a failed acceptance
check is a finding.
- **Version 2 scene parser.** The target is the worker's own routing, so a mutated source may also become a
version 1 scene, which is then held to the version 1 property. An accepted version 2 scene, read by the
second parser, has only the declared top-level properties, a physical design size, at most 1000 elements
with unique ids of the fixed pattern, only `box`, `group` and `text` elements with only their declared
properties (barcodes and images are refused until their packages exist), groups at most four deep, every
length a number and a unit, and overrides only for the three resolutions and for declared ids. A `text`
element is read as it stands at each resolution (the defaults, then the element, then the overrides for that
resolution): it names a bundled face, has a physical size from 1 to 1000 pt, exactly one of a literal value
and a pointer into the record, and only fit, length, threshold, rotation, reverse and line height settings of
the documented kinds and ranges. The corpus holds the three text cases (`text-faces`, `text-fit`,
`text-turned`) beside the layout cases, and the spliced tokens include the text properties, a combining
mark, a tab, half of a surrogate pair, a size of `1000pt` and the number `1e400`. About one version 2 input in
four, chosen by its bytes so that a replay does the same, is rendered instead of validated: the label is read
back into a page, must be only the header, uncompressed graphic fields and the end of a label, must put no ink
outside the printable area, and validation of the same input must give the same answer (accepted with the same
findings, or refused with the same diagnostic). The one difference allowed is `VALUE_MISSING`: a text bound to
the record has no value in the campaign's empty record, and validation reads no record. A refusal is the scene's own `Refusal`, the exception that
carries a diagnostic, and nothing else: the routing turns unreadable JSON and an unknown schema into one. A
plain `IllegalArgumentException` is a finding, because the package raises those for its own broken invariants
(`CANVAS_BOUNDS`, `CANVAS_LIMIT`, `LENGTH_NOT_ABSOLUTE`, `LENGTH_NOT_PHYSICAL`), which no scene may reach; so is
the text package's `IllegalStateException` for ink outside a measured line (`TEXT_INK_OUTSIDE_MEASURE`), and
any arithmetic or number-format failure. The
one exception is a source the routing sends to the frozen version 1 parser, whose own refusal is a plain
`IllegalArgumentException`; such sources are validated only. The campaign also asserts that it rendered labels.
- **Printer gate.** An accepted input contains only the commands the renderer may emit and no tilde command.
A refusal is the gate's `IllegalArgumentException`, or the strict decoder's `CharacterCodingException` for
field text that is not UTF-8. Any other failure, or a failed acceptance check, is a finding.
- **Page decoder.** The same mutated labels go to the gate and to the decoder. A label the gate accepts must
decode, and for a label without printer font text the page must equal, dot for dot, a second drawing of its
graphic fields and boxes made by a regular expression and none of the decoder's code. A label the gate refuses
(which production never hands the decoder) must be drawn within the dot limit or refused with the decoder's
own `IllegalArgumentException`. Any other failure is a finding.
- **Answer reader.** The corpus is answer frames of both accepted renderers for a version 2 scene: a label with
a warning, a refused answer, an error with its detail. An accepted input, read again by a plain JSON reader,
is an answer of renderer 0.2.0 that is a whole label with no error or a refusal with no part of a label, and
each of its diagnostics has only the known fields, names an element the scene declares and points only
through array indexes, schema property names and declared ids. A typed refusal's diagnostic is held to the
same rule. A rejection is the reader's `IllegalArgumentException` or the JSON reader's `IOException`; any
other failure is a finding.
Each campaign also asserts that it reached both acceptance and refusal, so a campaign that only ever refuses
cannot pass.
This is seeded generated-input fuzzing, not coverage-guided instrumentation. Do not claim OSS-Fuzz or
ClusterFuzzLite enrolment.
## Running and replaying
The campaigns run in the normal test phase, so every `./mvnw verify`, and therefore every CI build of a pull
request or a push, runs them. No network, clock or unseeded randomness is used: a seed and an iteration
number determine the input.
```sh
# What CI runs: seeds 20261111 and 7919, 20000 iterations each, per target.
./mvnw -B -pl renderer,bridges/renderer -am verify
# Replay a finding, or run a longer campaign before a MINOR or MAJOR release (both seeds at 100000).
./mvnw -B -pl renderer -am test -Dtest=MutationCampaignTest -Dsurefire.failIfNoSpecifiedTests=false -Dfuzz.seed=20261111 -Dfuzz.iterations=100000
./mvnw -B -pl bridges/renderer -am test -Dtest=MutationCampaignTest -Dsurefire.failIfNoSpecifiedTests=false -Dfuzz.seed=20261111 -Dfuzz.iterations=100000
```
A failure lists each finding as `Finding[seed, iteration, failure]`. `MutationCampaign.input(seed, iteration)`
returns that exact input against the same checkout. Reduce it to a named regression test beside the parser's
other tests, fix the parser, and rerun both seeds. Report a suspected vulnerability privately rather than in a
public issue.
Limits: inputs are at most 1 MiB, a campaign is at most 100000 iterations, and the corpus entries used are
under 20 KiB. The harness writes no files, launches no process and reads no credentials. Generated ZPL is never
sent to a printer. Generated version 2 scenes are rendered in memory on a 2 x 1 in stock at 203 dpi, a canvas of
374 by 171 dots; generated version 1 scenes are only validated.
## Adding a target
A new parser of untrusted input adds one test method to the `MutationCampaignTest` of its module, with a
corpus of valid inputs, a dictionary of the format's tokens, the refusal it declares and an independent check
of what it accepts, and adds a row to the table above.
## Review record
- **Added:** 2026-11-11, with the version 1 scene parser and printer gate campaigns.
- **2026-11-12:** the version 2 scene parser campaign was added with the parser. The version 1 campaign had
counted any exception as a refusal, so a crash in the parser would have passed; it now accepts only the
declared refusals. Both seeds at 20000 iterations, and both at 100000, found nothing under the stricter rule.
- **2026-11-12, review of the scene 2 core:** the version 2 campaign had counted any `IllegalArgumentException`
as a refusal and only validated. It now accepts only a `Refusal` and renders about a quarter of its inputs,
reading each label back. Both seeds at 20000 iterations, and both at 100000, found nothing under the stricter
rule. The defect the review found by reading (a length such as `84600in` overflowing an `int` of micrometres,
an `ArithmeticException`) was already outside the old rule; the mutations did not reach it because they rarely
write a five-digit length, so it is covered by named tests instead (`LengthTest`, `Scene2Test`).
- **2026-11-12, bridge preview:** the page decoder and answer reader campaigns were added with their classes.
Both seeds at 20000 iterations found nothing.
- The first run of the printer gate campaign showed the `CharacterCodingException` refusal, which the property
had not declared. It is a refusal, not a defect; the property now names it.
- Not yet done: a weekly long campaign and the `docs/security/assurance.json` record that K22-TEST-25 also asks
for. The long campaign is the manual command above until a scheduled job exists.
- Reassess the targets when a parser boundary changes.
+17 -1
View File
@@ -7,7 +7,7 @@
<version>${revision}</version>
<name>QBit Document Generation</name>
<description>User-defined document templates and generation coordination for QQQ</description>
<properties><qqq.version>4.1.0-RC.22</qqq.version><maven.compiler.source>21</maven.compiler.source><maven.compiler.target>21</maven.compiler.target><maven.compiler.proc>none</maven.compiler.proc><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><enforcer.skip>false</enforcer.skip></properties>
<properties><qqq.version>4.1.0-RC.26</qqq.version><maven.compiler.source>21</maven.compiler.source><maven.compiler.target>21</maven.compiler.target><maven.compiler.proc>none</maven.compiler.proc><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><enforcer.skip>false</enforcer.skip></properties>
<licenses><license><name>Apache License, Version 2.0</name><url>https://www.apache.org/licenses/LICENSE-2.0</url><distribution>repo</distribution></license></licenses>
<dependencyManagement><dependencies><dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-bom-pom</artifactId><version>${qqq.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>
<dependencies>
@@ -48,6 +48,22 @@
<execution><id>coverage</id><phase>verify</phase><goals><goal>check</goal></goals><configuration><rules><rule><element>BUNDLE</element><limits>
<limit><counter>INSTRUCTION</counter><value>COVEREDRATIO</value><minimum>0.85</minimum></limit>
<limit><counter>CLASS</counter><value>COVEREDRATIO</value><minimum>0.90</minimum></limit>
</limits></rule>
<!-- Classes added since the label layout design (section 10.7) are held to 100% line coverage from their first commit. A pattern matches nothing until its class exists,
so a later package only adds its class here if the design did not already name it. The BUNDLE rule above is unchanged and is never lowered. -->
<rule><element>CLASS</element><includes>
<include>com.kingsrook.qbits.documentgeneration.GenerationPorts.Diagnostic*</include>
<include>com.kingsrook.qbits.documentgeneration.GenerationPorts.Preview*</include>
<include>com.kingsrook.qbits.documentgeneration.GenerationPreviewProcesses*</include>
<include>com.kingsrook.qbits.documentgeneration.GenerationPreviewWidget*</include>
<include>com.kingsrook.qbits.documentgeneration.GenerationAssetProcesses*</include>
<include>com.kingsrook.qbits.documentgeneration.GenerationAssetTables*</include>
<include>com.kingsrook.qbits.documentgeneration.GenerationAssetStore*</include>
<include>com.kingsrook.qbits.documentgeneration.GenerationUpgradeProcesses*</include>
<include>com.kingsrook.qbits.documentgeneration.DocumentPreviewService*</include>
<include>com.kingsrook.qbits.documentgeneration.DocumentAvailability*</include>
</includes><limits>
<limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>1.00</minimum></limit>
</limits></rule></rules></configuration></execution>
</executions></plugin>
<plugin>
@@ -24,6 +24,7 @@ package com.kingsrook.qbits.documentgeneration;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import java.util.stream.Stream;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerMultiOutput;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
@@ -138,7 +139,7 @@ public class DocumentGenerationQBitProducer implements QBitMetaDataProducer<Docu
QBitMetaData bit = getQBitMetaData();
instance.addQBit(bit);
MetaDataProducerMultiOutput output = new MetaDataProducerMultiOutput();
GenerationTables.tables(config).forEach(table ->
Stream.concat(GenerationTables.tables(config).stream(), GenerationAssetTables.tables(config).stream()).forEach(table ->
{
table.setSourceQBitName(bit.getName());
output.add(table);
@@ -146,6 +147,9 @@ public class DocumentGenerationQBitProducer implements QBitMetaDataProducer<Docu
output.addSelfToInstance(instance);
GenerationProcesses.register(instance, config.getSourceTables());
GenerationAuthoringProcesses.register(instance, config);
GenerationPreviewProcesses.register(instance, config);
GenerationAssetProcesses.register(instance, config);
GenerationUpgradeProcesses.register(instance, config);
return (new MetaDataProducerMultiOutput());
}
}
@@ -51,18 +51,30 @@ public class DocumentGenerationService
/*******************************************************************************
** Explicit generation intent, with optional immediate queue submission. Copies
** is how many copies the one queued job prints (1 through 100); it only has a
** meaning with a destination.
** meaning with a destination. The render target is the resolution a label is
** rendered at (203, 300 or 600 dpi); absent means the stock's own resolution.
*******************************************************************************/
public record Request(Integer templateId, GenerationPorts.Source source, GenerationPorts.Format format, String requestKey, String destination, Expected expected,
GenerationPorts.MediaProfile mediaProfile, Integer copies)
GenerationPorts.MediaProfile mediaProfile, Integer copies, Integer targetDpi)
{
/***************************************************************************
** Absent means one; anything outside 1 through 100 is refused when built,
** so an invalid count can never reach admission, rendering or submission.
** A render target other than 203, 300 or 600 is refused the same way.
***************************************************************************/
public Request
{
copies = GenerationPorts.PrintRequest.normalizeCopies(copies);
GenerationPorts.renderTarget(targetDpi);
}
/***************************************************************************
** Existing copies callers render at the stock's own resolution.
***************************************************************************/
public Request(Integer templateId, GenerationPorts.Source source, GenerationPorts.Format format, String requestKey, String destination, Expected expected,
GenerationPorts.MediaProfile mediaProfile, Integer copies)
{
this(templateId, source, format, requestKey, destination, expected, mediaProfile, copies, null);
}
/***************************************************************************
@@ -169,7 +181,8 @@ public class DocumentGenerationService
String actor = GenerationSecurity.require("generate");
GenerationSecurity.require("configure");
noAmbientTransaction();
if(request == null || request.destination() != null || request.format() == null || request.expected() != null || request.mediaProfile() != null || request.copies() != 1)
if(request == null || request.destination() != null || request.format() == null || request.expected() != null || request.mediaProfile() != null || request.copies() != 1
|| request.targetDpi() != null)
{
throw new QBadRequestException("Preview requires a source record and format without a print destination.");
}
@@ -425,9 +438,11 @@ public class DocumentGenerationService
QRecord selected = GenerationSecurity.sourceForMutation(requested.source());
String canonicalId = selected.getValueString(QContext.getQInstance().getTable(requested.source().tableName()).getPrimaryKeyField());
Request request = new Request(requested.templateId(), new GenerationPorts.Source(requested.source().tableName(), canonicalId),
requested.format(), requested.requestKey(), requested.destination(), requested.expected(), requested.mediaProfile(), requested.copies());
requested.format(), requested.requestKey(), requested.destination(), requested.expected(), requested.mediaProfile(), requested.copies(), requested.targetDpi());
// Before any row, render or submission: a count the owner cannot honor is refused, not silently reduced.
requireCopiesSupport(request);
// The same for a render target: a renderer that would ignore it never gets the job.
requireTargetSupport(request);
Admission admission = admit(actor, request, pinned);
if(admission.existing())
{
@@ -462,7 +477,7 @@ public class DocumentGenerationService
GenerationSecurity.require("generate");
GenerationSecurity.sourceForMutation(request.source());
GenerationPorts.Content content = config.getRenderer().render(new GenerationPorts.RenderRequest(row.getValueString("operationId"), actor,
request.source(), request.format(), revision, snapshot, config.getMaximumOutputBytes()));
request.source(), request.format(), revision, snapshot, config.getMaximumOutputBytes(), target(row)));
if(content == null)
{
throw (new QException("Renderer returned no output."));
@@ -593,6 +608,7 @@ public class DocumentGenerationService
GenerationSecurity.requireRead(request.source() == null ? null : request.source().tableName());
requireMediaSupport(request.mediaProfile());
requireCopiesSupport(request);
requireTargetSupport(request);
QRecord row = existing(actor, request, "GENERATE");
if(row == null)
{
@@ -684,7 +700,9 @@ public class DocumentGenerationService
|| !Objects.equals(row.getValueString("format"), request.format().name()) || !Objects.equals(row.getValueString("destination"), request.destination())
|| !Objects.equals(row.getValueString("kind"), kind) || !Objects.equals(media(row), request.mediaProfile())
// Rows stored before copies existed have no count; compare them as one so a legacy default-one retry still matches.
|| !Objects.equals(copies(row), request.copies()))
|| !Objects.equals(copies(row), request.copies())
// Rows stored before the render target existed have none, which is what a request without one asks for.
|| !Objects.equals(target(row), request.targetDpi()))
{
throw (new QBadRequestException("Request key already belongs to a different generation intent."));
}
@@ -719,7 +737,7 @@ public class DocumentGenerationService
.withValue("format", request.format().name()).withValue("destination", request.destination()).withValue("state", "STARTED").withValue("kind", kind)
.withValue("mediaProfileId", request.mediaProfile() == null ? null : request.mediaProfile().id())
.withValue("mediaProfileRevision", request.mediaProfile() == null ? null : request.mediaProfile().revision())
.withValue("copies", request.copies())));
.withValue("copies", request.copies()).withValue("targetDpi", request.targetDpi())));
}
/*******************************************************************************
@@ -815,6 +833,11 @@ public class DocumentGenerationService
{
identity.addAll(List.of("copies/v1", String.valueOf(copies(row))));
}
// No render target (including every earlier row) keeps the digest it always had; a stated target is part of the identity.
if(target(row) != null)
{
identity.addAll(List.of("target-dpi/v1", String.valueOf(target(row))));
}
String digest = hash(identity.stream().map(value -> value.length() + ":" + value).collect(java.util.stream.Collectors.joining())
.getBytes(java.nio.charset.StandardCharsets.UTF_8));
return (new Result(row.getValueInteger("id"), row.getValueString("state"), new GenerationPorts.Receipt(row.getValueString("fileId"),
@@ -859,6 +882,45 @@ public class DocumentGenerationService
}
}
/***************************************************************************
** Rows stored before the render target existed carry none, which means the
** stock's own resolution; a stored value that is not a resolution a printer
** can have is corrupt and refuses rather than rendering at another one.
***************************************************************************/
private Integer target(QRecord row) throws QException
{
Integer target = row.getValueInteger("targetDpi");
try
{
GenerationPorts.renderTarget(target);
}
catch(IllegalArgumentException invalid)
{
throw new QException("Accepted render target is unavailable.");
}
return (target);
}
/***************************************************************************
** A render target is a label's resolution, and only a renderer that declares
** it renders at the target may be given one; refuse before creating work.
***************************************************************************/
private void requireTargetSupport(Request request) throws QException
{
if(request.targetDpi() == null)
{
return;
}
if(request.format() != GenerationPorts.Format.ZPL)
{
throw new QBadRequestException("A render target applies to ZPL output only.");
}
if(!config.getRenderer().supportsRenderTarget())
{
throw new QBadRequestException("RENDER_TARGET_UNSUPPORTED");
}
}
/***************************************************************************
** More than one copy needs a destination to print to and an owner that
** declares it prints them; refuse before creating work or any print call.
@@ -0,0 +1,46 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
/*******************************************************************************
** Processes that upload and manage built-in template assets such as fonts.
** The producer already calls this registration point; it registers nothing yet.
*******************************************************************************/
final class GenerationAssetProcesses
{
/*******************************************************************************
** Metadata namespace.
*******************************************************************************/
private GenerationAssetProcesses()
{
}
/*******************************************************************************
** Called once by the producer after the generation and authoring processes.
*******************************************************************************/
static void register(QInstance instance, DocumentGenerationQBitConfig config) throws QException
{
}
}
@@ -0,0 +1,47 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration;
import java.util.List;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** Tables of the built-in asset store. The producer already registers whatever
** this returns, with the QBit's own tables; it returns none yet.
*******************************************************************************/
final class GenerationAssetTables
{
/*******************************************************************************
** Metadata namespace.
*******************************************************************************/
private GenerationAssetTables()
{
}
/*******************************************************************************
** Complete table metadata, on the configured backend, for the producer to add.
*******************************************************************************/
static List<QTableMetaData> tables(DocumentGenerationQBitConfig config)
{
return (List.of());
}
}
@@ -38,6 +38,17 @@ public final class GenerationPorts
{
}
/***************************************************************************
** A render target is absent or one of the resolutions the renderer supports.
***************************************************************************/
static void renderTarget(Integer dpi)
{
if(dpi != null && !List.of(203, 300, 600).contains(dpi))
{
throw new IllegalArgumentException("A render target is 203, 300 or 600 dpi.");
}
}
/*******************************************************************************
** Initial output contracts; new formats require a qualified renderer adapter.
*******************************************************************************/
@@ -93,7 +104,129 @@ public final class GenerationPorts
SCANNER_BARCODE_PAYLOAD_UNSUPPORTED,
SCANNER_BARCODE_CHECKSUM_REQUIRED,
SCANNER_BARCODE_CHECKSUM_MISMATCH,
UNSUPPORTED_BARCODE_OPTION
UNSUPPORTED_BARCODE_OPTION,
//////////////////////////////////////////////////////////////////////////////////////
// version 2 scene refusals; no released renderer names these for a version 1 scene //
//////////////////////////////////////////////////////////////////////////////////////
SCENE_INVALID,
STOCK_MISMATCH,
TARGET_REQUIRES_SCENE_2,
ELEMENT_OUTSIDE_PRINTABLE_AREA,
TEXT_DOES_NOT_FIT,
VALUE_MISSING,
VALUE_TOO_LONG,
FONT_UNKNOWN,
FONT_MISSING_GLYPH,
RESERVED_FONT_NAME,
BARCODE_DOES_NOT_FIT,
GS1_INVALID,
ASSET_UNKNOWN,
PREVIEW_TOO_LARGE,
RENDERER_TOO_OLD
}
/***************************************************************************
** A caller's context, held apart from the map the caller keeps: the entries
** are copied (a value may be null) and the copy cannot be changed. Values are
** not copied; the renderer adapter snapshots them when it frames the job.
***************************************************************************/
private static Map<String, Object> held(Map<String, Object> context)
{
return (context == null ? null : java.util.Collections.unmodifiableMap(new java.util.LinkedHashMap<>(context)));
}
/***************************************************************************
** One renderer finding about a layout: a code from a closed vocabulary, the
** element id the template author wrote, numbers, and for a finding about the
** scene source itself the JSON pointer of the offending place. It has no free
** text, so no record value, context text or exception message can travel in
** it: a pointer is only property names of the scene schema, array indexes
** and declared element ids, which the renderer checks where it creates the
** diagnostic and this record holds to their shape.
***************************************************************************/
public record Diagnostic(String code, Severity severity, String element, List<Integer> box, Map<String, Integer> measured, Map<String, Integer> limit, String pointer)
{
private static final java.util.regex.Pattern POINTER = java.util.regex.Pattern.compile("(/(0|[1-9][0-9]{0,3}|[A-Za-z][A-Za-z0-9_-]{0,31})){0,16}");
private static final java.util.Set<String> WARNINGS = java.util.Set.of("TEXT_TRUNCATED", "TEXT_SMALL_FOR_DPI", "TEXT_LIGHT_FACE", "FIT_NOT_PROVEN",
"BARCODE_MODULE_BELOW_RECOMMENDED", "QUIET_ZONE_INTRUDED", "ELEMENTS_OVERLAP", "IMAGE_UPSCALED", "DEVICE_UNIT_USED", "PRINTER_FONT_NOT_SHOWN");
private static final java.util.Set<String> INFORMATION = java.util.Set.of("TEXT_SHRUNK", "TEXT_WRAPPED", "BARCODE_MODULE", "IMAGE_SCALED");
/************************************************************************
** An error stops printing; a warning and information do not.
************************************************************************/
public enum Severity
{
ERROR, WARNING, INFO
}
/************************************************************************
** A diagnostic that points at no place in the scene source.
************************************************************************/
public Diagnostic(String code, Severity severity, String element, List<Integer> box, Map<String, Integer> measured, Map<String, Integer> limit)
{
this(code, severity, element, box, measured, limit, null);
}
/************************************************************************
** Admit only the vocabulary: an error is a FailureCode name, a warning or
** information is one of the fixed names. The element is absent or an
** author-written id, the box is absent or x, y, width and height in dots,
** measured values and limits are at most eight named integers each, and
** the pointer is absent or at most sixteen segments, each an array index
** or a name of the same shape as an element id (the empty pointer is the
** whole scene).
************************************************************************/
public Diagnostic
{
if(pointer != null && !POINTER.matcher(pointer).matches())
{
throw new IllegalArgumentException("A diagnostic pointer is made of names and indexes.");
}
if(severity == null || code == null || !known(code, severity))
{
throw new IllegalArgumentException("Unknown diagnostic code for its severity.");
}
if(element != null && !element.matches("[A-Za-z][A-Za-z0-9_-]{0,31}"))
{
throw new IllegalArgumentException("Invalid diagnostic element id.");
}
if(box != null && (box.size() != 4 || box.stream().anyMatch(java.util.Objects::isNull) || box.get(2) < 0 || box.get(3) < 0))
{
throw new IllegalArgumentException("A diagnostic box is x, y, width and height in dots.");
}
box = box == null ? null : List.copyOf(box);
measured = numbers(measured);
limit = numbers(limit);
}
/************************************************************************
** The closed vocabulary, by severity.
************************************************************************/
private static boolean known(String code, Severity severity)
{
return (switch(severity)
{
case ERROR -> java.util.Arrays.stream(FailureCode.values()).anyMatch(failure -> failure.name().equals(code));
case WARNING -> WARNINGS.contains(code);
case INFO -> INFORMATION.contains(code);
});
}
/************************************************************************
** Freeze named integers; a name is a short identifier, never a sentence.
************************************************************************/
private static Map<String, Integer> numbers(Map<String, Integer> values)
{
if(values == null)
{
return (Map.of());
}
if(values.size() > 8 || values.entrySet().stream().anyMatch(entry -> entry.getKey() == null || !entry.getKey().matches("[a-z][A-Za-z0-9]{0,31}") || entry.getValue() == null))
{
throw new IllegalArgumentException("Diagnostic values are at most eight named integers.");
}
return (Map.copyOf(values));
}
}
/***************************************************************************
@@ -103,14 +236,29 @@ public final class GenerationPorts
{
private static final long serialVersionUID = 1L;
private final FailureCode code;
private final transient Diagnostic diagnostic;
/***************************************************************************
** Construct a native process error whose public message is the safe code.
***************************************************************************/
public RenderException(FailureCode code)
{
this(code, null);
}
/***************************************************************************
** A refusal that also says where and by how much: the diagnostic, when
** present, is the error with this same code. The message stays the code.
***************************************************************************/
public RenderException(FailureCode code, Diagnostic diagnostic)
{
super(java.util.Objects.requireNonNull(code).name());
if(diagnostic != null && (diagnostic.severity() != Diagnostic.Severity.ERROR || !code.name().equals(diagnostic.code())))
{
throw new IllegalArgumentException("A refusal's diagnostic must be the error with the same code.");
}
this.code = code;
this.diagnostic = diagnostic;
}
/***************************************************************************
@@ -120,6 +268,14 @@ public final class GenerationPorts
{
return (code);
}
/***************************************************************************
** The detail the worker gave with the refusal, or null when it gave none.
***************************************************************************/
public Diagnostic diagnostic()
{
return (diagnostic);
}
}
/*******************************************************************************
@@ -223,7 +379,121 @@ public final class GenerationPorts
** Bounded worker job with all revision inputs captured before dispatch.
*******************************************************************************/
public record RenderRequest(String requestId, String actorId, Source source, Format format, Revision revision,
Map<String, Object> context, Integer maximumBytes) {}
Map<String, Object> context, Integer maximumBytes, Integer targetDpi)
{
/***************************************************************************
** The render target is absent (the stock's own resolution) or a resolution
** the renderer supports.
***************************************************************************/
public RenderRequest
{
renderTarget(targetDpi);
context = held(context);
}
/***************************************************************************
** The context is record data and the revision is template source; neither
** belongs in a log line, so only the job's identity is shown.
***************************************************************************/
@Override
public String toString()
{
return ("RenderRequest[requestId=" + requestId + ", format=" + format + ", targetDpi=" + targetDpi + "]");
}
/***************************************************************************
** Existing callers render at the stock's own resolution.
***************************************************************************/
public RenderRequest(String requestId, String actorId, Source source, Format format, Revision revision,
Map<String, Object> context, Integer maximumBytes)
{
this(requestId, actorId, source, format, revision, context, maximumBytes, null);
}
}
/***************************************************************************
** A layout preview job: the print path stopped before retention. It has no
** request id and no source record because nothing is written for it.
***************************************************************************/
public record PreviewRequest(String actorId, Format format, Revision revision, Map<String, Object> context, Integer targetDpi, Integer maximumBytes)
{
/***************************************************************************
** Refuse a job that names no format or content, an unsupported render
** target or no output bound.
***************************************************************************/
public PreviewRequest
{
if(format == null || revision == null || maximumBytes == null || maximumBytes < 1)
{
throw new IllegalArgumentException("A preview needs a format, a revision and an output limit.");
}
renderTarget(targetDpi);
context = held(context);
}
/***************************************************************************
** The context is record data and the revision is template source; neither
** belongs in a log line, so only the format and the render target are shown.
***************************************************************************/
@Override
public String toString()
{
return ("PreviewRequest[format=" + format + ", targetDpi=" + targetDpi + "]");
}
}
/***************************************************************************
** One preview page: a PNG whose pixels are printer dots at the render target.
***************************************************************************/
public record PreviewPage(byte[] png, Integer widthDots, Integer heightDots)
{
private static final byte[] SIGNATURE = {(byte) 0x89, 'P', 'N', 'G', 13, 10, 26, 10};
/***************************************************************************
** Only a PNG with a stated size is a page; the bytes cannot change later.
***************************************************************************/
public PreviewPage
{
if(png == null || png.length < SIGNATURE.length || !java.util.Arrays.equals(png, 0, SIGNATURE.length, SIGNATURE, 0, SIGNATURE.length)
|| widthDots == null || widthDots < 1 || heightDots == null || heightDots < 1)
{
throw new IllegalArgumentException("A preview page is a PNG with its size in dots.");
}
png = png.clone();
}
/***************************************************************************
** Never expose the stored byte array to a consumer.
***************************************************************************/
@Override
public byte[] png()
{
return (png.clone());
}
}
/***************************************************************************
** What a preview shows: the pages, whether they are exactly what prints,
** whether the layout can print at all, every diagnostic, and the size and
** hash of the output the pages were decoded from.
***************************************************************************/
public record Preview(List<PreviewPage> pages, Boolean exact, Boolean printable, List<Diagnostic> diagnostics, Long outputBytes, String outputSha256)
{
/***************************************************************************
** Freeze the lists and refuse a contradiction: a layout with an error
** diagnostic is not printable.
***************************************************************************/
public Preview
{
pages = List.copyOf(pages);
diagnostics = List.copyOf(diagnostics);
if(exact == null || printable == null || outputBytes == null || outputBytes < 0 || outputSha256 == null || !outputSha256.matches("[a-f0-9]{64}")
|| (printable && diagnostics.stream().anyMatch(diagnostic -> diagnostic.severity() == Diagnostic.Severity.ERROR)))
{
throw new IllegalArgumentException("Invalid preview result.");
}
}
}
/*******************************************************************************
** Temporary bounded worker result, discarded after retained intake.
@@ -393,6 +663,28 @@ public final class GenerationPorts
throw new QException("Renderer barcode reference is unavailable.");
}
/***********************************************************************
** Optional layout preview: the print path stopped before retention, with
** the pages decoded from the validated output. A renderer that does not
** provide it refuses, so an existing adapter is unchanged.
***********************************************************************/
default Preview preview(PreviewRequest request) throws QException
{
throw new QException("Renderer preview is unavailable.");
}
/***********************************************************************
** Declare that this renderer renders a version 2 scene at the request's
** render target and refuses, by name, a job it cannot render there. An
** adapter that does not read `RenderRequest.targetDpi` keeps the default,
** and generation then refuses a render target before creating any work:
** a caller who asks for 300 dpi never silently gets another resolution.
***********************************************************************/
default boolean supportsRenderTarget()
{
return (false);
}
/*******************************************************************************
** Authorize assets and validate user source outside the application JVM.
*******************************************************************************/
@@ -38,7 +38,8 @@ import com.kingsrook.qqq.backend.module.rdbms.model.metadata.RDBMSBackendMetaDat
/*******************************************************************************
** Qualification of the native QQQ PostgreSQL17 backend (vendor and backend type
** "postgres") and this QBit's owned tables. Observes the live connection only;
** it never changes session or server settings, schema or data.
** it never changes session or server settings, schema or data. Amazon Aurora
** PostgreSQL is the one accepted variant: see durable().
*******************************************************************************/
final class GenerationPostgres
{
@@ -46,7 +47,11 @@ final class GenerationPostgres
private static final String SETTINGS = "SELECT current_setting('server_version_num')::int, current_setting('transaction_read_only'), pg_is_in_recovery(),"
+ " current_setting('synchronous_commit'), current_setting('fsync'), current_setting('full_page_writes'), current_setting('TimeZone'),"
+ " (SELECT setting::bigint FROM pg_settings WHERE name='lock_timeout'), current_setting('transaction_isolation'), current_schema(), current_database()";
+ " (SELECT setting::bigint FROM pg_settings WHERE name='lock_timeout'), current_setting('transaction_isolation'), current_schema(), current_database(),"
+ " to_regprocedure('aurora_version()') IS NOT NULL";
private static final String REQUIREMENTS = "Generation requires synchronous PostgreSQL commits, full-page writes (except on Amazon Aurora PostgreSQL),"
+ " a primary writable server, READ COMMITTED and UTC sessions";
private static final String TABLE = "SELECT c.relpersistence FROM pg_class c JOIN pg_namespace n ON n.oid=c.relnamespace"
+ " WHERE n.nspname=current_schema() AND c.relname=? AND c.relkind='r'";
@@ -91,7 +96,25 @@ final class GenerationPostgres
}
/***************************************************************************
** Exact server, durability, session and owned-table checks for PostgreSQL 17.
** Commit durability of the observed server. Every server needs
** synchronous_commit on or remote_apply and fsync on. Stock PostgreSQL also
** needs full_page_writes on, which protects crash recovery from torn pages.
** Amazon Aurora PostgreSQL runs with full_page_writes off and offers no
** parameter to change it, because its storage layer does not write torn
** pages; so off is accepted there, and only there. Aurora is detected in the
** settings query by to_regprocedure('aurora_version()') IS NOT NULL, which is
** true on Aurora, false on stock PostgreSQL and never raises an error (calling
** a missing function would abort the transaction).
***************************************************************************/
static boolean durable(String synchronousCommit, String fsync, String fullPageWrites, boolean aurora)
{
return (("on".equals(synchronousCommit) || "remote_apply".equals(synchronousCommit)) && "on".equals(fsync)
&& ("on".equals(fullPageWrites) || aurora && "off".equals(fullPageWrites)));
}
/***************************************************************************
** Exact server, durability, session and owned-table checks for PostgreSQL 17,
** with the single Amazon Aurora PostgreSQL allowance stated on durable().
***************************************************************************/
static void qualify(Connection connection, RDBMSBackendMetaData backend) throws SQLException, QException
{
@@ -105,7 +128,7 @@ final class GenerationPostgres
{
if(!row.next())
{
throw new QException("Generation requires synchronous PostgreSQL commits, full-page writes, a primary writable server, READ COMMITTED and UTC sessions.");
throw new QException(REQUIREMENTS + ".");
}
List<String> weak = new java.util.ArrayList<>();
if(row.getInt(1) / 10000 != 17 || row.getString(10) == null || !Objects.equals(backend.getDatabaseName(), row.getString(11)))
@@ -116,7 +139,7 @@ final class GenerationPostgres
{
weak.add("writable primary");
}
if(!Set.of("on", "remote_apply").contains(row.getString(4)) || !"on".equals(row.getString(5)) || !"on".equals(row.getString(6)))
if(!durable(row.getString(4), row.getString(5), row.getString(6), row.getBoolean(12)))
{
weak.add("synchronous commit");
}
@@ -130,7 +153,7 @@ final class GenerationPostgres
}
if(!weak.isEmpty())
{
throw new QException("Generation requires synchronous PostgreSQL commits, full-page writes, a primary writable server, READ COMMITTED and UTC sessions; not satisfied: " + String.join(", ", weak));
throw new QException(REQUIREMENTS + "; not satisfied: " + String.join(", ", weak));
}
long lockTimeout = row.getLong(8);
if(lockTimeout < 1 || lockTimeout > 5000)
@@ -0,0 +1,46 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
/*******************************************************************************
** Layout preview processes for a template: sample, stress and record data.
** The producer already calls this registration point; it registers nothing yet.
*******************************************************************************/
final class GenerationPreviewProcesses
{
/*******************************************************************************
** Metadata namespace.
*******************************************************************************/
private GenerationPreviewProcesses()
{
}
/*******************************************************************************
** Called once by the producer after the generation and authoring processes.
*******************************************************************************/
static void register(QInstance instance, DocumentGenerationQBitConfig config) throws QException
{
}
}
@@ -0,0 +1,45 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** The "Label preview" section of the template record screen. The template
** table already offers itself here after its own sections; nothing is added yet.
*******************************************************************************/
final class GenerationPreviewWidget
{
/*******************************************************************************
** Metadata namespace.
*******************************************************************************/
private GenerationPreviewWidget()
{
}
/*******************************************************************************
** Called once for the template table, after its standard sections.
*******************************************************************************/
static void section(QTableMetaData table)
{
}
}
@@ -128,6 +128,10 @@ public final class GenerationProcesses
form.withFormField(new QFieldMetaData("templateId", QFieldType.INTEGER).withLabel("Published template").withPossibleValueSourceName(GenerationTables.TEMPLATE));
form.withFormField(new QFieldMetaData("format", QFieldType.STRING).withLabel("Output format").withPossibleValueSourceName(GenerationAuthoringProcesses.FORMAT));
}
if("generate".equals(operation))
{
form.withFormField(new QFieldMetaData("targetDpi", QFieldType.INTEGER).withLabel("Render target in dpi: 203, 300 or 600 (optional, ZPL only; default is the stock's resolution)"));
}
if(List.of("generate", "enqueue", "reprint").contains(operation))
{
form.withFormField(new QFieldMetaData("destination", QFieldType.STRING).withLabel("Print destination (optional for generation)").withMaxLength(255));
@@ -261,7 +265,7 @@ public final class GenerationProcesses
throw new QBadRequestException("Select PDF or ZPL output.");
}
result = "generate".equals(operation)
? service.generate(new DocumentGenerationService.Request(input.getValueInteger("templateId"), sources.getFirst(), format, input.getValueString("requestKey"), input.getValueString("destination")))
? service.generate(request(input, sources.getFirst(), format))
: new GenerationQueue(config).enqueue(input.getValueInteger("templateId"), sources, format, input.getValueString("requestKey"), input.getValueString("destination"));
}
else
@@ -335,6 +339,24 @@ public final class GenerationProcesses
}
}
/*******************************************************************************
** The generate action's intent: one record, with the optional render target.
** A target that is not a resolution a printer can have is refused here, as a
** bad request, before the service sees it.
*******************************************************************************/
private static DocumentGenerationService.Request request(RunBackendStepInput input, GenerationPorts.Source source, GenerationPorts.Format format) throws QException
{
try
{
return (new DocumentGenerationService.Request(input.getValueInteger("templateId"), source, format, input.getValueString("requestKey"), input.getValueString("destination"),
null, null, 1, input.getValueInteger("targetDpi")));
}
catch(IllegalArgumentException invalid)
{
throw new QBadRequestException("A render target is 203, 300 or 600 dpi.");
}
}
/*******************************************************************************
** Status exposes only the currently authorized request, never hidden context.
*******************************************************************************/
@@ -344,7 +366,7 @@ public final class GenerationProcesses
QRecord row = GenerationStore.get(GenerationTables.REQUEST, id);
GenerationRetainedAccess.require(row, false);
java.util.Map<String, java.io.Serializable> result = new java.util.LinkedHashMap<>();
for(String field : List.of("id", "state", "format", "tableName", "recordId", "revisionId", "fileId", "versionId", "sha256", "length", "available", "printJobId", "errorCode", "mediaProfileId", "mediaProfileRevision"))
for(String field : List.of("id", "state", "format", "tableName", "recordId", "revisionId", "fileId", "versionId", "sha256", "length", "available", "printJobId", "errorCode", "mediaProfileId", "mediaProfileRevision", "targetDpi"))
{
result.put(field, row.getValue(field));
}
@@ -90,7 +90,7 @@ public final class GenerationTables
.withField(string("actorId", 255)).withField(string("tableName", 128)).withField(string("recordId", 255))
.withField(integer("templateId")).withField(integer("revisionId")).withField(string("format", 16))
.withField(string("destination", 255)).withField(string("state", 32)).withField(string("fileId", 255))
.withField(string("mediaProfileId", 128)).withField(string("mediaProfileRevision", 64)).withField(integer("copies"))
.withField(string("mediaProfileId", 128)).withField(string("mediaProfileRevision", 64)).withField(integer("copies")).withField(integer("targetDpi"))
.withField(string("versionId", 255)).withField(string("sha256", 64)).withField(new QFieldMetaData("length", QFieldType.LONG))
.withField(string("printJobId", 255)).withField(string("errorCode", 64)).withField(string("resolvedFileName", 184))
.withUniqueKey(new UniqueKey("actorId", "requestKey"))
@@ -182,6 +182,7 @@ public final class GenerationTables
table.withSection(new QFieldSection("advanced", new QIcon("settings"), Tier.T3, List.of("id", "createDate", "scriptArtifact", "assetIds")).withLabel("Advanced references")
.withCollapsible(CollapsibleMetaData.INITIALLY_CLOSED)
.withHelpContent(help("These are exact stored identities for support and provenance. Change scripts and included assets through the named actions; do not edit integrity references.")));
GenerationPreviewWidget.section(table);
}
/*******************************************************************************
@@ -0,0 +1,46 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
/*******************************************************************************
** The authoring action that converts a version 1 scene to version 2.
** The producer already calls this registration point; it registers nothing yet.
*******************************************************************************/
final class GenerationUpgradeProcesses
{
/*******************************************************************************
** Metadata namespace.
*******************************************************************************/
private GenerationUpgradeProcesses()
{
}
/*******************************************************************************
** Called once by the producer after the generation and authoring processes.
*******************************************************************************/
static void register(QInstance instance, DocumentGenerationQBitConfig config) throws QException
{
}
}
@@ -0,0 +1,4 @@
-- Copyright (c) 2026 Kingsrook, LLC. SPDX-License-Identifier: Apache-2.0
-- Apply once before adopting render-target-aware Generation metadata.
-- Existing requests keep a null target, which is read as the stock's own resolution: their identity digests and retries are unchanged.
ALTER TABLE document_generation_request ADD COLUMN target_dpi INTEGER NULL;
@@ -0,0 +1,4 @@
-- Copyright (c) 2026 Kingsrook, LLC. SPDX-License-Identifier: Apache-2.0
-- Apply once before adopting render-target-aware Generation metadata.
-- Existing requests keep a null target, which is read as the stock's own resolution: their identity digests and retries are unchanged.
ALTER TABLE document_generation_request ADD COLUMN target_dpi INT NULL;
@@ -0,0 +1,5 @@
-- Copyright (c) 2026 Kingsrook, LLC. SPDX-License-Identifier: Apache-2.0
-- Apply once before adopting render-target-aware Generation metadata.
-- Existing requests keep a null target, which is read as the stock's own resolution: their identity digests and retries are unchanged.
-- PostgreSQL17: re-runnable via IF NOT EXISTS, no rewrite of existing rows.
ALTER TABLE document_generation_request ADD COLUMN IF NOT EXISTS target_dpi INTEGER NULL;
@@ -453,6 +453,239 @@ class GenerationExpectedIntentTest
assertThat(submissions).hasValue(1);
}
/***************************************************************************
** Publish a label on the fixture's template and install a renderer that
** declares it renders at the request's target and records each target.
***************************************************************************/
private List<Integer> labelRenderer() throws Exception
{
List<Integer> targets = new java.util.ArrayList<>();
fixture.config.withRenderer(new GenerationPorts.IsolatedRenderer()
{
/***************************************************************************
** The fixture renders at the target, as the renderer bridge declares.
***************************************************************************/
@Override
public boolean supportsRenderTarget()
{
return (true);
}
/***************************************************************************
** Accept every revision.
***************************************************************************/
@Override
public void validate(String actor, GenerationPorts.Revision revision)
{
}
/***************************************************************************
** Record the target and return bytes that differ by it.
***************************************************************************/
@Override
public GenerationPorts.Content render(GenerationPorts.RenderRequest request)
{
targets.add(request.targetDpi());
return (new GenerationPorts.Content(("label at " + request.targetDpi()).getBytes(java.nio.charset.StandardCharsets.UTF_8)));
}
});
definitions.saveDraft(fixture.template, fixture.stock, new DocumentDefinitionService.Draft("page", "{\"schema\":\"qqq-zpl-scene/2\"}", null, List.of()));
definitions.publish(fixture.template);
return (targets);
}
/***************************************************************************
** A label intent for the first order, with or without a render target.
***************************************************************************/
private DocumentGenerationService.Request label(String key, Integer targetDpi)
{
return (new DocumentGenerationService.Request(fixture.template, new GenerationPorts.Source("orders", "1"), GenerationPorts.Format.ZPL, key, null, null, null, 1, targetDpi));
}
/***************************************************************************
** The intent digest as it was framed before the render target existed, with
** the target's own frame added when one is given. Written out here so the
** test does not borrow the service's arithmetic.
***************************************************************************/
private String digest(DocumentGenerationService.Result result, String key, Integer targetDpi) throws Exception
{
List<String> identity = new java.util.ArrayList<>(List.of("document-generation-intent/v1", "alice", key, "GENERATE", "6:orders1:1", String.valueOf(result.accepted().templateId()),
String.valueOf(result.accepted().revisionId()), result.accepted().stock().toString(), "ZPL", ""));
if(targetDpi != null)
{
identity.addAll(List.of("target-dpi/v1", String.valueOf(targetDpi)));
}
StringBuilder framed = new StringBuilder();
identity.forEach(value -> framed.append(value.length()).append(':').append(value));
return (java.util.HexFormat.of().formatHex(java.security.MessageDigest.getInstance("SHA-256").digest(framed.toString().getBytes(java.nio.charset.StandardCharsets.UTF_8))));
}
/***************************************************************************
** A render target travels from the request to the row and to the renderer,
** and is part of the intent: the same key with another target, or with
** none, is another intent and is refused. A request without a target has
** exactly the digest it had before the target existed.
***************************************************************************/
@Test
void aRenderTargetIsCarriedPersistedAndPartOfTheIntent() throws Exception
{
List<Integer> targets = labelRenderer();
var none = service.generate(label("label:target-none", null));
var three = service.generate(label("label:target-300", 300));
var six = service.generate(label("label:target-600", 600));
assertThat(targets).containsExactly(null, 300, 600);
assertThat(service.generate(label("label:target-300", 300))).isEqualTo(three);
assertThat(service.generate(label("label:target-none", null))).isEqualTo(none);
assertThat(targets).hasSize(3);
for(var other : List.of(label("label:target-300", null), label("label:target-300", 203), label("label:target-300", 600), label("label:target-none", 203), label("label:target-none", 300)))
{
assertThatThrownBy(() -> service.generate(other)).hasMessageContaining("different generation intent");
}
assertThat(targets).hasSize(3);
assertThat(none.intentSha256()).isEqualTo(digest(none, "label:target-none", null));
assertThat(three.intentSha256()).isEqualTo(digest(three, "label:target-300", 300)).isNotEqualTo(digest(three, "label:target-300", null)).isNotEqualTo(digest(three, "label:target-300", 600));
assertThat(six.intentSha256()).isEqualTo(digest(six, "label:target-600", 600));
try(var connection = fixture.connection(); var statement = connection.createStatement();
var rows = statement.executeQuery("SELECT request_key, target_dpi FROM document_generation_request ORDER BY id"))
{
for(Integer expected : new Integer[] {null, 300, 600})
{
assertThat(rows.next()).isTrue();
int stored = rows.getInt(2);
assertThat(rows.wasNull() ? null : Integer.valueOf(stored)).isEqualTo(expected);
}
assertThat(rows.next()).isFalse();
}
///////////////////////////////////////////////////////////////////////////////////////////
// a stored target that no printer has is corrupt: it refuses, and renders at no dpi //
///////////////////////////////////////////////////////////////////////////////////////////
fixture.sql("UPDATE document_generation_request SET target_dpi = 250 WHERE request_key = 'label:target-300'");
assertThatThrownBy(() -> service.generate(label("label:target-300", 300))).hasMessageContaining("Accepted render target is unavailable");
assertThat(targets).hasSize(3);
}
/***************************************************************************
** A target that cannot be honoured is refused before any row, render or
** event: a value that is not a printer resolution, a target for a PDF, and
** a renderer that does not declare it renders at a target (it would ignore
** the value and print at another resolution). Without a target that same
** renderer works as it always did.
***************************************************************************/
@Test
void aRenderTargetThatCannotBeHonouredIsRefusedBeforeAnyEffect() throws Exception
{
for(int invalid : new int[] {0, 72, 200, 204, 1200, -300})
{
assertThatThrownBy(() -> label("label:invalid-target", invalid)).isInstanceOf(IllegalArgumentException.class).hasMessageContaining("203, 300 or 600");
}
var page = request("label:pdf-target");
var pdf = new DocumentGenerationService.Request(page.templateId(), page.source(), page.format(), page.requestKey(), null, null, null, 1, 300);
assertThatThrownBy(() -> service.generate(pdf)).hasMessageContaining("A render target applies to ZPL output only");
assertThatThrownBy(() -> service.generate(label("label:unsupported-target", 300))).hasMessageContaining("RENDER_TARGET_UNSUPPORTED");
assertThatThrownBy(() -> service.generate(label("label:unsupported-target", 203))).hasMessageContaining("RENDER_TARGET_UNSUPPORTED");
var withDestination = new DocumentGenerationService.Request(page.templateId(), page.source(), GenerationPorts.Format.ZPL, page.requestKey(), page.destination(), page.expected(), null, 1, 300);
assertThatThrownBy(() -> service.lookupAcceptedPrint(withDestination)).hasMessageContaining("RENDER_TARGET_UNSUPPORTED");
assertThatThrownBy(() -> service.preview(label("label:preview-target", 300), "0".repeat(64))).hasMessageContaining("Preview requires");
assertThat(count("document_generation_request")).isZero();
assertThat(count("document_generation_event")).isZero();
assertThat(submissions).hasValue(0);
assertThat(service.generate(page).state()).isEqualTo("QUEUED");
assertThat(count("document_generation_request")).isEqualTo(1);
}
/***************************************************************************
** A renderer that refuses the target by name (a version 1 scene asked for
** another resolution than its stock's) leaves a typed, replayable refusal
** and no output.
***************************************************************************/
@Test
void aRefusedRenderTargetIsTypedAndIsNotRenderedAgain() throws Exception
{
labelRenderer();
AtomicInteger attempts = new AtomicInteger();
fixture.config.withRenderer(new GenerationPorts.IsolatedRenderer()
{
/***************************************************************************
** The fixture reads the target and refuses it, as the bridge does.
***************************************************************************/
@Override
public boolean supportsRenderTarget()
{
return (true);
}
/***************************************************************************
** Accept every revision.
***************************************************************************/
@Override
public void validate(String actor, GenerationPorts.Revision revision)
{
}
/***************************************************************************
** Refuse a target other than the stock's resolution, by name.
***************************************************************************/
@Override
public GenerationPorts.Content render(GenerationPorts.RenderRequest request) throws QException
{
attempts.incrementAndGet();
throw new GenerationPorts.RenderException(GenerationPorts.FailureCode.TARGET_REQUIRES_SCENE_2);
}
});
for(int attempt = 0; attempt < 2; attempt++)
{
assertThatThrownBy(() -> service.generate(label("label:refused-target", 300))).isInstanceOf(GenerationPorts.RenderException.class).hasMessage("TARGET_REQUIRES_SCENE_2");
}
assertThat(attempts).hasValue(1);
try(var connection = fixture.connection(); var statement = connection.createStatement();
var rows = statement.executeQuery("SELECT state, error_code, target_dpi, version_id FROM document_generation_request"))
{
assertThat(rows.next()).isTrue();
assertThat(rows.getString(1)).isEqualTo("INCOMPLETE");
assertThat(rows.getString(2)).isEqualTo("TARGET_REQUIRES_SCENE_2");
assertThat(rows.getInt(3)).isEqualTo(300);
assertThat(rows.getString(4)).isNull();
}
}
/***************************************************************************
** The shipped additive migration leaves earlier rows without a target: they
** keep their receipt and digest, still match a retry without a target, and
** never match a retry that names one.
***************************************************************************/
@Test
void renderTargetMigrationKeepsEarlierRowsAndTheirDigests() throws Exception
{
labelRenderer();
var before = service.generate(label("label:legacy-target", null));
int events = count("document_generation_event");
fixture.sql("ALTER TABLE document_generation_request DROP COLUMN target_dpi");
for(String statement : java.nio.file.Files.readString(java.nio.file.Path.of("src/main/resources/db/migrations/20261112-render-target-dpi-h2.sql")).split(";"))
{
if(!statement.isBlank())
{
fixture.sql(statement);
}
}
try(var connection = fixture.connection(); var statement = connection.createStatement(); var rows = statement.executeQuery("SELECT target_dpi FROM document_generation_request"))
{
assertThat(rows.next()).isTrue();
rows.getInt(1);
assertThat(rows.wasNull()).isTrue();
}
assertThat(service.generate(label("label:legacy-target", null))).isEqualTo(before);
assertThat(before.intentSha256()).isEqualTo(digest(before, "label:legacy-target", null));
assertThatThrownBy(() -> service.generate(label("label:legacy-target", 203))).hasMessageContaining("different generation intent");
assertThat(count("document_generation_event")).isEqualTo(events);
assertThat(count("document_generation_request")).isEqualTo(1);
for(String dialect : List.of("mysql", "postgres"))
{
assertThat(java.nio.file.Files.readString(java.nio.file.Path.of("src/main/resources/db/migrations/20261112-render-target-dpi-" + dialect + ".sql")))
.contains("ALTER TABLE document_generation_request ADD COLUMN").contains("target_dpi IN").contains("NULL;");
}
}
/***************************************************************************
** A closed worker refusal is persisted and replayed without repeated render,
** while arbitrary exception messages remain the generic operational code.
@@ -0,0 +1,363 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.Diagnostic;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.Diagnostic.Severity;
import com.kingsrook.qbits.documentgeneration.GenerationPorts.FailureCode;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
/*******************************************************************************
** The preview, diagnostic and render target ports: what each value admits, what
** the defaults refuse, and that every existing constructor and adapter still
** compiles and means what it did.
*******************************************************************************/
class GenerationPortsContractTest
{
private static final GenerationPorts.Stock STOCK = new GenerationPorts.Stock(101600, 25400, 3000, 3000, 3000, 3000, 203);
private static final GenerationPorts.Revision REVISION = new GenerationPorts.Revision(1, 2, "orders", STOCK, null, "{}", null, List.of());
private static final GenerationPorts.Source SOURCE = new GenerationPorts.Source("orders", "1");
private static final byte[] PNG = {(byte) 0x89, 'P', 'N', 'G', 13, 10, 26, 10, 0};
private static final String SHA = "0".repeat(64);
/***************************************************************************
** An adapter written before the preview port: it implements what it always
** did, and this class compiling is the source compatibility proof.
***************************************************************************/
private static final class ExistingAdapter implements GenerationPorts.IsolatedRenderer
{
/************************************************************************
** Accept every revision.
************************************************************************/
@Override
public void validate(String actorId, GenerationPorts.Revision revision)
{
}
/************************************************************************
** Return fixed bytes.
************************************************************************/
@Override
public GenerationPorts.Content render(GenerationPorts.RenderRequest request)
{
return (new GenerationPorts.Content(new byte[] {1}));
}
}
/***************************************************************************
** The seven-argument request and the one-argument refusal are unchanged, and
** an existing adapter refuses the optional operations it never had.
***************************************************************************/
@Test
void existingConstructorsAndAdaptersMeanWhatTheyDid() throws Exception
{
var request = new GenerationPorts.RenderRequest("request-1", "actor-1", SOURCE, GenerationPorts.Format.ZPL, REVISION, Map.of("record", Map.of()), 1024);
assertNull(request.targetDpi());
assertEquals(request, new GenerationPorts.RenderRequest("request-1", "actor-1", SOURCE, GenerationPorts.Format.ZPL, REVISION, Map.of("record", Map.of()), 1024, null));
var refusal = new GenerationPorts.RenderException(FailureCode.BARCODE_FIT_TOO_SMALL);
assertEquals(FailureCode.BARCODE_FIT_TOO_SMALL, refusal.code());
assertEquals("BARCODE_FIT_TOO_SMALL", refusal.getMessage());
assertNull(refusal.diagnostic());
assertThrows(NullPointerException.class, () -> new GenerationPorts.RenderException(null));
var adapter = new ExistingAdapter();
assertArrayEquals(new byte[] {1}, adapter.render(request).bytes());
adapter.validate("actor-1", REVISION);
assertEquals("Renderer preview is unavailable.", assertThrows(QException.class,
() -> adapter.preview(new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, REVISION, Map.of(), null, 1024))).getMessage());
assertEquals("Renderer barcode reference is unavailable.", assertThrows(QException.class, adapter::barcodeReference).getMessage());
assertEquals(false, adapter.supportsRenderTarget());
}
/***************************************************************************
** A job holds its own copy of the context, which may hold a null value and
** cannot be changed through the job or through the map the caller kept. A
** job written to a log shows its format and render target and nothing of
** the record or the template source.
***************************************************************************/
@Test
void aJobHoldsItsOwnContextAndNeverPrintsIt()
{
Map<String, Object> context = new HashMap<>();
context.put("name", "PRIVATE_SENTINEL");
context.put("absent", null);
var secret = new GenerationPorts.Revision(1, 2, "orders", STOCK, "<p>SOURCE_SENTINEL</p>", "{\"text\":\"SOURCE_SENTINEL\"}", null, List.of());
var preview = new GenerationPorts.PreviewRequest("actor-PRIVATE", GenerationPorts.Format.ZPL, secret, context, 300, 1024);
var render = new GenerationPorts.RenderRequest("request-1", "actor-PRIVATE", SOURCE, GenerationPorts.Format.ZPL, secret, context, 1024, 600);
context.put("name", "changed");
context.put("added", "later");
for(Map<String, Object> held : List.of(preview.context(), render.context()))
{
assertEquals("PRIVATE_SENTINEL", held.get("name"));
assertEquals(2, held.size());
assertNull(held.get("absent"));
assertEquals(true, held.containsKey("absent"));
assertThrows(UnsupportedOperationException.class, () -> held.put("more", "x"));
assertThrows(UnsupportedOperationException.class, () -> held.remove("name"));
}
assertEquals("PreviewRequest[format=ZPL, targetDpi=300]", preview.toString());
assertEquals("RenderRequest[requestId=request-1, format=ZPL, targetDpi=600]", render.toString());
assertEquals("PreviewRequest[format=PDF, targetDpi=null]", new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.PDF, secret, null, null, 1).toString());
assertNull(new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.PDF, secret, null, null, 1).context());
assertNull(new GenerationPorts.RenderRequest("request-1", "actor-1", SOURCE, GenerationPorts.Format.PDF, secret, null, 1).context());
assertEquals(preview, new GenerationPorts.PreviewRequest("actor-PRIVATE", GenerationPorts.Format.ZPL, secret, preview.context(), 300, 1024));
}
/***************************************************************************
** Stored error codes are read back by name, so the released names keep their
** order and the version 2 refusals follow them.
***************************************************************************/
@Test
void failureCodesKeepTheReleasedNamesThenAddTheSceneTwoRefusals()
{
List<String> names = Arrays.stream(FailureCode.values()).map(Enum::name).toList();
assertEquals(List.of("BARCODE_FIT_TOO_SMALL", "BARCODE_FIT_UNSUPPORTED", "BARCODE_FIT_BOX_OUTSIDE_STOCK", "BARCODE_FIT_GEOMETRY_MISMATCH", "INVALID_BARCODE_FIT_PROFILE",
"INVALID_BARCODE_FIT_REQUEST", "BARCODE_SYMBOLOGY_NOT_ALLOWED", "SYMBOLOGY_ALLOWLIST_REQUIRED", "SCANNER_BARCODE_PROFILE_UNSUPPORTED", "SCANNER_BARCODE_PAYLOAD_UNSUPPORTED",
"SCANNER_BARCODE_CHECKSUM_REQUIRED", "SCANNER_BARCODE_CHECKSUM_MISMATCH", "UNSUPPORTED_BARCODE_OPTION"), names.subList(0, 13));
assertEquals(List.of("SCENE_INVALID", "STOCK_MISMATCH", "TARGET_REQUIRES_SCENE_2", "ELEMENT_OUTSIDE_PRINTABLE_AREA", "TEXT_DOES_NOT_FIT", "VALUE_MISSING", "VALUE_TOO_LONG",
"FONT_UNKNOWN", "FONT_MISSING_GLYPH", "RESERVED_FONT_NAME", "BARCODE_DOES_NOT_FIT", "GS1_INVALID", "ASSET_UNKNOWN", "PREVIEW_TOO_LARGE", "RENDERER_TOO_OLD"), names.subList(13, names.size()));
}
/***************************************************************************
** A render target is absent or a resolution the renderer supports, for a
** render and for a preview alike.
***************************************************************************/
@ParameterizedTest
@ValueSource(ints = {0, 72, 200, 204, 301, 1200, -203})
void anUnsupportedRenderTargetIsRefused(int dpi)
{
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.RenderRequest("request-1", "actor-1", SOURCE, GenerationPorts.Format.ZPL, REVISION, Map.of(), 1024, dpi));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, REVISION, Map.of(), dpi, 1024));
}
/***************************************************************************
** Each supported resolution is carried unchanged.
***************************************************************************/
@ParameterizedTest
@ValueSource(ints = {203, 300, 600})
void aSupportedRenderTargetIsCarried(int dpi)
{
assertEquals(dpi, new GenerationPorts.RenderRequest("request-1", "actor-1", SOURCE, GenerationPorts.Format.ZPL, REVISION, Map.of(), 1024, dpi).targetDpi());
assertEquals(dpi, new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, REVISION, Map.of(), dpi, 1024).targetDpi());
}
/***************************************************************************
** A preview job names its format, its content and an output bound.
***************************************************************************/
@Test
void aPreviewRequestNeedsAFormatARevisionAndALimit()
{
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewRequest("actor-1", null, REVISION, Map.of(), null, 1024));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, null, Map.of(), null, 1024));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, REVISION, Map.of(), null, null));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.ZPL, REVISION, Map.of(), null, 0));
assertEquals(REVISION, new GenerationPorts.PreviewRequest("actor-1", GenerationPorts.Format.PDF, REVISION, Map.of(), null, 1).revision());
}
/***************************************************************************
** A page is a PNG with a size, and neither the caller nor a consumer can
** change its bytes afterwards.
***************************************************************************/
@Test
void aPreviewPageIsAnImmutablePngWithItsSize()
{
byte[] supplied = PNG.clone();
var page = new GenerationPorts.PreviewPage(supplied, 812, 203);
supplied[8] = 9;
page.png()[8] = 9;
assertArrayEquals(PNG, page.png());
assertEquals(812, page.widthDots());
assertEquals(203, page.heightDots());
byte[] jpeg = PNG.clone();
jpeg[1] = 'J';
for(byte[] bytes : new byte[][] {null, new byte[0], Arrays.copyOf(PNG, 7), jpeg})
{
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewPage(bytes, 812, 203));
}
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewPage(PNG, null, 203));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewPage(PNG, 0, 203));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewPage(PNG, 812, null));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.PreviewPage(PNG, 812, 0));
}
/***************************************************************************
** A preview freezes its lists, states its output exactly, and cannot call a
** layout with an error printable.
***************************************************************************/
@Test
void aPreviewIsFrozenAndCannotContradictItsDiagnostics()
{
var page = new GenerationPorts.PreviewPage(PNG, 812, 203);
var error = new Diagnostic("TEXT_DOES_NOT_FIT", Severity.ERROR, "caption", null, null, null);
var warning = new Diagnostic("PRINTER_FONT_NOT_SHOWN", Severity.WARNING, null, null, null, null);
List<GenerationPorts.PreviewPage> pages = new ArrayList<>(List.of(page));
List<Diagnostic> diagnostics = new ArrayList<>(List.of(warning));
var preview = new GenerationPorts.Preview(pages, false, true, diagnostics, 1234L, SHA);
pages.clear();
diagnostics.clear();
assertEquals(List.of(page), preview.pages());
assertEquals(List.of(warning), preview.diagnostics());
assertThrows(UnsupportedOperationException.class, () -> preview.pages().clear());
assertThrows(UnsupportedOperationException.class, () -> preview.diagnostics().clear());
assertEquals(false, new GenerationPorts.Preview(List.of(), true, false, List.of(error), 0L, SHA).printable());
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.Preview(List.of(page), true, true, List.of(warning, error), 1234L, SHA));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.Preview(List.of(page), null, true, List.of(), 1234L, SHA));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.Preview(List.of(page), true, null, List.of(), 1234L, SHA));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.Preview(List.of(page), true, true, List.of(), null, SHA));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.Preview(List.of(page), true, true, List.of(), -1L, SHA));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.Preview(List.of(page), true, true, List.of(), 1234L, null));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.Preview(List.of(page), true, true, List.of(), 1234L, SHA.toUpperCase().replace('0', 'A')));
assertThrows(NullPointerException.class, () -> new GenerationPorts.Preview(null, true, true, List.of(), 1234L, SHA));
assertThrows(NullPointerException.class, () -> new GenerationPorts.Preview(List.of(page), true, true, null, 1234L, SHA));
}
/***************************************************************************
** The design's example diagnostic, and every code of the first release under
** its own severity only.
***************************************************************************/
@Test
void aDiagnosticAdmitsOnlyItsClosedVocabulary()
{
var example = new Diagnostic("TEXT_DOES_NOT_FIT", Severity.ERROR, "caption", List.of(24, 131, 764, 56),
Map.of("widthDots", 902, "sizeCentipoints", 700, "lines", 2), Map.of("widthDots", 764, "lines", 2));
assertEquals(List.of(24, 131, 764, 56), example.box());
assertEquals(902, example.measured().get("widthDots"));
assertEquals(2, example.limit().get("lines"));
for(FailureCode code : FailureCode.values())
{
assertEquals(code.name(), new Diagnostic(code.name(), Severity.ERROR, null, null, null, null).code());
assertThrows(IllegalArgumentException.class, () -> new Diagnostic(code.name(), Severity.WARNING, null, null, null, null));
assertThrows(IllegalArgumentException.class, () -> new Diagnostic(code.name(), Severity.INFO, null, null, null, null));
}
for(String code : List.of("TEXT_TRUNCATED", "TEXT_SMALL_FOR_DPI", "TEXT_LIGHT_FACE", "FIT_NOT_PROVEN", "BARCODE_MODULE_BELOW_RECOMMENDED", "QUIET_ZONE_INTRUDED", "ELEMENTS_OVERLAP",
"IMAGE_UPSCALED", "DEVICE_UNIT_USED", "PRINTER_FONT_NOT_SHOWN"))
{
assertEquals(Severity.WARNING, new Diagnostic(code, Severity.WARNING, null, null, null, null).severity());
assertThrows(IllegalArgumentException.class, () -> new Diagnostic(code, Severity.ERROR, null, null, null, null));
assertThrows(IllegalArgumentException.class, () -> new Diagnostic(code, Severity.INFO, null, null, null, null));
}
for(String code : List.of("TEXT_SHRUNK", "TEXT_WRAPPED", "BARCODE_MODULE", "IMAGE_SCALED"))
{
assertEquals(Severity.INFO, new Diagnostic(code, Severity.INFO, null, null, null, null).severity());
assertThrows(IllegalArgumentException.class, () -> new Diagnostic(code, Severity.ERROR, null, null, null, null));
assertThrows(IllegalArgumentException.class, () -> new Diagnostic(code, Severity.WARNING, null, null, null, null));
}
assertThrows(IllegalArgumentException.class, () -> new Diagnostic("RENDER_FAILED", Severity.ERROR, null, null, null, null));
assertThrows(IllegalArgumentException.class, () -> new Diagnostic("Customer Jane Example could not be printed", Severity.ERROR, null, null, null, null));
assertThrows(IllegalArgumentException.class, () -> new Diagnostic(null, Severity.ERROR, null, null, null, null));
assertThrows(IllegalArgumentException.class, () -> new Diagnostic("TEXT_DOES_NOT_FIT", null, null, null, null, null));
}
/***************************************************************************
** Nothing but an author-written id and numbers fits beside the code: a
** sentence, a record value or a message has no field that will hold it.
***************************************************************************/
@Test
void aDiagnosticCannotHoldFreeText()
{
assertEquals("order_id-2", new Diagnostic("VALUE_MISSING", Severity.ERROR, "order_id-2", null, null, null).element());
for(String element : List.of("", "9caption", "two words", "Jane Example, 1 Test Street", "a".repeat(33), "caption\n", "/record/name"))
{
assertThrows(IllegalArgumentException.class, () -> new Diagnostic("VALUE_MISSING", Severity.ERROR, element, null, null, null), element);
}
for(List<Integer> box : List.of(List.<Integer>of(), List.of(1, 2, 3), List.of(1, 2, 3, 4, 5), List.of(1, 2, -3, 4), List.of(1, 2, 3, -4), Arrays.asList(1, null, 3, 4)))
{
assertThrows(IllegalArgumentException.class, () -> new Diagnostic("ELEMENT_OUTSIDE_PRINTABLE_AREA", Severity.ERROR, "caption", box, null, null), String.valueOf(box));
}
assertEquals(List.of(-12, -4, 0, 0), new Diagnostic("ELEMENT_OUTSIDE_PRINTABLE_AREA", Severity.ERROR, "caption", List.of(-12, -4, 0, 0), null, null).box());
Map<String, Integer> nullValue = new HashMap<>();
nullValue.put("widthDots", null);
Map<String, Integer> nullName = new HashMap<>();
nullName.put(null, 1);
Map<String, Integer> tooMany = new HashMap<>();
for(int index = 0; index < 9; index++)
{
tooMany.put("value" + index, index);
}
for(Map<String, Integer> values : List.of(Map.of("Width", 1), Map.of("width dots", 1), Map.of("the value Jane Example is too long", 1), Map.of("w".repeat(33), 1), nullValue, nullName, tooMany))
{
assertThrows(IllegalArgumentException.class, () -> new Diagnostic("TEXT_DOES_NOT_FIT", Severity.ERROR, "caption", null, values, null));
assertThrows(IllegalArgumentException.class, () -> new Diagnostic("TEXT_DOES_NOT_FIT", Severity.ERROR, "caption", null, null, values));
}
List<Integer> box = new ArrayList<>(List.of(1, 2, 3, 4));
Map<String, Integer> measured = new HashMap<>(Map.of("widthDots", 902));
var diagnostic = new Diagnostic("TEXT_DOES_NOT_FIT", Severity.ERROR, "caption", box, measured, null);
box.set(0, 99);
measured.put("widthDots", 1);
assertEquals(List.of(1, 2, 3, 4), diagnostic.box());
assertEquals(Map.of("widthDots", 902), diagnostic.measured());
assertEquals(Map.of(), diagnostic.limit());
assertThrows(UnsupportedOperationException.class, () -> diagnostic.box().set(0, 99));
assertThrows(UnsupportedOperationException.class, () -> diagnostic.measured().put("widthDots", 1));
}
/***************************************************************************
** A finding about the scene source says where: a JSON pointer made only of
** names and array indexes. A value, a sentence or an escaped segment has no
** way into it, and a diagnostic made without one has none.
***************************************************************************/
@Test
void aDiagnosticPointerIsMadeOfNamesAndIndexes()
{
assertNull(new Diagnostic("SCENE_INVALID", Severity.ERROR, "caption", null, null, null).pointer());
for(String pointer : List.of("", "/schema", "/design/width", "/elements/0", "/elements/12/fit/shrinkTo", "/elements/3/children/0/children/1/children/2/children/9999/thickness",
"/overrides/1/set/order_id-2/threshold", "/a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p"))
{
assertEquals(pointer, new Diagnostic("SCENE_INVALID", Severity.ERROR, null, null, null, null, pointer).pointer());
}
for(String pointer : List.of("elements", "/", "/elements/", "//elements", "/elements/01", "/elements/-1", "/elements/12345", "/Jane Example", "/record/name value", "/elements/0/~1", "/elements/0/fit\n",
"/9caption", "/" + "a".repeat(33), "/a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q", "/(01)00012345678905"))
{
assertThrows(IllegalArgumentException.class, () -> new Diagnostic("SCENE_INVALID", Severity.ERROR, null, null, null, null, pointer), pointer);
}
var detail = new Diagnostic("SCENE_INVALID", Severity.ERROR, "caption", null, Map.of("unknownProperties", 2), Map.of("unknownProperties", 0), "/elements/1");
assertEquals("/elements/1", new GenerationPorts.RenderException(FailureCode.SCENE_INVALID, detail).diagnostic().pointer());
}
/***************************************************************************
** A refusal carries only the error diagnostic with its own code, and its
** public message is still the code alone.
***************************************************************************/
@Test
void aRefusalCarriesOnlyItsOwnErrorDiagnostic()
{
var detail = new Diagnostic("TEXT_DOES_NOT_FIT", Severity.ERROR, "caption", List.of(24, 131, 764, 56), Map.of("widthDots", 902), Map.of("widthDots", 764));
var refusal = new GenerationPorts.RenderException(FailureCode.TEXT_DOES_NOT_FIT, detail);
assertEquals(FailureCode.TEXT_DOES_NOT_FIT, refusal.code());
assertEquals(detail, refusal.diagnostic());
assertEquals("TEXT_DOES_NOT_FIT", refusal.getMessage());
assertNull(new GenerationPorts.RenderException(FailureCode.TEXT_DOES_NOT_FIT, null).diagnostic());
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.RenderException(FailureCode.VALUE_MISSING, detail));
assertThrows(IllegalArgumentException.class, () -> new GenerationPorts.RenderException(FailureCode.TEXT_DOES_NOT_FIT, new Diagnostic("TEXT_SHRUNK", Severity.INFO, "caption", null, null, null)));
assertThrows(NullPointerException.class, () -> new GenerationPorts.RenderException(null, detail));
}
}
@@ -1283,6 +1283,41 @@ class GenerationProcessesTest
assertThatThrownBy(() -> execute(input)).hasMessageContaining("PDF or ZPL");
}
/***************************************************************************
** The generate action offers a render target, carries it to the service and
** refuses one that is not a printer resolution; queueing has no such option.
** The request status names the stored target.
***************************************************************************/
@Test
void generateActionCarriesTheRenderTargetOrRefusesIt() throws Exception
{
var options = (com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendStepMetaData) instance.getProcess(GenerationProcesses.name("orders", "generate")).getStep("options");
assertThat(options.getFormFields().stream().map(QFieldMetaData::getName)).contains("targetDpi");
var queued = (com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendStepMetaData) instance.getProcess(GenerationProcesses.name("orders", "enqueue")).getStep("options");
assertThat(queued.getFormFields().stream().map(QFieldMetaData::getName)).doesNotContain("targetDpi");
for(int invalid : new int[] {150, 0, 601})
{
var input = prepared("orders", "generate", 1);
input.addValue("templateId", template);
input.addValue("targetDpi", invalid);
assertThatThrownBy(() -> execute(input)).hasMessageContaining("A render target is 203, 300 or 600 dpi.");
}
var page = prepared("orders", "generate", 1);
page.addValue("templateId", template);
page.addValue("targetDpi", 300);
assertThatThrownBy(() -> execute(page)).hasMessageContaining("A render target applies to ZPL output only");
///////////////////////////////////////////////////////////////////////////////////////////
// the fixture renderer does not declare that it renders at a target, so the service, //
// which was given the value, refuses it //
///////////////////////////////////////////////////////////////////////////////////////////
var label = prepared("orders", "generate", 1);
label.addValue("templateId", template);
label.addValue("format", "ZPL");
label.addValue("targetDpi", 300);
assertThatThrownBy(() -> execute(label)).hasMessageContaining("RENDER_TARGET_UNSUPPORTED");
assertThat(new ObjectMapper().readTree(execute(prepared(GenerationTables.REQUEST, "status", generate()))).has("targetDpi")).isTrue();
}
/***************************************************************************
** Reject substituted retained versions and unsafe download links before exposing delivery metadata.
***************************************************************************/
@@ -173,6 +173,41 @@ class GenerationQueueJdbcTest
queue = new GenerationQueue(config,clock,1,30);
}
/***************************************************************************
** The database this suite runs on, as the shipped migration scripts name it.
***************************************************************************/
protected String dialect()
{
return ("h2");
}
/***************************************************************************
** The shipped render target migration for this database adds one nullable
** column to the request table: a request made before it reads as having no
** target, and generation goes on afterwards.
***************************************************************************/
@Test
void renderTargetMigrationAddsOneNullableColumn() throws Exception
{
assertThat(queue.advance(enqueue("before-target")).state()).isEqualTo("GENERATED");
sql("ALTER TABLE document_generation_request DROP COLUMN target_dpi");
for(String statement : Files.readString(Path.of("src/main/resources/db/migrations/20261112-render-target-dpi-" + dialect() + ".sql")).split(";"))
{
if(!statement.isBlank())
{
sql(statement);
}
}
try(var connection = connection(); var statement = connection.createStatement(); var rows = statement.executeQuery("SELECT target_dpi FROM document_generation_request"))
{
assertThat(rows.next()).isTrue();
rows.getInt(1);
assertThat(rows.wasNull()).isTrue();
assertThat(rows.next()).isFalse();
}
assertThat(queue.advance(enqueue("after-target")).state()).isEqualTo("GENERATED");
}
/***************************************************************************
** Clear native context, pooled connections and memory records after each database scenario.
***************************************************************************/
@@ -0,0 +1,111 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.documentgeneration;
import java.util.List;
import java.util.TreeSet;
import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QFieldSection;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
/*******************************************************************************
** The registration points for the preview, asset and upgrade packages exist and
** are called, and add nothing: a host that registers the QBit gets exactly the
** tables, processes, choices, widgets and template sections it got before.
*******************************************************************************/
class GenerationRegistrationHooksTest
{
/***************************************************************************
** The complete default wiring, as the released foundation registers it.
***************************************************************************/
@Test
void theProducerRegistersExactlyWhatItDidBeforeTheHooks() throws Exception
{
QInstance instance = instance();
new DocumentGenerationQBitProducer().withQBitConfig(config()).produce(instance);
assertEquals(List.of("document_generation_asset", "document_generation_batch", "document_generation_binding", "document_generation_control", "document_generation_event",
"document_generation_item", "document_generation_queue", "document_generation_request", "document_generation_revision", "document_generation_stock",
"document_generation_template", "document_generation_type", "orders"),
List.copyOf(new TreeSet<>(instance.getTables().keySet())), "tables");
assertEquals(List.of("document_generation_binding_author_create", "document_generation_queue_document_advance", "document_generation_queue_document_cancel",
"document_generation_queue_document_reconcileItem", "document_generation_queue_document_recover", "document_generation_queue_document_status",
"document_generation_request_document_download", "document_generation_request_document_reconcile", "document_generation_request_document_reprint",
"document_generation_request_document_status", "document_generation_stock_author_create", "document_generation_stock_author_rename",
"document_generation_template_author_asset", "document_generation_template_author_catalog", "document_generation_template_author_context",
"document_generation_template_author_create", "document_generation_template_author_edit", "document_generation_template_author_naming",
"document_generation_template_author_packingSlip", "document_generation_template_author_preview", "document_generation_template_author_publish",
"document_generation_template_author_removeAsset", "document_generation_template_author_rename", "document_generation_template_author_replaceAsset",
"document_generation_type_author_create", "document_generation_type_author_rename", "orders_document_enqueue", "orders_document_generate"),
List.copyOf(new TreeSet<>(instance.getProcesses().keySet())), "processes");
assertEquals(List.of("document_generation_asset", "document_generation_context_publications", "document_generation_formats", "document_generation_preview_source",
"document_generation_preview_source_orders", "document_generation_retained_assets", "document_generation_revision",
"document_generation_source_tables", "document_generation_stock", "document_generation_template", "document_generation_type"),
List.copyOf(new TreeSet<>(instance.getPossibleValueSources().keySet())), "possible value sources");
assertEquals(List.of(),
List.copyOf(new TreeSet<>(instance.getWidgets().keySet())), "widgets");
assertEquals(List.of("overview", "layout", "context", "advanced"),
instance.getTable(GenerationTables.TEMPLATE).getSections().stream().map(QFieldSection::getName).toList(), "template sections");
}
/***************************************************************************
** Each registration point, called directly, changes nothing.
***************************************************************************/
@Test
void eachRegistrationPointAddsNothingYet() throws Exception
{
DocumentGenerationQBitConfig config = config();
assertEquals(List.of(), GenerationAssetTables.tables(config));
QInstance instance = instance();
GenerationPreviewProcesses.register(instance, config);
GenerationAssetProcesses.register(instance, config);
GenerationUpgradeProcesses.register(instance, config);
assertEquals(List.of(), List.copyOf(instance.getProcesses().keySet()));
assertEquals(List.of("orders"), List.copyOf(instance.getTables().keySet()));
QTableMetaData table = new QTableMetaData().withName("template");
GenerationPreviewWidget.section(table);
assertEquals(new QTableMetaData().withName("template").getSections(), table.getSections());
}
/***************************************************************************
** The smallest host: one backend and one source table.
***************************************************************************/
private static QInstance instance()
{
QInstance instance = new QInstance();
instance.addBackend(new QBackendMetaData().withName("memory").withBackendType(MemoryBackendModule.class));
instance.addTable(new QTableMetaData().withName("orders").withBackendName("memory").withPrimaryKeyField("id").withField(new QFieldMetaData("id", QFieldType.INTEGER)));
return (instance);
}
/***************************************************************************
** Default limits, with one source table so the source choices are registered.
***************************************************************************/
private static DocumentGenerationQBitConfig config()
{
return (new DocumentGenerationQBitConfig().withBackendName("memory").withSourceTables(List.of("orders")));
}
}
@@ -97,6 +97,15 @@ class MySqlGenerationQueueTest extends GenerationQueueJdbcTest
mysql.sql(source);
}
/***********************************************************************
** The shipped migration scripts for this engine.
***********************************************************************/
@Override
protected String dialect()
{
return ("mysql");
}
/***********************************************************************
** Exercise the shipped native schema, including binary idempotency keys.
***********************************************************************/
@@ -52,13 +52,24 @@ final class PostgresGenerationDatabase implements AutoCloseable
** Starts only this suite's loopback container with durable settings.
***************************************************************************/
PostgresGenerationDatabase()
{
this(true);
}
/***************************************************************************
** Pinned durability settings come from the server command line, which no
** ALTER SYSTEM can override. An unpinned engine starts with the same values
** (the PostgreSQL defaults) and lets a test weaken them through system().
***************************************************************************/
PostgresGenerationDatabase(boolean pinned)
{
// pgjdbc announces the JVM zone as the session TimeZone; qualification requires UTC.
previousZone = java.util.TimeZone.getDefault();
java.util.TimeZone.setDefault(java.util.TimeZone.getTimeZone("UTC"));
container = new GenericContainer<>(IMAGE)
.withEnv("POSTGRES_PASSWORD", rootPassword).withEnv("POSTGRES_DB", "bootstrap")
.withCommand("postgres", "-c", "fsync=on", "-c", "synchronous_commit=on", "-c", "full_page_writes=on", "-c", "max_connections=60")
.withCommand(pinned ? new String[] { "postgres", "-c", "fsync=on", "-c", "synchronous_commit=on", "-c", "full_page_writes=on", "-c", "max_connections=60" }
: new String[] { "postgres", "-c", "max_connections=60" })
.withExposedPorts(5432)
.withCreateContainerCmdModifier(command -> command.getHostConfig().withMemory(768L * 1024 * 1024).withNanoCPUs(2_000_000_000L)
.withPortBindings(FixtureEndpoint.publishedBinding(5432)))
@@ -143,6 +154,38 @@ final class PostgresGenerationDatabase implements AutoCloseable
}
}
/***************************************************************************
** Change one reloadable server setting of an unpinned engine (ALTER SYSTEM and
** a configuration reload), then wait until a new session actually reports it.
** Fixed fixture names and values only, never application input.
***************************************************************************/
void system(String name, String value) throws Exception
{
ConnectionManager.closeConnectionProviders();
try(var connection = DriverManager.getConnection(server + "bootstrap" + OPTIONS, "postgres", rootPassword); var statement = connection.createStatement())
{
statement.execute("ALTER SYSTEM SET " + name + " = '" + value + "'");
statement.execute("SELECT pg_reload_conf()");
}
long deadline = System.nanoTime() + java.time.Duration.ofSeconds(30).toNanos();
while(true)
{
try(var connection = DriverManager.getConnection(server + "bootstrap" + OPTIONS, "postgres", rootPassword); var statement = connection.createStatement();
var row = statement.executeQuery("SELECT current_setting('" + name + "')"))
{
if(row.next() && value.equals(row.getString(1)))
{
return;
}
}
if(System.nanoTime() >= deadline)
{
throw new IllegalStateException("PostgreSQL fixture did not apply " + name);
}
Thread.sleep(100);
}
}
/***************************************************************************
** Cold server restart retains only this container's data layer (committed
** data must survive; Docker may publish a different loopback port).
@@ -41,6 +41,9 @@ class PostgresGenerationQueueTest extends GenerationQueueJdbcTest
{
private static PostgresGenerationDatabase postgres;
// The engine the fixture calls of the running test address: the shared pinned one unless that test started its own.
private PostgresGenerationDatabase current;
/***********************************************************************
** One exact disposable engine per suite; all test cases use new databases.
***********************************************************************/
@@ -68,7 +71,7 @@ class PostgresGenerationQueueTest extends GenerationQueueJdbcTest
@Override
protected RDBMSBackendMetaData database(String name, String defaultUrl) throws Exception
{
return (postgres.database(name));
return (engine().database(name));
}
/***********************************************************************
@@ -77,7 +80,7 @@ class PostgresGenerationQueueTest extends GenerationQueueJdbcTest
@Override
protected Connection connection() throws Exception
{
return (postgres.connection());
return (engine().connection());
}
/***********************************************************************
@@ -86,7 +89,24 @@ class PostgresGenerationQueueTest extends GenerationQueueJdbcTest
@Override
protected void sql(String source) throws Exception
{
postgres.sql(source);
engine().sql(source);
}
/***********************************************************************
** The shared pinned engine, or the unpinned one a single test started.
***********************************************************************/
private PostgresGenerationDatabase engine()
{
return (current == null ? postgres : current);
}
/***********************************************************************
** The shipped migration scripts for this engine.
***********************************************************************/
@Override
protected String dialect()
{
return ("postgres");
}
/***********************************************************************
@@ -178,6 +198,86 @@ class PostgresGenerationQueueTest extends GenerationQueueJdbcTest
assertThat(queue.status(enqueue("restored"), -1, 10).items()).hasSize(2);
}
/***************************************************************************
** Amazon Aurora PostgreSQL always runs with full_page_writes off (its storage
** layer does not write torn pages), so that one setting is accepted there and
** nowhere else. The engine is a real PostgreSQL 17 whose settings are really
** changed. Only Aurora itself is simulated: a function named aurora_version()
** is created in the test database, so the same to_regprocedure detection that
** is true on Aurora resolves here.
***************************************************************************/
@Test
void fullPageWritesOffIsAcceptedOnlyOnAuroraAndNothingElseIsRelaxed() throws Exception
{
current = new PostgresGenerationDatabase(false);
try
{
// Rebuild the instance, schema and definitions on the unpinned engine (durable defaults, so this qualifies).
cleanup();
setup();
assertThat(queue.advance(enqueue("stock-durable")).state()).isEqualTo("GENERATED");
// Stock PostgreSQL with full_page_writes off is refused, and the refusal states the rule.
current.system("full_page_writes", "off");
assertThatThrownBy(() -> enqueue("stock-torn-pages")).isInstanceOf(QException.class)
.hasMessageContaining("full-page writes (except on Amazon Aurora PostgreSQL)").hasMessageContaining("not satisfied: synchronous commit");
// The same server, now resolving aurora_version(), is accepted and work really commits.
sql("CREATE FUNCTION aurora_version() RETURNS text LANGUAGE sql IMMUTABLE AS $$ SELECT '17.9'::text $$");
ConnectionManager.closeConnectionProviders();
assertThat(queue.advance(enqueue("aurora")).state()).isEqualTo("GENERATED");
// Aurora relaxes nothing else: fsync off is refused.
current.system("fsync", "off");
assertThatThrownBy(() -> enqueue("aurora-no-fsync")).isInstanceOf(QException.class).hasMessageContaining("not satisfied: synchronous commit");
current.system("fsync", "on");
// Aurora relaxes nothing else: asynchronous commit is refused.
sql("ALTER ROLE generation_app SET synchronous_commit='off'");
ConnectionManager.closeConnectionProviders();
assertThatThrownBy(() -> enqueue("aurora-async-commit")).isInstanceOf(QException.class).hasMessageContaining("not satisfied: synchronous commit");
sql("ALTER ROLE generation_app SET synchronous_commit='on'");
ConnectionManager.closeConnectionProviders();
assertThat(enqueue("aurora-restored")).isNotNull();
// Without the function the server is stock PostgreSQL again and is refused again.
sql("DROP FUNCTION aurora_version()");
ConnectionManager.closeConnectionProviders();
assertThatThrownBy(() -> enqueue("stock-again")).isInstanceOf(QException.class).hasMessageContaining("not satisfied: synchronous commit");
}
finally
{
ConnectionManager.closeConnectionProviders();
current.close();
current = null;
}
}
/***************************************************************************
** The durability decision itself, for the combinations the live case does
** not reach: no server and nothing simulated, only the values of one row.
***************************************************************************/
@Test
void durabilityRuleAcceptsOnlyTheAuroraFullPageWritesException()
{
assertThat(GenerationPostgres.durable("on", "on", "on", false)).isTrue();
assertThat(GenerationPostgres.durable("remote_apply", "on", "on", false)).isTrue();
assertThat(GenerationPostgres.durable("on", "on", "on", true)).isTrue();
assertThat(GenerationPostgres.durable("on", "on", "off", true)).isTrue();
assertThat(GenerationPostgres.durable("remote_apply", "on", "off", true)).isTrue();
assertThat(GenerationPostgres.durable("on", "on", "off", false)).isFalse();
assertThat(GenerationPostgres.durable("on", "off", "on", false)).isFalse();
assertThat(GenerationPostgres.durable("on", "off", "off", true)).isFalse();
for(String weak : List.of("off", "local", "remote_write"))
{
assertThat(GenerationPostgres.durable(weak, "on", "on", false)).isFalse();
assertThat(GenerationPostgres.durable(weak, "on", "off", true)).isFalse();
}
assertThat(GenerationPostgres.durable(null, "on", "on", true)).isFalse();
assertThat(GenerationPostgres.durable("on", null, "on", true)).isFalse();
assertThat(GenerationPostgres.durable("on", "on", null, true)).isFalse();
}
/***************************************************************************
** The native identity must be the postgres module on a real PostgreSQL17 server, not a vendor label.
***************************************************************************/
+2 -2
View File
@@ -5,7 +5,7 @@
no -Drevision, so a module that declared its own revision would stay at the SNAPSHOT. The root takes qbit-build-parent 2.1.1 (the version foundation already used);
modules that had no parent now inherit its defaults and this Apache-2.0 license (the vendored OpenHTML module keeps its explicit LGPL-2.1+; bridges/scripting keeps
its previously inherited AGPL-3.0 explicitly). Each module still keeps its own dependency boundary and builds on its own through its relative parent. -->
<parent><groupId>com.kingsrook</groupId><artifactId>qbit-build-parent</artifactId><version>2.1.1</version><relativePath/></parent>
<parent><groupId>com.kingsrook</groupId><artifactId>qbit-build-parent</artifactId><version>2.2.1</version><relativePath/></parent>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-document-generation-reactor</artifactId>
<version>${revision}</version>
@@ -14,7 +14,7 @@
<url>https://github.com/Kingsrook/qbit-bom</url>
<scm><connection>scm:git:https://github.com/Kingsrook/qbit-bom.git</connection><developerConnection>scm:git:ssh://git@github.com/Kingsrook/qbit-bom.git</developerConnection><url>https://github.com/Kingsrook/qbit-bom</url><tag>HEAD</tag></scm>
<licenses><license><name>Apache License, Version 2.0</name><url>https://www.apache.org/licenses/LICENSE-2.0</url><distribution>repo</distribution></license></licenses>
<properties><revision>0.1.0-SNAPSHOT</revision><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><enforcer.skip>true</enforcer.skip></properties>
<properties><revision>1.4.0-SNAPSHOT</revision><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><enforcer.skip>true</enforcer.skip><qqq.version>4.1.0-RC.26</qqq.version></properties>
<!-- Every module of the repository, so one release builds and publishes every GAV. Maven orders the reactor by dependency (the patched OpenHTML
module before the renderer; foundation before the bridges). Build a subset with -pl <module> -am. -->
<modules>
+16 -15
View File
@@ -10,18 +10,18 @@ COPY Dockerfile ./
RUN apt-get update && apt-get install -y --no-install-recommends gcc g++ libc6-dev make cmake patch \
&& sh ./build-zint.sh
# The renderer's version comes from its parent, the repository reactor POM (../pom.xml). Build from this directory with that file as a named BuildKit context:
# docker build --build-context reactor=<repository root> ... (the reactor POM is copied to /pom.xml, where ../pom.xml resolves for /renderer/pom.xml)
FROM ${BUILD_IMAGE} AS build
COPY --from=reactor pom.xml /pom.xml
WORKDIR /renderer
COPY vendor/openhtml-1.1.105-qqq-p1 ./vendor/openhtml-1.1.105-qqq-p1
RUN sh ./vendor/openhtml-1.1.105-qqq-p1/build-openhtml.sh /renderer/openhtml-build /renderer/.m2
COPY pom.xml ./
COPY LICENSE NOTICE ./
COPY checkstyle ./checkstyle
COPY src ./src
RUN mvn -B -Dmaven.repo.local=/renderer/.m2 verify
# The engine and its libraries are the RELEASED artifacts, resolved at the exact RENDERER_VERSION from the QRun-IO
# Gitea Maven registry and Maven Central (Maven checks each registry checksum). No SNAPSHOT, no local build and no
# local-cache coordinate: the version is a required build argument with no default.
# docker build --build-arg BUILD_IMAGE=... --build-arg JAVA_IMAGE=... --build-arg RENDERER_VERSION=1.0.0 renderer/
FROM ${BUILD_IMAGE} AS release
ARG RENDERER_VERSION
WORKDIR /release
COPY release-image/pom.xml ./pom.xml
RUN test -n "${RENDERER_VERSION}" && case "${RENDERER_VERSION}" in *SNAPSHOT*|*forge*) echo "RENDERER_VERSION must be a released version" >&2; exit 1;; esac \
&& mvn -B -Drenderer.version="${RENDERER_VERSION}" -Dmaven.repo.local=/release/.m2 package \
&& mv "target/lib/qbit-document-renderer-${RENDERER_VERSION}.jar" target/renderer.jar \
&& test -f target/renderer.jar && ls target/lib
FROM ${JAVA_IMAGE}
# Reviewed runtime family: Temurin 21.0.13+9 on Ubuntu noble. The approved digest
@@ -37,8 +37,9 @@ RUN . /etc/os-release \
WORKDIR /renderer
COPY --from=zint-build /zint-build/build/frontend/zint /usr/local/bin/zint
COPY --from=zint-build /zint-build/corresponding-source /usr/share/doc/qqq-zint
COPY --from=build /renderer/openhtml-build/corresponding-source /usr/share/doc/qqq-openhtml
COPY --from=build /renderer/target/qbit-document-renderer-0.1.0-SNAPSHOT.jar ./renderer.jar
COPY --from=build /renderer/target/lib ./lib
# LGPL corresponding source for the vendored OpenHTML module that the released openhtmltopdf-pdfbox jar was built from.
COPY vendor/openhtml-1.1.105-qqq-p1 /usr/share/doc/qqq-openhtml
COPY --from=release /release/target/renderer.jar ./renderer.jar
COPY --from=release /release/target/lib ./lib
USER 65532:65532
ENTRYPOINT ["java", "-Xmx256m", "-XX:ActiveProcessorCount=1", "-Djava.awt.headless=true", "-Dpdfbox.fontcache=/tmp", "-jar", "/renderer/renderer.jar"]
+120
View File
@@ -0,0 +1,120 @@
# Renderer container images: build from a released version and publish
Two images, built in this order. Both are built from **released** Maven artifacts (QRun-IO Gitea registry
`https://git.kof22.com/api/packages/QRun-IO/maven` and Maven Central); there is no SNAPSHOT, local-cache or reactor
input. The version is a required build argument with no default, and the Dockerfiles refuse a `SNAPSHOT` or `forge`
version.
| Image | Dockerfile (context) | Version argument | Contents |
|---|---|---|---|
| `ghcr.io/gg-engineering/qqq-document-renderer` | `renderer/Dockerfile` (`renderer/`) | `RENDERER_VERSION` (`qbit-document-renderer`) | engine, its libraries, patched Zint built from `renderer/vendor`, Temurin runtime |
| `ghcr.io/gg-engineering/qqq-remote-renderer` | `bridges/remote-renderer/Dockerfile` (`bridges/remote-renderer/`) | `TRANSPORT_VERSION` (`qqq-remote-renderer-transport`), `RENDERER_IMAGE` | the mTLS service, on top of the engine image |
The service image is the one Forge deploys. The adapter (`qbit-document-generation-remote-renderer`) is a client-side
library and is not in either image.
## Version choice
`1.0.0` is the released, non-RC version and the one `gg-forge` pins for the document-generation family. `1.1.0-RC.1`
contains the same `renderer/` and `bridges/remote-renderer/` sources as `1.0.0` (only POM/CI alignment differs), so it
adds nothing for the renderer and is a release candidate. Build the version the host library pins.
## Reviewed base images
`BUILD_IMAGE` and `JAVA_IMAGE` must be immutable digests. `JAVA_IMAGE` is the reviewed runtime in `DEPLOYMENT.md`.
`BUILD_IMAGE` only resolves artifacts; no layer of it reaches the final image.
```sh
BUILD_IMAGE=maven@sha256:99e61abcff91a9b1333463bd8451fb18495d6eba9250ac66a338b518f8278320 # maven:3.9-eclipse-temurin-21
JAVA_IMAGE=eclipse-temurin@sha256:db724162e4ff5f71fa0a2815026314d9e5e0e9a139f49be1d4717e6930e93341 # 21.0.13_9-jre-noble (amd64)
VERSION=1.0.0
```
## Build, smoke, push
Disable BuildKit provenance and SBOM attestations so each tag is a single OCI image manifest (the digest the chart pins).
```sh
docker build --provenance=false --sbom=false --build-arg BUILD_IMAGE=$BUILD_IMAGE --build-arg JAVA_IMAGE=$JAVA_IMAGE --build-arg RENDERER_VERSION=$VERSION -t qqq-document-renderer:$VERSION renderer
docker build --provenance=false --sbom=false --build-arg BUILD_IMAGE=$BUILD_IMAGE --build-arg RENDERER_IMAGE=qqq-document-renderer:$VERSION --build-arg TRANSPORT_VERSION=$VERSION -t qqq-remote-renderer:$VERSION bridges/remote-renderer
# Optional scan of the final image
docker save qqq-remote-renderer:$VERSION -o svc.tar
docker run --rm -v "$PWD/svc.tar:/svc.tar:ro" aquasec/trivy:latest image --input /svc.tar --severity HIGH,CRITICAL --scanners vuln
# Publish (docker must be logged in to ghcr.io with a token that has write:packages)
for n in qqq-document-renderer qqq-remote-renderer; do
docker tag $n:$VERSION ghcr.io/gg-engineering/$n:$VERSION
docker push ghcr.io/gg-engineering/$n:$VERSION # prints the manifest digest
done
```
New GHCR packages are private. Package access is per package and is managed in the GitHub UI (Package settings,
Manage access); the REST API cannot grant it. The credential behind `ghcr-pull-secret` must be able to read both packages.
## Pins for gg-forge-cd
`sh renderer/image-pins.sh ghcr.io/gg-engineering/qqq-remote-renderer@sha256:<manifest digest>` pulls the published
image and prints the `echoRenderer.*` image, classpath and file-hash pins from the image itself. `imageId` is
`docker image inspect --format '{{.Id}}'`; with the containerd image store this equals the manifest digest, otherwise
it is the config digest. Whatever value is chosen must be the same on Forge and the service.
Values for `1.0.0` as published (the java, zint and patchset hashes match the 2026-11-05 local qualification; the
engine JAR and the OpenHTML JAR differ because they are the released artifacts):
```yaml
echoRenderer:
image:
repository: ghcr.io/gg-engineering/qqq-remote-renderer
digest: sha256:4152a4253e543068bedfd438775ed5327807bdddf679bc5a8e6eab26855e09ea
imageId: sha256:4152a4253e543068bedfd438775ed5327807bdddf679bc5a8e6eab26855e09ea
classpath:
- /renderer/renderer.jar
- /renderer/lib/commons-logging-1.4.0.jar
- /renderer/lib/fontbox-3.0.8.jar
- /renderer/lib/freemarker-2.3.35.jar
- /renderer/lib/graphics2d-3.0.1.jar
- /renderer/lib/jackson-annotations-2.22.jar
- /renderer/lib/jackson-core-2.22.4.jar
- /renderer/lib/jackson-databind-2.22.4.jar
- /renderer/lib/jsoup-1.23.2.jar
- /renderer/lib/okapibarcode-0.5.7.jar
- /renderer/lib/openhtmltopdf-core-1.1.105.jar
- /renderer/lib/openhtmltopdf-pdfbox-1.0.0.jar
- /renderer/lib/pdfbox-3.0.8.jar
- /renderer/lib/pdfbox-io-3.0.8.jar
- /renderer/lib/slf4j-api-2.0.17.jar
- /renderer/lib/slf4j-nop-2.0.17.jar
- /renderer/lib/xmpbox-3.0.8.jar
fileHashes:
/opt/java/openjdk/bin/java: 7afc28801f744050aeba646b20e7314265279f76f9d0273b21a2b66411e1bf6d
/renderer/renderer.jar: 0061e1bce631e468b0d7d08735bb764ba2b6d85260c79c144beabad7ffbc19db
/usr/local/bin/zint: ea8dc40c917abd7e8ccc824ef0adafed245a2425abbdfac6a30faeb8e4642233
/usr/share/doc/qqq-zint/patchset-id.txt: a287946580d5eeb8691ac1d98d6a7f50bf22dcc5dc0ef039d7033e76e15c52d2
/renderer/lib/commons-logging-1.4.0.jar: d175dbd751dd782a63bde28c7a039520e971f25e84b79c19b8435edc3603e0dc
/renderer/lib/fontbox-3.0.8.jar: a1915c24e3edbe0ecec93896dfbf6d41427810b663ade97bd4e8bae86ec3fdab
/renderer/lib/freemarker-2.3.35.jar: 0fac87dddd78f1223139e8ef88e819c7f483c0a3835cdf5982ad5e4576d1d896
/renderer/lib/graphics2d-3.0.1.jar: 4849aaa6f536d75dea1b835a71086702216787036f42716adfad438c6e7928c0
/renderer/lib/jackson-annotations-2.22.jar: 21ddb598807d3a51a876704eb979d9296e1c6a6f47ab1826ff88c6d6a127a2d0
/renderer/lib/jackson-core-2.22.4.jar: 2d30c375cddea9657a1e1ef97547a2694b663b355facb4de53a097782b312d1a
/renderer/lib/jackson-databind-2.22.4.jar: d4cbf8947087f305869826801913abdc50735a1fab2074a1993e7bc67ca974a3
/renderer/lib/jsoup-1.23.2.jar: e9d8c856856680427f096d156f02a414289985c930998fcb519ce5be39b42003
/renderer/lib/okapibarcode-0.5.7.jar: f33b7d17b7040aa1d9c23b1f3bb274e492b786c340b02d9557bcc027ac874355
/renderer/lib/openhtmltopdf-core-1.1.105.jar: d5951a8407c3be41108698066e6d67cf952e526be39d4e49b0b9fbcee761de7d
/renderer/lib/openhtmltopdf-pdfbox-1.0.0.jar: ec2865bfa45513e63adaa1a3c6387eb6bbd481e6b23f4d68a33cfedfc753cfe8
/renderer/lib/pdfbox-3.0.8.jar: 97647cfbde61ebcfc06b4cf8c9b0ffcaaee073396eceb4a7f6836a9b9128903c
/renderer/lib/pdfbox-io-3.0.8.jar: 36a0e04001010b4c764857817412b96339930b19755e728959805cc0352061b2
/renderer/lib/slf4j-api-2.0.17.jar: 7b751d952061954d5abfed7181c1f645d336091b679891591d63329c622eb832
/renderer/lib/slf4j-nop-2.0.17.jar: 3716f83649ec66161a2edefd4f49df34d1dd1c51cdcf941996c6987260f0a829
/renderer/lib/xmpbox-3.0.8.jar: f044d2e316e57714a0adf272ad8abf4a863b8978fd17dc5b86dcfa8135469b10
```
Not covered by these pins: `identity.*`, `certificateNamespaces`, TLS identities, and chart switches.
## What was and was not verified (1.0.0 build)
* Verified: `renderer` (174) and transport (19) tests and Checkstyle pass on this source (same sources as the `v1.0.0` tag);
both images build; the service image runs read-only, non-root, all capabilities dropped, and served CATALOG, PDF
(Code128, GS1-128, Zint DotCode) and ZPL renders over a real mutual-TLS handshake with ephemeral certificates.
* Not verified: no cluster run, no handshake against Forge, no gVisor or hostile-input qualification (the service is
`TRUSTED_LAB` only), no byte-for-byte rebuild of the OpenHTML jar from `vendor/`.
+9
View File
@@ -26,3 +26,12 @@ The encoder and prime-field ECC helper retain the MIT license. See
META-INF/licenses/bwipp-code93i-MIT.txt and Code93i.java. Pinned corresponding
upstream source, helper, tests and provenance are retained under
src/test/resources/barcodes/code93i.
Bundled fonts (2026-11-12). This distribution contains, unmodified and as data,
IBM Plex Sans Regular and Bold and IBM Plex Sans Condensed Bold, Copyright (c)
2017 IBM Corp. with Reserved Font Name "Plex", and JetBrains Mono Regular and
Bold, Copyright 2020 The JetBrains Mono Project Authors
(https://github.com/JetBrains/JetBrainsMono). They are licensed under the SIL
Open Font License, Version 1.1, separately from the renderer's Apache license,
which does not replace it. Each font is in /fonts of the renderer JAR beside
the full license text and a provenance note; /fonts/SHA256SUMS lists the hashes.
+44 -2
View File
@@ -40,7 +40,11 @@ One UTF-8 JSON object followed by a newline enters stdin, and one JSON response
`operation` is `RENDER`, `VALIDATE`, or `CATALOG`. A catalog request needs only protocol, requestId and operation and returns versioned barcode IDs and typed option metadata. `VALIDATE` compiles PDF template syntax or checks the ZPL scene structure plus asset identity. It does not evaluate arbitrary context, certify future layout fit, or promise that every source option will render with every record. Production publication should also render representative fixtures inside the qualified boundary.
A successful render returns protocol, requestId, `outcome: "OK"`, `rendererVersion: "qqq-renderer-0.1.0"`, `catalogVersion: "qqq-barcodes-9"`, mediaType, base64, SHA-256, decoded byte length and pageCount. Validation returns no document bytes. Errors return `outcome: "ERROR", code: "RENDER_FAILED"`; no source/context or exception stack is included. The host must independently check request identity, response shape, decoded size/hash, format policy, successful process termination and container removal. Worker-reported metadata is untrusted. An external parent must not persist raw stderr containing dependency diagnostics.
A successful render returns protocol, requestId, `outcome: "OK"`, `rendererVersion: "qqq-renderer-0.2.0"`, `catalogVersion: "qqq-barcodes-9"`, mediaType, base64, SHA-256, decoded byte length, pageCount and `diagnostics` (a list, empty except for a version 2 scene). Validation returns no document bytes. Errors return `outcome: "ERROR", code: "RENDER_FAILED"`; no source/context or exception stack is included. A version 2 scene refusal returns its own code and one diagnostic as `detail` (see "ZPL scene 2").
Renderer `0.2.0` adds, all optional: `"targetDpi"` (203, 300 or 600; the resolution a version 2 scene is rendered at, by default the stock's `dpi`; a version 1 scene with a target other than its stock's `dpi` is refused as `TARGET_REQUIRES_SCENE_2`) and `"diagnostics": "COLLECT"` (keep every element's refusal instead of stopping at the first; the outcome is then `REFUSED` when there is at least one, and the answer carries the diagnostics and no document: no `mediaType`, `base64`, `sha256`, `length` or `pageCount`, so a host that looks for `base64` without reading the outcome finds nothing to print). The operations `INSPECT_ASSET` and `UPGRADE_SCENE` are routed and answer `UNSUPPORTED_OPERATION` until their packages exist. A host bridge that accepts only `qqq-renderer-0.1.0` does not accept these answers: upgrade the host library before the image. The host must independently check request identity, response shape, decoded size/hash, format policy, successful process termination and container removal. Worker-reported metadata is untrusted. An external parent must not persist raw stderr containing dependency diagnostics.
**Compatibility of version 1 answers.** The ZPL bytes of a version 1 scene are unchanged; the corpus in `src/test/resources/compat-v1` holds them byte for byte. The answer envelope around them changed in two ways in `0.2.0`, for a request a `0.1.0` host already sends. Every `OK` answer gains `diagnostics: []`: six fields for `VALIDATE` and eleven for `RENDER`, where there were five and ten. And a ZPL source that is not readable JSON, has no `schema` or has an unknown `schema` now answers `code: "SCENE_INVALID"` with a `detail` diagnostic (pointer `""`, or `/schema`), where `0.1.0` answered the opaque `RENDER_FAILED`. Every other version 1 refusal keeps its code. Nothing in a released host depended on `RENDER_FAILED` for those three cases: it is not a `GenerationPorts.FailureCode`, so `bridges/renderer` rejects such an answer as `WORKER_ERROR_REJECTED`, exactly as it rejects every `0.2.0` answer today (it accepts only `qqq-renderer-0.1.0` and the exact `0.1.0` field counts). The bridge that accepts `0.2.0` must take the extra `diagnostics` field, `detail` on an error, the `REFUSED` outcome, and `SCENE_INVALID` and the other diagnostic codes as failure codes.
## PDF authoring
@@ -98,9 +102,47 @@ Before any text font/raster allocation, the scene is bounded to 64 `rasterText`
Only `^XA`, `^XZ`, `^PW`, `^LL`, `^LH`, `^CI28`, `^FO`, `^A0N`, `^FH_`, `^FD`, `^FS`, `^GB` and `^GFA` are generated. Text is fully hex-encoded UTF-8, so `^`, `~` and `_` in record values cannot become new commands. Barcode/image raster fields use fixed uppercase hex and split below the 99,999-byte field limit. Placement uses overflow-safe bounds checks. No stored formats, downloads, network commands, persistent settings, cuts or resets are emitted. The printing boundary still needs independent output grammar enforcement because a compromised worker must not be trusted to report safe printer bytes.
## ZPL scene 2
A source with schema `qqq-zpl-scene/2` is a layout in physical units that renders at 203, 300 or 600 dpi. The worker chooses the code path from `schema` alone: version 1 is unchanged and frozen, and any other source is refused as `SCENE_INVALID`. The schema is `schema/zpl-scene-2.schema.json`; the design is `docs/design/LABEL-LAYOUT-FONTS-PREVIEW.md`.
```json
{
"schema": "qqq-zpl-scene/2",
"design": { "width": "4in", "height": "1in" },
"elements": [
{ "id": "frame", "type": "box", "thickness": "0.5pt" },
{ "id": "panel", "type": "group", "anchor": "center", "width": "50%", "height": "60%", "children": [
{ "id": "mark", "type": "box", "anchor": "bottom-right", "x": "1mm", "y": "1mm", "width": "6mm", "height": "3mm", "fill": true } ] },
{ "id": "rule", "type": "box", "anchor": "bottom-center", "y": "2mm", "width": "80%", "height": "0.2mm", "thickness": "0.2mm" }
],
"overrides": [ { "when": { "dpi": [203] }, "set": { "frame": { "thickness": "1dot" } } } ]
}
```
- **Lengths** are strings of a number (up to three decimals) and a unit: `mm`, `in`, `pt` (1/72 in), `%` (of the container's width for `x` and `width`, of its height for `y` and `height`) and `dot`. The most a length may be is 2 m (`2000mm`, `78.74in`, `5669.292pt`), `32000dot` or `100%`; anything longer, up to the largest number the syntax can write, is `SCENE_INVALID` at its pointer. A physical length becomes whole micrometres, then dots at the render target: a position to the nearest dot, a box width or height rounded down, a thickness to the nearest dot and never less than one. A `dot` length outside an override raises the warning `DEVICE_UNIT_USED`.
- **Coordinates** start at the top left of the printable area, the stock less its margins. In dots the printable area is `floor((width - left - right) x dpi)` wide and `floor((height - top - bottom) x dpi)` high, which is how a box size is rounded, and it starts at `ceil(left x dpi)`, `ceil(top x dpi)`, moved back by one dot where it would otherwise pass the page edge. So a box of exactly the printable width and height fits at 203, 300 and 600 dpi alike. No ink is ever a whole dot inside a margin; the right and bottom edges may pass theirs by a fraction of a dot (less than 0.125 mm at 203 dpi). `design` states the stock the layout was drawn for; the request's stock must match it within 0.5 mm on each side (`STOCK_MISMATCH`).
- **Every element** has a unique `id` (`[A-Za-z][A-Za-z0-9_-]{0,31}`), a `type`, an `anchor` (one of nine points, default `top-left`: the same point of the box is placed on that point of its container), `x` and `y` (distances inward from the anchored edge; on a centred axis a shift that may be negative), `width` and `height` (omitted: the rest of the container), and `align` and `valign` (where content sits in the box).
- **`box`** has `thickness` and optional `fill`; a line is a box whose width or height is its thickness. **`group`** has `children`, placed relative to its box; groups nest four deep. A scene holds at most 1000 elements, and its elements may paint at most sixteen times its printable area in all, an overlap counted each time: a filled box counts its area, an outline its four bars, a group nothing. The element that would pass that is refused as `SCENE_INVALID` at its pointer, with its box and `measured.paintedPercent` against `limit.paintedPercent` of 1600. A real label paints less than twice its area; the limit holds the worst scene to sixteen fills of the canvas where 1000 were possible.
- **`text`** draws one value in a face bundled with the renderer: `qqq-sans`, `qqq-sans-bold` (IBM Plex Sans), `qqq-condensed-bold` (IBM Plex Sans Condensed) and `qqq-mono`, `qqq-mono-bold` (JetBrains Mono). There is no printer font in version 2 and no installed font is used; any other `font` is `FONT_UNKNOWN`, and a request that supplies an asset whose name begins `qqq-` is refused as `RESERVED_FONT_NAME`. `font` and `size` may come from the scene's `defaults`. The value is `value` or, read from the record when rendering, `valuePath` (text as it is, `true` or `false`, or a number in plain decimal digits with no exponent and no fraction that is only zeros: `1.0E10` prints `10000000000`, `2.50` prints `2.5`; anything else is `VALUE_MISSING`); at most 1024 characters, each of which the face must draw as one glyph from left to right (no control or format characters, combining marks, shaping or right-to-left scripts: `FONT_MISSING_GLYPH`, with the count).
- **Size and measurement.** `size` is the em as a physical length from `1pt` to `1000pt`, not rounded to dots. A text is measured before it is drawn, by integer arithmetic on the face's own numbers, so the measurement is the same on every machine. A line's box is its pen advance widened to hold the ink of every character in it, plus two dots on each inked side for the rasteriser. A text whose ink the rasteriser puts outside that box is not printed in part and does not fail the render: the one element is refused as `TEXT_DOES_NOT_FIT` with `measured.glyphsOutsideMeasure` and `measured.dotsOutsideMeasure`, when the scene is validated if its value is a literal. No bundled face does so at any size from 1 pt to 1000 pt. The block of lines is placed in the element's box by `align` and `valign`, and each line in the block by `align`. `lineHeight` is the distance between baselines as a multiple of the size (default: the face's own). `rotation` turns the text clockwise in a box given as it appears on the label; `reverse` prints white letters on the box filled black.
- **Fit.** In this order: lay the value out at `size` within `fit.maxLines` (default 1); if it does not fit, take the largest size, in steps of 0.25 pt down to `fit.shrinkTo`, at which it does (`TEXT_SHRUNK`); if none does, apply `fit.overflow`. `shrinkTo` defaults to 70% of the size and not below 5 pt. `overflow` is `refuse` (the default: `TEXT_DOES_NOT_FIT`, with the measured width, height, lines and size against the box) or `truncate`, which cuts at a character, ends with an ellipsis and warns `TEXT_TRUNCATED`. At each size a line is broken between words while that fits and at any character when it does not, so a value with no space wraps and a larger size is preferred to whole words (`TEXT_WRAPPED`). A member of `fit` that is wrong is `SCENE_INVALID` at that member (`/elements/3/fit/maxLines`). The size chosen is exactly the one a search of every quarter-point step gives, found without making that search, and all the text of one scene is held to a stated amount of work: 64 million steps, where a character visited while fitting is one step, a character to be drawn is 16 and a glyph the scene draws for the first time at a size is 4096. A scene that passes it is refused as `SCENE_INVALID` at the element that did, with `measured.textWorkSteps` against `limit.textWorkSteps`, the same whether it is validated or rendered and on every machine. That is about a second of a worker; a label of a hundred values takes a few percent of it.
- **Proving the fit.** `maxLength` is the longest value in characters. When a scene is validated, that many of the face's widest character must fit whole, each taken to reach as far above, below and beside its advance as the furthest-reaching character of the face; otherwise the scene is refused as `TEXT_DOES_NOT_FIT`. The proof never cuts. An element with `overflow: truncate` whose stated length is not proven is still valid, since cutting is what its author chose, but every validation warns `FIT_NOT_PROVEN` with `measured.provenCharacters`, the longest length that is proven to fit whole, against `limit.characters`: longer values may be cut. A scene that passes cannot be refused at that render target because a value of up to that length does not fit, whichever of the face's characters it holds. The proof is therefore stricter than a typical value needs, and a box that is exactly `lines x lineHeight` high is not proven: leave room for an accent above a capital. When printing, a longer value is `VALUE_TOO_LONG` before any layout. A bound element without `maxLength` warns `FIT_NOT_PROVEN` with no number. Validation reads no record. The proof is for the render target of the request; validate at each resolution the document prints at.
- **Legibility.** Glyphs are drawn antialiased and a dot is ink when its grey is darker than `threshold` (1 to 254, default 128), so a higher value prints heavier. `TEXT_SMALL_FOR_DPI` warns when the capitals are under 12 dots high at the render target (about 6 pt at 203 dpi), `TEXT_LIGHT_FACE` when a regular weight is used with capitals under 20 dots (about 10 pt at 203 dpi). A literal is judged at the size it is drawn at; a bound value, when validated, at the size its `maxLength` is proven at, which is the smallest any value is printed at (the floor when the proof fails and the element cuts), and at its stated size when it has no `maxLength`. An override is how a scene answers for one resolution: a bold face or a higher `threshold` at 203 dpi.
- **`barcode` and `image`** are parsed and placed by renderer `0.2.0` and then refused as `RENDERER_TOO_OLD`, with the box they would have had, until their packages are in the renderer.
- **`overrides`** replace properties of declared elements at the listed resolutions and are the only place a scene may depend on resolution. They are checked for all three resolutions whatever the request's target. **`samples`** are accepted and ignored by rendering.
- **Output.** The whole label is composed on one 1-bit canvas and emitted as uncompressed `^GFA` fields: rows are cut into bands wherever eight or more blank rows separate ink, each band is trimmed to its inked columns, and a band is continued in a further field at 99,999 bytes. Only `^XA`, `^PW`, `^LL`, `^LH`, `^CI28`, `^FO`, `^GFA`, `^FS` and `^XZ` are emitted.
- **Diagnostics.** A refusal is one diagnostic: `code`, `severity`, the `element` id, the element's `box` in dots from the top left of the printable area, and `measured` and `limit` as named integers. `SCENE_INVALID` also carries `pointer`, the JSON pointer of the offending place. A diagnostic names only an id the scene declares and points only through schema property names, array indexes and declared ids, so no record value, sample or unknown property name can leave the worker in one. A stock the printer language cannot address stays the opaque `RENDER_FAILED`, as for version 1.
```json
{ "code": "ELEMENT_OUTSIDE_PRINTABLE_AREA", "severity": "ERROR", "element": "mark", "box": [719, 0, 79, 39],
"measured": { "bottomDots": 39, "leftDots": 719, "rightDots": 798, "topDots": 0 },
"limit": { "bottomDots": 155, "leftDots": 0, "rightDots": 764, "topDots": 0 } }
```
## Limits
Sources: 262,144 characters. Context: depth 16, 10,000 nodes, 65,536 characters per string, 262,144 aggregate text characters. Stock: 1 mm–2 m, valid margins, 72–1200 DPI (ZPL additionally bounds width to 9,999 dots and height to 32,000). Assets: 100 entries, 2 MiB each, 8 MiB aggregate; image dimensions ≤4096 and ≤4 million pixels. Expanded HTML: 2 million characters and 20,000 elements. PDF pages: 1–500, checked after rendering. Output: caller limit, hard maximum 100 MiB; normal host default is 20 MiB. ZPL: 1,000 elements. Barcodes: 4,000-character payload, scale 1–16, bounded quiet zones, ≤4 million pixels.
Sources: 262,144 characters. Context: depth 16, 10,000 nodes, 65,536 characters per string, 262,144 aggregate text characters. Stock: 1 mm–2 m, valid margins, 72–1200 DPI (ZPL additionally bounds width to 9,999 dots and height to 32,000). Assets: 100 entries, 2 MiB each, 8 MiB aggregate; image dimensions ≤4096 and ≤4 million pixels. Expanded HTML: 2 million characters and 20,000 elements. PDF pages: 1–500, checked after rendering. Output: caller limit, hard maximum 100 MiB; normal host default is 20 MiB. ZPL: 1,000 elements; a version 2 scene paints at most 16 times its printable area. Barcodes: 4,000-character payload, scale 1–16, bounded quiet zones, ≤4 million pixels.
The PDF engine and font/image decoders can consume resources before post-render limits fire. A qualified container's independent CPU/memory/PID/wall limits remain mandatory for both validation and rendering. These ceilings are not performance guarantees; load testing and font/locale/large-batch qualification remain outstanding.
+29
View File
@@ -58,3 +58,32 @@ the Java file preserves the full license and identifies the dated port.
Unmodified source, tests, hashes and maintenance policy are retained in
`src/test/resources/barcodes/coop2of5`. No interpreter or additional runtime
dependency is introduced. See [the capability contract](BARCODES.md#coop-2-of-5).
## Bundled fonts for version 2 label text (2026-11-12)
Version 2 label scenes draw text in five TrueType faces shipped inside the renderer JAR under `/fonts`. They are
data, not code: unmodified files taken from each project's official release archive, each beside its licence text
and a provenance note, with their SHA-256 in `/fonts/SHA256SUMS`. A test (`FaceTest`) fails the build when a
licence, a provenance note or a hash is missing or a file's bytes change.
| Scene name | Family and style | File | Release | SHA-256 | Licence |
| --- | --- | --- | --- | --- | --- |
| `qqq-sans` | IBM Plex Sans Regular | `ibm-plex-sans/IBMPlexSans-Regular.ttf` | [`@ibm/plex-sans@1.1.0`](https://github.com/IBM/plex/releases/download/%40ibm/plex-sans%401.1.0/ibm-plex-sans.zip), font version 3.005 | `975dcda37d80f038dcd143c22e33ca2d97a0cc5a929aace1c749153b0fe1afa5` | SIL OFL 1.1 |
| `qqq-sans-bold` | IBM Plex Sans Bold | `ibm-plex-sans/IBMPlexSans-Bold.ttf` | the same archive, font version 3.005 | `9e6c74a889a700d707613d24548fe4ffa6bc59559a0689d2cf9e133bdcdafb2f` | SIL OFL 1.1 |
| `qqq-condensed-bold` | IBM Plex Sans Condensed Bold | `ibm-plex-sans-condensed/IBMPlexSansCondensed-Bold.ttf` | [`@ibm/plex-sans-condensed@2.0.0`](https://github.com/IBM/plex/releases/download/%40ibm/plex-sans-condensed%402.0.0/ibm-plex-sans-condensed.zip), font version 3.000 | `723e245902b45a49f8cf602d15891bae08c31309dce7c56d209d10cd471b88c7` | SIL OFL 1.1 |
| `qqq-mono` | JetBrains Mono Regular | `jetbrains-mono/JetBrainsMono-Regular.ttf` | [`v2.304`](https://github.com/JetBrains/JetBrainsMono/releases/download/v2.304/JetBrainsMono-2.304.zip), font version 2.304 | `a0bf60ef0f83c5ed4d7a75d45838548b1f6873372dfac88f71804491898d138f` | SIL OFL 1.1 |
| `qqq-mono-bold` | JetBrains Mono Bold | `jetbrains-mono/JetBrainsMono-Bold.ttf` | the same archive, font version 2.304 | `5590990c82e097397517f275f430af4546e1c45cff408bde4255dad142479dcb` | SIL OFL 1.1 |
Each licence was confirmed from the release archive itself and not from memory: the archive's own licence file
(`LICENSE.txt` for the two IBM Plex archives, `OFL.txt` for JetBrains Mono) states the SIL Open Font License,
Version 1.1 and carries its full text, the licence field of every font's name table says the same, and every
font's embedding bits are 0 (installable embedding). The licence files are shipped byte for byte. IBM Plex
declares the Reserved Font Name "Plex"; the files are neither modified nor renamed, and the scene names
(`qqq-sans` and so on) are names of the renderer's faces, not of derived fonts.
The SIL Open Font License 1.1 is not on the allowlist of `K22-DEP-02`. The maintainer approved one recorded
exception for unmodified OFL 1.1 fonts shipped as data on 2026-11-12. The register is kept in the standards
repository (`exceptions/register.md`), not here; the entry was proposed with the pull request that added the
fonts. The OFL permits bundling and redistribution with software provided the copyright and
licence notices accompany the fonts, the fonts are not sold by themselves and a Reserved Font Name is not used
for a modified version; it does not apply to documents made with the fonts.
+25
View File
@@ -0,0 +1,25 @@
#!/bin/sh
# Print the gg-forge-cd echoRenderer.* pins (non-secret) for a PUBLISHED service image, read from the image itself:
# sh renderer/image-pins.sh ghcr.io/gg-engineering/qqq-remote-renderer@sha256:<manifest digest>
# The classpath is /renderer/renderer.jar followed by /renderer/lib/*.jar in byte order; hashes are SHA256 of the files in the image.
set -eu
image=${1:?image reference by digest required}
case "$image" in *@sha256:*) ;; *) echo 'Reference the image by @sha256: digest' >&2; exit 2;; esac
repository=${image%@*}
digest=${image#*@}
docker pull "$image" >/dev/null
image_id=$(docker image inspect "$image" --format '{{.Id}}')
echo "echoRenderer:"
echo " image:"
echo " repository: $repository"
echo " digest: $digest"
echo " imageId: $image_id"
docker run --rm --pull never --network none --user 65532:65532 --entrypoint sh "$image" -c '
set -eu
echo " classpath:"
echo " - /renderer/renderer.jar"
for f in $(LC_ALL=C ls /renderer/lib/*.jar); do echo " - $f"; done
echo " fileHashes:"
for f in /opt/java/openjdk/bin/java /renderer/renderer.jar /usr/local/bin/zint /usr/share/doc/qqq-zint/patchset-id.txt $(LC_ALL=C ls /renderer/lib/*.jar); do
printf " %s: %s\n" "$f" "$(sha256sum "$f" | cut -d" " -f1)"
done'
+20
View File
@@ -36,6 +36,26 @@
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-dependency-plugin</artifactId><version>3.9.0</version><executions><execution><id>runtime-libraries</id><phase>package</phase><goals><goal>copy-dependencies</goal></goals><configuration><includeScope>runtime</includeScope><outputDirectory>${project.build.directory}/lib</outputDirectory></configuration></execution></executions></plugin>
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><version>3.4.2</version><configuration><archive><manifest><mainClass>com.kingsrook.qbits.renderer.RendererMain</mainClass><addClasspath>true</addClasspath><classpathPrefix>lib/</classpathPrefix></manifest></archive></configuration></plugin>
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-checkstyle-plugin</artifactId><version>3.3.1</version><dependencies><dependency><groupId>com.puppycrawl.tools</groupId><artifactId>checkstyle</artifactId><version>10.12.6</version></dependency></dependencies><configuration><configLocation>${project.basedir}/checkstyle/config.xml</configLocation><propertyExpansion>checkstyle.reactor.root=${project.basedir}</propertyExpansion><includeTestSourceDirectory>true</includeTestSourceDirectory><consoleOutput>true</consoleOutput><violationSeverity>warning</violationSeverity><failOnViolation>true</failOnViolation></configuration><executions><execution><phase>validate</phase><goals><goal>check</goal></goals></execution></executions></plugin>
<plugin>
<!-- Coverage gates. The BUNDLE rule is the measured baseline of the existing renderer, rounded down (2026-11-11: 94.0% of instructions and 91.3% of lines); raise it when coverage rises and
never lower it. The PACKAGE and CLASS rules hold new code to 100% line coverage from its first commit; a pattern matches nothing until its package or class exists, so the package that adds
it needs no change here. Nothing is excluded: JaCoCo skips only code annotated as generated, and this build defines no such annotation. There is no skip switch. -->
<groupId>org.jacoco</groupId><artifactId>jacoco-maven-plugin</artifactId><version>0.8.15</version><executions>
<execution><goals><goal>prepare-agent</goal></goals></execution>
<execution><id>report</id><phase>verify</phase><goals><goal>report</goal></goals></execution>
<execution><id>coverage</id><phase>verify</phase><goals><goal>check</goal></goals><configuration><rules>
<rule><element>BUNDLE</element><limits>
<limit><counter>INSTRUCTION</counter><value>COVEREDRATIO</value><minimum>0.94</minimum></limit>
<limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>0.91</minimum></limit>
</limits></rule>
<rule><element>PACKAGE</element><includes><include>com.kingsrook.qbits.renderer.scene2</include><include>com.kingsrook.qbits.renderer.scene2.*</include></includes><limits>
<limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>1.00</minimum></limit>
</limits></rule>
<rule><element>CLASS</element><includes><include>com.kingsrook.qbits.renderer.AssetInspector</include><include>com.kingsrook.qbits.renderer.AssetInspector.*</include></includes><limits>
<limit><counter>LINE</counter><value>COVEREDRATIO</value><minimum>1.00</minimum></limit>
</limits></rule>
</rules></configuration></execution>
</executions></plugin>
<plugin>
<!-- Publish a self-contained POM: ${revision} is resolved at build time, so a consumer needs no -Drevision -->
<groupId>org.codehaus.mojo</groupId><artifactId>flatten-maven-plugin</artifactId><version>1.7.3</version>
+2 -2
View File
@@ -3,9 +3,9 @@
"qualified": false,
"qualificationId": null,
"imageDigest": null,
"rendererVersion": "qqq-renderer-0.1.0",
"rendererVersion": "qqq-renderer-0.2.0",
"protocol": "qbit-document-renderer/1",
"catalogVersion": "qqq-barcodes-1",
"catalogVersion": "qqq-barcodes-9",
"javaVersion": "21.0.13",
"requiredRuntime": "runsc",
"requiredHostOs": "linux",
+21
View File
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Image-assembly project, not a published module. It resolves the RELEASED renderer engine and its runtime
libraries from the QRun-IO Gitea Maven registry (and Maven Central) at one exact version, so the renderer image
carries release bytes and not a local build. renderer.version has no default: pass -Drenderer.version=<released>. -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.kingsrook.qbits</groupId><artifactId>qbit-document-renderer-image</artifactId><version>0</version><packaging>pom</packaging>
<repositories>
<repository><id>central</id><url>https://repo.maven.apache.org/maven2</url><snapshots><enabled>false</enabled></snapshots></repository>
<repository><id>qrun-io</id><url>https://git.kof22.com/api/packages/QRun-IO/maven</url><snapshots><enabled>false</enabled></snapshots><releases><checksumPolicy>fail</checksumPolicy></releases></repository>
</repositories>
<dependencies>
<dependency><groupId>com.kingsrook.qbits</groupId><artifactId>qbit-document-renderer</artifactId><version>${renderer.version}</version></dependency>
</dependencies>
<build><plugins>
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-dependency-plugin</artifactId><version>3.9.0</version>
<executions><execution><id>release-libraries</id><phase>package</phase><goals><goal>copy-dependencies</goal></goals>
<configuration><includeScope>runtime</includeScope><outputDirectory>${project.build.directory}/lib</outputDirectory></configuration>
</execution></executions></plugin>
</plugins></build>
</project>
+143
View File
@@ -0,0 +1,143 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "QQQ ZPL scene 2",
"description": "A label layout in physical units, rendered at 203, 300 or 600 dpi. Coordinates start at the top left of the printable area (the stock less its margins). The renderer is the authority: it also enforces unique element ids, 1000 elements in all, groups four deep, magnitudes (2000 mm, 100 %, 32000 dot), a negative x or y only on a centred axis, overrides only for declared ids, a stock within 0.5 mm of the design, every box inside the printable area and at least one dot in size, and at most sixteen times the printable area painted in all. A refusal is a diagnostic with a code, the element id and numbers; SCENE_INVALID carries the JSON pointer of the offending place.",
"type": "object",
"additionalProperties": false,
"required": ["schema", "design", "elements"],
"properties": {
"schema": {"const": "qqq-zpl-scene/2"},
"design": {
"description": "The stock the layout was drawn for.",
"type": "object",
"additionalProperties": false,
"required": ["width", "height"],
"properties": {"width": {"$ref": "#/$defs/physical"}, "height": {"$ref": "#/$defs/physical"}}
},
"defaults": {
"description": "The face and size of a text element that states none.",
"type": "object",
"additionalProperties": false,
"properties": {"font": {"type": "string", "pattern": "^[A-Za-z0-9_-][A-Za-z0-9_.-]{0,99}$"}, "size": {"$ref": "#/$defs/physical"}}
},
"samples": {
"description": "Named synthetic contexts for a preview. Accepted and ignored by rendering.",
"type": "object",
"maxProperties": 16,
"additionalProperties": {"type": "object"}
},
"elements": {"type": "array", "items": {"$ref": "#/$defs/element"}},
"overrides": {
"description": "The only place a scene may depend on resolution. Each entry replaces properties of declared elements at the listed resolutions; later entries win. `id`, `type` and `children` cannot change.",
"type": "array",
"maxItems": 32,
"items": {
"type": "object",
"additionalProperties": false,
"required": ["when", "set"],
"properties": {
"when": {
"type": "object",
"additionalProperties": false,
"required": ["dpi"],
"properties": {"dpi": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"enum": [203, 300, 600]}}}
},
"set": {
"type": "object",
"minProperties": 1,
"propertyNames": {"$ref": "#/$defs/id"},
"additionalProperties": {"type": "object", "minProperties": 1, "not": {"anyOf": [{"required": ["id"]}, {"required": ["type"]}, {"required": ["children"]}]}}
}
}
}
}
},
"$defs": {
"id": {"type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_-]{0,31}$"},
"length": {
"description": "A number of up to three decimals and a unit. `%` is a share of the container's width (x, width) or height (y, height); `dot` is one printer dot and is whole.",
"type": "string",
"pattern": "^-?(0|[1-9][0-9]{0,4})(\\.[0-9]{1,3})?(mm|in|pt|%)$|^-?(0|[1-9][0-9]{0,4})dot$"
},
"size": {"type": "string", "pattern": "^(0|[1-9][0-9]{0,4})(\\.[0-9]{1,3})?(mm|in|pt|%)$|^(0|[1-9][0-9]{0,4})dot$"},
"physical": {"type": "string", "pattern": "^(0|[1-9][0-9]{0,4})(\\.[0-9]{1,3})?(mm|in|pt)$"},
"absolute": {"type": "string", "pattern": "^(0|[1-9][0-9]{0,4})(\\.[0-9]{1,3})?(mm|in|pt)$|^(0|[1-9][0-9]{0,4})dot$"},
"placement": {
"type": "object",
"required": ["id", "type"],
"properties": {
"id": {"$ref": "#/$defs/id"},
"anchor": {
"description": "The point of the box that is placed on the same point of its container.",
"enum": ["top-left", "top-center", "top-right", "middle-left", "center", "middle-right", "bottom-left", "bottom-center", "bottom-right"],
"default": "top-left"
},
"x": {"$ref": "#/$defs/length", "default": "0mm", "description": "Distance inward from the anchored edge; on a centred axis a shift right, which may be negative."},
"y": {"$ref": "#/$defs/length", "default": "0mm", "description": "Distance inward from the anchored edge; on a centred axis a shift down, which may be negative."},
"width": {"$ref": "#/$defs/size", "description": "Rounded down to whole dots. Omitted: the rest of the container."},
"height": {"$ref": "#/$defs/size", "description": "Rounded down to whole dots. Omitted: the rest of the container."},
"align": {"enum": ["left", "center", "right"], "default": "left"},
"valign": {"enum": ["top", "middle", "bottom"], "default": "top"}
}
},
"element": {
"oneOf": [
{
"$ref": "#/$defs/placement",
"description": "A rectangle. A line is a box whose width or height is its thickness.",
"unevaluatedProperties": false,
"properties": {"type": {"const": "box"}, "thickness": {"$ref": "#/$defs/absolute", "description": "Nearest dot, never less than one. Required unless `fill` is true."}, "fill": {"type": "boolean", "default": false}},
"anyOf": [{"required": ["thickness"]}, {"required": ["fill"], "properties": {"fill": {"const": true}}}]
},
{
"$ref": "#/$defs/placement",
"description": "A box whose children are positioned relative to it.",
"unevaluatedProperties": false,
"required": ["children"],
"properties": {"type": {"const": "group"}, "children": {"type": "array", "items": {"$ref": "#/$defs/element"}}}
},
{
"$ref": "#/$defs/placement",
"description": "Text in a face bundled with the renderer, measured before it is drawn and placed in its box by `align` and `valign`. `font` and `size` may come from `defaults`. The renderer is the authority: it also enforces a size from 1pt to 1000pt, a `shrinkTo` from 1pt up to the size, at most three decimals in `lineHeight`, at most 1024 characters, only characters the face draws as one glyph each from left to right (FONT_MISSING_GLYPH), no supplied asset whose name begins `qqq-` (RESERVED_FONT_NAME), and a stated amount of work for all the text of one scene (SCENE_INVALID with `textWorkSteps`).",
"unevaluatedProperties": false,
"oneOf": [{"required": ["value"]}, {"required": ["valuePath"]}],
"properties": {
"type": {"const": "text"},
"value": {"type": "string", "maxLength": 1024, "description": "The text itself."},
"valuePath": {"type": "string", "pattern": "^/", "maxLength": 256, "description": "A JSON pointer into the record. Text is printed as it is; true and false as those words; a number in plain decimal digits, with no exponent and no fraction that is only zeros (`1.0E10` prints `10000000000`, `2.50` prints `2.5`, `12.0` prints `12`). Anything else, a number that is not finite among them, is VALUE_MISSING. No record is read when a scene is validated."},
"font": {"enum": ["qqq-sans", "qqq-sans-bold", "qqq-condensed-bold", "qqq-mono", "qqq-mono-bold"], "description": "A bundled face: IBM Plex Sans Regular and Bold, IBM Plex Sans Condensed Bold, JetBrains Mono Regular and Bold. Any other name is FONT_UNKNOWN."},
"size": {"$ref": "#/$defs/physical", "description": "The em size. Type scales continuously: the size is not rounded to dots."},
"lineHeight": {"type": "number", "minimum": 0.5, "maximum": 5, "description": "The distance between baselines as a multiple of the size. Default: the face's own ascent, descent and line gap."},
"fit": {
"type": "object",
"additionalProperties": false,
"description": "What happens when the value does not fit the box. In order: lay out at `size` within `maxLines`; else the largest size, in steps of 0.25pt down to `shrinkTo`, that fits; else `overflow`. At each size a line is broken between words while that fits and at any character when it does not. A member that is wrong is SCENE_INVALID at that member (`/fit/maxLines`); a member `fit` does not have is SCENE_INVALID at `fit`.",
"properties": {
"maxLines": {"type": "integer", "minimum": 1, "maximum": 64, "default": 1, "description": "The most lines the value may take."},
"shrinkTo": {"$ref": "#/$defs/physical", "description": "The smallest size the text may be reduced to: from 1pt up to `size`, which the renderer enforces. Default: 70% of `size` and not below 5pt, or `size` itself when that is smaller."},
"overflow": {"enum": ["refuse", "truncate"], "default": "refuse", "description": "What is done with a value that fits at no size: `refuse` (TEXT_DOES_NOT_FIT), or `truncate` (cut at a character, end with an ellipsis, warn TEXT_TRUNCATED)."}
}
},
"maxLength": {"type": "integer", "minimum": 1, "maximum": 1024, "description": "The longest value, in characters. Validation proves that this many of the face's widest character fit whole, never cut, so a length refusal happens when the scene is published; a longer value is VALUE_TOO_LONG when printing. When the proof fails and `fit.overflow` is `truncate` the scene stands and warns FIT_NOT_PROVEN with the longest length that is proven (`provenCharacters`): longer values may be cut. Without `maxLength` a bound element warns FIT_NOT_PROVEN."},
"threshold": {"type": "integer", "minimum": 1, "maximum": 254, "default": 128, "description": "Glyphs are drawn antialiased; a dot is ink when its grey is darker than this. Higher prints heavier."},
"reverse": {"type": "boolean", "default": false, "description": "White letters on the element's box filled black."},
"rotation": {"enum": [0, 90, 180, 270], "description": "Clockwise. The box is given as it appears on the label; a text turned a quarter is fitted along the box's height."}
}
},
{
"$ref": "#/$defs/placement",
"description": "A barcode. Parsed and placed by renderer 0.2.0 and refused as RENDERER_TOO_OLD until the barcode package; the values of these properties are not yet read.",
"unevaluatedProperties": false,
"properties": {"type": {"const": "barcode"}, "symbology": {}, "symbologyPath": {}, "allowedSymbologies": {}, "value": {}, "valuePath": {}, "minModule": {}, "maxModule": {}, "quiet": {}, "gs1": {}, "hri": {},
"scannerSymbologyPath": {}, "aimIdentifierPath": {}, "rotation": {"enum": [0, 90, 180, 270]}}
},
{
"$ref": "#/$defs/placement",
"description": "An image. Parsed and placed by renderer 0.2.0 and refused as RENDERER_TOO_OLD until the graphics package; the values of these properties are not yet read.",
"unevaluatedProperties": false,
"properties": {"type": {"const": "image"}, "asset": {}, "fit": {}, "mode": {}, "rotation": {"enum": [0, 90, 180, 270]}}
}
]
}
}
}
@@ -0,0 +1,54 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer;
import java.util.Map;
import com.fasterxml.jackson.databind.JsonNode;
/*******************************************************************************
** `INSPECT_ASSET`: parse an uploaded font or image inside the isolated worker
** and report what it is, so the application never parses one. The operation is
** routed here from the first version 2 renderer so the wire is settled; the
** inspection itself is a later package, and until then the operation is
** refused by name.
*******************************************************************************/
public final class AssetInspector
{
/***************************************************************************
** Utility class.
***************************************************************************/
private AssetInspector()
{
}
/***************************************************************************
** Answer one `INSPECT_ASSET` request.
***************************************************************************/
public static Map<String, Object> inspect(JsonNode request)
{
Wire.text(request.get("requestId"), 128);
throw new IllegalArgumentException("UNSUPPORTED_OPERATION");
}
}
@@ -47,6 +47,15 @@ public final class RenderInput
public final Stock stock;
public final Map<String, Asset> assets = new LinkedHashMap<>();
/////////////////////////////////////////////////////////////////////////////////////////////////
// the render target of a version 2 scene, or null for the stock's own resolution; and whether //
// the caller asked for every diagnostic rather than the first refusal //
/////////////////////////////////////////////////////////////////////////////////////////////////
public final Integer targetDpi;
public final boolean collectDiagnostics;
public static final String RESERVED_ASSET_PREFIX = "qqq-";
/*******************************************************************************
** Physical stock uses exact integer microns; dots are checked separately.
@@ -95,6 +104,16 @@ public final class RenderInput
validateData(context, 0, new int[2]);
maximumBytes = Wire.integer(root.get("maximumBytes"), 1, 100 * 1024 * 1024);
stock = stock(root.path("stock"));
targetDpi = root.has("targetDpi") ? Integer.valueOf(Wire.integer(root.get("targetDpi"), 203, 600)) : null;
if(targetDpi != null && !java.util.List.of(203, 300, 600).contains(targetDpi))
{
throw new IllegalArgumentException("INVALID_TARGET_DPI");
}
collectDiagnostics = root.has("diagnostics");
if(collectDiagnostics && !"COLLECT".equals(root.get("diagnostics").textValue()))
{
throw new IllegalArgumentException("INVALID_DIAGNOSTICS_MODE");
}
JsonNode supplied = root.path("assets");
if(!supplied.isArray() || supplied.size() > 100)
{
@@ -135,6 +154,17 @@ public final class RenderInput
}
/*******************************************************************************
** The supplied assets whose names begin with the prefix reserved for the faces
** bundled in the renderer. A version 2 scene may not carry one; the text
** package refuses it as `RESERVED_FONT_NAME`. Version 1 never had the rule.
*******************************************************************************/
public java.util.List<String> reservedAssetNames()
{
return (assets.keySet().stream().filter(name -> name.startsWith(RESERVED_ASSET_PREFIX)).toList());
}
/*******************************************************************************
** Shared immutable physical stock parser for rendering and fit measurement.
*******************************************************************************/
@@ -29,8 +29,14 @@ import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Base64;
import java.util.LinkedHashMap;
import java.util.Map;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.renderer.scene2.Diagnostics;
import com.kingsrook.qbits.renderer.scene2.Refusal;
import com.kingsrook.qbits.renderer.scene2.Scene2;
import com.kingsrook.qbits.renderer.scene2.upgrade.SceneUpgrade;
import org.apache.pdfbox.Loader;
import org.apache.pdfbox.pdmodel.PDDocument;
@@ -41,7 +47,7 @@ import org.apache.pdfbox.pdmodel.PDDocument;
*******************************************************************************/
public final class RendererMain
{
public static final String VERSION = "qqq-renderer-0.1.0";
public static final String VERSION = "qqq-renderer-0.2.0";
/*******************************************************************************
@@ -84,8 +90,7 @@ public final class RendererMain
catch(Exception expected)
{
// A failed invocation exposes no template/context text or stack trace.
output.write(Wire.JSON.writeValueAsBytes(Map.of("protocol", Wire.PROTOCOL, "requestId", requestId, "outcome", "ERROR",
"rendererVersion", VERSION, "catalogVersion", Barcodes.VERSION, "code", errorCode(expected))));
output.write(Wire.JSON.writeValueAsBytes(error(requestId, expected)));
output.write('\n');
}
}
@@ -93,13 +98,40 @@ public final class RendererMain
/*******************************************************************************
** Only fixed public fit refusals cross the process boundary. Encoder messages
** and all other failures remain opaque because they can contain source data.
** The error answer. A version 2 refusal adds its one diagnostic as `detail`:
** a code, a declared element id, a pointer of schema names and numbers.
*******************************************************************************/
static Map<String, Object> error(String requestId, Exception failure)
{
Map<String, Object> answer = new LinkedHashMap<>();
answer.put("protocol", Wire.PROTOCOL);
answer.put("requestId", requestId);
answer.put("outcome", "ERROR");
answer.put("rendererVersion", VERSION);
answer.put("catalogVersion", Barcodes.VERSION);
answer.put("code", errorCode(failure));
if(failure instanceof Refusal refusal)
{
answer.put("detail", refusal.diagnostic().wire());
}
return (answer);
}
/*******************************************************************************
** Only fixed public refusals cross the process boundary: the fit refusals, an
** operation this renderer does not perform, and the code of a version 2
** diagnostic. Encoder messages and all other failures remain opaque because
** they can contain source data.
*******************************************************************************/
static String errorCode(Exception failure)
{
String message = failure.getMessage();
if(failure instanceof IllegalArgumentException && message != null && java.util.Set.of(
if(failure instanceof Refusal refusal)
{
return (refusal.diagnostic().code());
}
if(failure instanceof IllegalArgumentException && message != null && java.util.Set.of("UNSUPPORTED_OPERATION",
"BARCODE_FIT_TOO_SMALL", "BARCODE_FIT_UNSUPPORTED", "BARCODE_FIT_BOX_OUTSIDE_STOCK",
"BARCODE_FIT_GEOMETRY_MISMATCH", "INVALID_BARCODE_FIT_PROFILE", "INVALID_BARCODE_FIT_REQUEST",
"BARCODE_SYMBOLOGY_NOT_ALLOWED", "SYMBOLOGY_ALLOWLIST_REQUIRED", "SCANNER_BARCODE_PROFILE_UNSUPPORTED",
@@ -154,29 +186,100 @@ public final class RendererMain
return (Map.of("protocol", Wire.PROTOCOL, "requestId", Wire.text(root.get("requestId"), 128), "outcome", "OK",
"rendererVersion", VERSION, "catalogVersion", Barcodes.VERSION, "fit", BarcodeFit.fit(request).metadata()));
}
RenderInput input = new RenderInput(root);
if("VALIDATE".equals(input.operation))
String operation = root.path("operation").asText();
if("INSPECT_ASSET".equals(operation) || "UPGRADE_SCENE".equals(operation))
{
if("PDF".equals(input.format))
if(!Wire.PROTOCOL.equals(root.path("protocol").asText()))
{
PdfRenderer.validate(input);
throw new IllegalArgumentException("INVALID_PROTOCOL");
}
else
{
ZplRenderer.validate(input);
}
return (Map.of("protocol", Wire.PROTOCOL, "requestId", input.requestId, "outcome", "OK", "rendererVersion", VERSION, "catalogVersion", Barcodes.VERSION));
return ("INSPECT_ASSET".equals(operation) ? AssetInspector.inspect(root) : SceneUpgrade.upgrade(root));
}
byte[] bytes = "PDF".equals(input.format) ? PdfRenderer.render(input) : ZplRenderer.render(input);
RenderInput input = new RenderInput(root);
Diagnostics diagnostics = new Diagnostics(input.collectDiagnostics);
byte[] bytes = null;
int pageCount = 1;
if("PDF".equals(input.format))
if("ZPL".equals(input.format))
{
bytes = label(input, diagnostics);
}
else if("VALIDATE".equals(input.operation))
{
PdfRenderer.validate(input);
}
else
{
bytes = PdfRenderer.render(input);
try(PDDocument document = Loader.loadPDF(bytes))
{
pageCount = document.getNumberOfPages();
}
}
return (Map.of("protocol", Wire.PROTOCOL, "requestId", input.requestId, "outcome", "OK", "rendererVersion", VERSION, "catalogVersion", Barcodes.VERSION,
"mediaType", "PDF".equals(input.format) ? "application/pdf" : "application/vnd.zebra-zpl", "base64", Base64.getEncoder().encodeToString(bytes), "sha256", Wire.sha256(bytes), "length", bytes.length, "pageCount", pageCount));
Map<String, Object> answer = new LinkedHashMap<>();
answer.put("protocol", Wire.PROTOCOL);
answer.put("requestId", input.requestId);
answer.put("outcome", diagnostics.refused() ? "REFUSED" : "OK");
answer.put("rendererVersion", VERSION);
answer.put("catalogVersion", Barcodes.VERSION);
////////////////////////////////////////////////////////////////////////////////////////////
// a refused answer carries no document: a host that looks for `base64` without reading //
// the outcome must find nothing it could print //
////////////////////////////////////////////////////////////////////////////////////////////
if(bytes != null && !diagnostics.refused())
{
answer.put("mediaType", "PDF".equals(input.format) ? "application/pdf" : "application/vnd.zebra-zpl");
answer.put("base64", Base64.getEncoder().encodeToString(bytes));
answer.put("sha256", Wire.sha256(bytes));
answer.put("length", bytes.length);
answer.put("pageCount", pageCount);
}
answer.put("diagnostics", diagnostics.wire());
return (answer);
}
/*******************************************************************************
** Route a label by the `schema` of its scene alone. Version 1 takes exactly
** the path it always took and prints at the stock's own resolution; version 2
** takes the scene 2 package; anything else is refused by name. The answer is
** the label, or null when the request only validates or a version 2 scene
** was refused while its diagnostics were collected.
*******************************************************************************/
private static byte[] label(RenderInput input, Diagnostics diagnostics) throws Exception
{
boolean validate = "VALIDATE".equals(input.operation);
JsonNode scene;
try
{
scene = Wire.JSON.readTree(input.source);
}
catch(JsonProcessingException expected)
{
throw diagnostics.refuse("SCENE_INVALID", null, "", null, null, null);
}
String schema = scene.path("schema").textValue();
if(Scene2.SCHEMA.equals(schema))
{
if(validate)
{
Scene2.validate(input, scene, diagnostics);
return (null);
}
return (Scene2.render(input, scene, diagnostics));
}
if(!"qqq-zpl-scene/1".equals(schema))
{
throw diagnostics.refuse("SCENE_INVALID", null, scene.isObject() ? "/schema" : "", null, null, null);
}
if(input.targetDpi != null && input.targetDpi != input.stock.dpi())
{
throw diagnostics.refuse("TARGET_REQUIRES_SCENE_2", null, null, null, Map.of("dpi", input.targetDpi), Map.of("dpi", input.stock.dpi()));
}
if(validate)
{
ZplRenderer.validate(input);
return (null);
}
return (ZplRenderer.render(input));
}
}
@@ -0,0 +1,156 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.Set;
import com.kingsrook.qbits.renderer.RenderInput;
/*******************************************************************************
** A rectangle: an outline of a stated thickness, or filled. A line is a box
** whose width or height is its thickness, and on that axis it takes the
** thickness rule (nearest dot, never less than one) so a thin rule does not
** vanish; every other size is rounded down.
*******************************************************************************/
final class BoxElement implements SceneElement
{
private final String id;
private final Placement placement;
private final Length thickness;
private final boolean fill;
/***************************************************************************
** The factory for `type: "box"`.
***************************************************************************/
static final class Factory implements ElementFactory
{
/************************************************************************
** A box reads its outline thickness and whether it is filled.
************************************************************************/
@Override
public Set<String> properties()
{
return (Set.of("thickness", "fill"));
}
/************************************************************************
** Build one box.
************************************************************************/
@Override
public SceneElement create(ElementSource source)
{
return (new BoxElement(source));
}
}
/***************************************************************************
** An outline needs a thickness that is more than nothing; a filled box
** needs none.
***************************************************************************/
private BoxElement(ElementSource source)
{
id = source.id();
placement = source.placement();
fill = source.flag("fill", false);
thickness = source.length("thickness", null, ElementSource.ABSOLUTE);
if(thickness == null ? !fill : thickness.thousandths() <= 0)
{
throw source.invalid("thickness");
}
}
/***************************************************************************
** The id the scene declares for the box.
***************************************************************************/
@Override
public String id()
{
return (id);
}
/***************************************************************************
** The standing rules, except on an axis where the box is a line.
***************************************************************************/
@Override
public Frame place(Layout layout)
{
int width = thickness != null && thickness.equals(placement.width()) ? thickness.thickness(layout.dpi()) : layout.width(placement);
int height = thickness != null && thickness.equals(placement.height()) ? thickness.thickness(layout.dpi()) : layout.height(placement);
return (layout.frame(placement.anchor(), layout.x(placement), layout.y(placement), width, height));
}
/***************************************************************************
** The whole box when it is painted whole, else its four bars; the corners,
** where two bars cross, are painted twice and counted twice.
***************************************************************************/
@Override
public long paintedDots(Frame frame, int dpi)
{
int bar = bar(frame, dpi);
return (bar < 0 ? SceneElement.super.paintedDots(frame, dpi) : 2L * bar * (frame.width() + frame.height()));
}
/***************************************************************************
** The thickness of the outline in dots, or -1 when the box is painted whole:
** it is filled, or its bars would meet.
***************************************************************************/
private int bar(Frame frame, int dpi)
{
int bar = fill ? frame.width() : thickness.thickness(dpi);
return (bar * 2 >= Math.min(frame.width(), frame.height()) ? -1 : bar);
}
/***************************************************************************
** Four bars inside the box, or the whole box when it is filled or when the
** bars would meet.
***************************************************************************/
@Override
public void paint(Canvas canvas, Frame frame, RenderInput input, Diagnostics diagnostics)
{
int bar = bar(frame, canvas.dpi());
if(bar < 0)
{
canvas.fill(frame, true);
return;
}
canvas.fill(new Frame(frame.x(), frame.y(), frame.width(), bar), true);
canvas.fill(new Frame(frame.x(), frame.bottom() - bar, frame.width(), bar), true);
canvas.fill(new Frame(frame.x(), frame.y(), bar, frame.height()), true);
canvas.fill(new Frame(frame.right() - bar, frame.y(), bar, frame.height()), true);
}
}
@@ -0,0 +1,262 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
/*******************************************************************************
** The whole label as one 1-bit picture at the target resolution: a dot is ink
** or it is not. Elements paint in list order, so a later element covers an
** earlier one, white as well as black. Painting outside the canvas is an error
** in the caller, never a silent clip, so ink cannot be lost at an edge.
*******************************************************************************/
public final class Canvas
{
public static final long MAXIMUM_DOTS = 64_000_000L;
/////////////////////////////////////////////////////////////////////////////////////////////////
// what one scene may paint, in canvases: the dots its elements paint, an overlap counted each //
// time, may total sixteen times the canvas. A real label paints less than two (a solid //
// ground, reversed panels, rules, text and codes), so sixteen refuses no layered design, and //
// it holds the worst scene to 16 x 64 million dots, 128 MB of byte writes, where the 1000 //
// full-canvas boxes the element limit allows were 8 GB //
/////////////////////////////////////////////////////////////////////////////////////////////////
public static final int MAXIMUM_COATS = 16;
private final int width;
private final int height;
private final int dpi;
private final int stride;
private final byte[] bits;
private long painted;
/***************************************************************************
** A blank canvas the size of the printable area, in dots.
***************************************************************************/
public Canvas(int width, int height, int dpi)
{
if(width < 1 || height < 1 || (long) width * height > MAXIMUM_DOTS)
{
throw new IllegalArgumentException("CANVAS_LIMIT");
}
this.width = width;
this.height = height;
this.dpi = dpi;
stride = (width + 7) / 8;
bits = new byte[stride * height];
}
/***************************************************************************
** Columns of dots.
***************************************************************************/
public int width()
{
return (width);
}
/***************************************************************************
** Rows of dots.
***************************************************************************/
public int height()
{
return (height);
}
/***************************************************************************
** The resolution the canvas was composed at, in dots per inch.
***************************************************************************/
public int dpi()
{
return (dpi);
}
/***************************************************************************
** Count the dots an element is about to paint. When they would take the
** scene past `MAXIMUM_COATS` canvases nothing is counted and the answer is
** no, so that element is refused and a later, smaller one may still paint.
***************************************************************************/
public boolean admit(long dots)
{
if(painted + dots > MAXIMUM_COATS * (long) width * height)
{
return (false);
}
painted += dots;
return (true);
}
/***************************************************************************
** What the scene would have painted with `dots` more, as a percentage of
** the canvas, rounded up.
***************************************************************************/
public int paintedPercent(long dots)
{
long area = (long) width * height;
return (Math.toIntExact(((painted + dots) * 100 + area - 1) / area));
}
/***************************************************************************
** Whether one dot holds ink.
***************************************************************************/
public boolean get(int x, int y)
{
return ((bits[index(x, y)] & (128 >> (x & 7))) != 0);
}
/***************************************************************************
** Put ink on one dot, or take it off.
***************************************************************************/
public void set(int x, int y, boolean ink)
{
int index = index(x, y);
int mask = 128 >> (x & 7);
bits[index] = (byte) (ink ? bits[index] | mask : bits[index] & ~mask);
}
/***************************************************************************
** Paint a box black, or white to clear what an earlier element painted.
***************************************************************************/
public void fill(Frame area, boolean ink)
{
paint(area, ink ? Paint.BLACK : Paint.WHITE);
}
/***************************************************************************
** Reverse a box: black becomes white and white becomes black.
***************************************************************************/
public void invert(Frame area)
{
paint(area, Paint.REVERSE);
}
/***************************************************************************
** What painting does to the dots of a box.
***************************************************************************/
private enum Paint
{
BLACK, WHITE, REVERSE
}
/***************************************************************************
** Paint a box a byte of dots at a time, so that a scene of many large filled
** boxes costs memory writes rather than a visit to every dot. A box with no
** dots paints nothing.
***************************************************************************/
private void paint(Frame area, Paint paint)
{
if(area.width() < 1 || area.height() < 1)
{
return;
}
index(area.x(), area.y());
index(area.right() - 1, area.bottom() - 1);
for(int y = area.y(); y < area.bottom(); y++)
{
int x = area.x();
while(x < area.right())
{
int first = x & 7;
int count = Math.min(8 - first, area.right() - x);
int mask = (0xFF >> first) & (0xFF << (8 - first - count));
int index = y * stride + (x >> 3);
int painted = switch(paint)
{
case BLACK -> bits[index] | mask;
case WHITE -> bits[index] & ~mask;
case REVERSE -> bits[index] ^ mask;
};
bits[index] = (byte) painted;
x += count;
}
}
}
/***************************************************************************
** The first inked column of a row, or -1 when the row is blank.
***************************************************************************/
public int firstInk(int row)
{
for(int x = 0; x < width; x++)
{
if(get(x, row))
{
return (x);
}
}
return (-1);
}
/***************************************************************************
** The last inked column of a row, or -1 when the row is blank.
***************************************************************************/
public int lastInk(int row)
{
for(int x = width - 1; x >= 0; x--)
{
if(get(x, row))
{
return (x);
}
}
return (-1);
}
/***************************************************************************
** The byte that holds a dot, after refusing a dot that is not on the canvas.
***************************************************************************/
private int index(int x, int y)
{
if(x < 0 || y < 0 || x >= width || y >= height)
{
throw new IllegalArgumentException("CANVAS_BOUNDS");
}
return (y * stride + (x >> 3));
}
}
@@ -0,0 +1,213 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.regex.Pattern;
/*******************************************************************************
** One finding about a version 2 scene, in a closed vocabulary: a code, a
** severity, the id of an element the scene declares, a pointer made of schema
** names, indexes and declared ids, a box in dots, and named integers. It has no
** field that can hold a sentence, so no record value, context text or exception
** message can leave the renderer in it. Only `Diagnostics` creates one, because
** only the collector knows which ids the scene declares.
*******************************************************************************/
public final class Diagnostic
{
private static final Set<String> ERRORS = Set.of("SCENE_INVALID", "STOCK_MISMATCH", "TARGET_REQUIRES_SCENE_2", "ELEMENT_OUTSIDE_PRINTABLE_AREA", "TEXT_DOES_NOT_FIT", "VALUE_MISSING",
"VALUE_TOO_LONG", "FONT_UNKNOWN", "FONT_MISSING_GLYPH", "RESERVED_FONT_NAME", "BARCODE_DOES_NOT_FIT", "GS1_INVALID", "ASSET_UNKNOWN", "PREVIEW_TOO_LARGE", "RENDERER_TOO_OLD");
private static final Set<String> WARNINGS = Set.of("TEXT_TRUNCATED", "TEXT_SMALL_FOR_DPI", "TEXT_LIGHT_FACE", "FIT_NOT_PROVEN", "BARCODE_MODULE_BELOW_RECOMMENDED", "QUIET_ZONE_INTRUDED",
"ELEMENTS_OVERLAP", "IMAGE_UPSCALED", "DEVICE_UNIT_USED", "PRINTER_FONT_NOT_SHOWN");
private static final Set<String> INFORMATION = Set.of("TEXT_SHRUNK", "TEXT_WRAPPED", "BARCODE_MODULE", "IMAGE_SCALED");
private static final Pattern NAME = Pattern.compile("[a-z][A-Za-z0-9]{0,31}");
private final String code;
private final Severity severity;
private final String element;
private final String pointer;
private final Frame box;
private final Map<String, Integer> measured;
private final Map<String, Integer> limit;
/***************************************************************************
** An error stops printing; a warning and information do not.
***************************************************************************/
public enum Severity
{
ERROR, WARNING, INFO
}
/***************************************************************************
** Admit only the vocabulary. A mistake here is a defect in the renderer, not
** in the scene, so it is an illegal state and stays opaque to the host.
***************************************************************************/
Diagnostic(String code, Severity severity, String element, String pointer, Frame box, Map<String, Integer> measured, Map<String, Integer> limit)
{
Set<String> codes = switch(severity)
{
case ERROR -> ERRORS;
case WARNING -> WARNINGS;
case INFO -> INFORMATION;
};
if(code == null || !codes.contains(code) || (box != null && (box.width() < 0 || box.height() < 0)))
{
throw new IllegalStateException("DIAGNOSTIC_OUTSIDE_VOCABULARY");
}
this.code = code;
this.severity = severity;
this.element = element;
this.pointer = pointer;
this.box = box;
this.measured = numbers(measured);
this.limit = numbers(limit);
}
/***************************************************************************
** The code, from the closed vocabulary of its severity.
***************************************************************************/
public String code()
{
return (code);
}
/***************************************************************************
** Whether the finding stops printing.
***************************************************************************/
public Severity severity()
{
return (severity);
}
/***************************************************************************
** The declared id of the element the finding is about, or null.
***************************************************************************/
public String element()
{
return (element);
}
/***************************************************************************
** The JSON pointer of the offending property in the scene, or null.
***************************************************************************/
public String pointer()
{
return (pointer);
}
/***************************************************************************
** The element's resolved box in dots from the printable area's top left, or
** null.
***************************************************************************/
public Frame box()
{
return (box);
}
/***************************************************************************
** What was measured, by name.
***************************************************************************/
public Map<String, Integer> measured()
{
return (measured);
}
/***************************************************************************
** What the measured values were held against, by name.
***************************************************************************/
public Map<String, Integer> limit()
{
return (limit);
}
/***************************************************************************
** The diagnostic as the renderer's answer carries it. Absent parts are left
** out, and names are in a fixed order so equal findings are equal bytes.
***************************************************************************/
public Map<String, Object> wire()
{
Map<String, Object> wire = new LinkedHashMap<>();
wire.put("code", code);
wire.put("severity", severity.name());
if(element != null)
{
wire.put("element", element);
}
if(pointer != null)
{
wire.put("pointer", pointer);
}
if(box != null)
{
wire.put("box", box.box());
}
if(!measured.isEmpty())
{
wire.put("measured", measured);
}
if(!limit.isEmpty())
{
wire.put("limit", limit);
}
return (wire);
}
/***************************************************************************
** Freeze at most eight named integers; a name is a short identifier.
***************************************************************************/
private static Map<String, Integer> numbers(Map<String, Integer> values)
{
Map<String, Integer> numbers = new TreeMap<>(values == null ? Map.of() : values);
if(numbers.size() > 8 || numbers.keySet().stream().anyMatch(name -> !NAME.matcher(name).matches()) || numbers.containsValue(null))
{
throw new IllegalStateException("DIAGNOSTIC_OUTSIDE_VOCABULARY");
}
return (Collections.unmodifiableMap(numbers));
}
}
@@ -0,0 +1,215 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
/*******************************************************************************
** The collector of one render or validation, and the only maker of
** diagnostics. It knows the element ids the scene declares, so it is where the
** rule is enforced that a diagnostic names only a declared id and points only
** through schema names, indexes and declared ids: a data value has no way in.
**
** By default the first error ends the work as a `Refusal`. When the caller asks
** to collect, errors are kept and the work goes on as far as it can, which is
** what a preview wants. The findings of one scene are bounded by the scene: at
** most one error for each element and one warning for each property.
*******************************************************************************/
public final class Diagnostics
{
public static final Pattern ID = Pattern.compile("[A-Za-z][A-Za-z0-9_-]{0,31}");
private static final Pattern INDEX = Pattern.compile("0|[1-9][0-9]{0,3}");
private final boolean collect;
private final Map<String, String> declared = new LinkedHashMap<>();
private final List<Diagnostic> findings = new ArrayList<>();
private final Set<Map<String, Object>> seen = new HashSet<>();
private boolean refused;
/***************************************************************************
** A collector that stops at the first error, or one that keeps them.
***************************************************************************/
public Diagnostics(boolean collect)
{
this.collect = collect;
}
/***************************************************************************
** Record an id the scene declares and where its element is. From here on a
** diagnostic may name it.
***************************************************************************/
public void declare(String id, String pointer)
{
if(id == null || !ID.matcher(id).matches() || declared.containsKey(id))
{
throw new IllegalStateException("ELEMENT_ID_NOT_DECLARABLE");
}
declared.put(id, pointer);
}
/***************************************************************************
** Whether the scene declares this id.
***************************************************************************/
public boolean declared(String id)
{
return (declared.containsKey(id));
}
/***************************************************************************
** The pointer of a declared element, or null.
***************************************************************************/
public String pointer(String id)
{
return (declared.get(id));
}
/***************************************************************************
** An error, as the exception to throw. Every part is optional but the code.
***************************************************************************/
public Refusal refuse(String code, String element, String pointer, Frame box, Map<String, Integer> measured, Map<String, Integer> limit)
{
return (new Refusal(create(code, Diagnostic.Severity.ERROR, element, pointer, box, measured, limit)));
}
/***************************************************************************
** A finding that does not stop printing. Reporting the same one twice keeps
** one.
***************************************************************************/
public void warn(String code, String element, String pointer, Frame box, Map<String, Integer> measured, Map<String, Integer> limit)
{
add(create(code, Diagnostic.Severity.WARNING, element, pointer, box, measured, limit));
}
/***************************************************************************
** What the renderer chose, for the author to see: a module size, a shrunk
** type size.
***************************************************************************/
public void inform(String code, String element, String pointer, Frame box, Map<String, Integer> measured, Map<String, Integer> limit)
{
add(create(code, Diagnostic.Severity.INFO, element, pointer, box, measured, limit));
}
/***************************************************************************
** What to do with a refusal that was caught where work can continue: keep it
** when collecting, otherwise let it end the work.
***************************************************************************/
public void keep(Refusal refusal)
{
if(!collect)
{
throw refusal;
}
refused = true;
add(refusal.diagnostic());
}
/***************************************************************************
** Whether an error was kept, so the label must not print.
***************************************************************************/
public boolean refused()
{
return (refused);
}
/***************************************************************************
** Every finding so far, in the order found.
***************************************************************************/
public List<Diagnostic> findings()
{
return (List.copyOf(findings));
}
/***************************************************************************
** The findings as the renderer's answer carries them.
***************************************************************************/
public List<Map<String, Object>> wire()
{
return (findings.stream().map(Diagnostic::wire).toList());
}
/***************************************************************************
** The gate: the element is declared, and every segment of the pointer is an
** index, a property name of the schema or a declared id.
***************************************************************************/
private Diagnostic create(String code, Diagnostic.Severity severity, String element, String pointer, Frame box, Map<String, Integer> measured, Map<String, Integer> limit)
{
boolean known = element == null || declared.containsKey(element);
if(pointer != null && !pointer.isEmpty())
{
known &= pointer.startsWith("/");
for(String segment : pointer.substring(1).split("/", -1))
{
known &= INDEX.matcher(segment).matches() || ElementFactory.VOCABULARY.contains(segment) || declared.containsKey(segment);
}
}
if(!known)
{
throw new IllegalStateException("DIAGNOSTIC_NOT_DECLARED");
}
return (new Diagnostic(code, severity, element, pointer, box, measured, limit));
}
/***************************************************************************
** Keep a finding unless an equal one is already there.
***************************************************************************/
private void add(Diagnostic diagnostic)
{
if(seen.add(diagnostic.wire()))
{
findings.add(diagnostic);
}
}
}
@@ -0,0 +1,75 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.kingsrook.qbits.renderer.scene2.barcode.BarcodeFactory;
import com.kingsrook.qbits.renderer.scene2.graphics.GraphicsFactory;
import com.kingsrook.qbits.renderer.scene2.text.TextFactory;
/*******************************************************************************
** Builds the elements of one `type`. The core owns `box` and `group`; text,
** barcodes and images each live in their own sub-package and are registered
** here by class, so the package that fills one in edits only its own file.
*******************************************************************************/
public interface ElementFactory
{
/***************************************************************************
** Properties every element may state. The parser reads them into the
** element's `Placement` before any factory runs.
***************************************************************************/
Set<String> COMMON = Set.of("id", "type", "anchor", "x", "y", "width", "height", "align", "valign");
/***************************************************************************
** The factories by scene `type`. A `group` is built by the parser itself,
** because its children are elements.
***************************************************************************/
Map<String, ElementFactory> FACTORIES = Map.of("box", new BoxElement.Factory(), "text", new TextFactory(), "barcode", new BarcodeFactory(), "image", new GraphicsFactory());
/***************************************************************************
** Every property name the version 2 schema declares, the members of a text
** element's `fit` among them. A diagnostic's pointer is made only of these,
** of array indexes and of declared element ids.
***************************************************************************/
Set<String> VOCABULARY = Stream.concat(Stream.of("schema", "design", "defaults", "font", "size", "samples", "elements", "overrides", "when", "dpi", "set", "children", "maxLines", "shrinkTo", "overflow"),
Stream.concat(COMMON.stream(), FACTORIES.values().stream().flatMap(factory -> factory.properties().stream()))).collect(Collectors.toUnmodifiableSet());
/***************************************************************************
** The properties this type reads beyond the common ones. The parser refuses
** an element that states any other.
***************************************************************************/
Set<String> properties();
/***************************************************************************
** Build one element from its source, refusing a property value it cannot use
** with `source.invalid(name)`.
***************************************************************************/
SceneElement create(ElementSource source);
}
@@ -0,0 +1,305 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import com.fasterxml.jackson.databind.JsonNode;
/*******************************************************************************
** One element as the scene states it for one resolution: its own properties
** with the matching overrides applied, and its common placement already read.
** A factory reads its own properties through the typed readers here, which
** refuse a bad value as `SCENE_INVALID` at the property's own pointer (in the
** element, or in the override that set it).
*******************************************************************************/
public final class ElementSource
{
public static final Set<Length.Unit> PHYSICAL = Set.of(Length.Unit.MM, Length.Unit.IN, Length.Unit.PT);
public static final Set<Length.Unit> ABSOLUTE = Set.of(Length.Unit.MM, Length.Unit.IN, Length.Unit.PT, Length.Unit.DOT);
public static final Set<Length.Unit> ANY = Set.of(Length.Unit.values());
private final String id;
private final String pointer;
private final Diagnostics diagnostics;
private final Map<String, JsonNode> values = new LinkedHashMap<>();
private final Map<String, String> pointers = new LinkedHashMap<>();
private final Placement placement;
/***************************************************************************
** The element at `pointer`, whose id the collector already holds, with the
** overrides for this resolution: property name to its value and to the
** pointer of the override that states it.
***************************************************************************/
ElementSource(String id, String pointer, JsonNode element, Map<String, JsonNode> overrides, Map<String, String> overridePointers, Diagnostics diagnostics)
{
this.id = id;
this.pointer = pointer;
this.diagnostics = diagnostics;
element.fieldNames().forEachRemaining(name -> values.put(name, element.get(name)));
values.putAll(overrides);
pointers.putAll(overridePointers);
Placement.Anchor anchor = choice("anchor", Placement.Anchor.TOP_LEFT, Placement.Anchor::of);
placement = new Placement(anchor, offset("x", anchor.horizontal()), offset("y", anchor.vertical()), extent("width"), extent("height"),
choice("align", Placement.Align.LEFT, Placement.Align::of), choice("valign", Placement.Valign.TOP, Placement.Valign::of));
}
/***************************************************************************
** The id the scene declares for the element.
***************************************************************************/
public String id()
{
return (id);
}
/***************************************************************************
** The element's `type`.
***************************************************************************/
public String type()
{
return (values.get("type").textValue());
}
/***************************************************************************
** Anchor, offsets, box and content alignment, as the scene states them.
***************************************************************************/
public Placement placement()
{
return (placement);
}
/***************************************************************************
** A property's value as JSON, or null when the element does not state it.
***************************************************************************/
public JsonNode value(String name)
{
return (values.get(name));
}
/***************************************************************************
** A length in one of the allowed units, or the fallback when the element
** does not state it. A `dot` length stated outside an override depends on
** the printer, which the author is told.
***************************************************************************/
public Length length(String name, Length fallback, Set<Length.Unit> units)
{
JsonNode value = values.get(name);
if(value == null)
{
return (fallback);
}
Length length;
try
{
length = Length.parse(value.textValue());
}
catch(IllegalArgumentException expected)
{
throw invalid(name);
}
if(!units.contains(length.unit()))
{
throw invalid(name);
}
if(length.unit() == Length.Unit.DOT && !pointers.containsKey(name))
{
diagnostics.warn("DEVICE_UNIT_USED", id, pointer(name), null, null, null);
}
return (length);
}
/***************************************************************************
** A true or false property, or the fallback when the element does not state
** it.
***************************************************************************/
public boolean flag(String name, boolean fallback)
{
JsonNode value = values.get(name);
if(value == null)
{
return (fallback);
}
if(!value.isBoolean())
{
throw invalid(name);
}
return (value.booleanValue());
}
/***************************************************************************
** One word of a fixed set, or the fallback when the element does not state
** it. `lookup` answers null for a word outside the set.
***************************************************************************/
public <T> T choice(String name, T fallback, Function<String, T> lookup)
{
JsonNode value = values.get(name);
if(value == null)
{
return (fallback);
}
T choice = lookup.apply(value.textValue());
if(choice == null)
{
throw invalid(name);
}
return (choice);
}
/***************************************************************************
** Clockwise rotation of text, a barcode or an image: 0, 90, 180 or 270.
***************************************************************************/
public int rotation()
{
JsonNode value = values.get("rotation");
if(value == null)
{
return (0);
}
if(!value.isIntegralNumber() || !value.canConvertToInt() || !Set.of(0, 90, 180, 270).contains(value.intValue()))
{
throw invalid("rotation");
}
return (value.intValue());
}
/***************************************************************************
** The refusal for a property the element states wrongly, or lacks. A member
** of a property that is an object is named with a slash: `fit/maxLines`.
***************************************************************************/
public Refusal invalid(String name)
{
return (refuse("SCENE_INVALID", name));
}
/***************************************************************************
** The refusal, by its own code, for a property that is well formed but names
** something this renderer does not have, such as a font.
***************************************************************************/
public Refusal refuse(String code, String name)
{
return (diagnostics.refuse(code, id, pointer(name), null, null, null));
}
/***************************************************************************
** Refuse an element that states a property its type does not read. The
** names themselves are not reported: only declared names leave the renderer.
***************************************************************************/
void only(Set<String> properties)
{
int unknown = Math.toIntExact(values.keySet().stream().filter(name -> !ElementFactory.COMMON.contains(name) && !properties.contains(name)).count());
if(unknown > 0)
{
throw diagnostics.refuse("SCENE_INVALID", id, pointer, null, Map.of("unknownProperties", unknown), Map.of("unknownProperties", 0));
}
}
/***************************************************************************
** Give the element the scene's `defaults` for the properties its type reads
** and it does not state. A default is reported where the scene states it.
***************************************************************************/
void inherit(JsonNode defaults, Set<String> properties)
{
for(Map.Entry<String, JsonNode> property : defaults.properties())
{
if(properties.contains(property.getKey()) && !values.containsKey(property.getKey()))
{
values.put(property.getKey(), property.getValue());
pointers.put(property.getKey(), "/defaults/" + property.getKey());
}
}
}
/***************************************************************************
** Where a property is stated: in the override that set it, in the scene's
** defaults, else in the element. A member of a property that is an object
** (`fit/maxLines`) is in that property, wherever the property is stated.
***************************************************************************/
private String pointer(String name)
{
int member = name.indexOf('/');
String property = member < 0 ? name : name.substring(0, member);
return (pointers.getOrDefault(property, pointer + "/" + property) + (member < 0 ? "" : name.substring(member)));
}
/***************************************************************************
** A distance inward from the anchored edge. Only about the middle may it be
** negative, where it shifts left or up.
***************************************************************************/
private Length offset(String name, Placement.Position position)
{
Length offset = length(name, Length.ZERO, ANY);
if(offset.thousandths() < 0 && position != Placement.Position.CENTER)
{
throw invalid(name);
}
return (offset);
}
/***************************************************************************
** A box width or height, more than nothing; null when the scene leaves it
** to the rest of the container.
***************************************************************************/
private Length extent(String name)
{
Length extent = length(name, null, ANY);
if(extent != null && extent.thousandths() <= 0)
{
throw invalid(name);
}
return (extent);
}
}
@@ -0,0 +1,70 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.List;
/*******************************************************************************
** A resolved box in whole dots. The origin is the top left of the printable
** area, so a frame at 0, 0 touches the margins and never enters them.
*******************************************************************************/
public record Frame(int x, int y, int width, int height)
{
/***************************************************************************
** The first column to the right of the box.
***************************************************************************/
public int right()
{
return (x + width);
}
/***************************************************************************
** The first row below the box.
***************************************************************************/
public int bottom()
{
return (y + height);
}
/***************************************************************************
** Whether every dot of the other box is a dot of this one.
***************************************************************************/
public boolean contains(Frame other)
{
return (other.x >= x && other.y >= y && other.right() <= right() && other.bottom() <= bottom());
}
/***************************************************************************
** The box as a diagnostic carries it: x, y, width and height.
***************************************************************************/
public List<Integer> box()
{
return (List.of(x, y, width, height));
}
}
@@ -0,0 +1,105 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.List;
import com.kingsrook.qbits.renderer.RenderInput;
/*******************************************************************************
** A box with its own anchor, position and size whose children are placed
** relative to it. It moves a block as a unit and gives percentages something
** smaller than the label to refer to. It paints nothing itself.
*******************************************************************************/
final class GroupElement implements SceneElement
{
private final String id;
private final Placement placement;
private final List<SceneElement> children;
/***************************************************************************
** A group and the elements inside it, in paint order.
***************************************************************************/
GroupElement(ElementSource source, List<SceneElement> children)
{
id = source.id();
placement = source.placement();
this.children = List.copyOf(children);
}
/***************************************************************************
** The id the scene declares for the group.
***************************************************************************/
@Override
public String id()
{
return (id);
}
/***************************************************************************
** The group's box, by the standing rules.
***************************************************************************/
@Override
public Frame place(Layout layout)
{
return (layout.place(placement));
}
/***************************************************************************
** A group paints nothing, whatever the size of its box.
***************************************************************************/
@Override
public long paintedDots(Frame frame, int dpi)
{
return (0);
}
/***************************************************************************
** A group has no ink of its own.
***************************************************************************/
@Override
public void paint(Canvas canvas, Frame frame, RenderInput input, Diagnostics diagnostics)
{
// The scene paints the children after their group, inside its box.
}
/***************************************************************************
** The elements inside the group.
***************************************************************************/
@Override
public List<SceneElement> children()
{
return (children);
}
}
@@ -0,0 +1,166 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
/*******************************************************************************
** Anchor resolution inside one container at one resolution: lengths in, whole
** dots out. The container is the printable area or a group, and percentages
** refer to it. Integer arithmetic only.
*******************************************************************************/
public final class Layout
{
private final Frame container;
private final int dpi;
/***************************************************************************
** A container, in dots from the top left of the printable area, and the
** resolution every length resolves at.
***************************************************************************/
public Layout(Frame container, int dpi)
{
this.container = container;
this.dpi = dpi;
}
/***************************************************************************
** The box positions and percentages refer to.
***************************************************************************/
public Frame container()
{
return (container);
}
/***************************************************************************
** The render target, in dots per inch.
***************************************************************************/
public int dpi()
{
return (dpi);
}
/***************************************************************************
** The same resolution inside a smaller box, for the children of a group.
***************************************************************************/
public Layout within(Frame frame)
{
return (new Layout(frame, dpi));
}
/***************************************************************************
** The element's box by the standing rules: position to the nearest dot, size
** rounded down.
***************************************************************************/
public Frame place(Placement placement)
{
return (frame(placement.anchor(), x(placement), y(placement), width(placement), height(placement)));
}
/***************************************************************************
** The horizontal distance inward from the anchored edge, or the shift right
** on a centred axis.
***************************************************************************/
public int x(Placement placement)
{
return (placement.x().position(dpi, container.width()));
}
/***************************************************************************
** The vertical distance inward from the anchored edge, or the shift down on
** a centred axis.
***************************************************************************/
public int y(Placement placement)
{
return (placement.y().position(dpi, container.height()));
}
/***************************************************************************
** The box width, or the rest of the container when the scene states none.
***************************************************************************/
public int width(Placement placement)
{
return (extent(placement.width(), x(placement), placement.anchor().horizontal(), container.width()));
}
/***************************************************************************
** The box height, or the rest of the container when the scene states none.
***************************************************************************/
public int height(Placement placement)
{
return (extent(placement.height(), y(placement), placement.anchor().vertical(), container.height()));
}
/***************************************************************************
** A box of known size on an anchor: the same point of the box and of the
** container coincide, moved by the offsets.
***************************************************************************/
public Frame frame(Placement.Anchor anchor, int x, int y, int width, int height)
{
return (new Frame(container.x() + anchor.horizontal().place(container.width(), width, x), container.y() + anchor.vertical().place(container.height(), height, y), width, height));
}
/***************************************************************************
** Content of a measured size inside its box: text lines, a fitted barcode, a
** scaled image.
***************************************************************************/
public static Frame align(Frame box, int width, int height, Placement.Align align, Placement.Valign valign)
{
return (new Frame(box.x() + align.position().place(box.width(), width, 0), box.y() + valign.position().place(box.height(), height, 0), width, height));
}
/***************************************************************************
** A stated size is rounded down. An omitted one is what the offset leaves:
** from an edge, the container less the offset; about the middle, the
** container less the shift on both sides, so the box stays centred on it.
***************************************************************************/
private int extent(Length size, int offset, Placement.Position position, int available)
{
if(size != null)
{
return (size.size(dpi, available));
}
return (available - Math.abs(offset) * (position == Placement.Position.CENTER ? 2 : 1));
}
}
@@ -0,0 +1,250 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/*******************************************************************************
** A length as a version 2 scene writes it: a number of up to three decimals and
** a unit, such as `12.5mm`, `0.5in`, `9pt`, `25%` or `1dot`. There is no ambient
** unit, so a value read out of context is never ambiguous. A physical length
** becomes whole micrometres first (the unit the stock uses) and then dots by
** the rule its use states; no floating point takes part in a position or size.
*******************************************************************************/
public record Length(Unit unit, long thousandths)
{
public static final Length ZERO = new Length(Unit.MM, 0);
private static final Pattern SYNTAX = Pattern.compile("(-?)(0|[1-9][0-9]{0,4})(?:\\.([0-9]{1,3}))?(mm|in|pt|%|dot)");
private static final int MAXIMUM_MICROMETRES = 2_000_000;
private static final int MAXIMUM_DOTS = 32_000;
private static final int MICROMETRES_PER_INCH = 25_400;
private static final Map<String, Unit> UNITS = Map.of("mm", Unit.MM, "in", Unit.IN, "pt", Unit.PT, "%", Unit.PERCENT, "dot", Unit.DOT);
/***************************************************************************
** The five units of a scene. `%` is a share of the container and `dot` is one
** printer dot; the other three are physical.
***************************************************************************/
public enum Unit
{
MM, IN, PT, PERCENT, DOT
}
/***************************************************************************
** How a fraction of a dot is resolved. The magnitude is rounded and the sign
** restored, so a length and its negative are mirror images.
***************************************************************************/
public enum Rounding
{
NEAREST, DOWN, UP
}
/***************************************************************************
** Read one length. Anything else, including a bare number, an exponent, a
** fourth decimal, a fraction of a dot, more than the whole container or more
** than the largest stock, is refused.
***************************************************************************/
public static Length parse(String text)
{
Matcher matcher = SYNTAX.matcher(text == null ? "" : text);
if(!matcher.matches())
{
throw new IllegalArgumentException("INVALID_LENGTH");
}
String fraction = matcher.group(3) == null ? "" : matcher.group(3);
long magnitude = Long.parseLong(matcher.group(2)) * 1000 + Long.parseLong((fraction + "000").substring(0, 3));
Length length = new Length(UNITS.get(matcher.group(4)), matcher.group(1).isEmpty() ? magnitude : -magnitude);
long limit = switch(length.unit)
{
case PERCENT -> 100_000L;
case DOT -> MAXIMUM_DOTS * 1000L;
default -> Long.MAX_VALUE;
};
if(magnitude > limit || (length.unit == Unit.DOT && !fraction.isEmpty()) || (length.physical() && length.magnitude() > MAXIMUM_MICROMETRES))
{
throw new IllegalArgumentException("INVALID_LENGTH");
}
return (length);
}
/***************************************************************************
** Millimetres, inches and points are physical: the same on every printer.
***************************************************************************/
public boolean physical()
{
return (unit == Unit.MM || unit == Unit.IN || unit == Unit.PT);
}
/***************************************************************************
** Whole micrometres, nearest, with a half rounded away from zero. One inch
** is 25400 micrometres and one point is a 72nd of an inch.
***************************************************************************/
public int micrometres()
{
long micrometres = magnitude();
return (Math.toIntExact(thousandths < 0 ? -micrometres : micrometres));
}
/***************************************************************************
** The micrometres of the magnitude, not yet narrowed, so that the largest
** number the syntax allows (99999.999 of any unit) is compared with the limit
** as it is and refused by name, never as an arithmetic overflow.
***************************************************************************/
private long magnitude()
{
long magnitude = Math.abs(thousandths);
return (switch(unit)
{
case MM -> magnitude;
case IN -> (magnitude * 254 + 5) / 10;
case PT -> (magnitude * 127 + 180) / 360;
default -> throw new IllegalArgumentException("LENGTH_NOT_PHYSICAL");
});
}
/***************************************************************************
** Whole dots at a resolution. A percentage is a share of `container` dots;
** a `dot` length is itself; a physical length goes through micrometres.
***************************************************************************/
public int dots(int dpi, int container, Rounding rounding)
{
long numerator;
long denominator;
switch(unit)
{
case PERCENT ->
{
numerator = Math.abs(thousandths) * container;
denominator = 100_000;
}
case DOT ->
{
numerator = Math.abs(thousandths);
denominator = 1000;
}
default ->
{
numerator = (long) Math.abs(micrometres()) * dpi;
denominator = MICROMETRES_PER_INCH;
}
}
long magnitude = switch(rounding)
{
case NEAREST -> (numerator + denominator / 2) / denominator;
case DOWN -> numerator / denominator;
case UP -> (numerator + denominator - 1) / denominator;
};
return (Math.toIntExact(thousandths < 0 ? -magnitude : magnitude));
}
/***************************************************************************
** A position: the nearest dot, the rule the stock already uses, so the error
** is symmetric.
***************************************************************************/
public int position(int dpi, int container)
{
return (dots(dpi, container, Rounding.NEAREST));
}
/***************************************************************************
** A box width or height: rounded down, so content never leaves its designed
** box.
***************************************************************************/
public int size(int dpi, int container)
{
return (dots(dpi, container, Rounding.DOWN));
}
/***************************************************************************
** A line or box thickness: the nearest dot and never less than one, so a
** thin rule does not vanish.
***************************************************************************/
public int thickness(int dpi)
{
return (Math.max(1, absolute().dots(dpi, 0, Rounding.NEAREST)));
}
/***************************************************************************
** A barcode module from its stated minimum: up to a whole dot, because bars
** are whole dots and may not be narrower than the minimum.
***************************************************************************/
public int module(int dpi)
{
return (Math.max(1, absolute().dots(dpi, 0, Rounding.UP)));
}
/***************************************************************************
** A font size in dots, not rounded: a face is scaled by points times dpi
** over 72, so type scales continuously.
***************************************************************************/
public double scale(int dpi)
{
return (switch(absolute().unit)
{
case MM -> thousandths * (double) dpi / MICROMETRES_PER_INCH;
case IN -> thousandths * (double) dpi / 1000;
case PT -> thousandths * (double) dpi / 72_000;
default -> thousandths / 1000.0;
});
}
/***************************************************************************
** A thickness, a module and a font size have no container to be a share of.
***************************************************************************/
private Length absolute()
{
if(unit == Unit.PERCENT)
{
throw new IllegalArgumentException("LENGTH_NOT_ABSOLUTE");
}
return (this);
}
}
@@ -0,0 +1,231 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
/*******************************************************************************
** What every element states about where it sits: the point it is anchored to,
** its distances inward from that point, its box, and where content goes inside
** the box. `width` and `height` are null when the scene leaves them out, which
** means the rest of the container on that axis.
*******************************************************************************/
public record Placement(Anchor anchor, Length x, Length y, Length width, Length height, Align align, Valign valign)
{
/***************************************************************************
** One axis, three places: against the start, in the middle or against the end.
***************************************************************************/
public enum Position
{
START, CENTER, END;
/************************************************************************
** Where `size` dots begin within `available` dots. From an edge, `offset`
** runs inward. In the middle the slack is split with integer division, so
** a centred box is off by at most one dot, and `offset` shifts it right or
** down.
************************************************************************/
public int place(int available, int size, int offset)
{
return (switch(this)
{
case START -> offset;
case CENTER -> Math.floorDiv(available - size, 2) + offset;
case END -> available - size - offset;
});
}
}
/***************************************************************************
** Horizontal placement of content in its box.
***************************************************************************/
public enum Align
{
LEFT("left", Position.START), CENTER("center", Position.CENTER), RIGHT("right", Position.END);
private final String word;
private final Position position;
/************************************************************************
** The word a scene writes and the place it means.
************************************************************************/
Align(String word, Position position)
{
this.word = word;
this.position = position;
}
/************************************************************************
** The place on the horizontal axis.
************************************************************************/
public Position position()
{
return (position);
}
/************************************************************************
** The value a scene word names, or null.
************************************************************************/
public static Align of(String word)
{
for(Align align : values())
{
if(align.word.equals(word))
{
return (align);
}
}
return (null);
}
}
/***************************************************************************
** Vertical placement of content in its box.
***************************************************************************/
public enum Valign
{
TOP("top", Position.START), MIDDLE("middle", Position.CENTER), BOTTOM("bottom", Position.END);
private final String word;
private final Position position;
/************************************************************************
** The word a scene writes and the place it means.
************************************************************************/
Valign(String word, Position position)
{
this.word = word;
this.position = position;
}
/************************************************************************
** The place on the vertical axis.
************************************************************************/
public Position position()
{
return (position);
}
/************************************************************************
** The value a scene word names, or null.
************************************************************************/
public static Valign of(String word)
{
for(Valign valign : values())
{
if(valign.word.equals(word))
{
return (valign);
}
}
return (null);
}
}
/***************************************************************************
** The nine points of a box. The same point of the element is placed on that
** point of its container.
***************************************************************************/
public enum Anchor
{
TOP_LEFT("top-left", Position.START, Position.START),
TOP_CENTER("top-center", Position.CENTER, Position.START),
TOP_RIGHT("top-right", Position.END, Position.START),
MIDDLE_LEFT("middle-left", Position.START, Position.CENTER),
CENTER("center", Position.CENTER, Position.CENTER),
MIDDLE_RIGHT("middle-right", Position.END, Position.CENTER),
BOTTOM_LEFT("bottom-left", Position.START, Position.END),
BOTTOM_CENTER("bottom-center", Position.CENTER, Position.END),
BOTTOM_RIGHT("bottom-right", Position.END, Position.END);
private final String word;
private final Position horizontal;
private final Position vertical;
/************************************************************************
** The word a scene writes and the place it means on each axis.
************************************************************************/
Anchor(String word, Position horizontal, Position vertical)
{
this.word = word;
this.horizontal = horizontal;
this.vertical = vertical;
}
/************************************************************************
** The place on the horizontal axis.
************************************************************************/
public Position horizontal()
{
return (horizontal);
}
/************************************************************************
** The place on the vertical axis.
************************************************************************/
public Position vertical()
{
return (vertical);
}
/************************************************************************
** The value a scene word names, or null.
************************************************************************/
public static Anchor of(String word)
{
for(Anchor anchor : values())
{
if(anchor.word.equals(word))
{
return (anchor);
}
}
return (null);
}
}
}
@@ -0,0 +1,55 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
/*******************************************************************************
** The renderer saying no to a version 2 scene, with the one error diagnostic
** that says where and by how much. Its message is the diagnostic's code, never
** anything from the scene or the record.
*******************************************************************************/
public final class Refusal extends IllegalArgumentException
{
private static final long serialVersionUID = 1L;
private final transient Diagnostic diagnostic;
/***************************************************************************
** Only the collector raises a refusal, from a diagnostic it has checked.
***************************************************************************/
Refusal(Diagnostic diagnostic)
{
super(diagnostic.code());
this.diagnostic = diagnostic;
}
/***************************************************************************
** The error this refusal is.
***************************************************************************/
public Diagnostic diagnostic()
{
return (diagnostic);
}
}
@@ -0,0 +1,213 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.renderer.RenderInput;
/*******************************************************************************
** A version 2 scene from source to label: one design in physical units,
** resolved to whole dots at the render target, composed on one canvas and
** emitted as graphic fields. Coordinates start at the top left of the
** printable area and every box is held inside it, so nothing a scene says
** can print in a margin (`Page` states the rule to the dot).
*******************************************************************************/
public final class Scene2
{
public static final String SCHEMA = "qqq-zpl-scene/2";
public static final List<Integer> RESOLUTIONS = List.of(203, 300, 600);
static final int STOCK_TOLERANCE_MICROMETRES = 500;
private static final int MICROMETRES_PER_INCH = 25_400;
/***************************************************************************
** Utility class.
***************************************************************************/
private Scene2()
{
}
/***************************************************************************
** The page and its printable area in dots at the render target: the request's
** target when it names one, else the stock's own resolution.
**
** The printable area is the stock less its margins, in micrometres, rounded
** down to whole dots: exactly the size a box of the stated printable width
** and height resolves to, so a design that fills the printable area fits at
** every resolution. It starts at the left and top margins rounded up, and is
** moved back only as far as keeps it on the page. The left and top margins
** are therefore never entered unless the page itself ends first; the far
** edge may pass the right or bottom margin by less than one dot.
***************************************************************************/
record Page(int dpi, int width, int height, Frame printable)
{
/************************************************************************
** Resolve the stock, or refuse one the printer language cannot address.
************************************************************************/
static Page of(RenderInput input)
{
RenderInput.Stock stock = input.stock;
int dpi = input.targetDpi == null ? stock.dpi() : input.targetDpi;
if(!RESOLUTIONS.contains(dpi))
{
throw new IllegalArgumentException("UNSUPPORTED_ZPL_STOCK");
}
int pageWidth = dots(stock.widthMicrons(), dpi, MICROMETRES_PER_INCH / 2);
int pageHeight = dots(stock.heightMicrons(), dpi, MICROMETRES_PER_INCH / 2);
int width = dots(stock.widthMicrons() - stock.leftMicrons() - stock.rightMicrons(), dpi, 0);
int height = dots(stock.heightMicrons() - stock.topMicrons() - stock.bottomMicrons(), dpi, 0);
int left = Math.min(dots(stock.leftMicrons(), dpi, MICROMETRES_PER_INCH - 1), pageWidth - width);
int top = Math.min(dots(stock.topMicrons(), dpi, MICROMETRES_PER_INCH - 1), pageHeight - height);
Frame printable = new Frame(left, top, width, height);
Page page = new Page(dpi, pageWidth, pageHeight, printable);
if(page.width > 9999 || page.height > 32000 || printable.width() < 1 || printable.height() < 1 || (long) printable.width() * printable.height() > Canvas.MAXIMUM_DOTS)
{
throw new IllegalArgumentException("UNSUPPORTED_ZPL_STOCK");
}
return (page);
}
/************************************************************************
** Micrometres to dots. The addend chooses the rounding: half an inch of
** micrometres for the nearest dot (the page, as the host gate computes
** it), one less than an inch to round up (the left and top margins) and
** nothing to round down (the size of the printable area, as the size of
** a box is rounded).
************************************************************************/
private static int dots(int micrometres, int dpi, int addend)
{
return (Math.toIntExact(((long) micrometres * dpi + addend) / MICROMETRES_PER_INCH));
}
}
/***************************************************************************
** Check a scene without drawing it: its grammar for every resolution, and
** its layout on this stock at the render target.
***************************************************************************/
public static void validate(RenderInput input, JsonNode scene, Diagnostics diagnostics)
{
compose(input, scene, diagnostics, false);
}
/***************************************************************************
** Draw a scene and return the label, or null when the collector kept an
** error: a refused scene has no label, so one with elements missing cannot
** be printed by mistake. The canvas of such a scene, holding the elements
** that had no error, is what `compose` answers.
***************************************************************************/
public static byte[] render(RenderInput input, JsonNode scene, Diagnostics diagnostics) throws IOException
{
Page page = Page.of(input);
Canvas canvas = compose(input, scene, diagnostics, true);
return (diagnostics.refused() ? null : ZplEmitter.emit(canvas, page.width(), page.height(), page.printable().x(), page.printable().y(), input.maximumBytes));
}
/***************************************************************************
** Parse, lay out and, when asked, paint. A refusal about the scene as a
** whole ends the pass; a refusal about one element ends that element.
***************************************************************************/
static Canvas compose(RenderInput input, JsonNode root, Diagnostics diagnostics, boolean paint)
{
Page page = Page.of(input);
Canvas canvas = new Canvas(page.printable().width(), page.printable().height(), page.dpi());
try
{
SceneParser.Scene scene = SceneParser.parse(root, page.dpi(), diagnostics);
RenderInput.Stock stock = input.stock;
if(Math.abs(stock.widthMicrons() - scene.width().micrometres()) > STOCK_TOLERANCE_MICROMETRES || Math.abs(stock.heightMicrons() - scene.height().micrometres()) > STOCK_TOLERANCE_MICROMETRES)
{
throw diagnostics.refuse("STOCK_MISMATCH", null, "/design", null, Map.of("widthMicrometres", stock.widthMicrons(), "heightMicrometres", stock.heightMicrons()),
Map.of("widthMicrometres", scene.width().micrometres(), "heightMicrometres", scene.height().micrometres(), "toleranceMicrometres", STOCK_TOLERANCE_MICROMETRES));
}
walk(scene.elements(), new Layout(new Frame(0, 0, canvas.width(), canvas.height()), page.dpi()), canvas, paint, input, diagnostics);
}
catch(Refusal refusal)
{
diagnostics.keep(refusal);
}
return (canvas);
}
/***************************************************************************
** Elements in list order: place, hold the box to the printable area, check,
** count the dots it would paint against what one scene may paint, paint
** when asked, then the children inside the box. The dots are counted when a
** scene is only validated too, so validation refuses what rendering would.
***************************************************************************/
private static void walk(List<SceneElement> elements, Layout layout, Canvas canvas, boolean paint, RenderInput input, Diagnostics diagnostics)
{
Frame printable = new Frame(0, 0, canvas.width(), canvas.height());
for(SceneElement element : elements)
{
try
{
Frame frame = element.place(layout);
if(frame.width() < 1 || frame.height() < 1)
{
throw diagnostics.refuse("SCENE_INVALID", element.id(), diagnostics.pointer(element.id()), null, Map.of("widthDots", frame.width(), "heightDots", frame.height()),
Map.of("widthDots", 1, "heightDots", 1));
}
if(!printable.contains(frame))
{
throw diagnostics.refuse("ELEMENT_OUTSIDE_PRINTABLE_AREA", element.id(), null, frame,
Map.of("leftDots", frame.x(), "topDots", frame.y(), "rightDots", frame.right(), "bottomDots", frame.bottom()),
Map.of("leftDots", 0, "topDots", 0, "rightDots", printable.right(), "bottomDots", printable.bottom()));
}
element.check(frame, input, diagnostics);
long dots = element.paintedDots(frame, layout.dpi());
if(!canvas.admit(dots))
{
throw diagnostics.refuse("SCENE_INVALID", element.id(), diagnostics.pointer(element.id()), frame, Map.of("paintedPercent", canvas.paintedPercent(dots)),
Map.of("paintedPercent", Canvas.MAXIMUM_COATS * 100));
}
if(paint)
{
element.paint(canvas, frame, input, diagnostics);
}
walk(element.children(), layout.within(frame), canvas, paint, input, diagnostics);
}
catch(Refusal refusal)
{
diagnostics.keep(refusal);
}
}
}
}
@@ -0,0 +1,85 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.List;
import com.kingsrook.qbits.renderer.RenderInput;
/*******************************************************************************
** One element of a version 2 scene after parsing. The scene walks its elements
** in list order: place, check that the box is inside the printable area, check
** the element itself, paint, then the same for its children inside its box.
*******************************************************************************/
public interface SceneElement
{
/***************************************************************************
** The id the scene declares for the element.
***************************************************************************/
String id();
/***************************************************************************
** The element's box, in dots, inside the layout's container.
***************************************************************************/
Frame place(Layout layout);
/***************************************************************************
** Checks that need no ink, run when a scene is validated and again before it
** is painted. An element that cannot be drawn refuses here.
***************************************************************************/
default void check(Frame frame, RenderInput input, Diagnostics diagnostics)
{
}
/***************************************************************************
** The dots the element paints in this box, counted against what one scene
** may paint (`Canvas.MAXIMUM_COATS`) before any ink. An element paints only
** inside its box, so the box is the answer unless the element knows less.
***************************************************************************/
default long paintedDots(Frame frame, int dpi)
{
return ((long) frame.width() * frame.height());
}
/***************************************************************************
** Draw the element in its box.
***************************************************************************/
void paint(Canvas canvas, Frame frame, RenderInput input, Diagnostics diagnostics);
/***************************************************************************
** The elements positioned relative to this one's box; only a group has any.
***************************************************************************/
default List<SceneElement> children()
{
return (List.of());
}
}
@@ -0,0 +1,375 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
import com.fasterxml.jackson.databind.JsonNode;
/*******************************************************************************
** The parser of `qqq-zpl-scene/2`, a format written by template authors and so
** untrusted. It reads only the documented grammar: an unknown property, a
** wrong type, a bad length or a limit passed is `SCENE_INVALID` at the JSON
** pointer of the offending place. It evaluates nothing and reads no record
** data.
**
** The whole structure is checked first, which declares every element id, and
** the elements are then built once for each resolution a printer can have, so
** an override meant for another printer cannot hide a mistake until that
** printer is used. The elements of the requested resolution are returned.
*******************************************************************************/
final class SceneParser
{
static final int MAXIMUM_ELEMENTS = 1000;
static final int MAXIMUM_DEPTH = 4;
static final int MAXIMUM_OVERRIDES = 32;
static final int MAXIMUM_SAMPLES = 16;
private static final Set<String> TOP = Set.of("schema", "design", "defaults", "samples", "elements", "overrides");
private static final Set<String> FIXED = Set.of("id", "type", "children");
private static final Pattern FONT = Pattern.compile("[A-Za-z0-9_-][A-Za-z0-9_.-]{0,99}");
private final JsonNode root;
private final Diagnostics diagnostics;
private int elements;
/***************************************************************************
** What a scene says once parsed: the stock it was drawn for and its
** elements for one resolution, in paint order.
***************************************************************************/
record Scene(Length width, Length height, List<SceneElement> elements)
{
}
/***************************************************************************
** One scene and the collector that will hold its ids and findings.
***************************************************************************/
private SceneParser(JsonNode root, Diagnostics diagnostics)
{
this.root = root;
this.diagnostics = diagnostics;
}
/***************************************************************************
** Parse a scene for one of the three resolutions.
***************************************************************************/
static Scene parse(JsonNode root, int dpi, Diagnostics diagnostics)
{
SceneParser parser = new SceneParser(root, diagnostics);
parser.structure();
Length width = parser.physical(root.get("design").get("width"), "/design/width");
Length height = parser.physical(root.get("design").get("height"), "/design/height");
Scene scene = new Scene(width, height, parser.build(root.get("elements"), "/elements", dpi));
for(int other : Scene2.RESOLUTIONS)
{
if(other != dpi)
{
parser.build(root.get("elements"), "/elements", other);
}
}
return (scene);
}
/***************************************************************************
** Everything that does not depend on the resolution.
***************************************************************************/
private void structure()
{
object(root, "", TOP);
if(!Scene2.SCHEMA.equals(root.path("schema").textValue()))
{
throw invalid(null, "/schema");
}
object(root.get("design"), "/design", Set.of("width", "height"));
JsonNode defaults = root.get("defaults");
if(defaults != null)
{
object(defaults, "/defaults", Set.of("font", "size"));
String font = defaults.path("font").textValue();
if(defaults.has("font") && (font == null || !FONT.matcher(font).matches()))
{
throw invalid(null, "/defaults/font");
}
if(defaults.has("size"))
{
physical(defaults.get("size"), "/defaults/size");
}
}
JsonNode samples = root.get("samples");
if(samples != null)
{
object(samples, "/samples", null);
if(samples.size() > MAXIMUM_SAMPLES)
{
throw diagnostics.refuse("SCENE_INVALID", null, "/samples", null, Map.of("samples", samples.size()), Map.of("samples", MAXIMUM_SAMPLES));
}
samples.forEach(sample -> object(sample, "/samples", null));
}
declare(root.get("elements"), "/elements", 1);
JsonNode overrides = root.get("overrides");
if(overrides != null)
{
array(overrides, "/overrides");
if(overrides.size() > MAXIMUM_OVERRIDES)
{
throw diagnostics.refuse("SCENE_INVALID", null, "/overrides", null, Map.of("overrides", overrides.size()), Map.of("overrides", MAXIMUM_OVERRIDES));
}
for(int index = 0; index < overrides.size(); index++)
{
override(overrides.get(index), "/overrides/" + index);
}
}
}
/***************************************************************************
** Declare every element id, depth first, before anything refers to one. An
** id is the only author text a diagnostic may carry, so it is held to its
** pattern here and must be unique.
***************************************************************************/
private void declare(JsonNode list, String pointer, int depth)
{
array(list, pointer);
for(int index = 0; index < list.size(); index++)
{
JsonNode element = list.get(index);
String at = pointer + "/" + index;
if(++elements > MAXIMUM_ELEMENTS)
{
throw diagnostics.refuse("SCENE_INVALID", null, "/elements", null, Map.of("elements", elements), Map.of("elements", MAXIMUM_ELEMENTS));
}
object(element, at, null);
String id = element.path("id").textValue();
if(id == null || !Diagnostics.ID.matcher(id).matches() || diagnostics.declared(id))
{
throw invalid(null, at + "/id");
}
diagnostics.declare(id, at);
String type = element.path("type").textValue();
if("group".equals(type))
{
if(depth > MAXIMUM_DEPTH)
{
throw diagnostics.refuse("SCENE_INVALID", id, at, null, Map.of("depth", depth), Map.of("depth", MAXIMUM_DEPTH));
}
declare(element.get("children"), at + "/children", depth + 1);
}
else if(type == null || !ElementFactory.FACTORIES.containsKey(type))
{
throw invalid(id, at + "/type");
}
}
}
/***************************************************************************
** One override: the resolutions it is for, and replacement properties by
** element id. It may not change what an element is.
***************************************************************************/
private void override(JsonNode override, String pointer)
{
object(override, pointer, Set.of("when", "set"));
JsonNode when = override.get("when");
JsonNode set = override.get("set");
object(when, pointer + "/when", Set.of("dpi"));
array(when.get("dpi"), pointer + "/when/dpi");
Set<Integer> resolutions = new HashSet<>();
for(JsonNode dpi : when.get("dpi"))
{
if(!dpi.isIntegralNumber() || !dpi.canConvertToInt() || !Scene2.RESOLUTIONS.contains(dpi.intValue()) || !resolutions.add(dpi.intValue()))
{
throw invalid(null, pointer + "/when/dpi");
}
}
if(resolutions.isEmpty())
{
throw invalid(null, pointer + "/when/dpi");
}
object(set, pointer + "/set", null);
if(set.isEmpty())
{
throw invalid(null, pointer + "/set");
}
for(Map.Entry<String, JsonNode> entry : set.properties())
{
if(!diagnostics.declared(entry.getKey()))
{
throw invalid(null, pointer + "/set");
}
JsonNode replacement = entry.getValue();
if(!replacement.isObject() || replacement.isEmpty() || FIXED.stream().anyMatch(replacement::has))
{
throw invalid(entry.getKey(), pointer + "/set/" + entry.getKey());
}
}
}
/***************************************************************************
** Build a list of elements for one resolution, with the overrides for it.
***************************************************************************/
private List<SceneElement> build(JsonNode list, String pointer, int dpi)
{
List<SceneElement> built = new ArrayList<>();
for(int index = 0; index < list.size(); index++)
{
JsonNode element = list.get(index);
String at = pointer + "/" + index;
String id = element.get("id").textValue();
Map<String, JsonNode> overrides = new LinkedHashMap<>();
Map<String, String> pointers = new LinkedHashMap<>();
JsonNode all = root.path("overrides");
for(int entry = 0; entry < all.size(); entry++)
{
JsonNode replacement = all.get(entry).get("set").get(id);
if(replacement != null && applies(all.get(entry), dpi))
{
String from = "/overrides/" + entry + "/set/" + id + "/";
replacement.properties().forEach(property ->
{
overrides.put(property.getKey(), property.getValue());
pointers.put(property.getKey(), from + property.getKey());
});
}
}
ElementSource source = new ElementSource(id, at, element, overrides, pointers, diagnostics);
if("group".equals(source.type()))
{
source.only(Set.of("children"));
built.add(new GroupElement(source, build(element.get("children"), at + "/children", dpi)));
}
else
{
ElementFactory factory = ElementFactory.FACTORIES.get(source.type());
source.only(factory.properties());
source.inherit(root.path("defaults"), factory.properties());
built.add(factory.create(source));
}
}
return (built);
}
/***************************************************************************
** Whether an override is for a resolution.
***************************************************************************/
private static boolean applies(JsonNode override, int dpi)
{
for(JsonNode resolution : override.get("when").get("dpi"))
{
if(resolution.intValue() == dpi)
{
return (true);
}
}
return (false);
}
/***************************************************************************
** A physical length that is more than nothing: a stock side or a type size.
***************************************************************************/
private Length physical(JsonNode value, String pointer)
{
try
{
Length length = Length.parse(value == null ? null : value.textValue());
if(length.physical() && length.thousandths() > 0)
{
return (length);
}
}
catch(IllegalArgumentException expected)
{
// Refused below, with the pointer; the cause holds nothing more.
}
throw invalid(null, pointer);
}
/***************************************************************************
** A JSON object whose properties are all among `names`, when names are
** given. Unknown names are counted, never repeated.
***************************************************************************/
private void object(JsonNode node, String pointer, Set<String> names)
{
if(node == null || !node.isObject())
{
throw invalid(null, pointer);
}
if(names != null)
{
int unknown = 0;
for(Map.Entry<String, JsonNode> property : node.properties())
{
unknown += names.contains(property.getKey()) ? 0 : 1;
}
if(unknown > 0)
{
throw diagnostics.refuse("SCENE_INVALID", null, pointer, null, Map.of("unknownProperties", unknown), Map.of("unknownProperties", 0));
}
}
}
/***************************************************************************
** A JSON array; each caller holds it to its own bound.
***************************************************************************/
private void array(JsonNode node, String pointer)
{
if(node == null || !node.isArray())
{
throw invalid(null, pointer);
}
}
/***************************************************************************
** The refusal for a place in the scene that is not what the schema says.
***************************************************************************/
private Refusal invalid(String element, String pointer)
{
return (diagnostics.refuse("SCENE_INVALID", element, pointer, null, null, null));
}
}
@@ -0,0 +1,94 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import com.kingsrook.qbits.renderer.RenderInput;
/*******************************************************************************
** An element the schema declares but this renderer cannot draw yet. It is
** parsed and placed like any other, so its box is checked and reported, and it
** is then refused by name: a scene that needs it needs a newer renderer. It is
** never drawn as something else and never skipped.
*******************************************************************************/
public final class UnavailableElement implements SceneElement
{
private final String id;
private final Placement placement;
/***************************************************************************
** The placeholder for one element; its rotation is read so a bad one is
** still refused as the scene's mistake.
***************************************************************************/
public UnavailableElement(ElementSource source)
{
id = source.id();
placement = source.placement();
source.rotation();
}
/***************************************************************************
** The id the scene declares for the element.
***************************************************************************/
@Override
public String id()
{
return (id);
}
/***************************************************************************
** The element's box, by the standing rules.
***************************************************************************/
@Override
public Frame place(Layout layout)
{
return (layout.place(placement));
}
/***************************************************************************
** Refused when the scene is validated and before any ink.
***************************************************************************/
@Override
public void check(Frame frame, RenderInput input, Diagnostics diagnostics)
{
throw diagnostics.refuse("RENDERER_TOO_OLD", id, null, frame, null, null);
}
/***************************************************************************
** Never reached through the scene, which checks first; refused all the same.
***************************************************************************/
@Override
public void paint(Canvas canvas, Frame frame, RenderInput input, Diagnostics diagnostics)
{
throw diagnostics.refuse("RENDERER_TOO_OLD", id, null, frame, null, null);
}
}
@@ -0,0 +1,130 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.HexFormat;
import com.kingsrook.qbits.renderer.Wire;
/*******************************************************************************
** A canvas as printer commands: the header version 1 writes, then uncompressed
** `^GFA` graphic fields, then the end of the label. Nothing else is emitted,
** so the host's output policy accepts a version 2 label with no change.
**
** Only ink is sent. Rows are cut into bands wherever at least `BLANK_ROWS`
** blank rows separate ink, each band is trimmed to its inked columns, and a
** band taller than one field may hold is continued in the next field. A band
** needs at least one inked row and is followed by a gap, so a label of the
** greatest height has far fewer fields than the policy allows.
*******************************************************************************/
final class ZplEmitter
{
static final int BLANK_ROWS = 8;
static final int MAXIMUM_FIELD_BYTES = 99_999;
/***************************************************************************
** Utility class.
***************************************************************************/
private ZplEmitter()
{
}
/***************************************************************************
** The label for a page of `pageWidth` by `pageHeight` dots whose printable
** area, the canvas, starts at `originX`, `originY`.
***************************************************************************/
static byte[] emit(Canvas canvas, int pageWidth, int pageHeight, int originX, int originY, int maximumBytes) throws IOException
{
Wire.Bytes output = new Wire.Bytes(maximumBytes);
write(output, "^XA^PW" + pageWidth + "^LL" + pageHeight + "^LH0,0^CI28\n");
int row = 0;
while(row < canvas.height())
{
if(canvas.firstInk(row) < 0)
{
row++;
continue;
}
int last = row;
int left = canvas.width();
int right = 0;
for(int next = row; next < canvas.height() && next - last <= BLANK_ROWS; next++)
{
int first = canvas.firstInk(next);
if(first >= 0)
{
last = next;
left = Math.min(left, first);
right = Math.max(right, canvas.lastInk(next));
}
}
int stride = (right - left + 8) / 8;
int rowsPerField = MAXIMUM_FIELD_BYTES / stride;
for(int first = row; first <= last; first += rowsPerField)
{
field(output, canvas, left, right, first, Math.min(rowsPerField, last + 1 - first), originX, originY);
}
row = last + 1;
}
write(output, "^XZ\n");
return (output.result());
}
/***************************************************************************
** One graphic field: `rows` rows of the canvas from column `left` to column
** `right`, most significant bit first, with the padding bits left white.
***************************************************************************/
private static void field(Wire.Bytes output, Canvas canvas, int left, int right, int top, int rows, int originX, int originY) throws IOException
{
int stride = (right - left + 8) / 8;
byte[] raster = new byte[stride * rows];
for(int row = 0; row < rows; row++)
{
for(int column = left; column <= right; column++)
{
if(canvas.get(column, top + row))
{
raster[row * stride + (column - left) / 8] |= (byte) (128 >> (column - left) % 8);
}
}
}
write(output, "^FO" + (originX + left) + "," + (originY + top) + "^GFA," + raster.length + "," + raster.length + "," + stride + "," + HexFormat.of().withUpperCase().formatHex(raster) + "^FS\n");
}
/***************************************************************************
** All output is generated ASCII.
***************************************************************************/
private static void write(Wire.Bytes output, String value) throws IOException
{
output.write(value.getBytes(StandardCharsets.US_ASCII));
}
}
@@ -0,0 +1,61 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2.barcode;
import java.util.Set;
import com.kingsrook.qbits.renderer.scene2.ElementFactory;
import com.kingsrook.qbits.renderer.scene2.ElementSource;
import com.kingsrook.qbits.renderer.scene2.SceneElement;
import com.kingsrook.qbits.renderer.scene2.UnavailableElement;
/*******************************************************************************
** Barcodes: a symbol fitted to its box in whole-dot modules, never below its
** stated minimum.
**
** This is the placeholder of the scene 2 core: a `barcode` element is parsed and
** placed, then refused as `RENDERER_TOO_OLD`. The package that draws it
** replaces this class and nothing else.
*******************************************************************************/
public final class BarcodeFactory implements ElementFactory
{
/***************************************************************************
** The property names the design gives a `barcode` element. Their values are
** not read yet.
***************************************************************************/
@Override
public Set<String> properties()
{
return (Set.of("symbology", "symbologyPath", "allowedSymbologies", "value", "valuePath", "minModule", "maxModule", "quiet", "gs1", "hri", "scannerSymbologyPath", "aimIdentifierPath", "rotation"));
}
/***************************************************************************
** The element, placed and then refused by name.
***************************************************************************/
@Override
public SceneElement create(ElementSource source)
{
return (new UnavailableElement(source));
}
}
@@ -0,0 +1,60 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2.graphics;
import java.util.Set;
import com.kingsrook.qbits.renderer.scene2.ElementFactory;
import com.kingsrook.qbits.renderer.scene2.ElementSource;
import com.kingsrook.qbits.renderer.scene2.SceneElement;
import com.kingsrook.qbits.renderer.scene2.UnavailableElement;
/*******************************************************************************
** Images: an asset scaled into a physical box and reduced to black and white.
**
** This is the placeholder of the scene 2 core: a `image` element is parsed and
** placed, then refused as `RENDERER_TOO_OLD`. The package that draws it
** replaces this class and nothing else.
*******************************************************************************/
public final class GraphicsFactory implements ElementFactory
{
/***************************************************************************
** The property names the design gives a `image` element. Their values are
** not read yet.
***************************************************************************/
@Override
public Set<String> properties()
{
return (Set.of("asset", "fit", "mode", "rotation"));
}
/***************************************************************************
** The element, placed and then refused by name.
***************************************************************************/
@Override
public SceneElement create(ElementSource source)
{
return (new UnavailableElement(source));
}
}
@@ -0,0 +1,345 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2.text;
import java.awt.Font;
import java.awt.FontFormatException;
import java.awt.font.FontRenderContext;
import java.awt.font.GlyphVector;
import java.awt.font.LineMetrics;
import java.awt.geom.Rectangle2D;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
/*******************************************************************************
** The faces bundled with the renderer, by the name a scene writes. Each is an
** unmodified TrueType file under the SIL Open Font License 1.1, shipped in the
** jar beside its licence, provenance and hash (`/fonts`). No installed font is
** ever used and there is no fallback between faces.
**
** Every number here is in thousandths of the em, read once from the face at a
** reference size of 1000, where the bundled faces (1000 units to the em) give
** whole numbers. Layout multiplies those integers by the size and never asks
** the font for a measurement at the size it draws, so a measurement is the
** same on every machine.
**
** The four numbers after the widest character are the most any character of
** the face reaches past its own advance on the left and on the right, above
** the baseline and below it. They bound every character, so a value that was
** never seen can be proven to fit; a test recomputes them from the font file.
*******************************************************************************/
public final class Face
{
public static final Face SANS = new Face("qqq-sans", "ibm-plex-sans/IBMPlexSans-Regular.ttf", false, 0x2030, 203, 203, 1119, 245);
public static final Face SANS_BOLD = new Face("qqq-sans-bold", "ibm-plex-sans/IBMPlexSans-Bold.ttf", true, 0x2030, 245, 245, 1150, 275);
public static final Face CONDENSED_BOLD = new Face("qqq-condensed-bold", "ibm-plex-sans-condensed/IBMPlexSansCondensed-Bold.ttf", true, 0x2030, 241, 241, 1150, 275);
public static final Face MONO = new Face("qqq-mono", "jetbrains-mono/JetBrainsMono-Regular.ttf", false, 0x21, 165, 165, 1120, 400);
public static final Face MONO_BOLD = new Face("qqq-mono-bold", "jetbrains-mono/JetBrainsMono-Bold.ttf", true, 0x21, 165, 165, 1120, 400);
static final FontRenderContext CONTEXT = new FontRenderContext(null, true, true);
static final int REFERENCE = 1000;
private static final List<Face> ALL = List.of(SANS, SANS_BOLD, CONDENSED_BOLD, MONO, MONO_BOLD);
/////////////////////////////////////////////////////////////////////////////////////////////////
// characters that cannot be drawn one glyph each from left to right: controls and formats //
// (which would print nothing), marks (which need placing on the letter before) and the like //
/////////////////////////////////////////////////////////////////////////////////////////////////
private static final Set<Integer> UNDRAWN = Set.of((int) Character.CONTROL, (int) Character.FORMAT, (int) Character.SURROGATE, (int) Character.PRIVATE_USE, (int) Character.UNASSIGNED,
(int) Character.LINE_SEPARATOR, (int) Character.PARAGRAPH_SEPARATOR, (int) Character.NON_SPACING_MARK, (int) Character.ENCLOSING_MARK, (int) Character.COMBINING_SPACING_MARK);
private final String scene;
private final String file;
private final boolean bold;
private final int widest;
private final int left;
private final int right;
private final int top;
private final int bottom;
private final Map<Integer, Glyph> glyphs = new ConcurrentHashMap<>();
private Font font;
/***************************************************************************
** One character of a face: how far the pen moves, and the box its outline
** fills, from the pen (`left`, `right`) and from the baseline (`top` above,
** `bottom` below), rounded outward. A space has no ink; only U+0020 is a
** `space`, the one place a line may be broken between words.
***************************************************************************/
public record Glyph(int advance, int left, int right, int top, int bottom, boolean ink, boolean space)
{
}
/***************************************************************************
** A face, where its file is, and the bounds a test holds it to.
***************************************************************************/
private Face(String scene, String file, boolean bold, int widest, int left, int right, int top, int bottom)
{
this.scene = scene;
this.file = file;
this.bold = bold;
this.widest = widest;
this.left = left;
this.right = right;
this.top = top;
this.bottom = bottom;
}
/***************************************************************************
** The bundled set: a proportional sans in regular and bold, a condensed bold
** for long values on narrow labels, and a monospace in regular and bold.
***************************************************************************/
public static List<Face> all()
{
return (ALL);
}
/***************************************************************************
** The face a scene names, or null.
***************************************************************************/
public static Face of(String scene)
{
for(Face face : ALL)
{
if(face.scene.equals(scene))
{
return (face);
}
}
return (null);
}
/***************************************************************************
** The name a scene writes.
***************************************************************************/
public String scene()
{
return (scene);
}
/***************************************************************************
** The font file, under `/fonts` in the jar.
***************************************************************************/
public String file()
{
return (file);
}
/***************************************************************************
** Whether the strokes are bold. A regular face prints light when small.
***************************************************************************/
public boolean bold()
{
return (bold);
}
/***************************************************************************
** The character with the greatest advance, the lowest when several share it.
***************************************************************************/
public int widest()
{
return (widest);
}
/***************************************************************************
** A character no real one exceeds in any direction: the greatest advance and
** the greatest reach on each side. A line of these is at least as wide and
** as tall as a line of the same number of any characters of the face.
***************************************************************************/
public Glyph worst()
{
int advance = glyph(widest).advance();
return (new Glyph(advance, -left, advance + right, top, bottom, true, false));
}
/***************************************************************************
** The face at a size in dots, for drawing only.
***************************************************************************/
Font font(float size)
{
return (reference().deriveFont(size));
}
/***************************************************************************
** Height above the baseline that a line reserves.
***************************************************************************/
public int ascent()
{
return (Math.round(metrics().getAscent()));
}
/***************************************************************************
** Depth below the baseline that a line reserves.
***************************************************************************/
public int descent()
{
return (Math.round(metrics().getDescent()));
}
/***************************************************************************
** Extra space the face asks for between lines.
***************************************************************************/
public int leading()
{
return (Math.round(metrics().getLeading()));
}
/***************************************************************************
** The height of a capital letter, which is what legibility is judged by.
***************************************************************************/
public int capHeight()
{
return (glyph('H').top());
}
/***************************************************************************
** Whether the face can draw a character as one glyph, left to right.
***************************************************************************/
public boolean draws(int codePoint)
{
return (codePoint <= Character.MAX_VALUE && !UNDRAWN.contains(Character.getType(codePoint)) && reference().canDisplay(codePoint)
&& !Font.textRequiresLayout(new char[] {(char) codePoint}, 0, 1));
}
/***************************************************************************
** How many characters of a text the face cannot draw.
***************************************************************************/
public int missing(String text)
{
return (Math.toIntExact(text.codePoints().filter(codePoint -> !draws(codePoint)).count()));
}
/***************************************************************************
** The measurements of one character the face draws.
***************************************************************************/
public Glyph glyph(int codePoint)
{
return (glyphs.computeIfAbsent(codePoint, this::measure));
}
/***************************************************************************
** The measurements of a text the face draws, one for each character.
***************************************************************************/
public Glyph[] glyphs(String text)
{
return (text.codePoints().mapToObj(this::glyph).toArray(Glyph[]::new));
}
/***************************************************************************
** Read one character from the face at the reference size.
***************************************************************************/
private Glyph measure(int codePoint)
{
GlyphVector vector = reference().createGlyphVector(CONTEXT, new char[] {(char) codePoint});
int advance = Math.round(vector.getGlyphMetrics(0).getAdvanceX());
Rectangle2D bounds = vector.getGlyphOutline(0).getBounds2D();
if(bounds.isEmpty())
{
return (new Glyph(advance, 0, 0, 0, 0, false, codePoint == ' '));
}
return (new Glyph(advance, (int) Math.floor(bounds.getMinX()), (int) Math.ceil(bounds.getMaxX()), (int) Math.ceil(-bounds.getMinY()), (int) Math.ceil(bounds.getMaxY()), true, false));
}
/***************************************************************************
** The line metrics of the face at the reference size.
***************************************************************************/
private LineMetrics metrics()
{
return (reference().getLineMetrics("H", CONTEXT));
}
/***************************************************************************
** The face at the reference size, read from the jar the first time.
***************************************************************************/
private synchronized Font reference()
{
if(font == null)
{
font = load("/fonts/" + file);
}
return (font);
}
/***************************************************************************
** Read a TrueType file from the jar. A file that is not a font is a broken
** build, not a mistake in a scene, so it is an illegal state.
***************************************************************************/
static Font load(String resource)
{
try(InputStream stream = Face.class.getResourceAsStream(resource))
{
return (Font.createFont(Font.TRUETYPE_FONT, stream).deriveFont((float) REFERENCE));
}
catch(IOException | FontFormatException broken)
{
throw new IllegalStateException("BUNDLED_FONT_UNREADABLE", broken);
}
}
}
@@ -0,0 +1,565 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2.text;
import java.math.BigDecimal;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.WeakHashMap;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.kingsrook.qbits.renderer.RenderInput;
import com.kingsrook.qbits.renderer.scene2.Canvas;
import com.kingsrook.qbits.renderer.scene2.Diagnostics;
import com.kingsrook.qbits.renderer.scene2.ElementSource;
import com.kingsrook.qbits.renderer.scene2.Frame;
import com.kingsrook.qbits.renderer.scene2.Layout;
import com.kingsrook.qbits.renderer.scene2.Length;
import com.kingsrook.qbits.renderer.scene2.Placement;
import com.kingsrook.qbits.renderer.scene2.SceneElement;
/*******************************************************************************
** A `text` element: one value in one bundled face, measured before it is
** drawn, placed in its box by `align` and `valign`, and fitted by the rule the
** element states (`TextFit`). The value is a literal (`value`) or is read from
** the record by a JSON pointer (`valuePath`).
**
** Every refusal names the element and carries numbers only: a width, a line
** count, a size, a count of characters. The value itself never enters a
** diagnostic or an exception.
**
** A bound value is not known when a scene is validated, so validation reads no
** record. With `maxLength` it proves instead that the longest value fits whole:
** that many of the face's widest character, each taken to reach as far in
** every direction as the furthest-reaching character of the face. The proof
** never cuts. When it fails the scene is refused, unless the element asked for
** cutting: then the scene stands, with the warning `FIT_NOT_PROVEN` and the
** longest length that is proven. Without `maxLength` it warns `FIT_NOT_PROVEN`
** with no number. When rendering, a value longer than `maxLength` is refused
** before any layout.
**
** The text of one scene is held to a stated amount of work (`SCENE_WORK_STEPS`):
** every character visited while fitting counts one step, every character of
** a text that is to be drawn counts `TextRaster.PEN_STEPS`, and every glyph
** the scene draws for the first time at a size, which the runtime must
** rasterise, counts `TextRaster.GLYPH_STEPS`. A scene that passes it is
** refused by name at the element that did, and so is every text after it.
** The count is integer arithmetic, the same on every machine, and the same
** whether the scene is validated or rendered.
*******************************************************************************/
final class TextElement implements SceneElement
{
static final int MAXIMUM_CHARACTERS = 1024;
static final int MAXIMUM_LINES = 64;
static final int MINIMUM_MILLIPOINTS = 1000;
static final int MAXIMUM_MILLIPOINTS = 1_000_000;
static final int DEFAULT_FLOOR_PERCENT = 70;
static final int DEFAULT_FLOOR_MILLIPOINTS = 5000;
static final int DEFAULT_THRESHOLD = 128;
/////////////////////////////////////////////////////////////////////////////////////////////////
// capital heights in dots below which thermal print is hard to read: any face under 12 (about //
// 6 pt at 203 dpi), a regular weight under 20 (about 10 pt at 203 dpi). Starting values, to //
// be confirmed on the printed specimen //
/////////////////////////////////////////////////////////////////////////////////////////////////
static final int SMALL_CAPITAL_DOTS = 12;
static final int LIGHT_CAPITAL_DOTS = 20;
/////////////////////////////////////////////////////////////////////////////////////////////////
// the work the text of one scene may take, in steps. A value of forty characters costs //
// about a hundred thousand at a size its scene has not drawn, nearly all of it for the //
// glyphs the runtime must rasterise, and under two thousand at a size it has. The //
// allowance is fifteen thousand glyphs rasterised, or three thousand fits of the longest //
// value over the widest range of sizes: about a second of the worker, where one hostile //
// scene took minutes //
/////////////////////////////////////////////////////////////////////////////////////////////////
static final int SCENE_WORK_STEPS = 64_000_000;
private static final Set<String> FIT = Set.of("maxLines", "shrinkTo", "overflow");
/////////////////////////////////////////////////////////////////////////////////////////////////
// the work of each scene, by the collector of its one render or validation, which is all a //
// text element is given that belongs to the scene; it is forgotten with the collector //
/////////////////////////////////////////////////////////////////////////////////////////////////
private static final Map<Diagnostics, Scene> SCENES = Collections.synchronizedMap(new WeakHashMap<>());
private final String id;
private final Placement placement;
private final int rotation;
private final boolean reverse;
private final Face face;
private final int size;
private final int floor;
private final Integer lineHeight;
private final int maxLines;
private final boolean truncate;
private final Integer maxLength;
private final int threshold;
private final String value;
private final String path;
private Composed composed;
/***************************************************************************
** What the text of one scene has cost so far: the steps counted, and the
** glyphs it has drawn, each a face, a size and a character in one number.
** There are never more of those than the steps allow.
***************************************************************************/
private record Scene(TextFit.Work work, Set<Long> glyphs)
{
}
/***************************************************************************
** What `check` composed, kept for the `paint` of the same pass, so a text
** is fitted once.
***************************************************************************/
private record Composed(Frame frame, RenderInput input, Diagnostics diagnostics, TextRaster.Drawing drawing)
{
/************************************************************************
** Whether this is the answer for the same box of the same pass.
************************************************************************/
boolean of(Frame other, RenderInput request, Diagnostics collector)
{
return (frame.equals(other) && input == request && diagnostics == collector);
}
}
/***************************************************************************
** Read the element. A property that is not what the schema says is
** `SCENE_INVALID` at that property, a member of `fit` at that member; a
** member `fit` does not have is reported at `fit`, since only names the
** schema declares leave the renderer. A face this renderer does not bundle
** is `FONT_UNKNOWN`.
***************************************************************************/
TextElement(ElementSource source)
{
id = source.id();
placement = source.placement();
rotation = source.rotation();
reverse = source.flag("reverse", false);
JsonNode font = source.value("font");
if(font == null || !font.isTextual())
{
throw source.invalid("font");
}
face = Face.of(font.textValue());
if(face == null)
{
throw source.refuse("FONT_UNKNOWN", "font");
}
Length stated = source.length("size", null, ElementSource.PHYSICAL);
size = stated == null ? 0 : milliPoints(stated);
if(size < MINIMUM_MILLIPOINTS || size > MAXIMUM_MILLIPOINTS)
{
throw source.invalid("size");
}
lineHeight = lineHeight(source);
threshold = integer(source, "threshold", source.value("threshold"), 1, 254, DEFAULT_THRESHOLD);
maxLength = source.value("maxLength") == null ? null : Integer.valueOf(integer(source, "maxLength", source.value("maxLength"), 1, MAXIMUM_CHARACTERS, 0));
JsonNode fit = source.value("fit") == null ? JsonNodeFactory.instance.objectNode() : source.value("fit");
if(!fit.isObject() || fit.properties().stream().anyMatch(property -> !FIT.contains(property.getKey())))
{
throw source.invalid("fit");
}
maxLines = integer(source, "fit/maxLines", fit.get("maxLines"), 1, MAXIMUM_LINES, 1);
floor = floor(source, fit.get("shrinkTo"));
String overflow = fit.has("overflow") ? fit.get("overflow").textValue() : "refuse";
if(!"refuse".equals(overflow) && !"truncate".equals(overflow))
{
throw source.invalid("fit/overflow");
}
truncate = "truncate".equals(overflow);
JsonNode literal = source.value("value");
JsonNode pointer = source.value("valuePath");
if((literal == null) == (pointer == null))
{
throw source.invalid("value");
}
if(literal != null && (!literal.isTextual() || literal.textValue().codePointCount(0, literal.textValue().length()) > MAXIMUM_CHARACTERS))
{
throw source.invalid("value");
}
if(pointer != null && (!pointer.isTextual() || pointer.textValue().length() > 256 || !pointer.textValue().startsWith("/")))
{
throw source.invalid("valuePath");
}
value = literal == null ? null : literal.textValue();
path = pointer == null ? null : pointer.textValue();
}
/***************************************************************************
** A type size in thousandths of a point. A point is a 72nd of an inch and an
** inch is 25400 micrometres, so a micrometre is 360/127 of a millipoint.
***************************************************************************/
private static int milliPoints(Length length)
{
long thousandths = length.thousandths();
return (Math.toIntExact(switch(length.unit())
{
case IN -> thousandths * 72;
case MM -> Math.floorDiv(thousandths * 360 + 63, 127);
default -> thousandths;
}));
}
/***************************************************************************
** A whole number in a range, or the fallback when the scene states none.
***************************************************************************/
private static int integer(ElementSource source, String name, JsonNode stated, int minimum, int maximum, int fallback)
{
if(stated == null)
{
return (fallback);
}
if(!stated.isIntegralNumber() || !stated.canConvertToInt() || stated.intValue() < minimum || stated.intValue() > maximum)
{
throw source.invalid(name);
}
return (stated.intValue());
}
/***************************************************************************
** The distance between baselines as a multiple of the size, in thousandths:
** a number from 0.5 to 5 with at most three decimals. Null is the face's own.
** A number too large to be a number at all (`1e400`) is refused like any
** other, not left to fail as arithmetic.
***************************************************************************/
private static Integer lineHeight(ElementSource source)
{
JsonNode stated = source.value("lineHeight");
if(stated == null)
{
return (null);
}
BigDecimal thousandths = stated.isNumber() && Double.isFinite(stated.doubleValue()) ? stated.decimalValue().movePointRight(3) : BigDecimal.ZERO;
if(thousandths.stripTrailingZeros().scale() > 0 || thousandths.compareTo(BigDecimal.valueOf(500)) < 0 || thousandths.compareTo(BigDecimal.valueOf(5000)) > 0)
{
throw source.invalid("lineHeight");
}
return (thousandths.intValueExact());
}
/***************************************************************************
** The smallest size the text may be reduced to. Stated, it is a physical
** length from one point up to the size. Otherwise it is 70% of the size and
** not below 5 pt, or the size itself when that is smaller still.
***************************************************************************/
private int floor(ElementSource source, JsonNode stated)
{
if(stated == null)
{
return (Math.min(size, Math.max(size * DEFAULT_FLOOR_PERCENT / 100, DEFAULT_FLOOR_MILLIPOINTS)));
}
try
{
Length length = Length.parse(stated.textValue());
if(length.physical() && milliPoints(length) >= MINIMUM_MILLIPOINTS && milliPoints(length) <= size)
{
return (milliPoints(length));
}
}
catch(IllegalArgumentException expected)
{
// Refused below, at the property; the cause holds nothing more.
}
throw source.invalid("fit/shrinkTo");
}
/***************************************************************************
** The id the scene declares for the text.
***************************************************************************/
@Override
public String id()
{
return (id);
}
/***************************************************************************
** The element's box, by the standing rules.
***************************************************************************/
@Override
public Frame place(Layout layout)
{
return (layout.place(placement));
}
/***************************************************************************
** Everything that can refuse the text, with no ink: run when a scene is
** validated and before it is painted. What it composed is kept for the
** paint that follows.
***************************************************************************/
@Override
public void check(Frame frame, RenderInput input, Diagnostics diagnostics)
{
composed = null;
composed = new Composed(frame, input, diagnostics, compose(frame, input, diagnostics));
}
/***************************************************************************
** Reverse text paints its box and then clears its letters, so it is counted
** twice against what one scene may paint.
***************************************************************************/
@Override
public long paintedDots(Frame frame, int dpi)
{
return ((reverse ? 2L : 1L) * frame.width() * frame.height());
}
/***************************************************************************
** Draw the text as `check` fitted it, or not at all: a text whose ink the
** rasteriser put outside what was measured is refused and leaves the label
** as it was. Reverse text is white letters on its own box filled black.
***************************************************************************/
@Override
public void paint(Canvas canvas, Frame frame, RenderInput input, Diagnostics diagnostics)
{
Composed checked = composed;
composed = null;
TextRaster.Drawing drawing = checked != null && checked.of(frame, input, diagnostics) ? checked.drawing() : compose(frame, input, diagnostics);
measured(diagnostics, id, frame, TextRaster.paint(canvas, frame, drawing, TextRaster.BAND_DOTS), drawing.block().milliPoints());
}
/***************************************************************************
** Refuse a text whose ink is not where it was measured: the element, by
** name, with how many glyphs and dots strayed and at what size. The label
** holds none of it.
***************************************************************************/
static void measured(Diagnostics diagnostics, String id, Frame frame, TextRaster.Stray stray, int milliPoints)
{
if(stray.any())
{
throw diagnostics.refuse("TEXT_DOES_NOT_FIT", id, null, frame, Map.of("glyphsOutsideMeasure", stray.glyphs(), "dotsOutsideMeasure", stray.dots(), "sizeCentipoints", milliPoints / 10),
Map.of("glyphsOutsideMeasure", 0, "dotsOutsideMeasure", 0));
}
}
/***************************************************************************
** Compose the text within the work its scene may take, or refuse the
** element by name with the steps counted against the steps allowed.
***************************************************************************/
private TextRaster.Drawing compose(Frame frame, RenderInput input, Diagnostics diagnostics)
{
Scene scene = SCENES.computeIfAbsent(diagnostics, collector -> new Scene(new TextFit.Work(SCENE_WORK_STEPS), new HashSet<>()));
try
{
return (compose(frame, input, diagnostics, scene));
}
catch(TextFit.Exhausted exhausted)
{
throw diagnostics.refuse("SCENE_INVALID", id, diagnostics.pointer(id), frame, Map.of("textWorkSteps", Math.toIntExact(Math.min(scene.work().spent(), Integer.MAX_VALUE))), Map.of("textWorkSteps", SCENE_WORK_STEPS));
}
}
/***************************************************************************
** Resolve the value, hold it to its length and to the face, and fit it. The
** answer is what to draw, or null when a bound value is only being
** validated. A text that is only validated is also held to what the
** rasteriser would do with it, glyph by glyph, with no ink.
***************************************************************************/
private TextRaster.Drawing compose(Frame frame, RenderInput input, Diagnostics diagnostics, Scene scene)
{
TextFit.Work work = scene.work();
int reserved = input.reservedAssetNames().size();
if(reserved > 0)
{
throw diagnostics.refuse("RESERVED_FONT_NAME", id, null, frame, Map.of("reservedAssets", reserved), Map.of("reservedAssets", 0));
}
int dpi = input.targetDpi == null ? input.stock.dpi() : input.targetDpi;
boolean upright = rotation % 180 == 0;
boolean validate = "VALIDATE".equals(input.operation);
TextFit.Request request = new TextFit.Request(face, upright ? frame.width() : frame.height(), upright ? frame.height() : frame.width(), dpi, size, floor, lineHeight, maxLines, truncate);
if(path != null && maxLength == null)
{
diagnostics.warn("FIT_NOT_PROVEN", id, null, frame, null, null);
}
if(path != null && validate)
{
legibility(maxLength == null ? size : proven(request, frame, diagnostics, work), dpi, frame, diagnostics);
return (null);
}
String text = path == null ? value : bound(input.context.at(path), frame, diagnostics);
int characters = text.codePointCount(0, text.length());
int longest = maxLength == null ? MAXIMUM_CHARACTERS : maxLength;
if(characters > longest)
{
throw diagnostics.refuse("VALUE_TOO_LONG", id, null, frame, Map.of("characters", characters), Map.of("characters", longest));
}
int missing = face.missing(text);
if(missing > 0)
{
throw diagnostics.refuse("FONT_MISSING_GLYPH", id, null, frame, Map.of("missingGlyphs", missing, "characters", characters), Map.of("missingGlyphs", 0));
}
TextFit.Block block = fitted(request, face.glyphs(text), frame, diagnostics, work);
long drawn = (long) Face.all().indexOf(face) << 48 | (long) block.milliPoints() << 16;
long fresh = text.codePoints().filter(codePoint -> scene.glyphs().add(drawn | codePoint)).count();
work.spend(fresh * TextRaster.GLYPH_STEPS + (long) characters * TextRaster.PEN_STEPS);
if(block.milliPoints() < size)
{
diagnostics.inform("TEXT_SHRUNK", id, null, frame, Map.of("sizeCentipoints", block.milliPoints() / 10), Map.of("sizeCentipoints", size / 10, "floorCentipoints", floor / 10));
}
if(block.lines().size() > 1)
{
diagnostics.inform("TEXT_WRAPPED", id, null, frame, Map.of("lines", block.lines().size()), Map.of("lines", maxLines));
}
if(block.truncated())
{
diagnostics.warn("TEXT_TRUNCATED", id, null, frame, Map.of("characters", block.characters(), "shownCharacters", block.shown(), "lines", block.lines().size()), Map.of("lines", maxLines));
}
legibility(block.milliPoints(), dpi, frame, diagnostics);
TextRaster.Drawing drawing = new TextRaster.Drawing(face, text, block, placement.align(), placement.valign(), rotation, threshold, !reverse);
measured(diagnostics, id, frame, new TextRaster.Stray(validate ? TextRaster.outside(drawing, dpi) : 0, 0), block.milliPoints());
return (drawing);
}
/***************************************************************************
** The value the record holds at the element's pointer, as it is printed.
** Text is printed as it is and a truth value as `true` or `false`. A number
** is printed in plain decimal digits, as the schema says: no exponent, and
** no fraction that is only zeros, so `1.0E10` prints `10000000000`, `2.50`
** prints `2.5` and `12.0` prints `12`. Anything else, a number that is not
** finite among them, is `VALUE_MISSING`.
***************************************************************************/
private String bound(JsonNode bound, Frame frame, Diagnostics diagnostics)
{
if(bound.isTextual() || bound.isBoolean())
{
return (bound.asText());
}
if(bound.isIntegralNumber())
{
return (bound.bigIntegerValue().toString());
}
if(bound.isNumber() && Double.isFinite(bound.doubleValue()))
{
return (BigDecimal.valueOf(bound.doubleValue()).stripTrailingZeros().toPlainString());
}
throw diagnostics.refuse("VALUE_MISSING", id, null, frame, null, null);
}
/***************************************************************************
** Prove that the longest value fits whole, and answer the size it is
** proven at, which is the smallest any value is printed at. The proof never
** cuts: a cut value is not a value that fits. When it fails, an element
** that did not ask for cutting is refused; one that did stands, since
** cutting is what its author chose, with a warning that says how many
** characters are proven to fit whole. Fewer characters never fit worse, so
** that number is found by halving. The size is then the floor, where a cut
** value is printed.
***************************************************************************/
private int proven(TextFit.Request request, Frame frame, Diagnostics diagnostics, TextFit.Work work)
{
TextFit.Request whole = new TextFit.Request(face, request.width(), request.height(), request.dpi(), size, floor, lineHeight, maxLines, false);
Face.Glyph[] worst = new Face.Glyph[maxLength];
Arrays.fill(worst, face.worst());
TextFit.Block proof = truncate ? TextFit.fit(whole, worst, null, work) : fitted(whole, worst, frame, diagnostics, work);
if(!proof.fits())
{
int low = 0;
int high = maxLength - 1;
while(low < high)
{
int middle = (low + high + 1) >>> 1;
if(TextFit.fit(whole, Arrays.copyOf(worst, middle), null, work).fits())
{
low = middle;
}
else
{
high = middle - 1;
}
}
diagnostics.warn("FIT_NOT_PROVEN", id, null, frame, Map.of("provenCharacters", low), Map.of("characters", maxLength));
}
return (proof.milliPoints());
}
/***************************************************************************
** Fit, or refuse with what was measured at the floor size against the box.
***************************************************************************/
private TextFit.Block fitted(TextFit.Request request, Face.Glyph[] glyphs, Frame frame, Diagnostics diagnostics, TextFit.Work work)
{
TextFit.Block block = TextFit.fit(request, glyphs, face.glyph(TextFit.MARK), work);
if(!block.fits())
{
throw diagnostics.refuse("TEXT_DOES_NOT_FIT", id, null, frame,
Map.of("widthDots", block.width(), "heightDots", block.height(), "lines", block.lines().size(), "sizeCentipoints", block.milliPoints() / 10, "characters", block.characters()),
Map.of("widthDots", request.width(), "heightDots", request.height(), "lines", maxLines));
}
return (block);
}
/***************************************************************************
** Warn when the type is small for the printer: any face whose capitals are
** under 12 dots, and a regular weight whose capitals are under 20.
***************************************************************************/
private void legibility(int milliPoints, int dpi, Frame frame, Diagnostics diagnostics)
{
int capitals = new TextFit.Scale(milliPoints, dpi).floor(face.capHeight());
if(capitals < SMALL_CAPITAL_DOTS)
{
diagnostics.warn("TEXT_SMALL_FOR_DPI", id, null, frame, Map.of("capHeightDots", capitals, "sizeCentipoints", milliPoints / 10), Map.of("capHeightDots", SMALL_CAPITAL_DOTS));
}
if(!face.bold() && capitals < LIGHT_CAPITAL_DOTS)
{
diagnostics.warn("TEXT_LIGHT_FACE", id, null, frame, Map.of("capHeightDots", capitals, "sizeCentipoints", milliPoints / 10), Map.of("capHeightDots", LIGHT_CAPITAL_DOTS));
}
}
}
@@ -0,0 +1,57 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2.text;
import java.util.Set;
import com.kingsrook.qbits.renderer.scene2.ElementFactory;
import com.kingsrook.qbits.renderer.scene2.ElementSource;
import com.kingsrook.qbits.renderer.scene2.SceneElement;
/*******************************************************************************
** Text: a TrueType face bundled with the renderer, rasterised by it, with
** size, fit and legibility rules. Version 2 has no printer font: a face the
** renderer cannot measure can be neither fitted nor previewed truthfully.
*******************************************************************************/
public final class TextFactory implements ElementFactory
{
/***************************************************************************
** The properties of a `text` element beyond the common ones. `font` and
** `size` may come from the scene's `defaults`.
***************************************************************************/
@Override
public Set<String> properties()
{
return (Set.of("value", "valuePath", "font", "size", "lineHeight", "fit", "maxLength", "threshold", "reverse", "rotation"));
}
/***************************************************************************
** Build one text element.
***************************************************************************/
@Override
public SceneElement create(ElementSource source)
{
return (new TextElement(source));
}
}
@@ -0,0 +1,661 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2.text;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qbits.renderer.scene2.text.Face.Glyph;
/*******************************************************************************
** Measurement and fit of one text in one box, in whole dots, by integer
** arithmetic on the face's own numbers. Nothing is drawn here, and what is
** drawn later is drawn from this answer: the pen position of every character
** and the box of every line are decided once.
**
** The order is fixed. Lay the text out at the nominal size within the allowed
** lines. If it does not fit, take the largest size, in steps of a quarter of
** a point down to the floor, at which it does. If none does, the text is
** refused, or, only when the element asked for it, cut at a character and
** ended with an ellipsis at the floor size.
**
** The answer is the one a search of every step from the nominal size down
** gives, and is found without making it. A count that errs only toward yes
** (`possible`) says whether a size could hold the text; it never says no to a
** size that fits and never says yes to a larger size after no to a smaller,
** so the largest size it allows is found by halving, and no size above that
** one fits. From there the steps are laid out one by one as before; the count
** is within a few dots of the layout, so they are few. When one line at the
** floor is higher than the box, no size fits and none is searched.
**
** Every character visited is counted against the `Work` the caller gives, so
** a caller can hold all the fitting of one scene to a stated amount.
**
** At each size a line is first broken between words only. If that does not
** fit, it is broken at any character. So a value with no spaces wraps, a
** sentence keeps its words while it can, and a larger size is preferred to
** whole words. Breaking at any character is also what makes a length provable:
** a text of n characters needs no more lines than n of the face's widest.
**
** A line's box is its pen advance, widened to hold the ink of every character
** in it (a `j` that starts left of the pen, an accent above the ascent) plus
** `SLOP` dots on each inked side. The drawn glyph is the font's outline fitted
** to the dot grid by the rasteriser, which moves an edge by less than two dots
** from the outline scaled exactly; the slop is that allowance, and a test
** holds every character of every bundled face to it.
*******************************************************************************/
public final class TextFit
{
public static final int SLOP = 2;
public static final int STEP_MILLIPOINTS = 250;
public static final int MARK = 0x2026;
/***************************************************************************
** Utility class.
***************************************************************************/
private TextFit()
{
}
/***************************************************************************
** What is asked: a face, a box in dots as the text reads (before any
** rotation), the resolution, the nominal size and the floor in thousandths
** of a point, the line pitch in thousandths of the size (null for the
** face's own), the most lines, and whether a text that fits at no size is
** cut short rather than refused.
***************************************************************************/
public record Request(Face face, int width, int height, int dpi, int nominal, int floor, Integer lineHeight, int maxLines, boolean truncate)
{
}
/***************************************************************************
** One line: the characters `from` to `to` of the text, followed by the
** ellipsis when `marked`. `left` (never positive) and `right` are the sides
** of its box measured from the pen at the start of the line; `above` and
** `below` are how far its ink reaches from the baseline.
***************************************************************************/
public record Line(int from, int to, boolean marked, int left, int right, int above, int below)
{
/************************************************************************
** The width of the line's box.
************************************************************************/
public int width()
{
return (right - left);
}
}
/***************************************************************************
** The answer: the size chosen, the lines, the size of the block they make,
** the baseline of the first line from the top of the block, the distance
** between baselines, how many characters there were (trailing spaces never
** print and are not counted), how many are shown, and whether it fits. When
** it does not, the numbers are those of the text broken at any character at
** the floor size, which is what a refusal reports.
***************************************************************************/
public record Block(int milliPoints, List<Line> lines, int width, int height, int baseline, int pitch, int characters, int shown, boolean fits)
{
/************************************************************************
** Whether the text was cut short.
************************************************************************/
public boolean truncated()
{
return (shown < characters);
}
}
/***************************************************************************
** Dots from thousandths of the em at one size and resolution. A size of
** `milliPoints` is `milliPoints * dpi / 72000` dots to the em, so a length
** of `units` is `units * milliPoints * dpi / 72000000` dots, rounded as the
** use says. The products stay far inside a long.
***************************************************************************/
public record Scale(int milliPoints, int dpi)
{
private static final long DIVISOR = 72_000_000L;
/************************************************************************
** Rounded down.
************************************************************************/
public int floor(long units)
{
return (Math.toIntExact(Math.floorDiv(units * milliPoints * dpi, DIVISOR)));
}
/************************************************************************
** Rounded up.
************************************************************************/
public int ceil(long units)
{
return (-floor(-units));
}
/************************************************************************
** To the nearest dot, a half upward.
************************************************************************/
public int round(long units)
{
return (Math.toIntExact(Math.floorDiv(units * milliPoints * dpi + DIVISOR / 2, DIVISOR)));
}
/************************************************************************
** The size of the em in dots, for the font that draws.
************************************************************************/
public float size()
{
return ((float) ((double) milliPoints * dpi / 72_000));
}
}
/***************************************************************************
** The work fitting may do, in characters visited, shared by as many fits
** as the caller wants held to one amount. It is counted by integer
** arithmetic alone, so it is the same on every machine.
***************************************************************************/
public static final class Work
{
private final long limit;
private long spent;
/************************************************************************
** An allowance of this many steps.
************************************************************************/
public Work(long limit)
{
this.limit = limit;
}
/************************************************************************
** Count steps, and end the work when the allowance is passed. It stays
** passed: whatever is asked next ends at once.
************************************************************************/
public void spend(long steps)
{
spent += steps;
if(spent > limit)
{
throw new Exhausted();
}
}
/************************************************************************
** The steps counted so far.
************************************************************************/
public long spent()
{
return (spent);
}
}
/***************************************************************************
** The allowance of a `Work` was passed. It says nothing else: what was
** being fitted is not in it.
***************************************************************************/
public static final class Exhausted extends RuntimeException
{
private static final long serialVersionUID = 1L;
/************************************************************************
** No message beyond the name, no cause and no stack.
************************************************************************/
Exhausted()
{
super("TEXT_WORK_EXHAUSTED", null, false, false);
}
}
/***************************************************************************
** What a line reserves, in thousandths of the em, read from the face once
** for a fit: the ascent above the baseline, the descent below it, and the
** distance between baselines.
***************************************************************************/
record Leading(int ascent, int descent, int pitch)
{
/************************************************************************
** The face's own, with the line height the request states if it does.
************************************************************************/
static Leading of(Request request)
{
Face face = request.face();
return (new Leading(face.ascent(), face.descent(), request.lineHeight() == null ? face.ascent() + face.descent() + face.leading() : request.lineHeight()));
}
/************************************************************************
** The distance between baselines in dots, never less than one.
************************************************************************/
int pitch(Scale scale)
{
return (Math.max(1, scale.ceil(pitch)));
}
/************************************************************************
** The least a block of this many lines is high: one ascent, the pitches
** between and one descent. Ink that reaches further makes it higher.
************************************************************************/
int height(Scale scale, int lines)
{
return (scale.ceil(ascent) + (lines - 1) * pitch(scale) + scale.ceil(descent));
}
}
/***************************************************************************
** The box of a line as characters are added to it from the left.
***************************************************************************/
private static final class Extent
{
private final Scale scale;
private long units;
private int left;
private int right;
private int above;
private int below;
/************************************************************************
** An empty line at one size.
************************************************************************/
Extent(Scale scale)
{
this.scale = scale;
}
/************************************************************************
** Add the next character at the pen. A space moves the pen and widens
** nothing, so spaces at the end of a line take no room.
************************************************************************/
void add(Glyph glyph)
{
int pen = scale.round(units);
units += glyph.advance();
if(!glyph.space())
{
right = Math.max(right, scale.ceil(units));
}
if(glyph.ink())
{
left = Math.min(left, pen + scale.floor(glyph.left()) - SLOP);
right = Math.max(right, pen + scale.ceil(glyph.right()) + SLOP);
above = Math.max(above, scale.ceil(glyph.top()) + SLOP);
below = Math.max(below, scale.ceil(glyph.bottom()) + SLOP);
}
}
/************************************************************************
** The width of the box so far.
************************************************************************/
int width()
{
return (right - left);
}
}
/***************************************************************************
** Fit a text, given as the measurements of its characters, by the fixed
** order, with no limit on the work. `mark` is the face's ellipsis, used
** only when the request allows cutting.
***************************************************************************/
public static Block fit(Request request, Glyph[] glyphs, Glyph mark)
{
return (fit(request, glyphs, mark, new Work(Long.MAX_VALUE)));
}
/***************************************************************************
** Fit a text by the fixed order, counting the work against an allowance
** and ending as `Exhausted` when it is passed. The floor is never above
** the nominal size and no character has a negative advance.
***************************************************************************/
public static Block fit(Request request, Glyph[] glyphs, Glyph mark, Work work)
{
int count = glyphs.length;
while(count > 0 && glyphs[count - 1].space())
{
count--;
}
Leading leading = Leading.of(request);
int last = (request.nominal() - request.floor() + STEP_MILLIPOINTS - 1) / STEP_MILLIPOINTS;
Block block = at(request, leading, request.nominal(), glyphs, count, mark, work);
int step = block.fits() || last == 0 ? last + 1 : first(request, leading, glyphs, count, last, work);
while(step <= last)
{
block = at(request, leading, size(request, step), glyphs, count, mark, work);
step = block.fits() ? last + 1 : step + 1;
}
return (block);
}
/***************************************************************************
** The size a number of quarter-point steps below the nominal, which is the
** floor once the steps reach it.
***************************************************************************/
private static int size(Request request, int step)
{
return (Math.max(request.floor(), request.nominal() - step * STEP_MILLIPOINTS));
}
/***************************************************************************
** The answer at one size: the text broken between words if that fits, else
** broken at any character; and at the floor, when that does not fit either
** and the request allows it, cut. This is one step of the search of every
** size, which a test makes in full to hold `fit` to it.
***************************************************************************/
static Block at(Request request, Leading leading, int size, Glyph[] glyphs, int count, Glyph mark, Work work)
{
Scale scale = new Scale(size, request.dpi());
Block words = block(request, leading, scale, lines(request, scale, glyphs, count, true, work), count, count);
if(words.fits())
{
return (words);
}
Block characters = block(request, leading, scale, lines(request, scale, glyphs, count, false, work), count, count);
return (characters.fits() || size > request.floor() || !request.truncate() ? characters : cut(request, leading, scale, glyphs, mark, characters, work));
}
/***************************************************************************
** The fewest steps below the nominal, from one, at which the text could
** fit; `last`, the floor, when it could at none above it. No size above the
** answer fits, because `possible` never refuses a size that fits and, once
** it allows a size, allows every smaller one. One line at the floor higher
** than the box settles it for every text without a count.
***************************************************************************/
private static int first(Request request, Leading leading, Glyph[] glyphs, int count, int last, Work work)
{
if(leading.height(new Scale(request.floor(), request.dpi()), 1) > request.height())
{
return (last);
}
int low = 1;
int high = last;
while(low < high)
{
int middle = (low + high) >>> 1;
if(possible(request, leading, new Scale(size(request, middle), request.dpi()), glyphs, count, work))
{
high = middle;
}
else
{
low = middle + 1;
}
}
return (low);
}
/***************************************************************************
** Whether a text could fit at one size, erring only toward yes. Lines are
** filled at any character, each held to a width no layout of it can be
** under: its advance to the end of its last character that is not a space,
** or, when wider, the span of its ink scaled exactly and the allowance at
** both ends less the one dot two roundings can give back. A line of a real
** layout, by words or by characters, is never narrower than this, and a
** line that holds more is never narrower than one that holds less, so no
** layout has fewer lines than are counted here; and a block is never lower
** than its lines' ascent, pitches and descent. Every one of these numbers
** grows with the size, so a yes at one size is a yes at every smaller one.
***************************************************************************/
private static boolean possible(Request request, Leading leading, Scale scale, Glyph[] glyphs, int count, Work work)
{
work.spend(count);
int lines = 0;
int index = 0;
while(index < count)
{
lines++;
if(lines > request.maxLines() || leading.height(scale, lines) > request.height())
{
return (false);
}
int from = index;
long units = 0;
long end = 0;
long reach = Long.MIN_VALUE;
long lead = Long.MAX_VALUE;
while(index < count)
{
Glyph glyph = glyphs[index];
long after = units + glyph.advance();
long ended = glyph.space() ? end : after;
long reached = glyph.ink() ? Math.max(reach, units + glyph.right()) : reach;
long led = glyph.ink() ? Math.min(lead, units + glyph.left()) : lead;
int width = Math.max(scale.ceil(ended), reached < led ? 0 : scale.ceil(reached - led) + 2 * SLOP - 1);
if(width > request.width() && index > from)
{
break;
}
if(width > request.width())
{
return (false);
}
units = after;
end = ended;
reach = reached;
lead = led;
index++;
}
}
return (true);
}
/***************************************************************************
** Break a text into lines at one size, between words or at any character.
** Spaces where a line is broken are dropped. A line is measured twice, to
** find its end and to box it, and is counted so.
***************************************************************************/
private static List<Line> lines(Request request, Scale scale, Glyph[] glyphs, int count, boolean words, Work work)
{
List<Line> lines = new ArrayList<>();
int from = 0;
while(from < count)
{
int to = end(request, scale, glyphs, from, count, words);
work.spend(2L * (to - from) + 1);
lines.add(line(scale, glyphs, from, to, null));
from = to;
while(from < count && glyphs[from].space())
{
from++;
}
}
return (lines);
}
/***************************************************************************
** Where the line that starts at `from` ends: after the last word, or the
** last character, that still fits the width. The first one is taken even
** when it is too wide, so the line is then wider than the box and the
** layout does not fit. Broken at any character, a line may end after a
** space, which takes no room; so spaces at the start of a text cannot push
** its first letter out of the box.
***************************************************************************/
private static int end(Request request, Scale scale, Glyph[] glyphs, int from, int count, boolean words)
{
Extent extent = new Extent(scale);
int accepted = from;
for(int index = from; index < count; index++)
{
extent.add(glyphs[index]);
if(!words || (!glyphs[index].space() && (index + 1 == count || glyphs[index + 1].space())))
{
boolean wide = extent.width() > request.width();
if(wide && accepted > from)
{
return (accepted);
}
accepted = index + 1;
if(wide)
{
return (accepted);
}
}
}
return (accepted);
}
/***************************************************************************
** Measure one line, with the ellipsis after it when one is given.
***************************************************************************/
private static Line line(Scale scale, Glyph[] glyphs, int from, int to, Glyph mark)
{
Extent extent = new Extent(scale);
for(int index = from; index < to; index++)
{
extent.add(glyphs[index]);
}
if(mark != null)
{
extent.add(mark);
}
return (new Line(from, to, mark != null, extent.left, extent.right, extent.above, extent.below));
}
/***************************************************************************
** Stack lines into a block and hold it against the box. A line reserves the
** face's ascent above its baseline and its descent below; the block grows
** where the ink of a line reaches further.
***************************************************************************/
private static Block block(Request request, Leading leading, Scale scale, List<Line> lines, int characters, int shown)
{
if(lines.isEmpty())
{
return (new Block(scale.milliPoints(), lines, 0, 0, 0, 0, characters, shown, true));
}
int ascent = scale.ceil(leading.ascent());
int pitch = leading.pitch(scale);
int top = 0;
int bottom = leading.height(scale, lines.size());
int width = 0;
for(int index = 0; index < lines.size(); index++)
{
Line line = lines.get(index);
int baseline = ascent + index * pitch;
top = Math.min(top, baseline - line.above());
bottom = Math.max(bottom, baseline + line.below());
width = Math.max(width, line.width());
}
boolean fits = lines.size() <= request.maxLines() && width <= request.width() && bottom - top <= request.height();
return (new Block(scale.milliPoints(), lines, width, bottom - top, ascent - top, pitch, characters, shown, fits));
}
/***************************************************************************
** Cut a text that fits at no size: keep as many lines as the box holds, and
** end the last of them with the ellipsis after as many of its characters as
** still fit with it, down to the ellipsis alone. Something is always left
** out, so the ellipsis always stands for text, and spaces before it are
** dropped. When not even the ellipsis fits, the answer is the refusal that
** was passed in. A box lower than a number of lines holds no cut of that
** many, which is known without trying; so one lower than a single line
** holds no ellipsis at all.
***************************************************************************/
private static Block cut(Request request, Leading leading, Scale scale, Glyph[] glyphs, Glyph mark, Block refused, Work work)
{
int all = refused.lines().size();
int most = Math.min(request.maxLines(), all);
while(most > 0 && leading.height(scale, most) > request.height())
{
most--;
}
for(int kept = most; kept > 0; kept--)
{
List<Line> lines = new ArrayList<>(refused.lines().subList(0, kept));
int from = lines.get(kept - 1).from();
for(int to = lines.get(kept - 1).to() - (kept == all ? 1 : 0); to >= from; to--)
{
if(to > from && glyphs[to - 1].space())
{
continue;
}
work.spend(to - from + 1L + kept);
lines.set(kept - 1, line(scale, glyphs, from, to, mark));
Block block = block(request, leading, scale, lines, refused.characters(), to);
if(block.fits())
{
return (block);
}
}
}
return (refused);
}
}
@@ -0,0 +1,291 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2.text;
import java.awt.Color;
import java.awt.Font;
import java.awt.Graphics2D;
import java.awt.Rectangle;
import java.awt.RenderingHints;
import java.awt.font.GlyphVector;
import java.awt.image.BufferedImage;
import java.awt.image.DataBufferByte;
import java.util.BitSet;
import com.kingsrook.qbits.renderer.scene2.Canvas;
import com.kingsrook.qbits.renderer.scene2.Frame;
import com.kingsrook.qbits.renderer.scene2.Layout;
import com.kingsrook.qbits.renderer.scene2.Placement;
/*******************************************************************************
** Draws a fitted text onto the label. Each glyph is drawn antialiased at the
** whole-dot pen position the fit decided, by the same Java rasteriser version 1
** raster text uses, and a dot is ink when its grey is darker than the
** element's threshold, so a higher threshold prints heavier.
**
** A line is drawn on a strip: its measured box and a guard of `GUARD` dots all
** round. Ink found in the guard, or a glyph whose bitmap the runtime places
** anywhere outside the measured box, means the measurement was wrong. Such
** ink is never clipped away and never printed outside the box, and a text is
** never printed in part: the dots of a text are gathered first and reach the
** label only when none strayed. What strayed is counted (`Stray`), for the
** element to be refused by name.
**
** A strip of more than `BAND_DOTS` dots (very large type) is drawn in bands of
** whole rows, so one line never needs more grey than that. Where the bands
** fall depends only on the box of the line, so the picture is the same on
** every machine; the rasteriser may shade an edge dot at the border of a band
** differently than it would in one piece.
*******************************************************************************/
final class TextRaster
{
static final int GUARD = 2;
static final int BAND_DOTS = 1 << 23;
/////////////////////////////////////////////////////////////////////////////////////////////////
// what drawing counts against the work of a scene, in characters visited while fitting, //
// which take about 15 ns each. A glyph the runtime has not drawn at a size is rasterised //
// once, in 20 to 50 microseconds; after that, asking for it and for where its bitmap //
// falls takes about a quarter of a microsecond //
/////////////////////////////////////////////////////////////////////////////////////////////////
static final int GLYPH_STEPS = 4096;
static final int PEN_STEPS = 16;
/***************************************************************************
** Utility class.
***************************************************************************/
private TextRaster()
{
}
/***************************************************************************
** What to draw and how: the face, the text, its fitted block, where lines
** sit across the block, the clockwise rotation, the grey below which a dot
** is ink, and whether the dots are ink or (for reverse text) cleared from
** the element's box filled black.
***************************************************************************/
record Drawing(Face face, String text, TextFit.Block block, Placement.Align align, Placement.Valign valign, int rotation, int threshold, boolean ink)
{
}
/***************************************************************************
** What the rasteriser put outside the measure: glyphs whose bitmap is not
** wholly inside the box of their line, and dots of ink found in the guard
** round a line or outside the element's box.
***************************************************************************/
record Stray(int glyphs, int dots)
{
/************************************************************************
** Whether anything strayed.
************************************************************************/
boolean any()
{
return (glyphs > 0 || dots > 0);
}
}
/***************************************************************************
** How many glyphs of a fitted text the runtime would place outside the box
** measured for their line at this resolution, without drawing any: what
** can be known of a text when a scene is only validated.
***************************************************************************/
static int outside(Drawing drawing, int dpi)
{
TextFit.Scale scale = new TextFit.Scale(drawing.block().milliPoints(), dpi);
Font font = drawing.face().font(scale.size());
int outside = 0;
for(TextFit.Line line : drawing.block().lines())
{
outside += glyphs(drawing, scale, font, line, null, 0);
}
return (outside);
}
/***************************************************************************
** Draw into the element's box, which is given as it appears on the label:
** a text turned a quarter reads along the box's height. The answer is what
** strayed; when anything did, the label is left as it was.
***************************************************************************/
static Stray paint(Canvas canvas, Frame frame, Drawing drawing, int bandDots)
{
TextFit.Block block = drawing.block();
boolean upright = drawing.rotation() % 180 == 0;
Frame reading = new Frame(0, 0, upright ? frame.width() : frame.height(), upright ? frame.height() : frame.width());
Frame content = Layout.align(reading, block.width(), block.height(), drawing.align(), drawing.valign());
TextFit.Scale scale = new TextFit.Scale(block.milliPoints(), canvas.dpi());
Font font = drawing.face().font(scale.size());
BitSet ink = new BitSet();
int glyphs = 0;
int dots = 0;
for(int index = 0; index < block.lines().size(); index++)
{
TextFit.Line line = block.lines().get(index);
int left = content.x() + drawing.align().position().place(block.width(), line.width(), 0);
int top = content.y() + block.baseline() + index * block.pitch() - line.above();
Stray stray = strip(ink, reading, drawing, scale, font, line, left, top, bandDots);
glyphs += stray.glyphs();
dots += stray.dots();
}
Stray stray = new Stray(glyphs, dots);
if(!stray.any())
{
if(!drawing.ink())
{
canvas.fill(frame, true);
}
for(int dot = ink.nextSetBit(0); dot >= 0; dot = ink.nextSetBit(dot + 1))
{
dot(canvas, frame, reading, drawing, dot % reading.width(), dot / reading.width());
}
}
return (stray);
}
/***************************************************************************
** Gather the ink of one line whose box has its top left at `left`, `top` of
** the reading frame, a band of rows at a time, and count what strayed.
***************************************************************************/
private static Stray strip(BitSet ink, Frame reading, Drawing drawing, TextFit.Scale scale, Font font, TextFit.Line line, int left, int top, int bandDots)
{
int width = line.width() + 2 * GUARD;
int height = line.above() + line.below() + 2 * GUARD;
int rows = Math.max(1, bandDots / width);
int glyphs = 0;
int dots = 0;
for(int first = 0; first < height; first += rows)
{
BufferedImage band = new BufferedImage(width, Math.min(rows, height - first), BufferedImage.TYPE_BYTE_GRAY);
Graphics2D graphics = band.createGraphics();
try
{
graphics.setColor(Color.WHITE);
graphics.fillRect(0, 0, band.getWidth(), band.getHeight());
graphics.setColor(Color.BLACK);
graphics.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
graphics.setRenderingHint(RenderingHints.KEY_FRACTIONALMETRICS, RenderingHints.VALUE_FRACTIONALMETRICS_ON);
graphics.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
//////////////////////////////////////////////////////////////////////////////////
// ink that fell wholly beyond the guard is clipped by the strip and leaves no //
// dot to find; the bounds of its glyph say so, and they are the same for every //
// band, so those of the first are the count //
//////////////////////////////////////////////////////////////////////////////////
int beyond = glyphs(drawing, scale, font, line, graphics, first);
glyphs = first == 0 ? beyond : glyphs;
}
finally
{
graphics.dispose();
}
byte[] grey = ((DataBufferByte) band.getRaster().getDataBuffer()).getData();
for(int y = 0; y < band.getHeight(); y++)
{
for(int x = 0; x < width; x++)
{
if((grey[y * width + x] & 255) < drawing.threshold())
{
int row = first + y;
int dotX = left + x - GUARD;
int dotY = top + row - GUARD;
if(x < GUARD || x >= width - GUARD || row < GUARD || row >= height - GUARD || dotX < 0 || dotY < 0 || dotX >= reading.width() || dotY >= reading.height())
{
dots++;
}
else
{
ink.set(dotY * reading.width() + dotX);
}
}
}
}
}
return (new Stray(glyphs, dots));
}
/***************************************************************************
** The glyphs of one line at their pens on its strip: how many the runtime
** places outside the line's measured box, drawing each on a band of the
** strip whose first row is `first` when one is given.
***************************************************************************/
private static int glyphs(Drawing drawing, TextFit.Scale scale, Font font, TextFit.Line line, Graphics2D band, int first)
{
int width = line.width() + 2 * GUARD;
int height = line.above() + line.below() + 2 * GUARD;
int outside = 0;
long units = 0;
for(int index = line.from(); index < line.to() + (line.marked() ? 1 : 0); index++)
{
char character = index < line.to() ? drawing.text().charAt(index) : (char) TextFit.MARK;
Face.Glyph glyph = drawing.face().glyph(character);
if(glyph.ink())
{
GlyphVector vector = font.createGlyphVector(Face.CONTEXT, new char[] {character});
int pen = GUARD - line.left() + scale.round(units);
Rectangle pixels = vector.getGlyphPixelBounds(0, Face.CONTEXT, pen, GUARD + line.above());
outside += !pixels.isEmpty() && (pixels.x < GUARD || pixels.y < GUARD || pixels.x + pixels.width > width - GUARD || pixels.y + pixels.height > height - GUARD) ? 1 : 0;
if(band != null)
{
band.drawGlyphVector(vector, pen, GUARD + line.above() - first);
}
}
units += glyph.advance();
}
return (outside);
}
/***************************************************************************
** Put one dot of the reading frame on the label, turned clockwise.
***************************************************************************/
private static void dot(Canvas canvas, Frame frame, Frame reading, Drawing drawing, int x, int y)
{
int turnedX = switch(drawing.rotation())
{
case 90 -> reading.height() - 1 - y;
case 180 -> reading.width() - 1 - x;
case 270 -> y;
default -> x;
};
int turnedY = switch(drawing.rotation())
{
case 90 -> x;
case 180 -> reading.height() - 1 - y;
case 270 -> reading.width() - 1 - x;
default -> y;
};
canvas.set(frame.x() + turnedX, frame.y() + turnedY, drawing.ink());
}
}
@@ -0,0 +1,54 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.renderer.scene2.upgrade;
import java.util.Map;
import com.fasterxml.jackson.databind.JsonNode;
import com.kingsrook.qbits.renderer.Wire;
/*******************************************************************************
** `UPGRADE_SCENE`: a version 2 rendering of a version 1 scene, for an author to
** review and save as a draft. The operation is routed here from the first
** version 2 renderer so the wire is settled; the conversion itself is a later
** package, and until then the operation is refused by name.
*******************************************************************************/
public final class SceneUpgrade
{
/***************************************************************************
** Utility class.
***************************************************************************/
private SceneUpgrade()
{
}
/***************************************************************************
** Answer one `UPGRADE_SCENE` request.
***************************************************************************/
public static Map<String, Object> upgrade(JsonNode request)
{
Wire.text(request.get("requestId"), 128);
throw new IllegalArgumentException("UNSUPPORTED_OPERATION");
}
}
@@ -0,0 +1,8 @@
9e6c74a889a700d707613d24548fe4ffa6bc59559a0689d2cf9e133bdcdafb2f ibm-plex-sans/IBMPlexSans-Bold.ttf
975dcda37d80f038dcd143c22e33ca2d97a0cc5a929aace1c749153b0fe1afa5 ibm-plex-sans/IBMPlexSans-Regular.ttf
7e6b2818edbd8f6a01ae80641cc8f16a51080d08fb4e532be3a0b6f74adb07da ibm-plex-sans/LICENSE.txt
723e245902b45a49f8cf602d15891bae08c31309dce7c56d209d10cd471b88c7 ibm-plex-sans-condensed/IBMPlexSansCondensed-Bold.ttf
7e6b2818edbd8f6a01ae80641cc8f16a51080d08fb4e532be3a0b6f74adb07da ibm-plex-sans-condensed/LICENSE.txt
5590990c82e097397517f275f430af4546e1c45cff408bde4255dad142479dcb jetbrains-mono/JetBrainsMono-Bold.ttf
a0bf60ef0f83c5ed4d7a75d45838548b1f6873372dfac88f71804491898d138f jetbrains-mono/JetBrainsMono-Regular.ttf
30f0c136e3c88e422d0791acd97238870f9054a9729bc34cf2ff0d4ed8cac4ad jetbrains-mono/OFL.txt
@@ -0,0 +1,93 @@
Copyright © 2017 IBM Corp. with Reserved Font Name "Plex"
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
@@ -0,0 +1,23 @@
# IBM Plex Sans Condensed (Bold)
An unmodified file from the official release of the IBM Plex project, retrieved 2026-11-12.
| | |
| --- | --- |
| Project | https://github.com/IBM/plex |
| Release | `@ibm/plex-sans-condensed@2.0.0` |
| Archive | https://github.com/IBM/plex/releases/download/%40ibm/plex-sans-condensed%402.0.0/ibm-plex-sans-condensed.zip |
| Archive SHA-256 | `f86ba73abbeed7cf7690ead863192a87211dfc2b0cef0ac6bf4700533ec5ab9e` |
| Licence | SIL Open Font License 1.1, `LICENSE.txt` in this directory (the archive's `ibm-plex-sans-condensed/LICENSE.txt`, byte for byte) |
| Reserved Font Name | "Plex" (the file is not modified and not renamed) |
| File here | Path in the archive | Font version (name table) | SHA-256 |
| --- | --- | --- | --- |
| `IBMPlexSansCondensed-Bold.ttf` | `ibm-plex-sans-condensed/fonts/complete/ttf/IBMPlexSansCondensed-Bold.ttf` | Version 3.000 | `723e245902b45a49f8cf602d15891bae08c31309dce7c56d209d10cd471b88c7` |
| `LICENSE.txt` | `ibm-plex-sans-condensed/LICENSE.txt` | | `7e6b2818edbd8f6a01ae80641cc8f16a51080d08fb4e532be3a0b6f74adb07da` |
The licence was confirmed from the release archive itself: its `LICENSE.txt` states "This Font Software is
licensed under the SIL Open Font License, Version 1.1" and carries the full text; the licence field of the
font's name table says the same, and the font's embedding bits (`OS/2.fsType`) are 0, installable embedding.
Scene name: `qqq-condensed-bold`.
Loaded 100 of 260 files, more files were not shown because too many files have changed in this diff. Show more