Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 james.maes
|
9ccdece03c
|
||
 james.maesandCodex GPT-6
|
175c88b999
|
||
|
james.maesandCodex
|
bb86b2d507
|
No files matched your search
@@ -1,9 +0,0 @@
|
||||
# Copyright 2026 Kingsrook, LLC
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
.git
|
||||
**/bin
|
||||
**/obj
|
||||
target
|
||||
.local
|
||||
.venv
|
||||
@@ -1,11 +0,0 @@
|
||||
# Shared QRun Maven CI/CD (KofTwentyTwo/ci-workflows): every push verifies; vX.Y.Z tags publish the
|
||||
# tested JAR/POM to the QRun-IO Gitea Maven registry. QQQ resolves from that registry with the job token.
|
||||
name: build
|
||||
on:
|
||||
push:
|
||||
jobs:
|
||||
maven:
|
||||
uses: self:KofTwentyTwo/ci-workflows/.gitea/workflows/maven.yaml@v1
|
||||
with:
|
||||
maven-args: -Pui-demo
|
||||
secrets: inherit
|
||||
@@ -1,15 +0,0 @@
|
||||
{
|
||||
"typeCheckingMode": "strict",
|
||||
"pythonVersion": "3.13",
|
||||
"include": [
|
||||
"scripts/*.py"
|
||||
],
|
||||
"reportMissingTypeStubs": "error",
|
||||
"reportUnnecessaryTypeIgnoreComment": "error",
|
||||
"reportImplicitOverride": "error",
|
||||
"exclude": [
|
||||
"**/__pycache__"
|
||||
],
|
||||
"venvPath": "..",
|
||||
"venv": ".venv"
|
||||
}
|
||||
@@ -2,107 +2,55 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
"""Reject missing/malformed CodeQL evidence before enforcing the severity gate."""
|
||||
|
||||
import json
|
||||
import math
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import TypedDict
|
||||
|
||||
RuleProperties = TypedDict("RuleProperties", {"security-severity": str | float | None}, total=False)
|
||||
|
||||
|
||||
class Rule(TypedDict):
|
||||
"""Keep the rule identity and optional severity metadata used by the gate."""
|
||||
|
||||
id: str
|
||||
properties: RuleProperties
|
||||
|
||||
|
||||
class Component(TypedDict, total=False):
|
||||
"""Describe CodeQL driver or extension rule metadata."""
|
||||
|
||||
name: str
|
||||
rules: list[Rule]
|
||||
|
||||
|
||||
class Tool(TypedDict, total=False):
|
||||
"""Group the driver and optional extension rule catalogs."""
|
||||
|
||||
driver: Component
|
||||
extensions: list[Component]
|
||||
|
||||
|
||||
class Result(TypedDict, total=False):
|
||||
"""Describe only the result fields consumed by the severity gate."""
|
||||
|
||||
ruleId: str
|
||||
rule: dict[str, str]
|
||||
suppressions: list[object]
|
||||
|
||||
|
||||
class Run(TypedDict, total=False):
|
||||
"""Retain invocation success and findings for one analyzed language."""
|
||||
|
||||
tool: Tool
|
||||
results: list[Result]
|
||||
invocations: list[dict[str, bool]]
|
||||
|
||||
|
||||
class Report(TypedDict, total=False):
|
||||
"""Represent SARIF fields while retaining the explicit runtime validation."""
|
||||
|
||||
version: str
|
||||
runs: list[Run]
|
||||
|
||||
|
||||
MAX_SEVERITY = 10
|
||||
|
||||
|
||||
def check(directory: str | Path, language: str, threshold: float) -> bool: # noqa: PLR0912 -- Keep the ordered evidence checks together; none may be skipped.
|
||||
"""Validate complete CodeQL evidence and report findings at the threshold."""
|
||||
if not math.isfinite(threshold) or not 0 <= threshold <= MAX_SEVERITY:
|
||||
raise ValueError("Invalid security severity threshold")
|
||||
canonical = {"java-kotlin": "java", "javascript-typescript": "javascript", "c-cpp": "cpp"}.get(language, language)
|
||||
files = sorted(Path(directory).glob("*.sarif"))
|
||||
if not canonical or not any(path.name == canonical + ".sarif" for path in files):
|
||||
raise ValueError("Missing expected CodeQL SARIF report for " + language)
|
||||
blocking: list[tuple[float, str]] = []
|
||||
for path in files:
|
||||
report: Report = json.loads(path.read_text(encoding="utf-8"))
|
||||
runs = report.get("runs")
|
||||
if report.get("version") != "2.1.0" or not isinstance(runs, list) or not runs:
|
||||
raise ValueError("Invalid or empty SARIF runs: " + path.name)
|
||||
for run in runs:
|
||||
driver = run.get("tool", {}).get("driver", {})
|
||||
results = run.get("results")
|
||||
if driver.get("name") != "CodeQL" or not isinstance(driver.get("rules"), list) or not isinstance(results, list):
|
||||
raise ValueError("Missing CodeQL tool/rules/results evidence: " + path.name)
|
||||
rules: dict[str, Rule] = {}
|
||||
for component in [driver, *run.get("tool", {}).get("extensions", [])]:
|
||||
for rule in component.get("rules", []):
|
||||
rules[rule["id"]] = rule
|
||||
if not rules:
|
||||
raise ValueError("CodeQL report has no analyzed rule metadata: " + path.name)
|
||||
for invocation in run.get("invocations", []):
|
||||
if invocation.get("executionSuccessful") is False:
|
||||
raise ValueError("CodeQL invocation failed: " + path.name)
|
||||
for result in results:
|
||||
rule_id = result.get("ruleId") or result.get("rule", {}).get("id")
|
||||
if rule_id not in rules:
|
||||
raise ValueError("Result references missing rule metadata: " + path.name)
|
||||
if result.get("suppressions"):
|
||||
continue
|
||||
severity = float(rules[rule_id].get("properties", {}).get("security-severity", 0) or 0)
|
||||
if not math.isfinite(severity) or not 0 <= severity <= MAX_SEVERITY:
|
||||
raise ValueError("Invalid rule severity: " + rule_id)
|
||||
if severity >= threshold:
|
||||
blocking.append((severity, rule_id))
|
||||
for severity, rule_id in sorted(blocking, reverse=True):
|
||||
print(f"::error title=CodeQL security finding::{rule_id} ({severity})")
|
||||
print(f"Validated {len(files)} SARIF report(s); {len(blocking)} blocking result(s)")
|
||||
return bool(blocking)
|
||||
def check(directory, language, threshold):
|
||||
if not math.isfinite(threshold) or not 0 <= threshold <= 10:
|
||||
raise ValueError("Invalid security severity threshold")
|
||||
canonical = {"java-kotlin": "java", "javascript-typescript": "javascript", "c-cpp": "cpp"}.get(language, language)
|
||||
files = sorted(Path(directory).glob("*.sarif"))
|
||||
if not canonical or not any(path.name == canonical + ".sarif" for path in files):
|
||||
raise ValueError("Missing expected CodeQL SARIF report for " + language)
|
||||
blocking = []
|
||||
for path in files:
|
||||
report = json.loads(path.read_text(encoding="utf-8"))
|
||||
runs = report.get("runs")
|
||||
if report.get("version") != "2.1.0" or not isinstance(runs, list) or not runs:
|
||||
raise ValueError("Invalid or empty SARIF runs: " + path.name)
|
||||
for run in runs:
|
||||
driver = run.get("tool", {}).get("driver", {})
|
||||
results = run.get("results")
|
||||
if driver.get("name") != "CodeQL" or not isinstance(driver.get("rules"), list) or not isinstance(results, list):
|
||||
raise ValueError("Missing CodeQL tool/rules/results evidence: " + path.name)
|
||||
rules = {}
|
||||
for component in [driver, *run.get("tool", {}).get("extensions", [])]:
|
||||
for rule in component.get("rules", []):
|
||||
rules[rule["id"]] = rule
|
||||
if not rules:
|
||||
raise ValueError("CodeQL report has no analyzed rule metadata: " + path.name)
|
||||
for invocation in run.get("invocations", []):
|
||||
if invocation.get("executionSuccessful") is False:
|
||||
raise ValueError("CodeQL invocation failed: " + path.name)
|
||||
for result in results:
|
||||
rule_id = result.get("ruleId") or result.get("rule", {}).get("id")
|
||||
if rule_id not in rules:
|
||||
raise ValueError("Result references missing rule metadata: " + path.name)
|
||||
if result.get("suppressions"):
|
||||
continue
|
||||
severity = float(rules[rule_id].get("properties", {}).get("security-severity", 0) or 0)
|
||||
if not math.isfinite(severity) or not 0 <= severity <= 10:
|
||||
raise ValueError("Invalid rule severity: " + rule_id)
|
||||
if severity >= threshold:
|
||||
blocking.append((severity, rule_id))
|
||||
for severity, rule_id in sorted(blocking, reverse=True):
|
||||
print(f"::error title=CodeQL security finding::{rule_id} ({severity})")
|
||||
print(f"Validated {len(files)} SARIF report(s); {len(blocking)} blocking result(s)")
|
||||
return bool(blocking)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(1 if check(os.environ["SARIF_DIR"], os.environ["EXPECTED_LANGUAGE"], float(os.environ["THRESHOLD"])) else 0)
|
||||
raise SystemExit(1 if check(os.environ["SARIF_DIR"], os.environ["EXPECTED_LANGUAGE"], float(os.environ["THRESHOLD"])) else 0)
|
||||
@@ -1,120 +0,0 @@
|
||||
# Copyright (C) 2026 Kingsrook, LLC
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
"""Exercise the repository's actual compiler configuration on isolated probes."""
|
||||
|
||||
import argparse
|
||||
import copy
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import subprocess
|
||||
import tempfile
|
||||
import xml.etree.ElementTree as ET
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
|
||||
NS = "{http://maven.apache.org/POM/4.0.0}"
|
||||
LOG = logging.getLogger(__name__)
|
||||
PROBES: dict[str, tuple[str, str | None]] = {
|
||||
"positive": ('public String value() { return "present"; }', None),
|
||||
"nullaway": ("public String value() { return null; }", "[NullAway]"),
|
||||
"errorprone": ("public void value() { new IllegalArgumentException(); }", "[DeadException]"),
|
||||
"warnings": ('public long value() { return java.util.Date.parse("2000-01-01"); }', "warnings found and -Werror specified"),
|
||||
}
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class GuardContext:
|
||||
"""Everything shared by all probes: repository root, evidence folder, probe POM and Maven command."""
|
||||
|
||||
root: Path
|
||||
output: Path
|
||||
pom: ET.ElementTree
|
||||
command: list[str]
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Probe:
|
||||
"""One isolated compilation: source root, name, the member source and the diagnostic it must produce (None means it must compile)."""
|
||||
|
||||
phase: str
|
||||
name: str
|
||||
source: str
|
||||
expected: str | None
|
||||
|
||||
|
||||
def probe_pom(source: ET.Element) -> ET.ElementTree:
|
||||
"""Copy compiler configuration, including executions, without changing its flags."""
|
||||
compiler = source.find(f"{NS}build/{NS}plugins/{NS}plugin[{NS}artifactId='maven-compiler-plugin']")
|
||||
if compiler is None:
|
||||
raise ValueError("Repository must declare its compiler plugin")
|
||||
project = ET.Element(f"{NS}project")
|
||||
for name, value in (("modelVersion", "4.0.0"), ("groupId", "com.kingsrook.qbits"), ("artifactId", "compiler-configuration-probe"), ("version", "1")):
|
||||
ET.SubElement(project, f"{NS}{name}").text = value
|
||||
properties = source.find(f"{NS}properties")
|
||||
if properties is not None:
|
||||
project.append(copy.deepcopy(properties))
|
||||
plugins = ET.SubElement(ET.SubElement(project, f"{NS}build"), f"{NS}plugins")
|
||||
plugins.append(copy.deepcopy(compiler))
|
||||
return ET.ElementTree(project)
|
||||
|
||||
|
||||
def run_probe(context: GuardContext, probe: Probe) -> dict[str, str | bool]:
|
||||
"""Require the intended diagnostic, not merely an unrelated Maven failure."""
|
||||
folder = context.output / f"{probe.phase}-{probe.name}"
|
||||
package = folder / "src" / probe.phase / "java" / "com" / "kingsrook" / "qbits" / "printing"
|
||||
package.mkdir(parents=True)
|
||||
(package / "Probe.java").write_text(f"// Generated compiler guard fixture; not application source.\npackage com.kingsrook.qbits.printing;\npublic final class Probe {{ {probe.source} }}\n", encoding="utf-8")
|
||||
context.pom.write(folder / "pom.xml", encoding="utf-8", xml_declaration=True)
|
||||
result = subprocess.run( # noqa: S603 -- argument list (no shell) of the repository Maven wrapper or the operator-supplied executable plus fixed Maven goals
|
||||
[*context.command, "-f", str(folder / "pom.xml"), "test-compile"],
|
||||
cwd=context.root,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
check=False,
|
||||
)
|
||||
log = result.stdout + result.stderr
|
||||
(folder / "compiler.log").write_text(log, encoding="utf-8")
|
||||
passed = result.returncode == 0 if probe.expected is None else result.returncode != 0 and probe.expected in log
|
||||
if probe.name == "warnings":
|
||||
passed = passed and "[deprecation]" in log
|
||||
if not passed:
|
||||
raise RuntimeError(f"Compiler guard failed: {probe.phase}/{probe.name}; inspect {folder / 'compiler.log'}")
|
||||
return {"sourceRoot": probe.phase, "probe": probe.name, "expectedRejection": probe.expected is not None, "passed": True}
|
||||
|
||||
|
||||
def main() -> None:
|
||||
"""Run positive and negative main/test probes without installing any artifact."""
|
||||
parser = argparse.ArgumentParser(description=__doc__)
|
||||
parser.add_argument("--maven", help="Optional exact Maven executable; otherwise use the repository wrapper")
|
||||
parser.add_argument("--settings", type=Path)
|
||||
parser.add_argument("--local-repository", type=Path)
|
||||
parser.add_argument("--offline", action="store_true")
|
||||
args = parser.parse_args()
|
||||
root = Path(__file__).resolve().parents[2]
|
||||
command = [args.maven] if args.maven else ([str(root / "mvnw.cmd")] if os.name == "nt" else ["bash", str(root / "mvnw")])
|
||||
command += ["-B", "-ntp"]
|
||||
if args.offline:
|
||||
command.append("-o")
|
||||
if args.settings:
|
||||
command += ["-s", str(args.settings.resolve())]
|
||||
if args.local_repository:
|
||||
command.append(f"-Dmaven.repo.local={args.local_repository.resolve()}")
|
||||
output_root = root / "target" / "compiler-guard"
|
||||
output_root.mkdir(parents=True, exist_ok=True)
|
||||
output = Path(tempfile.mkdtemp(prefix="run-", dir=output_root))
|
||||
ET.register_namespace("", NS[1:-1])
|
||||
pom = probe_pom(ET.parse(root / "pom.xml").getroot()) # noqa: S314 -- parses this repository's own checked-in pom.xml, never external input
|
||||
context = GuardContext(root, output, pom, command)
|
||||
results: list[dict[str, str | bool]] = []
|
||||
for phase in ("main", "test"):
|
||||
for name, (source, expected) in PROBES.items():
|
||||
results.append(run_probe(context, Probe(phase, name, source, expected)))
|
||||
(output / "results.json").write_text(json.dumps(results, indent=3) + "\n", encoding="utf-8")
|
||||
LOG.info("Compiler guard passed", extra={"probeCount": len(results), "evidenceDirectory": str(output)})
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
logging.basicConfig(level=logging.INFO)
|
||||
main()
|
||||
@@ -2,172 +2,127 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
"""Fail closed unless scanners cover Maven's selected UI-host runtime graph."""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import re
|
||||
from collections import Counter
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import TypedDict, cast
|
||||
import re
|
||||
from urllib.parse import unquote, urlsplit
|
||||
|
||||
|
||||
class Bom(TypedDict, total=False):
|
||||
"""Describe the selected CycloneDX coordinate fields."""
|
||||
|
||||
bomFormat: str
|
||||
components: list[dict[str, str]]
|
||||
metadata: dict[str, dict[str, str]]
|
||||
|
||||
|
||||
class TrivyReport(TypedDict, total=False):
|
||||
"""Describe package coordinates, leaving runtime shape checks intact."""
|
||||
|
||||
Results: list[dict[str, list[dict[str, str]]]]
|
||||
|
||||
|
||||
class OsvReport(TypedDict, total=False):
|
||||
"""Keep result bodies untrusted until their explicit validation."""
|
||||
|
||||
results: list[object]
|
||||
|
||||
|
||||
class OsvResult(TypedDict, total=False):
|
||||
"""Describe source identity and packages after checking the object shape."""
|
||||
|
||||
source: dict[str, str]
|
||||
packages: list[object]
|
||||
|
||||
|
||||
class OsvEntry(TypedDict, total=False):
|
||||
"""Describe the coordinate and optional vulnerability array being checked."""
|
||||
|
||||
package: dict[str, str]
|
||||
vulnerabilities: object
|
||||
|
||||
|
||||
REQUIRED = {
|
||||
"com.kingsrook.qqq:qqq-frontend-next",
|
||||
"com.kingsrook.qqq:qqq-backend-core",
|
||||
"com.kingsrook.qqq:qqq-backend-module-filesystem",
|
||||
"com.google.guava:guava",
|
||||
"com.h2database:h2",
|
||||
"com.kingsrook.qqq:qqq-frontend-next",
|
||||
"com.kingsrook.qqq:qqq-backend-core",
|
||||
"com.kingsrook.qqq:qqq-backend-module-filesystem",
|
||||
"com.google.guava:guava",
|
||||
"com.h2database:h2",
|
||||
}
|
||||
REVIEWED_H2_VERSION = "2.4.240"
|
||||
OMITTED = object()
|
||||
|
||||
|
||||
def resolved(text: str) -> set[tuple[str, str]]:
|
||||
"""Read Maven's selected runtime JARs and enforce the reviewed H2 pin."""
|
||||
packages: set[tuple[str, str]] = set()
|
||||
for raw_line in text.splitlines():
|
||||
line = re.sub(r"\x1b\[[0-9;]*m", "", raw_line).strip().split(" -- ", 1)[0].strip()
|
||||
if not line or line == "The following files have been resolved:":
|
||||
continue
|
||||
parts = line.split(":")
|
||||
if len(parts) not in (5, 6) or parts[-1] not in ("compile", "runtime"):
|
||||
raise ValueError(f"Unexpected Maven runtime coordinate: {line}")
|
||||
if not all(parts) or parts[2] != "jar":
|
||||
raise ValueError(f"Invalid runtime JAR coordinate: {line}")
|
||||
name = parts[0] + ":" + parts[1]
|
||||
if parts[0].startswith(("org.junit", "org.opentest4j", "org.apiguardian")):
|
||||
raise ValueError("Test library in runtime inventory")
|
||||
packages.add((name, parts[-2]))
|
||||
if not REQUIRED.issubset({name for name, _ in packages}):
|
||||
raise ValueError("Maven inventory is empty or lacks required UI-host dependencies")
|
||||
# The pinned dependency-review license exception matcher ignores versions.
|
||||
# Keep any H2 metadata exception limited to the reviewed, unmodified runtime.
|
||||
if {version for name, version in packages if name == "com.h2database:h2"} != {REVIEWED_H2_VERSION}:
|
||||
raise ValueError("H2 runtime must match reviewed version " + REVIEWED_H2_VERSION)
|
||||
return packages
|
||||
def resolved(text):
|
||||
packages = set()
|
||||
for line in text.splitlines():
|
||||
line = re.sub(r"\x1b\[[0-9;]*m", "", line).strip().split(" -- ", 1)[0].strip()
|
||||
if not line or line == "The following files have been resolved:":
|
||||
continue
|
||||
parts = line.split(":")
|
||||
if len(parts) not in (5, 6) or parts[-1] not in ("compile", "runtime"):
|
||||
raise ValueError(f"Unexpected Maven runtime coordinate: {line}")
|
||||
if not all(parts) or parts[2] != "jar":
|
||||
raise ValueError(f"Invalid runtime JAR coordinate: {line}")
|
||||
name = parts[0] + ":" + parts[1]
|
||||
if parts[0].startswith(("org.junit", "org.opentest4j", "org.apiguardian")):
|
||||
raise ValueError("Test library in runtime inventory")
|
||||
packages.add((name, parts[-2]))
|
||||
if not REQUIRED.issubset({name for name, _ in packages}):
|
||||
raise ValueError("Maven inventory is empty or lacks required UI-host dependencies")
|
||||
# The pinned dependency-review license exception matcher ignores versions.
|
||||
# Keep any H2 metadata exception limited to the reviewed, unmodified runtime.
|
||||
if {version for name, version in packages if name == "com.h2database:h2"} != {REVIEWED_H2_VERSION}:
|
||||
raise ValueError("H2 runtime must match reviewed version " + REVIEWED_H2_VERSION)
|
||||
return packages
|
||||
|
||||
|
||||
def components(report: object) -> set[tuple[str, str]]:
|
||||
"""Extract exact Maven coordinates from the scanner's CycloneDX inventory."""
|
||||
typed_report = cast(Bom, report)
|
||||
if not isinstance(report, dict) or typed_report.get("bomFormat") != "CycloneDX":
|
||||
raise ValueError("Expected CycloneDX inventory")
|
||||
packages: set[tuple[str, str]] = set()
|
||||
for component in typed_report.get("components", []):
|
||||
purl = urlsplit(component.get("purl", ""))
|
||||
if purl.scheme != "pkg" or not purl.path.startswith("maven/"):
|
||||
raise ValueError("Missing Maven package URL")
|
||||
coordinate, version = purl.path.removeprefix("maven/").rsplit("@", 1)
|
||||
group, artifact = coordinate.split("/", 1)
|
||||
packages.add((unquote(group) + ":" + unquote(artifact), unquote(version)))
|
||||
if not packages:
|
||||
raise ValueError("Empty CycloneDX inventory")
|
||||
return packages
|
||||
def components(report):
|
||||
if not isinstance(report, dict) or report.get("bomFormat") != "CycloneDX":
|
||||
raise ValueError("Expected CycloneDX inventory")
|
||||
packages = set()
|
||||
for component in report.get("components", []):
|
||||
purl = urlsplit(component.get("purl", ""))
|
||||
if purl.scheme != "pkg" or not purl.path.startswith("maven/"):
|
||||
raise ValueError("Missing Maven package URL")
|
||||
coordinate, version = purl.path.removeprefix("maven/").rsplit("@", 1)
|
||||
group, artifact = coordinate.split("/", 1)
|
||||
packages.add((unquote(group) + ":" + unquote(artifact), unquote(version)))
|
||||
if not packages:
|
||||
raise ValueError("Empty CycloneDX inventory")
|
||||
return packages
|
||||
|
||||
|
||||
def check(expected: set[tuple[str, str]], bom: object, trivy: object = OMITTED) -> int:
|
||||
"""Require exact SBOM coverage and, when supplied, selected Trivy coverage."""
|
||||
actual = components(bom)
|
||||
if actual != expected:
|
||||
raise ValueError(f"Maven/SBOM mismatch: missing={sorted(expected - actual)}, extra={sorted(actual - expected)}")
|
||||
if trivy is not OMITTED:
|
||||
typed_trivy = cast(TrivyReport, trivy)
|
||||
if not isinstance(trivy, dict) or not isinstance(typed_trivy.get("Results"), list):
|
||||
raise ValueError("Expected Trivy report object with Results array")
|
||||
scanned = {(p["Name"], p["Version"]) for r in typed_trivy.get("Results", []) for p in r.get("Packages", [])}
|
||||
# Trivy also reports the root project represented by SBOM metadata.
|
||||
root = cast(Bom, bom).get("metadata", {}).get("component", {})
|
||||
allowed = expected | {(root.get("group", "") + ":" + root.get("name", ""), root.get("version", ""))}
|
||||
if not expected.issubset(scanned) or not scanned.issubset(allowed):
|
||||
raise ValueError(f"Maven/Trivy mismatch: missing={sorted(expected - scanned)}, extra={sorted(scanned - allowed)}")
|
||||
return len(expected)
|
||||
def check(expected, bom, trivy=OMITTED):
|
||||
actual = components(bom)
|
||||
if actual != expected:
|
||||
raise ValueError(f"Maven/SBOM mismatch: missing={sorted(expected - actual)}, extra={sorted(actual - expected)}")
|
||||
if trivy is not OMITTED:
|
||||
if not isinstance(trivy, dict) or not isinstance(trivy.get("Results"), list):
|
||||
raise ValueError("Expected Trivy report object with Results array")
|
||||
scanned = {(p["Name"], p["Version"]) for r in trivy.get("Results", []) for p in r.get("Packages", [])}
|
||||
# Trivy also reports the root project represented by SBOM metadata.
|
||||
root = bom.get("metadata", {}).get("component", {})
|
||||
allowed = expected | {(root.get("group", "") + ":" + root.get("name", ""), root.get("version", ""))}
|
||||
if not expected.issubset(scanned) or not scanned.issubset(allowed):
|
||||
raise ValueError(f"Maven/Trivy mismatch: missing={sorted(expected - scanned)}, extra={sorted(scanned - allowed)}")
|
||||
return len(expected)
|
||||
|
||||
|
||||
def check_osv(expected: set[tuple[str, str]], report: object) -> int:
|
||||
"""Reject missing, ambiguous, malformed or partial OSV package evidence."""
|
||||
typed_report = cast(OsvReport, report)
|
||||
if not isinstance(report, dict) or not isinstance(typed_report.get("results"), list):
|
||||
raise ValueError("Expected OSV report object with results array")
|
||||
# OSV 2.6.0 queries CycloneDX purls but omits Maven groups in JSON names:
|
||||
# https://github.com/google/osv-scanner/issues/3099
|
||||
# Fail on ambiguous display coordinates instead of claiming full identity proof.
|
||||
projected = Counter((name.split(":", 1)[1], version) for name, version in expected)
|
||||
if any(count != 1 for count in projected.values()):
|
||||
raise ValueError("Ambiguous Maven coordinates in pinned OSV report format")
|
||||
scanned: Counter[tuple[str, str]] = Counter()
|
||||
for raw_result in cast(list[object], typed_report.get("results")):
|
||||
result = cast(OsvResult, raw_result)
|
||||
if not isinstance(raw_result, dict) or not isinstance(result.get("source"), dict):
|
||||
raise ValueError("Missing OSV source")
|
||||
source = cast(dict[str, str], result.get("source"))
|
||||
if source.get("type") != "sbom" or not isinstance(source.get("path"), str):
|
||||
raise ValueError("Expected OSV SBOM source")
|
||||
if not isinstance(result.get("packages"), list):
|
||||
raise ValueError("Missing OSV package inventory; use --all-packages")
|
||||
for raw_entry in cast(list[object], result.get("packages")):
|
||||
entry = cast(OsvEntry, raw_entry)
|
||||
if not isinstance(raw_entry, dict) or not isinstance(entry.get("package"), dict):
|
||||
raise ValueError("Malformed OSV package")
|
||||
package = cast(dict[str, str], entry.get("package"))
|
||||
if package.get("ecosystem") != "Maven" or not all(isinstance(package.get(k), str) and package[k] for k in ("name", "version")):
|
||||
raise ValueError("Invalid OSV Maven package coordinate")
|
||||
if "vulnerabilities" in entry and not isinstance(entry["vulnerabilities"], list):
|
||||
raise ValueError("Malformed OSV vulnerabilities")
|
||||
scanned[(package["name"], package["version"])] += 1
|
||||
if scanned != projected:
|
||||
raise ValueError("OSV --all-packages inventory differs from selected Maven graph")
|
||||
return len(expected)
|
||||
def check_osv(expected, report):
|
||||
if not isinstance(report, dict) or not isinstance(report.get("results"), list):
|
||||
raise ValueError("Expected OSV report object with results array")
|
||||
# OSV 2.6.0 queries CycloneDX purls but omits Maven groups in JSON names:
|
||||
# https://github.com/google/osv-scanner/issues/3099
|
||||
# Fail on ambiguous display coordinates instead of claiming full identity proof.
|
||||
projected = Counter((name.split(":", 1)[1], version) for name, version in expected)
|
||||
if any(count != 1 for count in projected.values()):
|
||||
raise ValueError("Ambiguous Maven coordinates in pinned OSV report format")
|
||||
scanned = Counter()
|
||||
for result in report["results"]:
|
||||
if not isinstance(result, dict) or not isinstance(result.get("source"), dict):
|
||||
raise ValueError("Missing OSV source")
|
||||
if result["source"].get("type") != "sbom" or not isinstance(result["source"].get("path"), str):
|
||||
raise ValueError("Expected OSV SBOM source")
|
||||
if not isinstance(result.get("packages"), list):
|
||||
raise ValueError("Missing OSV package inventory; use --all-packages")
|
||||
for entry in result["packages"]:
|
||||
if not isinstance(entry, dict) or not isinstance(entry.get("package"), dict):
|
||||
raise ValueError("Malformed OSV package")
|
||||
package = entry["package"]
|
||||
if package.get("ecosystem") != "Maven" or not all(isinstance(package.get(k), str) and package[k] for k in ("name", "version")):
|
||||
raise ValueError("Invalid OSV Maven package coordinate")
|
||||
if "vulnerabilities" in entry and not isinstance(entry["vulnerabilities"], list):
|
||||
raise ValueError("Malformed OSV vulnerabilities")
|
||||
scanned[(package["name"], package["version"])] += 1
|
||||
if scanned != projected:
|
||||
raise ValueError("OSV --all-packages inventory differs from selected Maven graph")
|
||||
return len(expected)
|
||||
|
||||
|
||||
def main() -> None:
|
||||
"""Validate the exact evidence files supplied by the required CI job."""
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("resolved", type=Path)
|
||||
parser.add_argument("bom", type=Path)
|
||||
parser.add_argument("trivy", type=Path, nargs="?")
|
||||
parser.add_argument("--osv", type=Path)
|
||||
args = parser.parse_args()
|
||||
expected = resolved(args.resolved.read_text(encoding="utf-8"))
|
||||
count = check(expected, json.loads(args.bom.read_text(encoding="utf-8")), json.loads(args.trivy.read_text(encoding="utf-8")) if args.trivy else OMITTED)
|
||||
if args.osv:
|
||||
check_osv(expected, json.loads(args.osv.read_text(encoding="utf-8")))
|
||||
print(f"Verified {count} Maven runtime dependencies, including the UI frontend.")
|
||||
def main():
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("resolved", type=Path)
|
||||
parser.add_argument("bom", type=Path)
|
||||
parser.add_argument("trivy", type=Path, nargs="?")
|
||||
parser.add_argument("--osv", type=Path)
|
||||
args = parser.parse_args()
|
||||
expected = resolved(args.resolved.read_text(encoding="utf-8"))
|
||||
count = check(expected,
|
||||
json.loads(args.bom.read_text(encoding="utf-8")),
|
||||
json.loads(args.trivy.read_text(encoding="utf-8")) if args.trivy else OMITTED)
|
||||
if args.osv:
|
||||
check_osv(expected, json.loads(args.osv.read_text(encoding="utf-8")))
|
||||
print(f"Verified {count} Maven runtime dependencies, including the UI frontend.")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
main()
|
||||
@@ -1,112 +0,0 @@
|
||||
# Copyright 2026 Kingsrook, LLC
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
"""Fail closed unless every tracked owned script is covered by, and really analyzed by, the quality tools."""
|
||||
|
||||
import json
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path, PurePosixPath
|
||||
from typing import Any
|
||||
|
||||
PYTHON_SUFFIXES = (".py", ".pyi", ".pyw")
|
||||
SCRIPT_PATTERN = ".github/scripts/*.py"
|
||||
PYRIGHT_CONFIG = ".github"
|
||||
JAVASCRIPT_SUFFIXES = (".js", ".cjs", ".mjs", ".jsx", ".ts", ".mts", ".cts", ".tsx")
|
||||
# Microsoft's official npm Pyright, restored from package-lock.json by `npm ci --ignore-scripts`.
|
||||
PYRIGHT_ENTRY = Path(__file__).resolve().parents[2] / "node_modules" / "pyright" / "index.js"
|
||||
|
||||
|
||||
def tracked_files(root: Path) -> list[str]:
|
||||
"""List tracked and not-yet-ignored new paths so no source file can silently bypass the gates."""
|
||||
# Fixed Git inventory operation; the root is an argument, never shell input.
|
||||
output = subprocess.run(["git", "-C", str(root), "ls-files", "-z", "--cached", "--others", "--exclude-standard"], check=True, capture_output=True).stdout.decode("utf-8") # noqa: S603, S607 -- Resolve Git from the developer/CI PATH; no shell or user-supplied command.
|
||||
return [name for name in output.split("\u0000") if name]
|
||||
|
||||
|
||||
def python_scope(tracked: list[str]) -> list[str]:
|
||||
"""Return the tracked Python sources, rejecting any outside the one checked script root."""
|
||||
candidates = sorted(name for name in tracked if name.endswith(PYTHON_SUFFIXES))
|
||||
outside = [name for name in candidates if not PurePosixPath(name).full_match(SCRIPT_PATTERN)]
|
||||
if outside:
|
||||
raise ValueError("Tracked Python outside the checked script root: " + ", ".join(outside))
|
||||
if not candidates:
|
||||
raise ValueError("No owned Python scripts selected")
|
||||
return candidates
|
||||
|
||||
|
||||
def javascript_scope(root: Path, tracked: list[str]) -> list[str]:
|
||||
"""Return tracked JavaScript/TypeScript sources, rejecting any outside the tsconfig include list."""
|
||||
candidates = sorted(name for name in tracked if name.endswith(JAVASCRIPT_SUFFIXES))
|
||||
tsconfig = root / "tsconfig.json"
|
||||
if not tsconfig.is_file():
|
||||
if candidates:
|
||||
raise ValueError("Tracked JavaScript/TypeScript without a tsconfig.json: " + ", ".join(candidates))
|
||||
return []
|
||||
includes: list[str] = json.loads(tsconfig.read_text(encoding="utf-8"))["include"]
|
||||
outside = [name for name in candidates if not any(PurePosixPath(name).full_match(pattern) for pattern in includes)]
|
||||
if outside:
|
||||
raise ValueError("Tracked JavaScript/TypeScript outside the tsconfig include list: " + ", ".join(outside))
|
||||
if not candidates:
|
||||
raise ValueError("No owned JavaScript sources selected")
|
||||
return candidates
|
||||
|
||||
|
||||
def run_pyright(root: Path, config: str) -> dict[str, Any]:
|
||||
"""Run the locked npm Pyright through Node with JSON output and return its full report."""
|
||||
node = shutil.which("node")
|
||||
if node is None:
|
||||
raise ValueError("Node.js is required to run the locked Pyright")
|
||||
if not PYRIGHT_ENTRY.is_file():
|
||||
raise ValueError(f"Locked Pyright is missing; run npm ci --ignore-scripts ({PYRIGHT_ENTRY})")
|
||||
# Resolved Node and locked entry script; the config is an argument, never shell input.
|
||||
completed = subprocess.run([node, str(PYRIGHT_ENTRY), "-p", config, "--outputjson"], cwd=root, check=False, capture_output=True, text=True, encoding="utf-8") # noqa: S603 -- Resolved Node and locked entry script; no shell.
|
||||
try:
|
||||
report: dict[str, Any] = json.loads(completed.stdout[completed.stdout.index("{") :])
|
||||
int(report["summary"]["filesAnalyzed"]) # Fail here when the summary shape is missing.
|
||||
report["exitCode"] = completed.returncode
|
||||
except (ValueError, KeyError) as error:
|
||||
raise ValueError(f"Pyright produced no JSON summary (exit {completed.returncode}): {completed.stdout}{completed.stderr}") from error
|
||||
return report
|
||||
|
||||
|
||||
def check_pyright_report(report: dict[str, Any], expected: int) -> None:
|
||||
"""Require the analyzed-file count to match the selected sources, with no errors or warnings."""
|
||||
summary = report["summary"]
|
||||
analyzed = summary["filesAnalyzed"]
|
||||
if analyzed == 0 or analyzed != expected:
|
||||
raise ValueError(f"Pyright analyzed {analyzed} files, expected {expected}")
|
||||
if summary["errorCount"] or summary["warningCount"]:
|
||||
details = [f"{item['file']}: {item['message']}" for item in report["generalDiagnostics"]]
|
||||
raise ValueError("Pyright reported findings:\n" + "\n".join(details))
|
||||
if report["exitCode"] != 0:
|
||||
raise ValueError(f"Pyright exited {report['exitCode']} despite a clean summary")
|
||||
|
||||
|
||||
def run_ruff(root: Path, arguments: list[str], sources: list[str]) -> None:
|
||||
"""Run Ruff on the explicit source list so no selected file can be skipped."""
|
||||
# Fixed interpreter module invocation; paths are arguments, never shell input.
|
||||
if subprocess.run([sys.executable, "-m", "ruff", *arguments, "--no-cache", *sources], cwd=root, check=False).returncode != 0: # noqa: S603 -- Fixed interpreter and module; no shell.
|
||||
raise ValueError("Ruff " + " ".join(arguments) + " failed")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
"""Verify scope, then Ruff format/lint and strict Pyright with a positive analyzed count."""
|
||||
root = Path(__file__).resolve().parents[2]
|
||||
tracked = tracked_files(root)
|
||||
sources = python_scope(tracked)
|
||||
javascript = javascript_scope(root, tracked)
|
||||
run_ruff(root, ["format", "--check"], sources)
|
||||
run_ruff(root, ["check"], sources)
|
||||
report = run_pyright(root, PYRIGHT_CONFIG)
|
||||
check_pyright_report(report, len(sources))
|
||||
print(f"Script quality verified: {len(sources)} Python scripts analyzed by Ruff and Pyright, {len(javascript)} JavaScript files in tsconfig scope")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
main()
|
||||
except (ValueError, OSError, subprocess.CalledProcessError) as error:
|
||||
print(str(error), file=sys.stderr)
|
||||
sys.exit(1)
|
||||
@@ -19,14 +19,14 @@ def selected(name: str, policy: dict[str, Any]) -> bool:
|
||||
return any(fnmatch.fnmatchcase(name, pattern) for pattern in policy["includes"])
|
||||
|
||||
|
||||
def leading_comments(text: str, style: str) -> str: # noqa: PLR0912 -- Each recognized leading-comment syntax has a distinct fail-closed branch.
|
||||
def leading_comments(text: str, style: str) -> str:
|
||||
"""Read comments only, preserving required interpreter/XML directive ordering."""
|
||||
text = text.removeprefix("\ufeff")
|
||||
if text.startswith("<?xml"):
|
||||
declaration = re.match(r"<\?xml[^?]*\?>", text)
|
||||
if style != "xml" or declaration is None:
|
||||
raise ValueError("Invalid XML declaration")
|
||||
text = text[declaration.end() :]
|
||||
text = text[declaration.end():]
|
||||
elif text.startswith("#!"):
|
||||
if style not in ("hash", "powershell", "slash"):
|
||||
raise ValueError("Unexpected interpreter directive")
|
||||
@@ -35,7 +35,7 @@ def leading_comments(text: str, style: str) -> str: # noqa: PLR0912 -- Each rec
|
||||
if style != "powershell":
|
||||
raise ValueError("Unexpected PowerShell directive")
|
||||
text = text.partition("\n")[2]
|
||||
comments: list[str] = []
|
||||
comments = []
|
||||
while text.strip():
|
||||
text = text.lstrip()
|
||||
if text.startswith("<?xml") or re.match(r"#!|#Requires\b", text, re.IGNORECASE):
|
||||
@@ -46,9 +46,11 @@ def leading_comments(text: str, style: str) -> str: # noqa: PLR0912 -- Each rec
|
||||
elif style == "slash" and text.startswith("//"):
|
||||
line, _, text = text.partition("\n")
|
||||
comments.append(line[2:])
|
||||
elif (style == "slash" and text.startswith("/*")) or (style == "xml" and text.startswith("<!--")) or (style == "powershell" and text.startswith("<#")):
|
||||
elif ((style == "slash" and text.startswith("/*"))
|
||||
or (style == "xml" and text.startswith("<!--"))
|
||||
or (style == "powershell" and text.startswith("<#"))):
|
||||
opening, closing = {"slash": ("/*", "*/"), "xml": ("<!--", "-->"), "powershell": ("<#", "#>")}[style]
|
||||
body, separator, rest = text[len(opening) :].partition(closing)
|
||||
body, separator, rest = text[len(opening):].partition(closing)
|
||||
if not separator:
|
||||
raise ValueError("Unterminated leading comment")
|
||||
comments.append(body)
|
||||
@@ -70,22 +72,19 @@ def check_notice(name: str, text: str, policy: dict[str, Any]) -> None:
|
||||
approved = [item for item in policy["notices"] if any(fnmatch.fnmatchcase(name, pattern) for pattern in item["paths"])]
|
||||
for notice in approved:
|
||||
holder = re.escape(notice["holder"])
|
||||
copyright_pattern = rf"(?m)^Copyright\s+(?:\([cC]\)\s*)?\d{{4}}(?:[-\u2013]\d{{4}})?\.?\s+{holder}(?:\s+\(KofTwentyTwo\))?\.?(?:\s+Licensed under the MIT License \(see LICENSE\)\.)?$"
|
||||
copyright_pattern = rf"(?m)^Copyright\s+(?:\([cC]\)\s*)?\d{{4}}(?:[-–]\d{{4}})?\.?\s+{holder}(?:\s+\(KofTwentyTwo\))?\.?(?:\s+Licensed under the MIT License \(see LICENSE\)\.)?$"
|
||||
if re.search(copyright_pattern, comments) is None:
|
||||
continue
|
||||
spdx = re.findall(r"(?m)^SPDX-License-Identifier:\s*(\S+)\s*$", comments)
|
||||
if spdx and any(value != notice["license"] for value in spdx):
|
||||
continue
|
||||
apache = all(
|
||||
phrase in comments
|
||||
for phrase in (
|
||||
"Licensed under the Apache License, Version 2.0",
|
||||
"you may not use this file except in compliance with the License.",
|
||||
"https://www.apache.org/licenses/LICENSE-2.0",
|
||||
"WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND",
|
||||
"limitations under the License.",
|
||||
)
|
||||
)
|
||||
apache = all(phrase in comments for phrase in (
|
||||
"Licensed under the Apache License, Version 2.0",
|
||||
"you may not use this file except in compliance with the License.",
|
||||
"https://www.apache.org/licenses/LICENSE-2.0",
|
||||
"WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND",
|
||||
"limitations under the License.",
|
||||
))
|
||||
if suffix == ".java" and not apache:
|
||||
continue
|
||||
if notice["license"] in spdx or (notice["license"] == "Apache-2.0" and apache):
|
||||
@@ -95,9 +94,8 @@ def check_notice(name: str, text: str, policy: dict[str, Any]) -> None:
|
||||
|
||||
def check_repository(root: Path, policy: dict[str, Any]) -> int:
|
||||
"""Check tracked sources without scanning build outputs or executing source."""
|
||||
# Fixed Git inventory operation; paths are arguments, never shell input.
|
||||
tracked = subprocess.run(["git", "-C", str(root), "ls-files", "-z"], check=True, capture_output=True).stdout.decode("utf-8").split("\u0000") # noqa: S603, S607 -- Resolve Git from the developer/CI PATH; no shell or user-supplied command.
|
||||
failures: list[str] = []
|
||||
tracked = subprocess.run(["git", "-C", str(root), "ls-files", "-z"], check=True, capture_output=True).stdout.decode("utf-8").split("\u0000")
|
||||
failures = []
|
||||
count = 0
|
||||
for name in tracked:
|
||||
if not name or not selected(name, policy):
|
||||
|
||||
@@ -2,117 +2,107 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
"""Synthetic regressions for missing, incorrect and empty scanner inventories."""
|
||||
|
||||
import copy
|
||||
import importlib.util
|
||||
import json
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from typing import Any, cast, override
|
||||
import sys
|
||||
import subprocess
|
||||
import tempfile
|
||||
import json
|
||||
import unittest
|
||||
|
||||
|
||||
sys.dont_write_bytecode = True
|
||||
spec = importlib.util.spec_from_file_location("inventory", Path(__file__).with_name("check-maven-inventory.py"))
|
||||
assert spec is not None and spec.loader is not None
|
||||
inventory = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(inventory)
|
||||
|
||||
|
||||
class InventoryTests(unittest.TestCase):
|
||||
"""Exercise selected dependency coverage using isolated synthetic reports."""
|
||||
def setUp(self):
|
||||
self.expected = {(name, "2.4.240" if name == "com.h2database:h2" else "1.0") for name in inventory.REQUIRED} | {("org.jspecify:jspecify", "1.0.0")}
|
||||
self.text = "The following files have been resolved:\n" + "\n".join(
|
||||
f" {name}:jar:{version}:runtime\x1b[36m -- module example\x1b[m" for name, version in self.expected)
|
||||
self.bom = {"bomFormat": "CycloneDX", "components": [
|
||||
{"purl": "pkg:maven/" + name.replace(":", "/") + "@" + version + "?type=jar"}
|
||||
for name, version in self.expected]}
|
||||
self.trivy = {"Results": [{"Packages": [{"Name": n, "Version": v} for n, v in self.expected], "Vulnerabilities": []}]}
|
||||
|
||||
@override
|
||||
def setUp(self) -> None:
|
||||
"""Create isolated synthetic evidence with cleanup after each test."""
|
||||
self.expected = {(name, "2.4.240" if name == "com.h2database:h2" else "1.0") for name in inventory.REQUIRED} | {("org.jspecify:jspecify", "1.0.0")}
|
||||
self.text = "The following files have been resolved:\n" + "\n".join(f" {name}:jar:{version}:runtime\x1b[36m -- module example\x1b[m" for name, version in self.expected)
|
||||
self.bom: dict[str, Any] = {"bomFormat": "CycloneDX", "components": [{"purl": "pkg:maven/" + name.replace(":", "/") + "@" + version + "?type=jar"} for name, version in self.expected]}
|
||||
self.trivy: dict[str, Any] = {"Results": [{"Packages": [{"Name": n, "Version": v} for n, v in self.expected], "Vulnerabilities": []}]}
|
||||
def test_complete_graph_without_findings_passes(self):
|
||||
self.assertEqual(self.expected, inventory.resolved(self.text))
|
||||
self.assertEqual(6, inventory.check(self.expected, self.bom, self.trivy))
|
||||
|
||||
def test_complete_graph_without_findings_passes(self) -> None:
|
||||
"""Verify complete graph without findings passes."""
|
||||
self.assertEqual(self.expected, inventory.resolved(self.text))
|
||||
self.assertEqual(6, inventory.check(self.expected, self.bom, self.trivy))
|
||||
def test_missing_or_unreviewed_h2_version_fails(self):
|
||||
without_h2 = "\n".join(line for line in self.text.splitlines() if "com.h2database:h2:" not in line)
|
||||
for text in (without_h2, self.text.replace("2.4.240", "2.3.232"), self.text.replace("2.4.240", "2.4.241"),
|
||||
self.text + "\ncom.h2database:h2:jar:2.3.232:runtime"):
|
||||
with self.subTest(text=text), self.assertRaises(ValueError):
|
||||
inventory.resolved(text)
|
||||
|
||||
def test_missing_or_unreviewed_h2_version_fails(self) -> None:
|
||||
"""Verify missing or unreviewed h2 version fails."""
|
||||
without_h2 = "\n".join(line for line in self.text.splitlines() if "com.h2database:h2:" not in line)
|
||||
for text in (without_h2, self.text.replace("2.4.240", "2.3.232"), self.text.replace("2.4.240", "2.4.241"), self.text + "\ncom.h2database:h2:jar:2.3.232:runtime"):
|
||||
with self.subTest(text=text), self.assertRaises(ValueError):
|
||||
inventory.resolved(text)
|
||||
def test_missing_frontend_and_empty_maven_fail(self):
|
||||
for text in ("", "\n".join(line for line in self.text.splitlines() if "qqq-frontend-next" not in line)):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.resolved(text)
|
||||
|
||||
def test_missing_frontend_and_empty_maven_fail(self) -> None:
|
||||
"""Verify missing frontend and empty maven fail."""
|
||||
for text in ("", "\n".join(line for line in self.text.splitlines() if "qqq-frontend-next" not in line)):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.resolved(text)
|
||||
def test_test_scope_or_test_jar_fails(self):
|
||||
for extra in ("example:test:jar:1:test", "org.junit.jupiter:junit-jupiter:jar:5:runtime"):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.resolved(self.text + "\n" + extra)
|
||||
|
||||
def test_test_scope_or_test_jar_fails(self) -> None:
|
||||
"""Verify test scope or test jar fails."""
|
||||
for extra in ("example:test:jar:1:test", "org.junit.jupiter:junit-jupiter:jar:5:runtime"):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.resolved(self.text + "\n" + extra)
|
||||
def test_empty_malformed_or_missing_component_fails(self):
|
||||
for bom in ({}, {"bomFormat": "CycloneDX", "components": []}, {"bomFormat": "CycloneDX", "components": [{}]},
|
||||
{"bomFormat": "CycloneDX", "components": self.bom["components"][1:]}):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.check(self.expected, bom)
|
||||
|
||||
def test_empty_malformed_or_missing_component_fails(self) -> None:
|
||||
"""Verify empty malformed or missing component fails."""
|
||||
for bom in cast(tuple[object, ...], ({}, {"bomFormat": "CycloneDX", "components": []}, {"bomFormat": "CycloneDX", "components": [{}]}, {"bomFormat": "CycloneDX", "components": self.bom["components"][1:]})):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.check(self.expected, bom)
|
||||
def test_wrong_selected_version_fails(self):
|
||||
bad = copy.deepcopy(self.trivy)
|
||||
for package in bad["Results"][0]["Packages"]:
|
||||
if package["Name"] == "org.jspecify:jspecify":
|
||||
package["Version"] = "1.0.1"
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.check(self.expected, self.bom, bad)
|
||||
|
||||
def test_wrong_selected_version_fails(self) -> None:
|
||||
"""Verify wrong selected version fails."""
|
||||
bad = copy.deepcopy(self.trivy)
|
||||
for package in bad["Results"][0]["Packages"]:
|
||||
if package["Name"] == "org.jspecify:jspecify":
|
||||
package["Version"] = "1.0.1"
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.check(self.expected, self.bom, bad)
|
||||
def test_empty_or_dropped_trivy_package_fails(self):
|
||||
for report in (None, {}, {"Results": []}, {"Results": [{"Packages": self.trivy["Results"][0]["Packages"][1:]}]}):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.check(self.expected, self.bom, report)
|
||||
|
||||
def test_empty_or_dropped_trivy_package_fails(self) -> None:
|
||||
"""Verify empty or dropped trivy package fails."""
|
||||
for report in cast(tuple[object, ...], (None, {}, {"Results": []}, {"Results": [{"Packages": self.trivy["Results"][0]["Packages"][1:]}]})):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.check(self.expected, self.bom, report)
|
||||
def test_cli_supplied_null_trivy_fails(self):
|
||||
with tempfile.TemporaryDirectory() as temporary:
|
||||
directory = Path(temporary)
|
||||
(directory / "resolved.txt").write_text(self.text, encoding="utf-8")
|
||||
(directory / "bom.json").write_text(json.dumps(self.bom), encoding="utf-8")
|
||||
(directory / "trivy.json").write_text("null", encoding="utf-8")
|
||||
result = subprocess.run([sys.executable, str(Path(inventory.__file__)),
|
||||
str(directory / "resolved.txt"), str(directory / "bom.json"),
|
||||
str(directory / "trivy.json")], capture_output=True, text=True, check=False)
|
||||
self.assertNotEqual(0, result.returncode)
|
||||
self.assertIn("Expected Trivy report object", result.stderr)
|
||||
|
||||
def test_cli_supplied_null_trivy_fails(self) -> None:
|
||||
"""Verify cli supplied null trivy fails."""
|
||||
with tempfile.TemporaryDirectory() as temporary:
|
||||
directory = Path(temporary)
|
||||
(directory / "resolved.txt").write_text(self.text, encoding="utf-8")
|
||||
(directory / "bom.json").write_text(json.dumps(self.bom), encoding="utf-8")
|
||||
(directory / "trivy.json").write_text("null", encoding="utf-8")
|
||||
assert inventory.__file__ is not None
|
||||
result = subprocess.run([sys.executable, str(Path(inventory.__file__)), str(directory / "resolved.txt"), str(directory / "bom.json"), str(directory / "trivy.json")], capture_output=True, text=True, check=False) # noqa: S603 -- Execute this interpreter and the fixed sibling guard using synthetic paths, without a shell.
|
||||
self.assertNotEqual(0, result.returncode)
|
||||
self.assertIn("Expected Trivy report object", result.stderr)
|
||||
def osv(self):
|
||||
return {"results": [{"source": {"path": "/src/printing.cdx.json", "type": "sbom"}, "packages": [
|
||||
{"package": {"name": name.split(":", 1)[1], "version": version, "ecosystem": "Maven"}}
|
||||
for name, version in self.expected]}]}
|
||||
|
||||
def osv(self) -> dict[str, Any]:
|
||||
"""Build a clean OSV fixture whose identity matches the selected graph."""
|
||||
return {"results": [{"source": {"path": "/src/printing.cdx.json", "type": "sbom"}, "packages": [{"package": {"name": name.split(":", 1)[1], "version": version, "ecosystem": "Maven"}} for name, version in self.expected]}]}
|
||||
def test_osv_all_clean_packages_pass_without_vulnerabilities(self):
|
||||
self.assertEqual(6, inventory.check_osv(self.expected, self.osv()))
|
||||
|
||||
def test_osv_all_clean_packages_pass_without_vulnerabilities(self) -> None:
|
||||
"""Verify osv all clean packages pass without vulnerabilities."""
|
||||
self.assertEqual(6, inventory.check_osv(self.expected, self.osv()))
|
||||
def test_osv_missing_malformed_or_partial_evidence_fails(self):
|
||||
partial = self.osv()
|
||||
partial["results"][0]["packages"].pop()
|
||||
wrong = self.osv()
|
||||
wrong["results"][0]["packages"][0]["package"]["version"] = "wrong"
|
||||
duplicate = self.osv()
|
||||
duplicate["results"][0]["packages"].append(duplicate["results"][0]["packages"][0])
|
||||
for report in (None, {}, [], {"results": None}, {"results": []}, {"results": [{}]}, partial, wrong, duplicate):
|
||||
with self.subTest(report=report), self.assertRaises(ValueError):
|
||||
inventory.check_osv(self.expected, report)
|
||||
|
||||
def test_osv_missing_malformed_or_partial_evidence_fails(self) -> None:
|
||||
"""Verify osv missing malformed or partial evidence fails."""
|
||||
partial = self.osv()
|
||||
partial["results"][0]["packages"].pop()
|
||||
wrong = self.osv()
|
||||
wrong["results"][0]["packages"][0]["package"]["version"] = "wrong"
|
||||
duplicate = self.osv()
|
||||
duplicate["results"][0]["packages"].append(duplicate["results"][0]["packages"][0])
|
||||
for report in cast(tuple[object, ...], (None, {}, [], {"results": None}, {"results": []}, {"results": [{}]}, partial, wrong, duplicate)):
|
||||
with self.subTest(report=report), self.assertRaises(ValueError):
|
||||
inventory.check_osv(self.expected, report)
|
||||
|
||||
def test_osv_ambiguous_group_projection_fails(self) -> None:
|
||||
"""Verify osv ambiguous group projection fails."""
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.check_osv(self.expected | {("other:jspecify", "1.0.0")}, self.osv())
|
||||
def test_osv_ambiguous_group_projection_fails(self):
|
||||
with self.assertRaises(ValueError):
|
||||
inventory.check_osv(self.expected | {("other:jspecify", "1.0.0")}, self.osv())
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
unittest.main()
|
||||
@@ -2,106 +2,91 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
"""Exercise the exact CI guards using synthetic evidence only."""
|
||||
|
||||
import contextlib
|
||||
import copy
|
||||
import importlib.util
|
||||
import io
|
||||
import importlib.util
|
||||
import json
|
||||
from pathlib import Path
|
||||
import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from types import ModuleType
|
||||
from typing import Any, override
|
||||
|
||||
|
||||
sys.dont_write_bytecode = True
|
||||
|
||||
|
||||
def load(name: str) -> ModuleType:
|
||||
"""Load the real sibling guard for synthetic evidence tests."""
|
||||
spec = importlib.util.spec_from_file_location(name, Path(__file__).with_name(name + ".py"))
|
||||
assert spec is not None and spec.loader is not None
|
||||
module = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(module)
|
||||
return module
|
||||
def load(name):
|
||||
spec = importlib.util.spec_from_file_location(name, Path(__file__).with_name(name + ".py"))
|
||||
module = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(module)
|
||||
return module
|
||||
|
||||
|
||||
codeql = load("check-codeql-sarif")
|
||||
|
||||
|
||||
class SarifTests(unittest.TestCase):
|
||||
"""Reject incomplete SARIF evidence and preserve severity enforcement."""
|
||||
def setUp(self):
|
||||
self.temporary = tempfile.TemporaryDirectory()
|
||||
self.addCleanup(self.temporary.cleanup)
|
||||
self.directory = Path(self.temporary.name)
|
||||
self.report = {"version": "2.1.0", "runs": [{"tool": {"driver": {"name": "CodeQL", "rules": [{"id": "synthetic", "properties": {"security-severity": "8.0"}}]}}, "results": []}]}
|
||||
|
||||
@override
|
||||
def setUp(self) -> None:
|
||||
"""Create isolated synthetic evidence with cleanup after each test."""
|
||||
self.temporary = tempfile.TemporaryDirectory()
|
||||
self.addCleanup(self.temporary.cleanup)
|
||||
self.directory = Path(self.temporary.name)
|
||||
self.report: dict[str, Any] = {"version": "2.1.0", "runs": [{"tool": {"driver": {"name": "CodeQL", "rules": [{"id": "synthetic", "properties": {"security-severity": "8.0"}}]}}, "results": []}]}
|
||||
def save(self, report):
|
||||
(self.directory / "java.sarif").write_text(json.dumps(report), encoding="utf-8")
|
||||
|
||||
def save(self, report: object) -> None:
|
||||
"""Write the test body as SARIF without validating it first."""
|
||||
(self.directory / "java.sarif").write_text(json.dumps(report), encoding="utf-8")
|
||||
def test_clean_report_with_zero_findings_passes(self):
|
||||
self.save(self.report)
|
||||
self.assertFalse(codeql.check(self.directory, "java-kotlin", 7))
|
||||
|
||||
def test_clean_report_with_zero_findings_passes(self) -> None:
|
||||
"""Verify clean report with zero findings passes."""
|
||||
self.save(self.report)
|
||||
self.assertFalse(codeql.check(self.directory, "java-kotlin", 7))
|
||||
def test_missing_report_or_wrong_language_fails(self):
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
self.save(self.report)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "csharp", 7)
|
||||
|
||||
def test_missing_report_or_wrong_language_fails(self) -> None:
|
||||
"""Verify missing report or wrong language fails."""
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
self.save(self.report)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "csharp", 7)
|
||||
def test_empty_or_malformed_report_fails(self):
|
||||
for text in ["", "{", "null", "[]"]:
|
||||
with self.subTest(text=text):
|
||||
(self.directory / "java.sarif").write_text(text)
|
||||
with self.assertRaises((ValueError, AttributeError)):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
|
||||
def test_empty_or_malformed_report_fails(self) -> None:
|
||||
"""Verify empty or malformed report fails."""
|
||||
for text in ["", "{", "null", "[]"]:
|
||||
with self.subTest(text=text):
|
||||
(self.directory / "java.sarif").write_text(text)
|
||||
with self.assertRaises((ValueError, AttributeError)):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
def test_missing_runs_tool_rules_or_results_fails(self):
|
||||
variants = [{"version": "2.1.0"}, {"version": "2.1.0", "runs": []}]
|
||||
for field in ["tool", "results"]:
|
||||
bad = copy.deepcopy(self.report)
|
||||
del bad["runs"][0][field]
|
||||
variants.append(bad)
|
||||
bad = copy.deepcopy(self.report)
|
||||
bad["runs"][0]["tool"]["driver"]["rules"] = []
|
||||
variants.append(bad)
|
||||
for bad in variants:
|
||||
with self.subTest(report=bad):
|
||||
self.save(bad)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
|
||||
def test_missing_runs_tool_rules_or_results_fails(self) -> None:
|
||||
"""Verify missing runs tool rules or results fails."""
|
||||
variants: list[dict[str, Any]] = [{"version": "2.1.0"}, {"version": "2.1.0", "runs": []}]
|
||||
for field in ["tool", "results"]:
|
||||
bad = copy.deepcopy(self.report)
|
||||
del bad["runs"][0][field]
|
||||
variants.append(bad)
|
||||
bad = copy.deepcopy(self.report)
|
||||
bad["runs"][0]["tool"]["driver"]["rules"] = []
|
||||
variants.append(bad)
|
||||
for bad in variants:
|
||||
with self.subTest(report=bad):
|
||||
self.save(bad)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
def test_high_finding_blocks_and_unknown_rule_fails(self):
|
||||
self.report["runs"][0]["results"] = [{"ruleId": "synthetic"}]
|
||||
self.save(self.report)
|
||||
with contextlib.redirect_stdout(io.StringIO()):
|
||||
self.assertTrue(codeql.check(self.directory, "java-kotlin", 7))
|
||||
self.report["runs"][0]["results"] = [{"ruleId": "missing"}]
|
||||
self.save(self.report)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
|
||||
def test_high_finding_blocks_and_unknown_rule_fails(self) -> None:
|
||||
"""Verify high finding blocks and unknown rule fails."""
|
||||
self.report["runs"][0]["results"] = [{"ruleId": "synthetic"}]
|
||||
self.save(self.report)
|
||||
with contextlib.redirect_stdout(io.StringIO()):
|
||||
self.assertTrue(codeql.check(self.directory, "java-kotlin", 7))
|
||||
self.report["runs"][0]["results"] = [{"ruleId": "missing"}]
|
||||
self.save(self.report)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
|
||||
def test_failed_invocation_and_invalid_threshold_fail(self) -> None:
|
||||
"""Verify failed invocation and invalid threshold fail."""
|
||||
self.report["runs"][0]["invocations"] = [{"executionSuccessful": False}]
|
||||
self.save(self.report)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", float("nan"))
|
||||
def test_failed_invocation_and_invalid_threshold_fail(self):
|
||||
self.report["runs"][0]["invocations"] = [{"executionSuccessful": False}]
|
||||
self.save(self.report)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", 7)
|
||||
with self.assertRaises(ValueError):
|
||||
codeql.check(self.directory, "java-kotlin", float("nan"))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
unittest.main()
|
||||
@@ -1,238 +0,0 @@
|
||||
# Copyright 2026 Kingsrook, LLC
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
"""Prove the quality gates reject real violations, using private temporary fixtures and the locked tools."""
|
||||
|
||||
import importlib.util
|
||||
import json
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from types import ModuleType
|
||||
from typing import Any, override
|
||||
from unittest import mock
|
||||
|
||||
sys.dont_write_bytecode = True
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[2]
|
||||
GOOD_PYTHON = '"""Probe module."""\n\n\ndef add(left: int, right: int) -> int:\n """Add two integers."""\n return left + right\n'
|
||||
UNUSED_IMPORT_PYTHON = '"""Probe module."""\n\nimport os\n\n\ndef add(left: int, right: int) -> int:\n """Add two integers."""\n return left + right\n'
|
||||
TWO_SPACE_PYTHON = '"""Probe module."""\n\n\ndef add(left: int, right: int) -> int:\n """Add two integers."""\n return left + right\n'
|
||||
INCOMPATIBLE_PYTHON = '"""Probe module."""\n\nVALUE: int = "text"\n'
|
||||
UNANNOTATED_PYTHON = '"""Probe module."""\n\n\ndef echo(value):\n """Return the value."""\n return value\n'
|
||||
GOOD_JAVASCRIPT = "export function addNumbers(left, right)\n{\n return left + right;\n}\n"
|
||||
BAD_LAYOUT_JAVASCRIPT = "export function addNumbers(left, right) {\n return left + right\n}\n"
|
||||
GOOD_TYPED_JAVASCRIPT = "/** @type {number} */\nexport const value = 1;\n"
|
||||
INCOMPATIBLE_JAVASCRIPT = '/** @type {number} */\nexport const value = "text";\n'
|
||||
|
||||
|
||||
def load(name: str) -> ModuleType:
|
||||
"""Load the real sibling guard for tests."""
|
||||
spec = importlib.util.spec_from_file_location(name, Path(__file__).with_name(name + ".py"))
|
||||
assert spec is not None and spec.loader is not None
|
||||
module = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(module)
|
||||
return module
|
||||
|
||||
|
||||
guard = load("check-script-quality")
|
||||
|
||||
|
||||
def run(command: list[str], cwd: Path, stdin: str | None = None) -> subprocess.CompletedProcess[str]:
|
||||
"""Run one real tool invocation without a shell and capture its diagnostics."""
|
||||
return subprocess.run(command, cwd=cwd, input=stdin, check=False, capture_output=True, text=True, encoding="utf-8") # noqa: S603 -- Fixed tool paths and private temporary arguments; no shell.
|
||||
|
||||
|
||||
def ruff(arguments: list[str], source: Path) -> subprocess.CompletedProcess[str]:
|
||||
"""Run the locked Ruff with the repository configuration on one private fixture."""
|
||||
return run([sys.executable, "-m", "ruff", *arguments, "--no-cache", "--config", str(ROOT / "ruff.toml"), str(source)], source.parent)
|
||||
|
||||
|
||||
class ScopeTests(unittest.TestCase):
|
||||
"""Reject tracked sources that fall outside the explicit tool roots."""
|
||||
|
||||
def test_python_outside_script_root_is_rejected(self) -> None:
|
||||
"""Reject a tracked Python file outside the script root instead of letting it disappear."""
|
||||
for stray in ("tools/helper.py", ".github/scripts/nested/helper.py", "helper.pyi"):
|
||||
with self.subTest(stray=stray), self.assertRaisesRegex(ValueError, "outside the checked script root"):
|
||||
guard.python_scope([".github/scripts/check-a.py", stray])
|
||||
|
||||
def test_python_scope_returns_sorted_script_root_and_rejects_empty(self) -> None:
|
||||
"""Select only the direct script root, sorted, and reject selecting nothing."""
|
||||
self.assertEqual([".github/scripts/a.py", ".github/scripts/b.py"], guard.python_scope([".github/scripts/b.py", "README.md", ".github/scripts/a.py"]))
|
||||
with self.assertRaisesRegex(ValueError, "No owned Python"):
|
||||
guard.python_scope(["README.md"])
|
||||
|
||||
def test_javascript_requires_tsconfig_include_scope(self) -> None:
|
||||
"""Reject tracked JavaScript outside tsconfig include patterns, including .js/.cjs/.ts."""
|
||||
with tempfile.TemporaryDirectory() as name:
|
||||
root = Path(name)
|
||||
(root / "tsconfig.json").write_text(json.dumps({"include": ["tools/**/*.mjs", "eslint.config.mjs"]}), encoding="utf-8")
|
||||
self.assertEqual(["eslint.config.mjs", "tools/a/b.mjs", "tools/c.mjs"], guard.javascript_scope(root, ["tools/c.mjs", "tools/a/b.mjs", "eslint.config.mjs", "README.md"]))
|
||||
for stray in ("src/z.js", "tools/w.cjs", "tools/v.ts", "tools/u.js"):
|
||||
with self.subTest(stray=stray), self.assertRaisesRegex(ValueError, "outside the tsconfig include list"):
|
||||
guard.javascript_scope(root, ["tools/c.mjs", stray])
|
||||
with self.assertRaisesRegex(ValueError, "No owned JavaScript"):
|
||||
guard.javascript_scope(root, ["README.md"])
|
||||
|
||||
def test_javascript_without_tsconfig_is_rejected(self) -> None:
|
||||
"""Reject JavaScript in a repository that has no tsconfig."""
|
||||
with tempfile.TemporaryDirectory() as name:
|
||||
root = Path(name)
|
||||
self.assertEqual([], guard.javascript_scope(root, ["README.md"]))
|
||||
with self.assertRaisesRegex(ValueError, "without a tsconfig.json"):
|
||||
guard.javascript_scope(root, ["tools/a.mjs"])
|
||||
|
||||
|
||||
class PyrightCountTests(unittest.TestCase):
|
||||
"""Reject Pyright reports that analyzed too few files or found anything."""
|
||||
|
||||
@staticmethod
|
||||
def report(analyzed: int, errors: int = 0, warnings: int = 0) -> dict[str, Any]:
|
||||
"""Build the exact Pyright JSON shape consumed by the guard."""
|
||||
return {"summary": {"filesAnalyzed": analyzed, "errorCount": errors, "warningCount": warnings}, "generalDiagnostics": [{"file": "x.py", "message": "finding"}] * (errors + warnings), "exitCode": 1 if errors or warnings else 0}
|
||||
|
||||
def test_nonzero_exit_fails_even_with_clean_summary(self) -> None:
|
||||
"""Fail a nonzero Pyright exit even when every count is clean."""
|
||||
clean = self.report(4)
|
||||
clean["exitCode"] = 1
|
||||
with self.assertRaisesRegex(ValueError, "exited 1"):
|
||||
guard.check_pyright_report(clean, 4)
|
||||
|
||||
def test_count_must_match_selected_sources(self) -> None:
|
||||
"""Fail zero or mismatched analyzed counts even with no diagnostics."""
|
||||
guard.check_pyright_report(self.report(4), 4)
|
||||
for analyzed in (0, 3, 5):
|
||||
with self.subTest(analyzed=analyzed), self.assertRaisesRegex(ValueError, "analyzed"):
|
||||
guard.check_pyright_report(self.report(analyzed), 4)
|
||||
|
||||
def test_errors_and_warnings_fail(self) -> None:
|
||||
"""Fail on errors and on warnings at the exact count."""
|
||||
for report in (self.report(4, errors=1), self.report(4, warnings=1)):
|
||||
with self.subTest(report=report), self.assertRaisesRegex(ValueError, "reported findings"):
|
||||
guard.check_pyright_report(report, 4)
|
||||
|
||||
|
||||
class RuffProbeTests(unittest.TestCase):
|
||||
"""Run the real locked Ruff on bounded private fixtures."""
|
||||
|
||||
def test_compliant_fixture_passes_and_violations_fail(self) -> None:
|
||||
"""Pass a compliant control and reject unused imports and wrong indentation."""
|
||||
with tempfile.TemporaryDirectory() as name:
|
||||
probe = Path(name) / "probe.py"
|
||||
probe.write_text(GOOD_PYTHON, encoding="utf-8", newline="\n")
|
||||
self.assertEqual(0, ruff(["check"], probe).returncode)
|
||||
self.assertEqual(0, ruff(["format", "--check"], probe).returncode)
|
||||
probe.write_text(UNUSED_IMPORT_PYTHON, encoding="utf-8", newline="\n")
|
||||
unused = ruff(["check", "--output-format", "concise"], probe)
|
||||
self.assertNotEqual(0, unused.returncode)
|
||||
self.assertIn("F401", unused.stdout)
|
||||
probe.write_text(TWO_SPACE_PYTHON, encoding="utf-8", newline="\n")
|
||||
indented = ruff(["format", "--check"], probe)
|
||||
self.assertNotEqual(0, indented.returncode)
|
||||
self.assertIn("would be reformatted", (indented.stdout + indented.stderr).lower())
|
||||
|
||||
|
||||
class PyrightProbeTests(unittest.TestCase):
|
||||
"""Run the real locked Pyright with the repository strict settings on private projects."""
|
||||
|
||||
@staticmethod
|
||||
def project(root: Path, include: list[str] | None = None) -> None:
|
||||
"""Write the repository Pyright config, without its venv location, into a private project."""
|
||||
config: dict[str, Any] = json.loads((ROOT / ".github/pyrightconfig.json").read_text(encoding="utf-8"))
|
||||
del config["venvPath"], config["venv"]
|
||||
if include is not None:
|
||||
config["include"] = include
|
||||
(root / "pyrightconfig.json").write_text(json.dumps(config), encoding="utf-8")
|
||||
|
||||
def test_compliant_control_passes_and_strict_violations_fail(self) -> None:
|
||||
"""Analyze the control once with no findings and reject incompatible and unannotated code."""
|
||||
with tempfile.TemporaryDirectory() as name:
|
||||
root = Path(name)
|
||||
self.project(root)
|
||||
scripts = root / "scripts"
|
||||
scripts.mkdir()
|
||||
probe = scripts / "probe.py"
|
||||
probe.write_text(GOOD_PYTHON, encoding="utf-8", newline="\n")
|
||||
clean = guard.run_pyright(root, ".")
|
||||
self.assertEqual(0, clean["exitCode"])
|
||||
guard.check_pyright_report(clean, 1)
|
||||
clean["exitCode"] = 1
|
||||
with self.assertRaisesRegex(ValueError, "exited 1"):
|
||||
guard.check_pyright_report(clean, 1)
|
||||
probe.write_text(INCOMPATIBLE_PYTHON, encoding="utf-8", newline="\n")
|
||||
report = guard.run_pyright(root, ".")
|
||||
self.assertIn("reportAssignmentType", {item.get("rule") for item in report["generalDiagnostics"]})
|
||||
with self.assertRaisesRegex(ValueError, "reported findings"):
|
||||
guard.check_pyright_report(report, 1)
|
||||
probe.write_text(UNANNOTATED_PYTHON, encoding="utf-8", newline="\n")
|
||||
strict = guard.run_pyright(root, ".")
|
||||
self.assertIn("reportMissingParameterType", {item.get("rule") for item in strict["generalDiagnostics"]})
|
||||
|
||||
def test_missing_locked_pyright_or_node_is_rejected(self) -> None:
|
||||
"""Reject a missing locked Pyright entry or Node instead of silently skipping the type gate."""
|
||||
with tempfile.TemporaryDirectory() as name:
|
||||
root = Path(name)
|
||||
with mock.patch.object(guard, "PYRIGHT_ENTRY", root / "missing.js"), self.assertRaisesRegex(ValueError, "Locked Pyright is missing"):
|
||||
guard.run_pyright(root, ".")
|
||||
with mock.patch.object(guard.shutil, "which", return_value=None), self.assertRaisesRegex(ValueError, "Node.js is required"):
|
||||
guard.run_pyright(root, ".")
|
||||
|
||||
def test_zero_analyzed_files_cannot_pass(self) -> None:
|
||||
"""Reject an empty include and a hidden-directory root config in the wrapper."""
|
||||
with tempfile.TemporaryDirectory() as name:
|
||||
root = Path(name)
|
||||
scripts = root / ".github" / "scripts"
|
||||
scripts.mkdir(parents=True)
|
||||
(scripts / "probe.py").write_text(GOOD_PYTHON, encoding="utf-8", newline="\n")
|
||||
for include in (["nothing/*.py"], [".github/scripts/*.py"]):
|
||||
self.project(root, include)
|
||||
with self.subTest(include=include), self.assertRaises(ValueError):
|
||||
guard.check_pyright_report(guard.run_pyright(root, "."), 1)
|
||||
|
||||
|
||||
class JavaScriptProbeTests(unittest.TestCase):
|
||||
"""Run the real locked ESLint and TypeScript on bounded private input."""
|
||||
|
||||
@override
|
||||
def setUp(self) -> None:
|
||||
"""Skip only where tsconfig is absent, because the scope guard forbids JavaScript there."""
|
||||
if not (ROOT / "tsconfig.json").is_file():
|
||||
self.skipTest("No JavaScript tooling in this repository")
|
||||
node = shutil.which("node")
|
||||
self.assertIsNotNone(node)
|
||||
self.node = str(node)
|
||||
|
||||
def eslint(self, text: str) -> subprocess.CompletedProcess[str]:
|
||||
"""Lint text as an in-scope tool file using the repository configuration."""
|
||||
return run([self.node, str(ROOT / "node_modules/eslint/bin/eslint.js"), "--stdin", "--stdin-filename", "tools/probe.mjs", "--max-warnings", "0", "--format", "json"], ROOT, text)
|
||||
|
||||
def test_eslint_rejects_wrong_layout(self) -> None:
|
||||
"""Pass a compliant control and reject K&R braces, two-space indent and a missing semicolon."""
|
||||
good = self.eslint(GOOD_JAVASCRIPT)
|
||||
self.assertEqual(0, good.returncode, good.stdout + good.stderr)
|
||||
bad = self.eslint(BAD_LAYOUT_JAVASCRIPT)
|
||||
self.assertNotEqual(0, bad.returncode)
|
||||
rules = {message["ruleId"] for message in json.loads(bad.stdout)[0]["messages"]}
|
||||
self.assertLessEqual({"@stylistic/brace-style", "@stylistic/semi", "@stylistic/indent"}, rules)
|
||||
|
||||
def test_checked_javascript_rejects_incompatible_assignment(self) -> None:
|
||||
"""Reject a real incompatible assignment under the repository strict checkJs settings."""
|
||||
with tempfile.TemporaryDirectory() as name:
|
||||
root = Path(name)
|
||||
(root / "tsconfig.json").write_text(json.dumps({"extends": (ROOT / "tsconfig.json").as_posix(), "compilerOptions": {"typeRoots": [(ROOT / "node_modules/@types").as_posix()]}, "include": ["probe.mjs"]}), encoding="utf-8")
|
||||
tsc = [self.node, str(ROOT / "node_modules/typescript/bin/tsc"), "-p", str(root / "tsconfig.json")]
|
||||
(root / "probe.mjs").write_text(GOOD_TYPED_JAVASCRIPT, encoding="utf-8", newline="\n")
|
||||
good = run(tsc, root)
|
||||
self.assertEqual(0, good.returncode, good.stdout + good.stderr)
|
||||
(root / "probe.mjs").write_text(INCOMPATIBLE_JAVASCRIPT, encoding="utf-8", newline="\n")
|
||||
bad = run(tsc, root)
|
||||
self.assertNotEqual(0, bad.returncode)
|
||||
self.assertIn("TS2322", bad.stdout)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -11,6 +11,7 @@ import unittest
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
|
||||
SPEC = importlib.util.spec_from_file_location("headers", Path(__file__).with_name("check-source-headers.py"))
|
||||
assert SPEC is not None and SPEC.loader is not None
|
||||
HEADERS = importlib.util.module_from_spec(SPEC)
|
||||
@@ -31,7 +32,8 @@ limitations under the License."""
|
||||
|
||||
def fixture_policy(holder: str = "James Maes", license_id: str = "MIT") -> dict[str, Any]:
|
||||
"""Use the production styles with a small explicit owned fixture scope."""
|
||||
return {"includes": ["src/*"], "exclusions": [], "styles": POLICY["styles"], "notices": [{"holder": holder, "license": license_id, "paths": ["src/*"]}]}
|
||||
return {"includes": ["src/*"], "exclusions": [], "styles": POLICY["styles"],
|
||||
"notices": [{"holder": holder, "license": license_id, "paths": ["src/*"]}]}
|
||||
|
||||
|
||||
class HeaderTests(unittest.TestCase):
|
||||
@@ -49,23 +51,12 @@ class HeaderTests(unittest.TestCase):
|
||||
with self.subTest(name=name):
|
||||
HEADERS.check_notice(name, text, fixture_policy())
|
||||
|
||||
def test_year_range_separator_is_hyphen_or_en_dash_only(self) -> None:
|
||||
"""Accept a hyphen or en dash between years and reject any other separator."""
|
||||
for separator, accepted in (("-", True), (chr(0x2013), True), ("/", False), (chr(0x2014), False)):
|
||||
text = f"# Copyright 2025{separator}2026 James Maes\n# SPDX-License-Identifier: MIT"
|
||||
with self.subTest(separator=separator):
|
||||
if accepted:
|
||||
HEADERS.check_notice("src/a.py", text, fixture_policy())
|
||||
else:
|
||||
with self.assertRaises(ValueError):
|
||||
HEADERS.check_notice("src/a.py", text, fixture_policy())
|
||||
|
||||
def test_required_first_lines_and_bom(self) -> None:
|
||||
"""Accept shebangs, PowerShell requirements and XML declarations first."""
|
||||
for name, prefix, body in (
|
||||
("src/a.sh", "#!/bin/sh\n", "# " + MIT.replace("\n", "\n# ")),
|
||||
("src/a.ps1", "#Requires -Version 7.4\n", "# " + MIT.replace("\n", "\n# ")),
|
||||
("src/a.xml", '<?xml version="1.0"?>\n', "<!--" + MIT + "--><root/>"),
|
||||
("src/a.xml", "<?xml version=\"1.0\"?>\n", "<!--" + MIT + "--><root/>"),
|
||||
("src/a.mjs", "#!/usr/bin/env node\n", "/*" + MIT + "*/"),
|
||||
):
|
||||
with self.subTest(name=name):
|
||||
@@ -76,20 +67,21 @@ class HeaderTests(unittest.TestCase):
|
||||
for name, text in (
|
||||
("src/a.sh", "# " + MIT.replace("\n", "\n# ") + "\n#!/bin/sh"),
|
||||
("src/a.ps1", "# " + MIT.replace("\n", "\n# ") + "\n#Requires -Version 7.4"),
|
||||
("src/a.xml", "<!--" + MIT + '--><?xml version="1.0"?><root/>'),
|
||||
("src/a.xml", "<!--" + MIT + "--><?xml version=\"1.0\"?><root/>"),
|
||||
):
|
||||
with self.subTest(name=name), self.assertRaises(ValueError):
|
||||
HEADERS.check_notice(name, text, fixture_policy())
|
||||
|
||||
def test_code_strings_and_late_comments_do_not_count(self) -> None:
|
||||
"""Reject docstrings and comments after executable declarations."""
|
||||
for text in ('notice = "' + MIT.replace("\n", "\\n") + '"', '"""' + MIT + '"""', "import os\n# " + MIT.replace("\n", "\n# ")):
|
||||
for text in ("notice = \"" + MIT.replace("\n", "\\n") + "\"",
|
||||
"\"\"\"" + MIT + "\"\"\"", "import os\n# " + MIT.replace("\n", "\n# ")):
|
||||
with self.subTest(text=text), self.assertRaises(ValueError):
|
||||
HEADERS.check_notice("src/a.py", text, fixture_policy())
|
||||
|
||||
def test_wrong_syntax_and_unterminated_comments_fail(self) -> None:
|
||||
"""Notice text alone is insufficient without a complete language comment."""
|
||||
for text in ("# " + MIT, "/*" + MIT, 'string text = "' + MIT + '";'):
|
||||
for text in ("# " + MIT, "/*" + MIT, "string text = \"" + MIT + "\";"):
|
||||
with self.subTest(text=text), self.assertRaises(ValueError):
|
||||
HEADERS.check_notice("src/a.cs", text, fixture_policy())
|
||||
with self.assertRaises(ValueError):
|
||||
@@ -97,7 +89,8 @@ class HeaderTests(unittest.TestCase):
|
||||
|
||||
def test_wrong_holder_or_license_and_conflicting_spdx_fail(self) -> None:
|
||||
"""Do not conflate repository licenses or accept conflicting identifiers."""
|
||||
for text in (MIT.replace("James Maes", "Someone Else"), MIT.replace("MIT", "Apache-2.0"), MIT + "\nSPDX-License-Identifier: Apache-2.0", MIT.splitlines()[0]):
|
||||
for text in (MIT.replace("James Maes", "Someone Else"), MIT.replace("MIT", "Apache-2.0"),
|
||||
MIT + "\nSPDX-License-Identifier: Apache-2.0", MIT.splitlines()[0]):
|
||||
with self.subTest(text=text), self.assertRaises(ValueError):
|
||||
HEADERS.check_notice("src/a.cs", "/*" + text + "*/", fixture_policy())
|
||||
|
||||
@@ -110,7 +103,8 @@ class HeaderTests(unittest.TestCase):
|
||||
def test_java_requires_full_apache_block(self) -> None:
|
||||
"""An abbreviated SPDX-only Java notice cannot replace scoped convention."""
|
||||
policy = fixture_policy("Kingsrook, LLC", "Apache-2.0")
|
||||
for notice in ("Copyright 2026 Kingsrook, LLC\nSPDX-License-Identifier: Apache-2.0", APACHE.replace("limitations under the License.", "")):
|
||||
for notice in ("Copyright 2026 Kingsrook, LLC\nSPDX-License-Identifier: Apache-2.0",
|
||||
APACHE.replace("limitations under the License.", "")):
|
||||
with self.subTest(notice=notice), self.assertRaises(ValueError):
|
||||
HEADERS.check_notice("src/A.java", "/*" + notice + "*/", policy)
|
||||
|
||||
@@ -127,7 +121,9 @@ class HeaderTests(unittest.TestCase):
|
||||
"""New scripts enter the guard; data, generated and upstream files do not."""
|
||||
self.assertTrue(HEADERS.selected(".github/scripts/new-tool.py", POLICY))
|
||||
self.assertTrue(HEADERS.selected(".github/workflows/new-check.yml", POLICY))
|
||||
for name in (".mvn/wrapper/MavenWrapperDownloader.java", "mvnw", "schemas/new.json", "src/main/resources/openapi/new.yaml", "src/test/resources/openapi/old.yaml", "src/generated/Example.cs", "src/Example/obj/Generated.cs", "packages.lock.json"):
|
||||
for name in (".mvn/wrapper/MavenWrapperDownloader.java", "mvnw", "schemas/new.json",
|
||||
"src/main/resources/openapi/new.yaml", "src/test/resources/openapi/old.yaml",
|
||||
"src/generated/Example.cs", "src/Example/obj/Generated.cs", "packages.lock.json"):
|
||||
with self.subTest(name=name):
|
||||
self.assertFalse(HEADERS.selected(name, POLICY))
|
||||
self.assertTrue(all(item["reason"].strip() for item in POLICY["exclusions"]))
|
||||
@@ -144,11 +140,11 @@ class HeaderTests(unittest.TestCase):
|
||||
"""A tracked new source fails while untracked generated output is ignored."""
|
||||
with tempfile.TemporaryDirectory() as directory:
|
||||
root = Path(directory)
|
||||
subprocess.run(["git", "init", "-q", str(root)], check=True) # noqa: S603, S607 -- Fixed Git command in the owned temporary test directory.
|
||||
subprocess.run(["git", "init", "-q", str(root)], check=True)
|
||||
root.joinpath("src").mkdir()
|
||||
source = root / "src/a.py"
|
||||
source.write_text("print(1)", encoding="utf-8")
|
||||
subprocess.run(["git", "-C", str(root), "add", "--", "src/a.py"], check=True) # noqa: S603, S607 -- Fixed synthetic path; never a shell command.
|
||||
subprocess.run(["git", "-C", str(root), "add", "--", "src/a.py"], check=True)
|
||||
with self.assertRaisesRegex(ValueError, "src/a.py"):
|
||||
HEADERS.check_repository(root, fixture_policy())
|
||||
source.write_text("# " + MIT.replace("\n", "\n# ") + "\nprint(1)", encoding="utf-8")
|
||||
|
||||
@@ -29,38 +29,19 @@ jobs:
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
repository: QRun-IO/qqq-print-protocol
|
||||
ref: 42c0d249f81395f00408ec0f92638dcbbf5deb03
|
||||
ref: f3cbc02e9b0fb4fdfefaa59d976c04df747cc589
|
||||
path: qqq-print-protocol
|
||||
persist-credentials: false
|
||||
- uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
|
||||
with:
|
||||
distribution: temurin
|
||||
java-version: '21'
|
||||
- uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
|
||||
with:
|
||||
node-version: '24'
|
||||
package-manager-cache: false
|
||||
- name: Restore locked Pyright
|
||||
run: npm ci --ignore-scripts --no-audit --no-fund
|
||||
- name: Set up uv
|
||||
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
||||
with:
|
||||
version: '0.13.6'
|
||||
enable-cache: false
|
||||
- name: Restore locked Python tools
|
||||
run: uv sync --locked
|
||||
- name: Verify script quality gates and rejection paths
|
||||
run: |
|
||||
uv run --locked --no-sync python .github/scripts/test-script-quality.py
|
||||
uv run --locked --no-sync python .github/scripts/check-script-quality.py
|
||||
- name: Verify owned source notices and rejection paths
|
||||
run: |
|
||||
python3 .github/scripts/test-source-headers.py
|
||||
python3 .github/scripts/check-source-headers.py
|
||||
- name: Checkstyle, unit tests and HTTP contract tests
|
||||
run: bash ./mvnw --batch-mode --no-transfer-progress -Pui-demo verify
|
||||
- name: Prove main and test compiler safety gates reject invalid source
|
||||
run: python3 .github/scripts/check-java-compiler.py
|
||||
- name: Prepare JAR, POM and checksums
|
||||
shell: bash
|
||||
run: |
|
||||
@@ -86,7 +67,6 @@ jobs:
|
||||
path: |
|
||||
qbit-printing/target/surefire-reports/
|
||||
qbit-printing/target/checkstyle-result.xml
|
||||
qbit-printing/target/compiler-guard/
|
||||
if-no-files-found: ignore
|
||||
|
||||
release-security:
|
||||
|
||||
@@ -50,48 +50,6 @@ jobs:
|
||||
$configuration.TestRegistry.Enabled = $false
|
||||
Invoke-Pester -Configuration $configuration
|
||||
|
||||
clients:
|
||||
name: development-clients (${{ matrix.fixture }})
|
||||
runs-on: ubuntu-24.04
|
||||
timeout-minutes: 20
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- fixture: workload
|
||||
dockerfile: dev/Dockerfile.client
|
||||
- fixture: native-auth
|
||||
dockerfile: dev/native-auth/Dockerfile.client
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
persist-credentials: false
|
||||
- name: Build strict fixtures and run fake-HTTP discovery checks
|
||||
env:
|
||||
DOCKERFILE: ${{ matrix.dockerfile }}
|
||||
run: docker build --target build --file "$DOCKERFILE" .
|
||||
|
||||
servers:
|
||||
name: development-servers (${{ matrix.fixture }})
|
||||
runs-on: ubuntu-24.04
|
||||
timeout-minutes: 40
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- fixture: workload
|
||||
dockerfile: dev/Dockerfile.server
|
||||
- fixture: native-auth
|
||||
dockerfile: dev/native-auth/Dockerfile.server
|
||||
steps:
|
||||
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
persist-credentials: false
|
||||
- name: Build strict Maven project and compile the fixture Java without starting it
|
||||
env:
|
||||
DOCKERFILE: ${{ matrix.dockerfile }}
|
||||
run: docker build --target build --file "$DOCKERFILE" .
|
||||
|
||||
docker:
|
||||
name: development-docker
|
||||
runs-on: ubuntu-24.04
|
||||
|
||||
-10
@@ -12,13 +12,3 @@ dist/
|
||||
*.iml
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# Local script-quality environments and tool caches.
|
||||
.venv/
|
||||
node_modules/
|
||||
.ruff_cache/
|
||||
__pycache__/
|
||||
|
||||
# Isolated .NET developer fixture output.
|
||||
dev/**/bin/
|
||||
dev/**/obj/
|
||||
@@ -1 +0,0 @@
|
||||
3.13
|
||||
+2
-398
@@ -1,405 +1,9 @@
|
||||
# Changelog
|
||||
|
||||
## Unreleased (1.2.0)
|
||||
## Unreleased (0.4.0-SNAPSHOT)
|
||||
|
||||
Print jobs have a real creation date-time. No wire or contract change (extension 2.4.0, wire
|
||||
v1, subprotocol unchanged); connectors need no update. **Schema change: a host that owns the
|
||||
printing schema must add one column before deploying this version** (below).
|
||||
Printing extension **2.1.0** (additive; the agent contract is unchanged).
|
||||
|
||||
- `printing_job.created_at` is ISO-8601 text and its QQQ field is a string, so QQQ could not
|
||||
apply a relative date filter ("created in the last day"), a date sort or a date bucket to
|
||||
print jobs. The table gains `created_time`, a `TIMESTAMP` without time zone holding UTC
|
||||
(the QQQ date-time convention), written by the same `INSERT` from the same instant as
|
||||
`created_at`. It is the read-only QQQ field **Created** (`created_time`, `DATE_TIME`) and
|
||||
replaces the text field in the Print jobs default columns and Summary section.
|
||||
- `created_at` is unchanged: the queue order, history cursors, admission seeding, the Printing
|
||||
home and the `createdAt` value of the job API still read it. Its QQQ field stays in Details,
|
||||
relabelled **Created at (ISO text)**.
|
||||
- `initialize()` adds the column (`ADD COLUMN IF NOT EXISTS`), backfills every existing row
|
||||
from `created_at` on each start (so a row written by an older node during a rolling restart
|
||||
is repaired) and creates `printing_job_created_time_idx (tenant_id, created_time, id)`.
|
||||
- A host that owns the schema (it never calls `initialize()`) appends the equivalent to its
|
||||
own migrations. For PostgreSQL, in one transaction:
|
||||
|
||||
```sql
|
||||
ALTER TABLE printing_job ADD COLUMN IF NOT EXISTS created_time TIMESTAMP WITHOUT TIME ZONE;
|
||||
UPDATE printing_job SET created_time = (created_at::timestamptz AT TIME ZONE 'UTC') WHERE created_time IS NULL;
|
||||
ALTER TABLE printing_job ALTER COLUMN created_time SET DEFAULT (now() AT TIME ZONE 'UTC');
|
||||
ALTER TABLE printing_job ALTER COLUMN created_time SET NOT NULL;
|
||||
CREATE INDEX IF NOT EXISTS printing_job_created_time_idx ON printing_job(tenant_id, created_time, id);
|
||||
```
|
||||
|
||||
The default and `NOT NULL` are optional hardening for a rolling deployment: a node still on
|
||||
an older library omits the column, and the default gives its rows the database clock in UTC
|
||||
instead of a null that date filters would skip. The library itself needs only the nullable
|
||||
column and always writes it.
|
||||
- On a schema without the column this version fails loudly and stores nothing: every
|
||||
submission is rolled back with the database's missing-column error for `created_time`, and
|
||||
QQQ cannot read the Print jobs table. Apply the schema step first; the previous library
|
||||
keeps working on the new schema.
|
||||
|
||||
### Delete print stations and printers; "Print station"; grouped reads
|
||||
|
||||
No wire or contract change (extension 2.4.0, wire v1, subprotocol unchanged); connectors need
|
||||
no update. **Schema change: a host that owns the printing schema applies the step below
|
||||
before deploying this version.**
|
||||
|
||||
- **Names.** The computer that runs the print client is a **Print station** in every label,
|
||||
action, preview, home page text and process message (it was "Print device", which read like
|
||||
the printer). **Printer** is unchanged. The words live in `PrintingNames`; a different
|
||||
choice is one edit there. Table, field and process names (`printing_device`,
|
||||
`printingEnrollDevice`, ...), the HTTP API texts and the agent protocol are unchanged.
|
||||
Changed labels a host may have help or tests for: tables **Print stations** and **Print
|
||||
station control history**; actions **Enroll a print station**, **Disconnect print
|
||||
stations**, **Reconnect print stations**, **Revoke print station access**, **Remove print
|
||||
station**; the enrollment field `deviceName` is **Computer name**.
|
||||
- **Delete print stations** (`printingDeleteDevices`) and **Delete printers**
|
||||
(`printingDeleteSelectedPrinters`), on the list selection and on the record screen. Each
|
||||
asks for a confirmation, then shows what will happen (printers that go with a station,
|
||||
queued jobs canceled, jobs closed as outcome unknown, finished jobs kept) and names every
|
||||
record it will not delete, with the reason. Service: `PrintingService.deleteDevice(deviceId,
|
||||
actor)`, `deletePrinter(printerRowId, actor)`, and the read-only `deviceDeletionPlan` /
|
||||
`printerDeletionPlan`.
|
||||
- A station is revoked through the existing REVOKE control (credential rotated,
|
||||
disconnected, pending commands closed) and, in the same transaction (RC.4, below; it was
|
||||
a separate step before): its queued jobs become
|
||||
`FAILED` ("Canceled before dispatch: its print station was deleted"); jobs it was sent
|
||||
without a reported result (`CLAIMED`, `RECEIVED`, `SUBMITTING`) become `OUTCOME_UNKNOWN`;
|
||||
each of those gets a `printing_event` row (`event_origin` `SERVER_DELETION`) naming the
|
||||
actor; its control receipts, its printers and the station row are deleted.
|
||||
- A printer: its queued jobs are canceled and its sent-but-unreported jobs closed the same
|
||||
way; the printer row is deleted; its station stays in service.
|
||||
- Refused, per record: a station (or a printer on a station) that holds a live credential,
|
||||
shows as ONLINE or PAUSED and has jobs in `CLAIMED`, `RECEIVED` or `SUBMITTING`. Wait, or
|
||||
use Disconnect or Revoke access first. A record that is gone or not the caller's is
|
||||
reported and skipped. The other records of the selection are still deleted.
|
||||
- Jobs are never deleted. `printing_job` gains `device_name`, `computer_name`,
|
||||
`printer_name` and `queue_name`: the names the station and printer had when the job was
|
||||
submitted (written by the same `INSERT`; existing jobs are filled from the current rows;
|
||||
a delete fills any job that still lacks them). They are the read-only fields **Print
|
||||
station**, **Computer name**, **Printer** and **Windows queue name** on Print jobs, and
|
||||
the first two replace the record links in the default columns. `device_id`, `printer_id`
|
||||
and `printer_row_id` keep the identifiers the deleted records had; they are no longer
|
||||
references that must resolve, so the foreign key from `printing_job.device_id` to
|
||||
`printing_device` is dropped.
|
||||
- A computer enrolled again is a new station with a new identifier. A queue that a station
|
||||
still shares is reported by its next inventory and comes back as a new printer, exposed
|
||||
and not approved. Old jobs are not attached to either.
|
||||
- Everything a deleted station sends afterwards (heartbeat, inventory, claim, content,
|
||||
event, control poll, control receipt) and every management action on it is answered
|
||||
`404 Device not found`; its token no longer authenticates (`401`). **Print again** on one
|
||||
of its jobs is refused with the reason.
|
||||
- New table `printing_deletion`, read-only as **Deletion history** in the Printing app: one
|
||||
row per deleted station and per deleted printer with what it was (kind, name, computer
|
||||
name, queue name, facility, the identifiers it had), who deleted it (`actor`), when
|
||||
(`deleted_time`, a UTC timestamp) and what went with it (printers, queued jobs canceled,
|
||||
jobs closed as unknown, jobs kept). It has no reference to the deleted rows.
|
||||
- New permission **`printing_delete`** (`PrintingDeletePermission`). Both actions require
|
||||
`printing_delete` **and** `printing_admin`; `printing_admin` alone does not delete and is
|
||||
not offered the actions. A host grants it where it grants the others.
|
||||
- **Revoke print station access** is unchanged (same process name, `printing_admin`).
|
||||
**Remove printers** and **Remove print station** were unchanged in RC.3 and RC.4 and are
|
||||
retired in RC.5 (below); a record they archived (`removed_at`) can be deleted.
|
||||
- **A grouped read is a read.** `PrintingReadPermission` let a query, a get and a count
|
||||
through and refused everything else as a write, so an aggregate ("print jobs by format")
|
||||
was refused for everybody, administrators included, wherever permissions are enforced. It
|
||||
now accepts `AggregateInput` and `ExportInput` with exactly the permission a query needs
|
||||
(`printing_operator` or `printing_admin` on stations and printers, `printing_admin` on the
|
||||
other tables; RC.5, below, adds print jobs to what an operator reads). Inserts, updates and
|
||||
deletes through table actions stay refused.
|
||||
- Schema step for a host that owns the schema (PostgreSQL, one transaction):
|
||||
|
||||
```sql
|
||||
ALTER TABLE printing_job ADD COLUMN IF NOT EXISTS device_name VARCHAR(1024);
|
||||
ALTER TABLE printing_job ADD COLUMN IF NOT EXISTS computer_name VARCHAR(1024);
|
||||
ALTER TABLE printing_job ADD COLUMN IF NOT EXISTS printer_name VARCHAR(1024);
|
||||
ALTER TABLE printing_job ADD COLUMN IF NOT EXISTS queue_name VARCHAR(1024);
|
||||
UPDATE printing_job j SET device_name = d.name, computer_name = d.computer_name
|
||||
FROM printing_device d WHERE d.id = j.device_id AND j.device_name IS NULL;
|
||||
UPDATE printing_job j SET printer_name = p.name, queue_name = p.queue_name
|
||||
FROM printing_printer p WHERE p.id = j.printer_row_id AND j.printer_name IS NULL;
|
||||
ALTER TABLE printing_job DROP CONSTRAINT IF EXISTS printing_job_device_id_fkey;
|
||||
CREATE TABLE IF NOT EXISTS printing_deletion (id VARCHAR(36) PRIMARY KEY, tenant_id VARCHAR(200) NOT NULL,
|
||||
kind VARCHAR(20) NOT NULL, record_id VARCHAR(36) NOT NULL, name VARCHAR(1024) NOT NULL,
|
||||
computer_name VARCHAR(1024), queue_name VARCHAR(1024), facility_id VARCHAR(200), device_id VARCHAR(36),
|
||||
actor VARCHAR(200) NOT NULL, deleted_time TIMESTAMP WITHOUT TIME ZONE NOT NULL,
|
||||
printer_count INTEGER DEFAULT 0 NOT NULL, cancelled_job_count INTEGER DEFAULT 0 NOT NULL,
|
||||
unknown_job_count INTEGER DEFAULT 0 NOT NULL, kept_job_count INTEGER DEFAULT 0 NOT NULL);
|
||||
CREATE INDEX IF NOT EXISTS printing_deletion_tenant_idx ON printing_deletion(tenant_id, deleted_time, id);
|
||||
```
|
||||
|
||||
`printing_job_device_id_fkey` is the name PostgreSQL gives the inline `REFERENCES` of the
|
||||
original `CREATE TABLE`; a schema that named it otherwise drops that name. `initialize()`
|
||||
does all of this itself and finds the foreign key by metadata.
|
||||
- Without the step this version fails loudly: every submission is rolled back with the
|
||||
database's missing-column error for `device_name`, and QQQ cannot read Print jobs. If only
|
||||
the foreign key is left in place, deleting a station that has jobs is refused (409, naming
|
||||
the step) before anything is revoked. The previous library keeps working on the new schema;
|
||||
jobs it writes get their names when their station or printer is deleted.
|
||||
|
||||
### 1.2.0-RC.4: a station delete decides its refusal under the lock
|
||||
|
||||
No wire, contract or schema change; the schema step above is the same.
|
||||
|
||||
- **Fixed: deleting a station could close a job as `OUTCOME_UNKNOWN` that the station had
|
||||
just been sent and was about to print.** `deleteDevice` decided "connected and printing"
|
||||
from a read without a lock, revoked the station, and only then locked and read again; a
|
||||
revoked station never counts as connected, so the second read could not refuse. A station
|
||||
that was idle at the first read and claimed a job before the revocation was deleted with
|
||||
that job in its hands.
|
||||
- The delete is now one transaction. It takes the tenant admission lock and then the
|
||||
station's row lock (the order the other paths use; a claim, a job event and a heartbeat
|
||||
take the station's row lock before they change anything), decides the refusal there,
|
||||
applies the REVOKE control on the same connection, closes the jobs, deletes the rows and
|
||||
commits once. A claim either commits before the delete locks, and the delete is refused
|
||||
(409, the station and its job untouched), or waits for the delete and is then answered
|
||||
`404 Device not found`: the job was canceled by the delete and was never sent.
|
||||
- A delete that is refused or fails changes nothing. Before, a delete whose transaction
|
||||
failed left the station revoked; now the revocation rolls back with the rest and the
|
||||
delete can simply be run again. A station that an earlier version left revoked, or that
|
||||
was revoked with **Revoke print station access**, is deleted without a second revocation.
|
||||
- The station's connection is woken once, after the commit. The revocation of a delete no
|
||||
longer goes through the public `PrintingService.deviceAction`; a host that wraps that
|
||||
method to observe revocations sees a delete in `printing_deletion` instead.
|
||||
- `deletePrinter` did not have the window (it decides under the station's row lock and
|
||||
revokes nothing) and is unchanged.
|
||||
- **HTTP API text restored.** RC.3 changed one text an HTTP route returns, contrary to the
|
||||
note above: approving or unapproving a removed printer (`PUT
|
||||
/printing/v1/admin/devices/{deviceId}/printers/{printerId}`, 409) answers "Printer was
|
||||
removed; share it from the device again before changing its approval" again. The other
|
||||
text RC.3 changed ("Revoke the print station's access before removing it") is raised only
|
||||
by `removeDevice`, which no HTTP or agent route calls, and stays.
|
||||
- `initialize()` fills `device_name` / `printer_name` only on jobs whose station or printer
|
||||
still exists. Before, jobs of a deleted station or printer that have no name were rewritten on
|
||||
every start, and where such a job had a queue name but no printer name the queue name was
|
||||
set to null. They are still read on every start; there is no index on the name columns.
|
||||
- Deleting a station or a printer writes the names only onto its jobs that lack one, so a
|
||||
long job history is not rewritten while the tenant's admission lock is held.
|
||||
- Tests added for: the claim that lands just before the delete locks (station and printer)
|
||||
and the claim in flight that the delete waits for; a printer refused while it prints on a
|
||||
connected station; an already revoked station; a failed transaction rolled back and
|
||||
retried; the foreign-key violation (`23503`) named as the missing schema step; the final
|
||||
step refusing a record that passed the review; the review naming a record that went away
|
||||
or conflicts; a grouped read of print jobs counting the caller's tenant only. They run on
|
||||
the in-memory database of the test suite; the build has no PostgreSQL driver or container
|
||||
support, so the delete and the schema step are not exercised on PostgreSQL here.
|
||||
|
||||
### 1.2.0-RC.5: operators read print jobs; Remove actions retired; plain refusal messages
|
||||
|
||||
No wire, contract or schema change (extension 2.4.0, wire v1, subprotocol unchanged; the
|
||||
published OpenAPI document changes in description text only). Print clients need no update.
|
||||
**A host reviews the upgrade notes at the end of this section.**
|
||||
|
||||
- **A holder of `printing_operator` reads print jobs, read only.** `PrintingReadPermission`
|
||||
let an operator read print stations and printers and required `printing_admin` for print
|
||||
jobs, so a person who prints could not see what was printed. An operator now has every
|
||||
read shape on `printing_job` that an administrator has: query, get, count, aggregate and
|
||||
export.
|
||||
- What an operator sees: **every print job of their tenant**, whoever submitted it, the
|
||||
same as print stations and printers. The tenant lock on the table (`printing_tenant`) is
|
||||
the boundary; a host that wants a narrower view adds its own record lock, as it can for
|
||||
stations and printers.
|
||||
- The fields are the ones an administrator reads: identifiers, title, format, status and
|
||||
status message, the names of the station and printer, the spooler job id, the document's
|
||||
size and SHA-256 (`content_hash`), the print options (`options_json`) and the request's
|
||||
idempotency key. The table has never had a field for the document, its storage
|
||||
reference, the retained binding, the retained actor or the accepted event, and has none
|
||||
now. An idempotency key is not a credential: an operator request is keyed by a hash of
|
||||
the submitting person, so another person cannot reconcile or replay it.
|
||||
- Unchanged: `printing_device_command` (control history) and `printing_deletion` (deletion
|
||||
history) require `printing_admin`. No table write for anybody. Every action on a job, a
|
||||
printer or a station (retry, cancel, approve, revoke, delete, enroll, ...) requires
|
||||
`printing_admin` as before, and the HTTP routes are unchanged: the operator routes still
|
||||
reconcile only the caller's own request. The Printing app entry in the navigation stays
|
||||
an administrator's; an operator reaches the jobs through table reads.
|
||||
- This reverses a property two tests asserted ("an operator cannot enumerate jobs").
|
||||
- **The Remove actions are retired; Delete is the one way to take a record away.** RC.3
|
||||
added Delete, which keeps the job history with its names and records who deleted what.
|
||||
Removed from the screens and the metadata:
|
||||
- process **Remove print station** (`printingRemoveDevices`) and its control action
|
||||
`PrintingDeviceProcesses.Action.REMOVE`;
|
||||
- process **Remove printers** (`printingRemoveSelectedPrinters`).
|
||||
What stays:
|
||||
- every HTTP and agent route. No route ever called a Remove process, and no print client
|
||||
calls a remove, unshare or revoke route. `POST .../admin/devices/{deviceId}/actions` with
|
||||
`REVOKE` still requires and runs `printingRevokeDevices`, as it always resolved.
|
||||
- **Revoke print station access**, **Delete print stations**, **Delete printers**.
|
||||
- `PrintingService.removePrinter` and `removeDevice`, as service methods for a host that
|
||||
calls them; nothing in this library does.
|
||||
- records archived earlier: `removed_at` keeps them out of the operator catalog, claims,
|
||||
the `PRINTERS` frame and the selectors; a queue shared again comes back awaiting
|
||||
approval; retention cleanup still purges archived records that no job references; an
|
||||
archived record can be deleted.
|
||||
- **Refusals say what happened and what to do, and name no framework.** Statuses, error
|
||||
codes and JSON field names are unchanged; only sentences changed.
|
||||
- Permission checks (shown on screens and by the table and process API):
|
||||
"Printing administrator permission is required" is now "You are signed in to this
|
||||
application, but your account is not allowed to manage print stations. Ask an
|
||||
administrator to give you the printing administrator role."; the operator and delete
|
||||
checks read the same way ("... not allowed to use printing ... the printing operator
|
||||
role", "... not allowed to delete print stations and printers ..."). A caller with no
|
||||
session is told to sign in. "The current session cannot manage this printing tenant" is
|
||||
now "... your account is not set up for printing in this organization. Ask an
|
||||
administrator to give your account printing access for your organization."
|
||||
- Native routes (`/qqq/v1/qbit/printing/...`), every `403`: the `error` and `message`
|
||||
text was "User or device is not authorized". It is now "You are signed in, but your
|
||||
account or this print station is not allowed to do this. Ask an administrator to check
|
||||
that you have the printing administrator role and that this print station still has
|
||||
access." on the station and administration routes, and "You are signed in, but your
|
||||
account is not allowed to print here. Ask an administrator to check that you have the
|
||||
printing operator role and that the printer is approved." on the three operator routes.
|
||||
One sentence per route family still covers every reason, so the answer does not say
|
||||
which check failed. Status `403` and code `PERMISSION_DENIED` are unchanged.
|
||||
- Legacy routes (`/printing/v1/...`, code `PRINTING_403` unchanged): "Enrollment requires
|
||||
native QQQ authentication" is now "This server enrolls a print station only for a
|
||||
signed-in person. Sign in from the print client, then enroll again."; "Printing
|
||||
administrator permission required" is now "Your account is not allowed to manage print
|
||||
stations. Ask an administrator to give you the printing administrator role."
|
||||
- A control action started without a signed-in person: "Sign in with an authorized QQQ
|
||||
user before controlling a print station" is now "Sign in to this application to control
|
||||
a print station."
|
||||
- OpenAPI descriptions: "Requires the current QQQ user session, ..." is "Requires a
|
||||
signed-in user session, ..."; the `401` response is described as "Sign-in required".
|
||||
- **`PrintingQBitConfig.withProductName(name)`**, optional. The name the host's users know
|
||||
the application by replaces "this application" in the sentences above that say "signed in
|
||||
to ...". It is used nowhere else; null or blank keeps the neutral words.
|
||||
|
||||
Upgrade notes for a host:
|
||||
|
||||
- **Permissions.** Nothing to grant. Everyone who already holds `printing_operator` can read
|
||||
the tenant's print jobs after the upgrade; a host for which that is too wide adds a record
|
||||
lock to `printing_job` or withholds the permission. Role documents that say an operator
|
||||
cannot read job history need the new sentence.
|
||||
- **Removed processes.** `printingRemoveDevices` and `printingRemoveSelectedPrinters` no
|
||||
longer exist. Delete them from help entries, reviewed or allow-listed process lists, role
|
||||
and permission documents, saved links, and tests that enumerate the Printing processes.
|
||||
A request to run either fails: the process does not exist.
|
||||
- **Message texts.** A host test or help page that quotes one of the old sentences needs the
|
||||
new one. Code that reads the status or the code needs no change.
|
||||
- **Optional.** Call `withProductName("...")` with the name on your sign-in page.
|
||||
|
||||
Tests added: an operator queries, gets, counts and groups the jobs of its tenant and never
|
||||
another tenant's; the job row has no document, binding or credential field (a new field
|
||||
fails the test until it is reviewed); an operator is refused control and deletion history,
|
||||
every table write and every administrator action; a person with neither permission is
|
||||
refused every read and write on every printing table; neither Remove process is registered
|
||||
and each control wire value belongs to one action; each new sentence, the host's name in
|
||||
it, and the unchanged status, code and field names of a refused HTTP request.
|
||||
|
||||
## 1.1.2
|
||||
|
||||
Runtime and publication move to the QRun-IO Gitea Maven registry; no printing contract
|
||||
change (extension 2.4.0, wire v1, subprotocol unchanged). The server now runs on QQQ
|
||||
**4.1.0-RC.22**, published only in the Gitea registry (it carries the session-logout,
|
||||
process-identity and scoped-session fixes the Forge cohort depends on). CI moves from the
|
||||
`qrun-release` caller and trusted publisher to the shared `ci-workflows` Maven workflow,
|
||||
which resolves QQQ from the Gitea registry with the job token and publishes `vX.Y.Z` tags
|
||||
straight to it. The ui-demo frontend (`qqq-frontend-next` 1.0.0-RC.37) was mirrored into the
|
||||
registry byte-for-byte from Central, so every QRun artifact resolves from Gitea; third-party
|
||||
dependencies still resolve through the Maven Central mirror until the registry proxies them.
|
||||
Same test gate (`-Pui-demo verify`).
|
||||
|
||||
## 1.1.1
|
||||
|
||||
Realtime upgrade fix; no contract change. The WebSocket callbacks read the device
|
||||
identifier from the socket context's headers, which are matched case-sensitively, while the
|
||||
HTTP upgrade matches them case-insensitively. Behind an ingress that lowercases header names
|
||||
the device resolved to null on connect and the connection failed before WELCOME (Forge had
|
||||
carried a local patch for this on 1.0.0). The device is now resolved once on the authorized
|
||||
upgrade and carried on the connection; a regression test connects with lowercase header
|
||||
names and verifies WELCOME, an acknowledged inventory, the PRINTERS push and socket replacement.
|
||||
|
||||
## 1.1.0
|
||||
|
||||
Native printing extension **2.4.0** (additive; wire payload v1 and the agent
|
||||
subprotocol `qqq-printing.v1` are unchanged). Pairs with protocol 1.1.0 and Windows
|
||||
connector 1.2.1; 1.0.x connectors keep working unchanged.
|
||||
|
||||
- New HELLO and HTTP control-poll capability `printer-approval-v1` (HELLO accepts up to
|
||||
five capabilities, the control poll up to four; it is stored in the device's control
|
||||
capabilities like the others).
|
||||
- New server-to-client realtime frame `PRINTERS`: `{ "printers": [ { "printerId", "enabled" } ] }`,
|
||||
the complete approval state of every printer in the device's latest accepted inventory.
|
||||
Sent only to connections that advertised the capability, after each accepted INVENTORY's
|
||||
ACK and whenever a printer's approval changes through any path (admin route, native
|
||||
approve/disable/set-approval processes, `PrintingService.enablePrinter`). An empty
|
||||
inventory yields an empty list; other connections never receive the frame.
|
||||
- `PrintingService.printerApprovals(deviceId)` exposes the same list to host code.
|
||||
- Remove printers and devices without losing history. New nullable `removed_at` columns on
|
||||
`printing_printer` and `printing_device` (read-only field **Removed at** on both tables, added
|
||||
by the idempotent migration). **Remove printers** (`printingRemoveSelectedPrinters`, on a
|
||||
printer record or a selection) and `PrintingService.removePrinter(deviceId, printerId)` set
|
||||
`removed_at`, clear approval and exposure, and drop the printer from the Printers default
|
||||
view (add the **Removed at is empty** filter), the operator catalog, claims and submissions,
|
||||
the device/printer selectors and the `PRINTERS` frame, which is pushed again on removal. A
|
||||
queue that the device shares again returns exposed but not approved. **Remove device**
|
||||
(`printingRemoveDevices`, confirmation required) revokes access through the existing REVOKE
|
||||
control, then `PrintingService.removeDevice(deviceId)` archives the device and all of its
|
||||
printers; an already revoked device is archived without a new command, and a removed device
|
||||
cannot be restored. Retention cleanup hard-deletes removed printers that no job references
|
||||
and removed devices with no jobs and no printers, bounded by the run's batch size.
|
||||
- Regenerated OpenAPI fragment (`printing.yaml`): semantic version 2.4.0 and the extended
|
||||
`ControlPollRequest` capability enumeration. No authorization, queue, replay or document
|
||||
behavior changed.
|
||||
|
||||
## 1.0.0
|
||||
|
||||
Product version 1.0.0 includes record, table-list and text print processes,
|
||||
PDF rendering with headers and footers, the least-privilege operator catalog,
|
||||
reported Windows queue-default media (`printer-media-v1`) and the opt-in retained-source
|
||||
facade. Native printing stays **2.3.0** with wire payload v1; 1.0 is a product version, not a
|
||||
wire change, and it pairs with Windows connector 1.0.1 and protocol 1.0.0. The QQQ dependency
|
||||
is the published 4.1.0-RC.21 candidate, which provides native session login.
|
||||
|
||||
## 0.4.0-rc.1
|
||||
|
||||
Printing extension **2.3.0** (additive; wire payload v1 and the agent subprotocol are
|
||||
unchanged). 2.1.0 added the record, table-list and text print processes; 2.2.0 added
|
||||
`printingRenderToPdf`, the header and footer values on every document and content
|
||||
sections; 2.3.0 adds the least-privilege operator catalog/submission/request lookup,
|
||||
reported Windows queue-default media (`printer-media-v1`) and the opt-in
|
||||
retained-source facade. Clients should offer a feature when its process is in the
|
||||
metadata, not by comparing versions. An agent that does not advertise
|
||||
`printer-media-v1` stays a three-capability peer and cannot claim a job carrying a
|
||||
media selection, whatever extension version it discovers.
|
||||
|
||||
- Built-in test prints add 4 x 1 and 4 x 2 inch labels (203/300/600 dpi) beside the unchanged
|
||||
4 x 6 path: compact PDF and ZPL layouts, and for short PDF labels an explicit actual-size
|
||||
job paper (`paperWidthMm`/`paperHeightMm`, a complete positive pair up to 2000 mm, never
|
||||
combined with a media profile). 4 x 6 and page profiles keep using the queue default.
|
||||
- Strict source standards: Error Prone 2.51.0 and NullAway run as errors with `-Werror` on
|
||||
main and test sources, with honest `@Nullable` contracts, strict source headers and
|
||||
development-fixture style gates. No authorization, retained-source, replay or queue
|
||||
behavior was changed by this work.
|
||||
- Realtime shutdown now waits, with a bound, for channel workers that are already
|
||||
running before the host's durable state is released. Previously the executor was
|
||||
only told to stop, so a late drain could query a stopped file database and
|
||||
recreate it empty (found as a temporary-directory cleanup error in a full test
|
||||
run).
|
||||
|
||||
Observed locally on the merged candidate: full `-Pui-demo verify` 189 reported,
|
||||
188 executed, one intentional opt-in workload skip, zero failures/errors, zero
|
||||
Checkstyle violations; five consecutive focused realtime runs passed. Hosted CI on
|
||||
the final signed head, publication and consumer qualification have not run; no
|
||||
physical output is claimed.
|
||||
|
||||
- The app's header and footer on every page of every document (record sheets,
|
||||
table lists, text and content pages): app name, title or breadcrumb, server,
|
||||
user and printed-at at the top; the client's footer (e.g. `qqq ui 1.0.1 ·
|
||||
server`), a list's filter and sort, and "Page n of m" at the bottom. Clients
|
||||
send `headerApp`, `headerTitle`, `headerServer`, `headerUser`, `headerPrintedAt`,
|
||||
`footerLeft` and `footerNote`; missing ones default to the instance branding,
|
||||
the session user, the current instant and "QQQ printing".
|
||||
- Content documents: `printingPrintText` and `printingRenderToPdf` (`TEXT`) take
|
||||
`sections` (JSON `[{title, lines}]`), a screen's panels without navigation or
|
||||
borders, rendered as headings with their lines wrapped to the page width.
|
||||
- Save as PDF: `printingRenderToPdf` renders the document a print would carry -
|
||||
a record sheet (`kind` `RECORD`, `tableName`, `recordId`), a table list (`LIST`,
|
||||
the `printingPrintTableList` values) or a text page (`TEXT`) - and returns it to
|
||||
the caller as the standard process download (`downloadFileName`,
|
||||
`serverFilePath`) instead of queueing a job. No printer is needed; reads enforce
|
||||
the caller's permissions, and a list over the limit says so in
|
||||
`printingMessage`. Clients offer it as "Save as PDF…" in their printer pickers.
|
||||
- Print anything: `PrintingRecordProcesses.registerAll(instance)` adds **Print** to
|
||||
every table that can be read one record at a time (call it after the host's
|
||||
tables are in the instance). Hidden tables, tables without a primary key or
|
||||
|
||||
+4
-15
@@ -1,22 +1,11 @@
|
||||
# Contributing
|
||||
|
||||
Use Java 21 and the checked-in Maven 3.9.11 wrapper. Clone `QRun-IO/qqq-print-protocol` as a sibling and check out the protocol commit pinned in `.gitea/workflows/qrun-release.yaml`. See README for the Windows and Unix build commands.
|
||||
Use Java 21 and the checked-in Maven 3.9.11 wrapper. Clone `QRun-IO/qqq-print-protocol` as a sibling and check out the protocol commit pinned in `.github/workflows/ci.yml`. See README for the Windows and Unix build commands.
|
||||
|
||||
Run `bash ./mvnw -Pui-demo verify` (`.\mvnw.cmd -Pui-demo verify` on Windows), matching the primary CI profile. The validate phase enforces the repository Checkstyle configuration; tests cover real H2 persistence, native QQQ metadata/processes and the public loopback HTTP contract. Add focused coverage for changed behavior. Do not replace spooler acceptance with a physical-print assertion.
|
||||
Run `./mvnw verify` (`.\mvnw.cmd verify` on Windows). The validate phase enforces the repository Checkstyle configuration; tests cover real H2 persistence, native QQQ metadata/processes and the public loopback HTTP contract. Add focused coverage for changed behavior. Do not replace spooler acceptance with a physical-print assertion.
|
||||
|
||||
Changes belong in a pull request on [the primary Gitea repository](https://git.kof22.com/QRun-IO/qbit-printing) with a concise behavior description and actual validation results. Update README, changelog, relevant tests and shared contract together when changing the wire interface. Use Conventional Commit subjects. Do not include local databases, logs, device credentials, customer documents or machine-specific printer information.
|
||||
Changes belong in a pull request with a concise behavior description and actual validation results. Update README, changelog, relevant tests and shared contract together when changing the wire interface. Use Conventional Commit subjects. Do not include local databases, logs, device credentials, customer documents or machine-specific printer information.
|
||||
|
||||
Keep the QBit compatible with QQQ 4.1+ and resolve runtime services through the current QQQ instance. Preserve tenant/device isolation and the distinction between local exposure (`available`) and server approval (`enabled`). Application callers must authorize destinations before submitting or emitting an effect.
|
||||
|
||||
Maintainers publish reviewed versions through the primary Gitea CI and trusted Maven publisher, then attach the verified JAR/POM/checksums to a Gitea release. Follow [release operations](docs/RELEASES.md). GitHub is a shadow/archive; its Actions are retired for this repository. Historical `.github` scripts remain available as local quality checks. Deployment and physical printer acceptance are separate from library publication.
|
||||
|
||||
## Script quality
|
||||
|
||||
Owned `.github/scripts/*.py` follow the KofTwentyTwo standard at revision `fbfc8d2cf3b5e16ae9750b04cf9de1794f1e7152` (config adapted from its `python` profile): three-space indentation, Ruff 0.17.3 format/lint (locked in `uv.lock`) and strict Pyright 1.1.414 (Microsoft's npm package, a development-only dependency locked in `package-lock.json` and run through Node 24). Restore with `uv sync --locked` and `npm ci --ignore-scripts`, then run:
|
||||
|
||||
```text
|
||||
uv run --locked --no-sync python .github/scripts/test-script-quality.py
|
||||
uv run --locked --no-sync python .github/scripts/check-script-quality.py
|
||||
```
|
||||
|
||||
`check-script-quality.py` fails for any tracked Python outside `.github/scripts/` or any JavaScript/TypeScript (this repository has no tsconfig), and requires Pyright's analyzed-file count to equal the selected scripts. Pyright must run as `pyright -p .github`: it silently skips dot directories from a root config. Documented exceptions: CLI `print` only in `check-*.py`; synthetic test assertions and boundary constants; narrow inline `noqa` comments for fixed no-shell Git/interpreter calls and ordered fail-closed validators. Do not loosen a rule or add a type waiver to pass.
|
||||
Maintainers create reviewed version tags. CI produces JAR/POM/checksum assets and publishes GitHub prereleases for hyphenated versions. Maven Central publication, deployment and physical printer tests are separate operations; this workflow does not perform them.
|
||||
@@ -1,14 +1,12 @@
|
||||
# QQQ Printing
|
||||
|
||||
Cloud printing for QQQ 4.1+, paired with the [Windows AppKit connector](https://git.kof22.com/QRun-IO/qqq-print-agent) 1.2.1 and the [shared protocol](https://git.kof22.com/QRun-IO/qqq-print-protocol) 1.1.0 (1.0.1 / 1.0.0 remain compatible). The Windows connector opens an outbound, authenticated two-way WebSocket; documents download separately over HTTPS. The cloud needs no inbound route into the facility. Version **1.1.0** supports native printing **2.4**, wire payload v1, real-time jobs and controls, native browser sign-in through QQQ, and pushes each exposed printer's approval to connectors that advertise `printer-approval-v1`. Upgrade the server before the matching Windows connector.
|
||||
Cloud printing for QQQ 4.1+, paired with the [Windows AppKit connector](https://github.com/QRun-IO/qqq-print-agent) and the [shared protocol](https://github.com/QRun-IO/qqq-print-protocol). The Windows connector opens an outbound, authenticated two-way WebSocket; documents download separately over HTTPS. The cloud needs no inbound route into the facility. Release candidate **0.3.0-rc.1** requires native printing API **2.0**, with no job/control polling fallback. Upgrade the server before the matching Windows connector.
|
||||
|
||||
**Released:** [QQQ Printing 1.1.2](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.1.2), with a library JAR, matching POM and `SHA256SUMS`, built on QQQ 4.1.0-RC.22 from the Gitea registry ([1.1.1](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.1.1) is the same code on RC.21 from Maven Central; [1.1.0](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.1.0) is superseded by the realtime upgrade fix; [1.0.0](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.0.0) remains available for rollback). The same JAR/POM are published in the QRun-IO Gitea Maven registry. Gitea requires sign-in for downloads. The QBit itself is not published to Maven Central and is not a standalone executable/fat JAR. See [installation and release access](docs/RELEASES.md).
|
||||
|
||||
**Runtime:** Java 21 and QQQ **4.1.0-RC.22**, published in the QRun-IO Gitea Maven registry (not on Maven Central) with native session login. The optional native UI demo uses QQQ frontend **1.0.0-RC.37**, also served from that registry. Product version 1.1.2, native extension 2.4.0 and wire payload v1 are separate version contracts.
|
||||
**Prerelease software**, tested against QQQ **4.1.0-RC.20** and Java 21. Current release candidate: [**0.3.0-rc.1**](https://github.com/QRun-IO/qbit-printing/releases/tag/v0.3.0-rc.1). The previous [**0.2.0-rc.1**](https://github.com/QRun-IO/qbit-printing/releases/tag/v0.2.0-rc.1) tagged build passed 110 tests and zero Checkstyle violations. The optional native UI demo uses QQQ frontend **1.0.0-RC.37**. GitHub releases provide a library JAR, POM and SHA-256 checksums, with build attestations for all three assets. Verify the exact downloaded release; publication does not establish installed or physical-output acceptance. This repository does not claim Maven Central publication or provide a standalone executable/fat JAR.
|
||||
|
||||
Implemented: single-use enrollment, device credentials, inventory/approval, PDF/ZPL submission, durable JDBC queue, idempotency, claim/content/events, native QQQ setup/test-print processes, read-only device/printer/job tables and a durable enqueue effect target.
|
||||
|
||||
Native record/selection actions expose per-device printers, jobs, queue and history, with desired versus observed status. The discovered `/qqq/v1/qbit/printing` extension uses standard QQQ session authentication. Device credentials are secondary identity proof alongside the current QQQ user's permissions. Existing unbound pairings require explicit association during sign-in. See the [authentication contract](https://git.kof22.com/QRun-IO/qqq-print-protocol/src/branch/main/docs/QQQ-AUTHENTICATION.md); bound devices cannot fall back to legacy `/printing/v1` authentication.
|
||||
The 0.2.0-rc.1 source adds native record/selection actions, per-device printers/jobs/queue/history, desired versus observed status and standard-session authentication at the discovered `/qqq/v1/qbit/printing` extension. Device credentials become secondary identity proof alongside the current QQQ user's permissions. Upgrade the server before the 0.2.0 Windows client, then explicitly associate an existing unbound pairing during sign-in. These changes are included in the published release above. See the [authentication contract](https://github.com/QRun-IO/qqq-print-protocol/blob/main/docs/QQQ-AUTHENTICATION.md); bound devices cannot fall back to legacy `/printing/v1` authentication.
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
@@ -29,14 +27,14 @@ Java/.NET WebSocket jobs and S3 checks without an installed connector or printer
|
||||
|
||||
## Build and verify
|
||||
|
||||
Install Java 21. Clone this repository and `qqq-print-protocol` as siblings from Gitea. Check out protocol commit `5005f3c9e27053b6c327bb923695012832c0fdcc`, the immutable fixture ref in `.gitea/workflows/qrun-release.yaml`. Use the checked-in wrapper (Maven 3.9.11).
|
||||
Install Java 21. Clone this repository and `qqq-print-protocol` as siblings. This source pins protocol commit `f3cbc02e9b0fb4fdfefaa59d976c04df747cc589`; use that commit for reproducible compatibility tests. Use the checked-in wrapper (Maven 3.9.11).
|
||||
|
||||
```powershell
|
||||
.\mvnw.cmd -Pui-demo verify
|
||||
.\mvnw.cmd verify
|
||||
.\mvnw.cmd dependency:build-classpath '-Dmdep.outputFile=target/runtime-classpath.txt' '-DincludeScope=runtime'
|
||||
```
|
||||
|
||||
On Linux/macOS use `bash ./mvnw -Pui-demo verify` and the corresponding wrapper commands. First builds download dependencies; `-o` is only appropriate after they are cached.
|
||||
On Linux/macOS use `bash ./mvnw verify` and the corresponding wrapper commands. First builds download dependencies; `-o` is only appropriate after they are cached.
|
||||
|
||||
Checkstyle runs during validate. Tests exercise real H2 persistence, native QQQ metadata/processes and real loopback HTTP through Javalin, including the shared fixtures and withdrawal of a locally exposed printer. Keep `../qqq-print-protocol` checked out or pass `-Dprinting.protocol.fixtures=<fixture-directory>`.
|
||||
|
||||
@@ -72,14 +70,14 @@ Open `http://127.0.0.1:18082`. On Linux/macOS use `:` as the classpath separator
|
||||
|
||||
The protocol-only `PrintingDemo` and synthetic, mock-authenticated `PrintingUiDemo` remain separate. Do not point the synthetic demo at real paired printer data. The local host retains database document storage until an actual dedicated S3 binding is configured in a deployment-owned application; it does not claim a remote cloud deployment.
|
||||
|
||||
The local setup uses the same native authorization and transport paths as an integrated application. Production authentication mappings, S3/IAM and database operation belong to the deploying host; the local fixture does not certify those settings. Dated test evidence is retained in [qualification notes](docs/QUALIFICATION-2026-11-01.md).
|
||||
Local native deployment is accepted with authentication and access-denial checks, preserved pairing/history, connector reconnection and 365-day retention. The previously accepted 0.1.4-rc.1 release passed 73 tests and zero Checkstyle violations; the user confirmed all three Query diagnostic outputs good. Production S3/IAM and remote deployment remain separate qualification work. The 0.2.0 controls/authentication release passed 25 real client/native QQQ interoperability checks; the user later confirmed installed Letter PDF and Zebra ZPL output, the Connected footer and both printers. These results do not qualify installed or physical behavior for 0.3.
|
||||
|
||||
## Add to a QQQ application
|
||||
|
||||
Use the [authenticated Gitea Maven registry](docs/RELEASES.md#use-the-maven-registry), or download the release JAR, matching POM and `SHA256SUMS` and verify both files. For a local installation of the downloaded artifacts:
|
||||
For a source checkout, `mvnw.cmd install` (or `bash ./mvnw install`) installs the verified library into your local Maven repository. For a GitHub release, download the JAR, matching POM and `SHA256SUMS`, verify the checksums, then install those artifacts locally or through your organization's artifact repository. Example using the release files in the current directory:
|
||||
|
||||
```powershell
|
||||
.\mvnw.cmd install:install-file '-Dfile=qbit-printing-1.1.2.jar' '-DpomFile=qbit-printing-1.1.2.pom'
|
||||
.\mvnw.cmd install:install-file '-Dfile=qbit-printing-0.3.0-rc.1.jar' '-DpomFile=qbit-printing-0.3.0-rc.1.pom'
|
||||
```
|
||||
|
||||
After the artifact is available in your configured repository, add:
|
||||
@@ -88,7 +86,7 @@ After the artifact is available in your configured repository, add:
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qbits</groupId>
|
||||
<artifactId>qbit-printing</artifactId>
|
||||
<version>1.1.2</version>
|
||||
<version>0.3.0-rc.1</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
@@ -98,8 +96,6 @@ Device and printer names, descriptions and locations are edited in the Windows c
|
||||
|
||||
`initialize()` adds profile columns, backfills physical names, widens existing name/title columns and creates dispatch/history indexes without deleting records. The existing `name` column becomes the effective display label; `computer_name`/`queue_name` retain technical names and `display_name` holds the optional override. Back up the database and run schema initialization during a maintenance/deployment window; column widening and index creation can lock populated tables.
|
||||
|
||||
Print jobs carry their creation instant twice: `created_at` is the ISO-8601 text the queue, history cursors and job API use, and `created_time` is the same instant as a UTC `TIMESTAMP` (no time zone, the QQQ convention), exposed as the date-time field **Created** so native filters ("created in the last day"), sorting and date buckets work. `initialize()` adds the column, backfills existing rows from `created_at` and creates `printing_job_created_time_idx (tenant_id, created_time, id)`. A host that owns the schema must add the column before deploying this version (see the [changelog](CHANGELOG.md) for the statements): without it every submission fails with the database's missing-column error and stores nothing, and the Print jobs table cannot be read.
|
||||
|
||||
Job history uses `GET /printing/v1/admin/jobs?limit=200&before=<nextCursor>` with opaque keyset cursors and a maximum 200 rows per page. Claims read one candidate, pending inspection reads 50, and all these queries project metadata without fetching stored documents. Native dashboard lists already cap attention rows at 10 per category and recent work at 25. Dispatch/history indexes support growing histories; the synthetic 10,000-row regression test checks bounded pages and claim correctness, **not** a certified 10,000-print/day throughput measurement. Driver speed, document size, database hardware and retention policy still determine capacity. Document cleanup follows the configured retention policy and host schedule; the audit does not run a live purge or delete job history.
|
||||
|
||||
```java
|
||||
@@ -110,32 +106,26 @@ new PrintingQBitProducer().withConfig(new PrintingQBitConfig()
|
||||
.withStorageTableName("printing_documents") // existing dedicated S3 storage table
|
||||
.withSchedulerName("appScheduler") // existing host scheduler
|
||||
.withService(printing)).produce(qInstance, "printing");
|
||||
server.withAdditionalRouteProviders(List.of(new PrintingRealtimeRoutes(printing)));
|
||||
server.withAdditionalRouteProviders(List.of(new PrintingRoutes(printing, context -> hostPrintingAdminGuard(context))));
|
||||
```
|
||||
|
||||
The producer registers the native printing API; the additional provider supplies its WebSocket transport. Preserve any other host route providers and close the printing provider during shutdown. The same service instance must be used for metadata and transport. The service is bound to one tenant; use a separate host service instance for each tenant. Device token verification and job ownership are enforced on every device operation. Management service methods are intended for trusted application code; enforce user/facility authorization before calling them. See [real-time integration](docs/REALTIME.md).
|
||||
`hostPrintingAdminGuard` is the host's own authenticated administrator policy, not a supplied library method. The service is bound to one tenant; use a separate host service instance for each tenant. Device token verification and job ownership are enforced on every device operation. Management service methods are intended for trusted application code; enforce user/facility authorization before calling them.
|
||||
|
||||
Configure a dedicated private printing bucket for the customer/environment through existing QQQ S3 metadata; no bucket credentials belong in printing forms. Admin retention defaults to 365 days after successful completion. Scheduled cleanup handles bounded batches every five minutes and preserves active, failed and uncertain work plus all receipts/history. Without a configured storage binding, legacy database documents remain supported; without a host scheduler, automatic cleanup does not run. Review [storage configuration, bucket isolation and S3 versioning](docs/STORAGE-AND-RETENTION.md) before deployment.
|
||||
The storage/scheduler options above are included in 0.1.4-rc.1. Configure a dedicated private printing bucket for the customer/environment through existing QQQ S3 metadata; no bucket credentials belong in printing forms. Admin retention defaults to 365 days after successful completion. Scheduled cleanup handles bounded batches every five minutes and preserves active, failed and uncertain work plus all receipts/history. Without a configured storage binding, legacy database documents remain supported; without a host scheduler, automatic cleanup does not run. Review [storage configuration, bucket isolation and S3 versioning](docs/STORAGE-AND-RETENTION.md) before deployment.
|
||||
|
||||
Enrollment uses a named facility selector. Set `withFacilityPossibleValueSourceName("your_existing_facility_source")` to reuse an already registered host source and its record security. Without it, the standalone choice is **Default facility**. The backend validates the selection under the current user's permissions before issuing an enrollment code; typing or forging an unknown/foreign-tenant ID cannot bypass that check. Existing stored facility IDs are preserved; configure their original source to resolve their names.
|
||||
|
||||
For native QQQ screens, grant `printing_admin` and populate the session's `printing_tenant` security key with the tenant ID; grant `printing_delete` as well to whoever may delete print stations and printers. A **print station** is the computer that runs the print client (table `printing_device`); a **printer** is a Windows queue it shares. The Printing home shows print station health, queue status and work needing attention, with Print stations, Printers, Print jobs, Print station control history and Deletion history beneath it. It nests under an existing `admin` app when available. Processes are dashboard/table/record actions, not navigation entries. Secret/token and document columns are excluded from metadata. Table mutations are rejected; use the service/processes instead.
|
||||
For native QQQ screens, grant `printing_admin` and populate the session's `printing_tenant` security key with the tenant ID. The Printing home shows device health, queue status and work needing attention, with Devices, Printers and Print jobs beneath it. It nests under an existing `admin` app when available. Processes are dashboard/table/record actions, not navigation entries. Secret/token and document columns are excluded from metadata. Table mutations are rejected; use the service/processes instead.
|
||||
|
||||
Typical setup: run **Enroll a print station** from Printing home or Print stations, enroll the Windows connector, and select local queues to expose in its companion/tray. Use **Set printer approval** to choose a named print station and one of its printers. Test-print forms offer only exposed, approved printers supporting the chosen format. Device and printer choices respect the current user's tenant access.
|
||||
Typical setup: run **Enroll a print device** from Printing home or Print devices, enroll the Windows connector, and select local queues to expose in its companion/tray. Use **Set printer approval** to choose a named device and one of its printers. Test-print forms offer only exposed, approved printers supporting the chosen format. Device and printer choices respect the current user's tenant access.
|
||||
|
||||
For label printers, configure the machine's **Windows Printing Defaults** for the actual stock size and print method before testing PDFs through the service. A test profile selects document size and ZPL resolution; it does not change the Windows driver or printer's media configuration. Our 300 dpi Zebra required 4 × 6-inch stock and Thermal Direct instead of its previous 4.09 × 2-inch Thermal Transfer defaults. After correcting those settings and resuming the printer, the user confirmed the built-in PDF label, alongside the already confirmed ZPL label and laser PDF. Barcode scanning and measured alignment remain separate checks; `SPOOLED` alone is not proof of physical output.
|
||||
|
||||
On Printers, select one or more rows or open a printer record to **Approve printers**, **Disable printers**, **Delete printers**, **Print a test page**, or **Print a test label**. Standard QQQ review/result screens show the selected scope; preview does not print. Each selected printer is read again under the current user's permissions before execution. Jobs display the printer and print station names they were submitted under (stored on the job, so they read the same after a rename or a delete); approval, availability, format and status fields have named choices.
|
||||
|
||||
**Delete printers** and **Delete print stations** (on a selection or a record; they need `printing_delete` as well as `printing_admin`) take the record out of every list for good. A station is revoked first, so its computer must be enrolled again and then is a new station; its printers go with it. Queued jobs are canceled, jobs already sent without a reported result are closed as outcome unknown, and finished jobs stay in Print jobs with the names they were printed under. A record is refused, by name, while its station is connected and printing. A printer that its station still shares comes back from the next inventory as a new printer awaiting approval. Every deletion is recorded in **Deletion history** (who, what, when, what went with it). See the [walkthrough](docs/UI-WALKTHROUGH.md#delete-a-print-station-or-a-printer).
|
||||
|
||||
The older **Remove printers** and **Remove print station** actions are retired (1.2.0); Delete is the one way to take a printer or a print station away. Records they archived before the upgrade keep their **Removed at** time and stay out of the operator catalog, claims, the `PRINTERS` frame and every station/printer selector. The Printers and Print stations tables have no server-side default filter, so keep the filter **Removed at is empty** on the view you use day to day, or delete the archived records. If a station shares an archived queue again, the next inventory brings it back exposed but **not approved**, exactly like a newly discovered queue. Retention cleanup hard-deletes archived printers and stations that no job references (see [storage and retention](docs/STORAGE-AND-RETENTION.md)). `PrintingService.removePrinter` and `removeDevice` remain for a host that calls them; no screen action or route does.
|
||||
|
||||
Who reads what: a holder of `printing_operator` (or `printing_admin`) reads the print stations, printers and print jobs of the tenant, read only; an operator sees every job of the tenant, not only its own. Control history, deletion history and every action need `printing_admin` (deleting needs `printing_delete` too). A refusal tells the person what happened and what to ask an administrator for; set `PrintingQBitConfig.withProductName("...")` so it names your application ("You are signed in to ..."), otherwise it says "this application".
|
||||
On Printers, select one or more rows or open a printer record to **Approve printers**, **Disable printers**, **Print a test page**, or **Print a test label**. Standard QQQ review/result screens show the selected scope; preview does not print. Each selected printer is read again under the current user's permissions before execution. Jobs display the related printer and device names; approval, availability, format and status fields have named choices.
|
||||
|
||||
Metadata names follow QBit conventions: tables and data sources use `printing_*`, while processes/widgets use `printing...`. The initial namespace is fixed to `printing`. The QBit preserves the host's `QBrandingMetaData`; customer identity belongs in the host branding, not a custom QBit build.
|
||||
|
||||
Two independent settings govern dispatch: `available` means the queue is present in the latest locally selected inventory; `enabled` means a QQQ administrator approved it. New submissions and claims require both. A connector whose HELLO advertises `printer-approval-v1` (extension 2.4.0, connector 1.2.1) receives a `PRINTERS` frame listing `{ printerId, enabled }` for every queue in its latest accepted inventory after each accepted inventory and whenever an approval changes through any path; older connectors never receive it and keep reading the operator catalog. Removing a queue from local selection makes it unavailable without deleting its approval/history; removing a printer in QQQ additionally drops it from the frame until the device shares it again. An empty inventory withdraws all queues. Withdrawing a queue cannot retract a job already accepted by Windows.
|
||||
Two independent settings govern dispatch: `available` means the queue is present in the latest locally selected inventory; `enabled` means a QQQ administrator approved it. New submissions and claims require both. Removing a queue from local selection makes it unavailable without deleting its approval/history. An empty inventory withdraws all queues. Withdrawing a queue cannot retract a job already accepted by Windows.
|
||||
|
||||
Application code calls `printing.submit(JSONObject)` with the shared `SubmitJobRequest` fields. A stable business idempotency key returns the same job when retried; changing document/options/target under the same key fails. PDF is sent as bytes encoded once in base64; ZPL is UTF-8 printer-ready bytes. Default decoded limits are 100 MiB for PDF and 20 MiB for ZPL, both configurable in the native Printing connection and limits process. Queue approval and format compatibility are checked before insertion.
|
||||
|
||||
@@ -151,37 +141,33 @@ JSONObject job = printing.submit(new JSONObject()
|
||||
String printJobId = job.getString("jobId");
|
||||
```
|
||||
|
||||
For terminal and web clients the QBit also offers ready-made print processes: `PrintingRecordProcesses.registerAll(instance)` (after all host tables are added) puts **Print** on every readable table, rendering a record sheet from the table's sections and child lists; `printingPrintTableList` prints a grid of any table (columns, filter, sort, page or all rows, paper and orientation); `printingPrintText` prints text such as a screen capture. Opt a table out with `PrintingTableSettings().withPrintable(false)`. Each returns the queued job id in `printingJobIds`. `printingRenderToPdf` (extension 2.2.0) renders the same documents to a PDF download for the caller instead ("Save as PDF"), and every document carries the app header and footer the client sends (`headerApp`, `headerTitle`, `headerServer`, `headerUser`, `headerPrintedAt`, `footerLeft`, `footerNote`).
|
||||
For terminal and web clients the QBit also offers ready-made print processes: `PrintingRecordProcesses.registerAll(instance)` (after all host tables are added) puts **Print** on every readable table, rendering a record sheet from the table's sections and child lists; `printingPrintTableList` prints a grid of any table (columns, filter, sort, page or all rows, paper and orientation); `printingPrintText` prints text such as a screen capture. Opt a table out with `PrintingTableSettings().withPrintable(false)`. Each returns the queued job id in `printingJobIds`.
|
||||
|
||||
The returned ID identifies durable queue acceptance. Check job status asynchronously. The [protocol v1 specification](https://git.kof22.com/QRun-IO/qqq-print-protocol/src/branch/main/README.md) defines HTTP endpoints, JSON fields, integrity checks and lifecycle semantics.
|
||||
The returned ID identifies durable queue acceptance. Check job status asynchronously. The [protocol v1 specification](https://github.com/QRun-IO/qqq-print-protocol/blob/f977bd01b62ceb7539190fd2861809537fcf504c/README.md) defines HTTP endpoints, JSON fields, integrity checks and lifecycle semantics.
|
||||
|
||||
For durable QQQ jobs register `PrintEnqueueEffectTarget` as an `IDEMPOTENT_EXTERNAL` target in `DurableJobsMetaData`, then emit the submit-request payload. The target replaces the payload idempotency key with the durable effect key. Its SENT result means accepted into the queue, not physical output. This implementation uses its own JDBC transaction; do not register it as LOCAL_TX. Authorize the destination in the emitting process before writing the effect. QQQ's durable dispatcher runs with a `QSystemUserSession` and does not propagate the user's tenant keys. For that trusted outbox path only, the target resolves the service configured on the dispatcher's current QQQ instance; that service fixes the tenant and rejects devices belonging to another tenant. The payload cannot choose a service or tenant. A cached target resolves the current instance on every call. Inline user calls retain the `printing_tenant` scope check, and native management processes (including enrollment) still require both administrator permission and matching tenant scope. Do not expose direct effect emission through an arbitrary user-supplied target/payload endpoint.
|
||||
|
||||
## Deployment boundaries
|
||||
## Deliberate first-version limits
|
||||
|
||||
Jobs target an explicit device/printer. Logical destination routing and a distributed real-time bus belong to the integrating host. The release includes cancellation of queued jobs, explicit reprints, owned spool-cancellation commands, durable receipt reconciliation, S3 delivery storage and scheduled retention. Received/submitting jobs are not automatically offered again; `SPOOLED` never asserts physical delivery.
|
||||
The implemented path targets an explicit device/printer. Logical destination bindings, cancellation, reprint workflow, automatic reconciliation, clustered throughput optimization, retention and alerts are follow-ups. Documents are durably stored as base64 in the database for this first path; object-storage integration is deferred. Custom paper dimensions are rejected; configure the Windows queue. Received/submitting jobs are not automatically offered again. The queue records SPOOLED honestly and does not assert physical delivery.
|
||||
|
||||
Job paper (`paperWidthMm` and `paperHeightMm`, both positive and at most 2000, never combined with `mediaProfile`) is supported by the matching Windows 1.0.1 connector. The built-in 4 × 1 and 4 × 2 PDF tests use 101.6 × 25.4 / 50.8 mm. Without explicit paper or a reported media selection, jobs follow the Windows queue default. See [media selection](docs/OPERATOR-CATALOG.md).
|
||||
The protocol demo and synthetic native UI preview are separate local hosts. Attaching the QBit to a deployed application and its real authentication/facility policy remains a host integration task. PostgreSQL behavior, production deployment, upgrades, cancellation/reprint and broad printer-driver coverage are not certified by the initial H2/laser tests.
|
||||
|
||||
The protocol demo and synthetic native UI preview are separate local hosts. Attaching the QBit to a deployed application requires that host's real authentication, facility policy, database, storage and supervision. PostgreSQL and multiple QQQ nodes are not qualified by the local H2/MinIO fixture.
|
||||
## Verified initial path
|
||||
|
||||
## Physical output
|
||||
|
||||
The user confirmed physical laser PDF and Zebra ZPL/PDF output during development, including a 4 × 1 test. A configured stock profile does not prove a physical result on another printer or stock; inspect the first output after changing media. Historical acceptance records remain in [session history](docs/SESSION-STATE.md).
|
||||
On 2026-10-29, both the development Windows connector and the installed LocalSystem service printed a PDF to a local laser printer. The user confirmed both physical pages. MSI installation/start and temporary uninstall passed. Zebra hardware testing is deferred until a Zebra is connected. A SPOOLED status alone is never used as proof of physical output.
|
||||
|
||||
## CI and releases
|
||||
|
||||
Gitea is the source, pull-request, CI and release authority. The thin `.gitea/workflows/qrun-release.yaml` delegates to the protected `qrun-release-v1` channel with Java 21, the Maven wrapper, `ui-demo` and the immutable protocol fixture checkout. Required verify, secrets and gate checks precede merge; successful main builds capture the tested Maven reactor for the trusted registry publisher. Maintainers publish the corresponding tagged Gitea release from those verified bytes. See [release operations](docs/RELEASES.md#maintainer-release-path).
|
||||
|
||||
GitHub is a shadow/archive. Its Actions were retired for this repository on 2026-11-04; checked-in `.github` workflows describe the former pipeline and do not publish current printing releases. The separate Windows repository retains its signing/update-feed workflow. The 1.0.0 and 1.1.0 server releases do not claim GitHub attestations or Maven Central publication. The JAR includes LICENSE, NOTICE and font/diagnostic asset licenses; publication does not deploy a QQQ host or print to hardware.
|
||||
Pull requests and `main` pushes run Java 21/Maven wrapper verification with the immutable sibling protocol checkout. A tag matching the POM version runs build/tests and the secrets, workflow, dependency and malicious-package security gates before publishing the tested JAR, POM and `SHA256SUMS` as GitHub release assets. Build verification enables the `ui-demo` profile used by the local host. Maven generates its selected compile/runtime graph as a CycloneDX SBOM, including frontend assets. Trivy and OSV scan that graph; a guard rejects missing or different package versions, missing frontend assets, and empty inventories. CI retains the resolved graph and scanner evidence. OSV uses `--all-packages`; its pinned 2.6.0 reporter [omits Maven groups](https://github.com/google/osv-scanner/issues/3099), so the guard checks every reported artifact/version and rejects ambiguous names while the verified input retains full package URLs. Hyphenated versions create prereleases. The packaged JAR includes the repository LICENSE and NOTICE under `META-INF`, alongside the existing font license and diagnostic assets. The workflow does not publish to Maven Central, deploy a QQQ application or print to hardware. The [0.1.0-rc.1 release](https://github.com/QRun-IO/qbit-printing/releases/tag/v0.1.0-rc.1) passed these hosted gates.
|
||||
|
||||
## Printing home
|
||||
|
||||
The admin-only Printing home uses stock QQQ widgets: a purpose/scope/help header, actionable exceptions, four health tiles, and a full-width pending/recent work list. Counts and record links use QQQ queries under the viewer's tenant. Device disconnection means no heartbeat for 90 seconds; job failure tiles cover jobs created in the past 24 hours. Older failures remain in Print jobs. An empty installation explains enrollment and printer setup.
|
||||
|
||||
The home uses the standard QQQ frontend widgets and scoped queries. Its timed dashboard refresh updates the visible summary; job delivery uses the independent real-time WebSocket and does not wait for a dashboard refresh. No custom frontend or HTML dashboard is required.
|
||||
This RC implements the happy path of the [QQQ dashboard standard](https://github.com/QRun-IO/qqq/blob/main/docs/DASHBOARD-STANDARD.md), with explicit remaining gaps: RC.20 carries role/priority hints in widget default values; attention uses scoped database queries and 60-second refresh rather than the core live attention feed; dismiss/snooze, interactive URL-backed page scope, and stale/retry presentation depend on further core/frontend integration. It has not passed the standard's full responsive/accessibility audit. No custom frontend or HTML dashboard is used.
|
||||
|
||||
### Operator actions
|
||||
### Operator actions (0.1.1-rc.1)
|
||||
|
||||
The Windows companion can request test prints and explicit reprints through device-scoped authenticated routes. The same printer approval/exposure rules apply. Upgrade the QBit and connector together for these additive protocol features. Reprints create a new job; uncertain/spooled originals require duplicate-output consent and remain unchanged.
|
||||
|
||||
@@ -191,6 +177,6 @@ QQQ's **Print jobs** table and records expose **Print again** and **Cancel queue
|
||||
|
||||
All built-in printer test actions share `PrintingTestDocuments`: QQQ branding, the official [Query dog mascot](https://qrun.io/query), large warehouse-style identifiers and embedded JetBrains Mono Bold with a dotted zero and distinct 1/I/l. Query's original artwork and aspect ratio are preserved in PDF and thermal output; [asset provenance](src/main/resources/com/kingsrook/qbits/printing/images/README.md) ships with the resource. The font is included under SIL OFL 1.1; its license and provenance ship in the JAR. PDF embeds a font subset. ZPL renders the same glyphs into document-local, row-aligned graphics below Zebra's 99,999-byte per-field limit; it does not download or save a printer font.
|
||||
|
||||
Native record and selected-table actions expose a possible-value stock/resolution selector. Letter and A4 are PDF-only. Label profiles cover 4 × 1, 4 × 2 and 4 × 6 inches at 203, 300 or 600 dpi, with corresponding PDF dimensions of 101.6 × 25.4, 50.8 or 152.4 mm. Select matching loaded stock and printer resolution. Bulk actions apply the chosen profile to every selected destination, so group compatible printers. The document does not change the Windows queue defaults, calibrate the printer or save device configuration; ZPL width/length are transient format settings. Direct-thermal stock needs the driver's Direct Thermal setting, without a ribbon.
|
||||
Native record and selected-table actions expose a possible-value stock/resolution selector. Letter and A4 are PDF-only. Label profiles are 4 × 6 inches at 203, 300 or 600 dpi; PDF label output is always 101.6 × 152.4 mm. Select matching stock and printer resolution. Bulk actions apply the chosen profile to every selected destination, so group compatible printers. The document does not reconfigure Windows stock, calibrate the printer or save device configuration; ZPL width/length are transient format settings.
|
||||
|
||||
The device test-print API accepts optional `testProfile` with the same choices. Existing clients default to Letter PDF or 203-dpi 4 × 6 ZPL. Invalid profiles fail before enqueueing. Test actions use the ordinary durable queue and existing printer exposure/approval rules; discovery never automatically prints. A ZPL barcode, glyph comparisons and size/alignment marks support physical inspection. Rendering previews and spool acceptance do not prove paper or scanner quality.
|
||||
+3
-3
@@ -1,9 +1,9 @@
|
||||
# Security
|
||||
|
||||
Report vulnerabilities privately through [GitHub vulnerability reporting](https://github.com/QRun-IO/qbit-printing/security/advisories/new), or `contact@kingsrook.com` if that channel is unavailable. Include affected versions, a minimal synthetic reproduction and expected versus actual authorization behavior. Ordinary source changes and pull requests belong in Gitea. Do not put enrollment codes, bearer credentials, customer documents or exploit details in public issues.
|
||||
Report vulnerabilities privately through [GitHub vulnerability reporting](https://github.com/QRun-IO/qbit-printing/security/advisories/new), or `contact@kingsrook.com` if that channel is unavailable. Include affected versions, a minimal synthetic reproduction and expected versus actual authorization behavior. Do not put enrollment codes, bearer credentials, customer documents or exploit details in public issues.
|
||||
|
||||
The supported release line is 1.0.x for QQQ 4.1+, currently built against QQQ 4.1.0-RC.21. Report the exact QBit, QQQ and Windows connector versions. Older QQQ versions are outside scope.
|
||||
The current prerelease targets QQQ 4.1+. Fixes target the current prerelease; older QQQ versions are outside scope.
|
||||
|
||||
The host must provide authenticated management authorization and the correct tenant/facility context. Native QQQ operations require `printing_admin` and a matching `printing_tenant` session security value. Native device operations require both the current QQQ user session and bound-device proof; a device token alone cannot authorize them. Operator catalog/submission uses `printing_operator` or administration plus native destination/process permissions; it grants no general device administration. `printing_operator` also reads the tenant's print stations, printers and print jobs (read only, every job of the tenant); control history and deletion history require `printing_admin`. See [authorization and controls](docs/OPERATIONS.md#device-controls-and-durable-action-receipts). HTTPS is required for remote deployment; the supplied HTTP demos deliberately bind to loopback.
|
||||
The host must provide authenticated management authorization and the correct tenant/facility context. Native QQQ operations require `printing_admin` and a matching `printing_tenant` session security value. Device credentials only authorize their device's queue/content/status operations. HTTPS is required for remote deployment; the supplied HTTP demos deliberately bind to loopback.
|
||||
|
||||
The UI demonstration uses a fixed mock identity and synthetic data and must remain local. It registers no connector transport routes. RAW ZPL is printer-control input: submit trusted generated labels, not arbitrary untrusted printer commands. Stored documents can contain personal information. See [storage and retention](docs/STORAGE-AND-RETENTION.md) for dedicated bucket boundaries, tenant isolation and the default 365-day policy.
|
||||
@@ -1,206 +0,0 @@
|
||||
# KofTwentyTwo .NET code style (standards: K22-CODE-CS): the Kingsrook code style
|
||||
# (https://github.com/QRun-IO/qqq/blob/develop/CODE_STYLE.md) applied to C#.
|
||||
# Copy to the repository root. Severities of "warning" fail the build because the
|
||||
# companion Directory.Build.props sets TreatWarningsAsErrors and EnforceCodeStyleInBuild,
|
||||
# so local `dotnet build` and CI enforce exactly the same rules. The resharper_* keys
|
||||
# apply the Kingsrook blank-line rules in Rider and ReSharper, which .NET's own
|
||||
# formatter cannot express.
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
indent_style = space
|
||||
# Kingsrook: always 3 spaces, never tabs.
|
||||
indent_size = 3
|
||||
tab_width = 3
|
||||
|
||||
# YAML stays at 2: the YAML ecosystem (GitHub Actions, Dependabot) assumes it.
|
||||
[*.{yml,yaml}]
|
||||
indent_size = 2
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
# Windows-only script formats require CRLF.
|
||||
[*.{cmd,bat}]
|
||||
end_of_line = crlf
|
||||
|
||||
[*.cs]
|
||||
# All fixture sources are repository-owned Apache-2.0 code.
|
||||
file_header_template = Copyright 2026 Kingsrook, LLC\nSPDX-License-Identifier: Apache-2.0
|
||||
dotnet_diagnostic.IDE0073.severity = warning
|
||||
#### Formatting (IDE0055 makes every rule below a build error) ####
|
||||
dotnet_diagnostic.IDE0055.severity = warning
|
||||
dotnet_sort_system_directives_first = true
|
||||
dotnet_separate_import_directive_groups = false
|
||||
csharp_new_line_before_open_brace = all
|
||||
csharp_new_line_before_else = true
|
||||
csharp_new_line_before_catch = true
|
||||
csharp_new_line_before_finally = true
|
||||
csharp_new_line_before_members_in_object_initializers = true
|
||||
csharp_new_line_before_members_in_anonymous_types = true
|
||||
csharp_new_line_between_query_expression_clauses = true
|
||||
csharp_indent_case_contents = true
|
||||
csharp_indent_switch_labels = true
|
||||
csharp_indent_labels = one_less_than_current
|
||||
csharp_indent_block_contents = true
|
||||
csharp_indent_braces = false
|
||||
csharp_space_after_cast = false
|
||||
# Kingsrook: no space between a control keyword and its parenthesis: if(x), for(...), catch(...).
|
||||
csharp_space_after_keywords_in_control_flow_statements = false
|
||||
csharp_space_between_method_declaration_parameter_list_parentheses = false
|
||||
csharp_space_between_method_call_parameter_list_parentheses = false
|
||||
csharp_space_between_parentheses = false
|
||||
csharp_space_before_colon_in_inheritance_clause = true
|
||||
csharp_space_after_colon_in_inheritance_clause = true
|
||||
csharp_space_around_binary_operators = before_and_after
|
||||
csharp_space_after_comma = true
|
||||
csharp_space_before_comma = false
|
||||
csharp_space_after_semicolon_in_for_statement = true
|
||||
csharp_preserve_single_line_statements = false
|
||||
csharp_preserve_single_line_blocks = false
|
||||
|
||||
#### Kingsrook blank lines and layout (Rider / ReSharper; .NET formatter cannot express) ####
|
||||
resharper_blank_lines_around_method = 3
|
||||
resharper_blank_lines_around_property = 3
|
||||
resharper_blank_lines_around_auto_property = 1
|
||||
resharper_blank_lines_around_type = 3
|
||||
resharper_blank_lines_after_using_list = 2
|
||||
resharper_keep_blank_lines_in_code = 1
|
||||
resharper_keep_blank_lines_in_declarations = 3
|
||||
resharper_brace_style = next_line
|
||||
resharper_indent_size = 3
|
||||
resharper_space_after_keywords_in_control_flow_statements = false
|
||||
resharper_max_line_length = 999
|
||||
resharper_wrap_before_first_method_call = true
|
||||
resharper_wrap_chained_method_calls = chop_if_long
|
||||
|
||||
#### Usings and namespaces ####
|
||||
# IDE0005 needs GenerateDocumentationFile=true to run during build (set in Directory.Build.props).
|
||||
dotnet_diagnostic.IDE0005.severity = warning
|
||||
csharp_using_directive_placement = outside_namespace:warning
|
||||
csharp_style_namespace_declarations = file_scoped:warning
|
||||
dotnet_diagnostic.IDE0161.severity = warning
|
||||
|
||||
#### var: only when the type is apparent from the right-hand side ####
|
||||
csharp_style_var_for_built_in_types = false:warning
|
||||
csharp_style_var_when_type_is_apparent = true:warning
|
||||
csharp_style_var_elsewhere = false:warning
|
||||
dotnet_diagnostic.IDE0007.severity = warning
|
||||
dotnet_diagnostic.IDE0008.severity = warning
|
||||
|
||||
#### Braces, modifiers, readonly ####
|
||||
csharp_prefer_braces = true:warning
|
||||
dotnet_diagnostic.IDE0011.severity = warning
|
||||
dotnet_style_require_accessibility_modifiers = for_non_interface_members:warning
|
||||
dotnet_diagnostic.IDE0040.severity = warning
|
||||
dotnet_style_readonly_field = true:warning
|
||||
dotnet_diagnostic.IDE0044.severity = warning
|
||||
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:warning
|
||||
dotnet_diagnostic.IDE0036.severity = warning
|
||||
|
||||
#### this. qualification: never ####
|
||||
dotnet_style_qualification_for_field = false:warning
|
||||
dotnet_style_qualification_for_property = false:warning
|
||||
dotnet_style_qualification_for_method = false:warning
|
||||
dotnet_style_qualification_for_event = false:warning
|
||||
dotnet_diagnostic.IDE0003.severity = warning
|
||||
|
||||
#### Language keywords over framework type names ####
|
||||
dotnet_style_predefined_type_for_locals_parameters_members = true:warning
|
||||
dotnet_style_predefined_type_for_member_access = true:warning
|
||||
dotnet_diagnostic.IDE0049.severity = warning
|
||||
|
||||
#### Dead code and redundancy ####
|
||||
dotnet_diagnostic.IDE0051.severity = warning # unused private member
|
||||
dotnet_diagnostic.IDE0052.severity = warning # unread private member
|
||||
dotnet_diagnostic.IDE0059.severity = warning # unnecessary assignment
|
||||
dotnet_diagnostic.IDE0060.severity = warning # unused parameter
|
||||
dotnet_diagnostic.IDE0035.severity = warning # unreachable code
|
||||
dotnet_diagnostic.IDE0004.severity = warning # unnecessary cast
|
||||
dotnet_diagnostic.IDE0100.severity = warning # unnecessary equality operator
|
||||
dotnet_diagnostic.IDE0080.severity = warning # unnecessary suppression operator
|
||||
dotnet_diagnostic.IDE0079.severity = warning # unnecessary suppression
|
||||
dotnet_code_quality_unused_parameters = all
|
||||
|
||||
#### Modern language features (suggestions: shown in IDE, not enforced) ####
|
||||
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
|
||||
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
|
||||
csharp_style_prefer_switch_expression = true:suggestion
|
||||
csharp_style_prefer_primary_constructors = true:suggestion
|
||||
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion
|
||||
dotnet_style_coalesce_expression = true:suggestion
|
||||
dotnet_style_null_propagation = true:suggestion
|
||||
dotnet_style_prefer_collection_expression = when_types_loosely_match:suggestion
|
||||
csharp_style_expression_bodied_methods = when_on_single_line:suggestion
|
||||
csharp_style_expression_bodied_properties = true:suggestion
|
||||
|
||||
#### Naming ####
|
||||
dotnet_naming_rule.interfaces_begin_with_i.symbols = interfaces
|
||||
dotnet_naming_rule.interfaces_begin_with_i.style = i_prefix_pascal_case
|
||||
dotnet_naming_rule.interfaces_begin_with_i.severity = warning
|
||||
dotnet_naming_symbols.interfaces.applicable_kinds = interface
|
||||
dotnet_naming_style.i_prefix_pascal_case.required_prefix = I
|
||||
dotnet_naming_style.i_prefix_pascal_case.capitalization = pascal_case
|
||||
|
||||
dotnet_naming_rule.type_parameters_begin_with_t.symbols = type_parameters
|
||||
dotnet_naming_rule.type_parameters_begin_with_t.style = t_prefix_pascal_case
|
||||
dotnet_naming_rule.type_parameters_begin_with_t.severity = warning
|
||||
dotnet_naming_symbols.type_parameters.applicable_kinds = type_parameter
|
||||
dotnet_naming_style.t_prefix_pascal_case.required_prefix = T
|
||||
dotnet_naming_style.t_prefix_pascal_case.capitalization = pascal_case
|
||||
|
||||
dotnet_naming_rule.types_and_members_are_pascal_case.symbols = types_and_members
|
||||
dotnet_naming_rule.types_and_members_are_pascal_case.style = pascal_case
|
||||
dotnet_naming_rule.types_and_members_are_pascal_case.severity = warning
|
||||
dotnet_naming_symbols.types_and_members.applicable_kinds = namespace, class, struct, enum, delegate, property, method, event
|
||||
dotnet_naming_style.pascal_case.capitalization = pascal_case
|
||||
|
||||
dotnet_naming_rule.private_fields_are_underscore_camel.symbols = private_fields
|
||||
dotnet_naming_rule.private_fields_are_underscore_camel.style = underscore_camel_case
|
||||
dotnet_naming_rule.private_fields_are_underscore_camel.severity = warning
|
||||
dotnet_naming_symbols.private_fields.applicable_kinds = field
|
||||
dotnet_naming_symbols.private_fields.applicable_accessibilities = private, private_protected
|
||||
dotnet_naming_symbols.private_fields.required_modifiers =
|
||||
dotnet_naming_style.underscore_camel_case.required_prefix = _
|
||||
dotnet_naming_style.underscore_camel_case.capitalization = camel_case
|
||||
|
||||
dotnet_naming_rule.private_static_fields_are_s_camel.symbols = private_static_fields
|
||||
dotnet_naming_rule.private_static_fields_are_s_camel.style = s_camel_case
|
||||
dotnet_naming_rule.private_static_fields_are_s_camel.severity = warning
|
||||
dotnet_naming_symbols.private_static_fields.applicable_kinds = field
|
||||
dotnet_naming_symbols.private_static_fields.applicable_accessibilities = private, private_protected
|
||||
dotnet_naming_symbols.private_static_fields.required_modifiers = static
|
||||
dotnet_naming_style.s_camel_case.required_prefix = s_
|
||||
dotnet_naming_style.s_camel_case.capitalization = camel_case
|
||||
|
||||
dotnet_naming_rule.constants_are_pascal_case.symbols = constants
|
||||
dotnet_naming_rule.constants_are_pascal_case.style = pascal_case
|
||||
dotnet_naming_rule.constants_are_pascal_case.severity = warning
|
||||
dotnet_naming_symbols.constants.applicable_kinds = field, local
|
||||
dotnet_naming_symbols.constants.required_modifiers = const
|
||||
|
||||
#### Analyzer adjustments (each one justified) ####
|
||||
# CA1716: flags members named like VB keywords (e.g. ILog.Error). KofTwentyTwo is C#-only.
|
||||
dotnet_diagnostic.CA1716.severity = none
|
||||
# MA0004 (ConfigureAwait): app code runs on UI threads where ConfigureAwait(false) is
|
||||
# wrong by default; libraries opt back in with a [*.cs] override in their own folder.
|
||||
dotnet_diagnostic.MA0004.severity = none
|
||||
# MA0049 (type name matches namespace): conflicts with the AppName/AppName.Core layout.
|
||||
dotnet_diagnostic.MA0049.severity = none
|
||||
|
||||
[**/{Generated,obj}/**.cs]
|
||||
generated_code = true
|
||||
|
||||
[{tests,test}/**.cs]
|
||||
# xUnit's Method_Scenario_Expectation names use underscores by convention.
|
||||
dotnet_diagnostic.CA1707.severity = none
|
||||
# Inline arrays keep test data at the assertion; each test runs once.
|
||||
dotnet_diagnostic.CA1861.severity = none
|
||||
# Test projects are not documented API.
|
||||
dotnet_diagnostic.CS1591.severity = none
|
||||
# MA0048 (one type per file): a test file groups the test classes and fakes of one feature.
|
||||
dotnet_diagnostic.MA0048.severity = none
|
||||
@@ -1,5 +0,0 @@
|
||||
# Copyright 2026 Kingsrook, LLC
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
# Keep the SDK formatter identical on Windows and Linux checkouts.
|
||||
*.cs text eol=lf
|
||||
+9
-21
@@ -1,24 +1,12 @@
|
||||
# Local Authentik reference
|
||||
|
||||
The released application uses QQQ 4.1.0-RC.21, including the native session-login
|
||||
grant. A production host configures QQQ's standard OAuth2/Authentik provider,
|
||||
trusted HTTPS, redirect registration and current user/tenant permissions. The
|
||||
Windows connector discovers that setup through the QQQ UI/UX API; provider
|
||||
refresh credentials remain on the server. See [the native authentication
|
||||
contract](https://git.kof22.com/QRun-IO/qqq-print-protocol/src/branch/main/docs/QQQ-AUTHENTICATION.md).
|
||||
Run the optional real-provider checks with Docker Compose and PowerShell 7.4+.
|
||||
The pinned fixture images use Linux/amd64; other hosts need Docker's corresponding
|
||||
Linux-container support or emulation:
|
||||
|
||||
## Historical reference fixture compatibility
|
||||
|
||||
The optional `Invoke-Dev.ps1 -Action Test -Authentik` diagnostic below was written
|
||||
for RC.20. `Invoke-Authentik.ps1` explicitly expects API 1.8 without
|
||||
`nativeSessionLogin`, so that diagnostic is not compatible with the current RC.21
|
||||
application baseline. Do not interpret its expected-absence assertion as a
|
||||
production native-authentication failure or use it as a 1.0 release gate. The
|
||||
separately pinned experimental profile remains available for reproducing its
|
||||
recorded result. No fixture code or pins were changed during documentation closeout.
|
||||
|
||||
The following describes the retained fixture and its recorded scope. It requires
|
||||
Docker Compose, PowerShell 7.4+ and Linux/amd64 container support.
|
||||
```powershell
|
||||
pwsh ./dev/Invoke-Dev.ps1 -Action Test -Authentik
|
||||
```
|
||||
|
||||
The command creates a fresh, owned development project, runs the normal QQQ and
|
||||
MinIO smoke test plus the Authentik reference checks, then removes that project's
|
||||
@@ -45,7 +33,7 @@ authentication.
|
||||
S256 capability. A valid state/S256 request with the registered callback
|
||||
continues to the provider login flow without following it. Changing only that
|
||||
callback to an unregistered redirect is rejected before any user login.
|
||||
- The historical QQQ RC.20 host advertised UI API 1.8 without `nativeSessionLogin`.
|
||||
- The current QQQ RC.20 host advertises UI API 1.8 without `nativeSessionLogin`.
|
||||
That expected absence is recorded as a native-client prerequisite failure,
|
||||
not silently replaced by bearer authentication or an unpublished core.
|
||||
|
||||
@@ -101,8 +89,8 @@ denials, logout replay rejection, renewal after expiry and provider revocation
|
||||
with the production Core client. Its synthetic HTTP driver and HTTPS callback
|
||||
receiver do not qualify the installed Windows browser UI or private URI callback.
|
||||
|
||||
The released application now adopts the compatible QQQ RC.21 tuple; this
|
||||
historical experimental result does not by itself qualify a different host configuration. Provider refresh tokens stay on the server. The short lifetime test does
|
||||
Production adoption still requires a compatible published central artifact
|
||||
tuple. Provider refresh tokens stay on the server. The short lifetime test does
|
||||
not prove months or years of unattended use. Do not route the private Windows
|
||||
callback to a live companion whose connection must remain intact.
|
||||
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
<!-- Copyright 2026 Kingsrook, LLC; SPDX-License-Identifier: Apache-2.0 -->
|
||||
<Project>
|
||||
<PropertyGroup>
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
<LangVersion>latest</LangVersion>
|
||||
<IsPackable>false</IsPackable>
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
<MSBuildTreatWarningsAsErrors>true</MSBuildTreatWarningsAsErrors>
|
||||
<AnalysisLevel>latest-recommended</AnalysisLevel>
|
||||
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
|
||||
<GenerateDocumentationFile>true</GenerateDocumentationFile>
|
||||
<Deterministic>true</Deterministic>
|
||||
<NuGetAudit>true</NuGetAudit>
|
||||
<NuGetAuditMode>all</NuGetAuditMode>
|
||||
<NuGetAuditLevel>low</NuGetAuditLevel>
|
||||
<RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
|
||||
<CoreAssemblyPath Condition="'$(CoreAssemblyPath)' == ''">/core/Qqq.PrintAgent.Core.dll</CoreAssemblyPath>
|
||||
</PropertyGroup>
|
||||
<PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true' or '$(CI)' == 'true'">
|
||||
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
|
||||
<RestoreLockedMode>true</RestoreLockedMode>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Meziantou.Analyzer" PrivateAssets="all" IncludeAssets="runtime; build; native; contentfiles; analyzers" />
|
||||
</ItemGroup>
|
||||
<Target Name="RequireProductionCore" BeforeTargets="ResolveAssemblyReferences">
|
||||
<Error Condition="!Exists('$(CoreAssemblyPath)')" Text="Build the pinned production Core source first and provide CoreAssemblyPath; fixture stubs are not supported." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -1,10 +0,0 @@
|
||||
<!-- Copyright 2026 Kingsrook, LLC; SPDX-License-Identifier: Apache-2.0 -->
|
||||
<Project>
|
||||
<PropertyGroup>
|
||||
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
|
||||
<CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<PackageVersion Include="Meziantou.Analyzer" Version="3.0.296" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -7,11 +7,9 @@ ADD --checksum=sha256:82fcdbf7240760939a63b219aeb15a2333b3a8a02b52307a8a328500fc
|
||||
RUN mkdir /client && tar -xzf /tmp/client.tar.gz -C /client --strip-components=1 && rm /tmp/client.tar.gz
|
||||
RUN dotnet build /client/src/Qqq.PrintAgent.Core/Qqq.PrintAgent.Core.csproj -c Release -p:Platform=x64 -p:Version=0.3.1-rc.1 -p:RestoreLockedMode=true --nologo
|
||||
RUN mkdir /core && cp /client/src/Qqq.PrintAgent.Core/bin/x64/Release/net10.0/Qqq.PrintAgent.Core.dll /core/
|
||||
COPY dev/Directory.Build.props dev/Directory.Packages.props dev/.editorconfig dev/global.json /fixture/dev/
|
||||
WORKDIR /fixture/dev/client
|
||||
WORKDIR /fixture
|
||||
COPY dev/client .
|
||||
RUN dotnet build -c Release -p:RestoreLockedMode=true --nologo -o /out
|
||||
RUN dotnet format --verify-no-changes --severity warn --no-restore
|
||||
RUN dotnet build -c Release --nologo -o /out
|
||||
RUN dotnet /out/Workload.dll --check-discovery
|
||||
# SDK image is reused deliberately: one pinned image, no hidden host SDK dependency.
|
||||
FROM mcr.microsoft.com/dotnet/sdk:10.0@sha256:de4fe90a98845d75910b9769662465c84de1a934665c431279d1382b2bddc02b
|
||||
|
||||
@@ -7,11 +7,10 @@ COPY pom.xml mvnw ./
|
||||
COPY .mvn .mvn
|
||||
COPY checkstyle checkstyle
|
||||
COPY src src
|
||||
COPY dev/java dev/java
|
||||
COPY dev/native-auth/java dev/native-auth/java
|
||||
COPY LICENSE NOTICE ./
|
||||
RUN chmod +x mvnw && ./mvnw -B -Pui-demo -DskipTests package dependency:copy-dependencies -DincludeScope=runtime -DoutputDirectory=target/runtime
|
||||
RUN mkdir -p /fixture-classes && javac -proc:none -cp 'target/classes:target/runtime/*' -d /fixture-classes dev/java/*.java
|
||||
COPY dev/java /fixture-src
|
||||
RUN mkdir -p /fixture-classes && javac -proc:none -cp 'target/classes:target/runtime/*' -d /fixture-classes /fixture-src/*.java
|
||||
|
||||
FROM eclipse-temurin:21-jdk-jammy@sha256:742daacb9316be4b6fc60258f6e4ac2a11882f6c597373c92290a57bfad0d2e0
|
||||
ARG SOURCE_COMMIT=unknown
|
||||
|
||||
+9
-29
@@ -32,13 +32,13 @@ The host provides native printing screens, settings, a dedicated MinIO document
|
||||
bucket and scheduled retention. No printer is enrolled automatically in this host.
|
||||
The test workload uses a separate disposable database and object store.
|
||||
|
||||
The current application dependency is QQQ RC.21, which supplies native session
|
||||
login. The optional `-Authentik` diagnostic still asserts the older RC.20 API 1.8
|
||||
absence of that feature; it is a retained historical check, not a current RC.21
|
||||
login test. See [provider setup and fixture compatibility](AUTHENTIK.md).
|
||||
Authentik uses PostgreSQL; the printing host itself uses H2, not PostgreSQL or MySQL.
|
||||
Add `-Authentik` when creating an environment or running a fresh test to include
|
||||
real Authentik/PostgreSQL. See [the provider checks and remaining native grant
|
||||
prerequisite](AUTHENTIK.md). Provider discovery does not establish successful OIDC
|
||||
user login or refresh; the current QQQ RC.20 API lacks that native-client grant.
|
||||
|
||||
```powershell
|
||||
pwsh ./dev/Invoke-Dev.ps1 -Action Test -Authentik
|
||||
pwsh ./dev/Invoke-Dev.ps1 -Action Test -Workload 10000
|
||||
```
|
||||
|
||||
@@ -126,28 +126,8 @@ It is opt-in, Test-only, and does not change the default released QQQ dependency
|
||||
|
||||
## Continuous integration
|
||||
|
||||
Primary Gitea CI runs the shared Maven verification with `ui-demo` and the pinned
|
||||
protocol fixtures. GitHub Actions were retired for this repository on 2026-11-04.
|
||||
The checked-in `.github/workflows/development.yml` records the former Windows/Linux
|
||||
Pester, image-build and Docker checks; it is not an active CI guarantee. The
|
||||
commands above remain available for intentional local development checks.
|
||||
|
||||
Maven Checkstyle checks all four Java fixture sources in `dev/java` and
|
||||
`dev/native-auth/java` during `validate`. They are deliberately **not** Maven
|
||||
compiler sources: the ordinary fixture uses the released QQQ tuple, while the
|
||||
native host compiles only inside its explicitly selected candidate image. Both
|
||||
server Dockerfiles copy both roots before Maven runs so neither image can skip
|
||||
this style coverage.
|
||||
|
||||
The ten C# fixture files share `dev/.editorconfig`, strict build properties,
|
||||
central Meziantou 3.0.296, and committed package locks. The existing pinned SDK
|
||||
image contains .NET SDK 10.0.403, matching `dev/global.json`. Both image builds
|
||||
perform locked, vulnerability-audited restore, warnings-as-errors compilation,
|
||||
formatter verification, and their nine or 12 fake-HTTP discovery cases. Core is
|
||||
still built from the exact public source archive above; no stubs or runtime
|
||||
package dependency were added. For a local build, supply the real pinned Core
|
||||
DLL through `-p:CoreAssemblyPath=/absolute/path/Qqq.PrintAgent.Core.dll`.
|
||||
|
||||
The longer experimental native-auth profile is
|
||||
an explicit local command; it is not silently substituted for the
|
||||
The development workflow runs the Pester and PowerShell analysis checks on
|
||||
Windows and Ubuntu for every pull request and main-branch push. Ubuntu also runs
|
||||
the real 40-job/S3 Docker smoke. The longer experimental native-auth profile is
|
||||
an explicit manual workflow option; it is not silently substituted for the
|
||||
released dependency baseline.
|
||||
@@ -1,24 +1,12 @@
|
||||
// Copyright 2026 Kingsrook, LLC
|
||||
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
using System.Net;
|
||||
using System.Text.Json;
|
||||
using Qqq.PrintAgent.Core.Authentication;
|
||||
namespace Printing.Development;
|
||||
|
||||
|
||||
|
||||
/// <summary>Exercises fixture compatibility decisions using credential-free fake HTTP responses.</summary>
|
||||
internal static class DiscoveryChecks
|
||||
{
|
||||
private static readonly string[] s_features = ["version", "metaData", "processes", "processCancel", "extensions", "widgets"];
|
||||
|
||||
|
||||
|
||||
private static readonly string[] s_channels = ["api"];
|
||||
|
||||
|
||||
|
||||
/// <summary>Verify supported stable versions and reject malformed or incompatible versions.</summary>
|
||||
internal static async Task RunAsync()
|
||||
{
|
||||
(string Version, bool Accepted)[] cases =
|
||||
@@ -37,14 +25,8 @@ internal static class DiscoveryChecks
|
||||
await WorkloadDiscovery.DiscoverRealtimeAsync(client, CancellationToken.None);
|
||||
accepted = true;
|
||||
}
|
||||
catch(QqqSessionException error) when(error.Failure == QqqSessionException.FailureKind.ConfigurationRequired)
|
||||
{
|
||||
// Expected for incompatible versions: the case stays rejected and the comparison below judges it.
|
||||
}
|
||||
catch(InvalidDataException)
|
||||
{
|
||||
// Expected for malformed versions: the case stays rejected and the comparison below judges it.
|
||||
}
|
||||
catch(QqqSessionException error) when(error.Failure == QqqSessionException.FailureKind.ConfigurationRequired) { }
|
||||
catch(InvalidDataException) { }
|
||||
if(accepted != expected || handler.Requests != 1)
|
||||
{
|
||||
throw new InvalidDataException($"Discovery compatibility case {version} failed.");
|
||||
@@ -53,29 +35,14 @@ internal static class DiscoveryChecks
|
||||
Console.WriteLine($"Discovery compatibility checks passed: {cases.Length}.");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Supply one version response and reject any premature credential transmission.</summary>
|
||||
private sealed class DiscoveryHandler(string version) : HttpMessageHandler
|
||||
{
|
||||
internal int Requests
|
||||
{
|
||||
get;
|
||||
internal int Requests { get; private set; }
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Return only the synthetic discovery response and count the request.</summary>
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
if(request.Method != HttpMethod.Get
|
||||
|| !string.Equals(request.RequestUri?.AbsolutePath, "/qqq/v1/version", StringComparison.Ordinal)
|
||||
|| request.Headers.Contains("Cookie")
|
||||
|| request.Headers.Contains("Authorization"))
|
||||
if(request.Method != HttpMethod.Get || request.RequestUri?.AbsolutePath != "/qqq/v1/version"
|
||||
|| request.Headers.Contains("Cookie") || request.Headers.Contains("Authorization"))
|
||||
{
|
||||
throw new InvalidOperationException("Discovery must precede authentication.");
|
||||
}
|
||||
@@ -83,8 +50,8 @@ internal static class DiscoveryChecks
|
||||
string json = JsonSerializer.Serialize(new
|
||||
{
|
||||
apiVersion = "1.8.0",
|
||||
features = s_features,
|
||||
clientChannels = s_channels,
|
||||
features = new[] { "version", "metaData", "processes", "processCancel", "extensions", "widgets" },
|
||||
clientChannels = new[] { "api" },
|
||||
extensions = new[] { new { name = "printing", version, pathPrefix = "/qbit/printing" } }
|
||||
});
|
||||
return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(json) });
|
||||
|
||||
+135
-611
@@ -1,5 +1,7 @@
|
||||
// Copyright 2026 Kingsrook, LLC
|
||||
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
using System.Collections.Concurrent;
|
||||
using System.Diagnostics;
|
||||
using System.Globalization;
|
||||
using System.Net.WebSockets;
|
||||
@@ -8,618 +10,140 @@ using System.Text.Json;
|
||||
using System.Threading.Channels;
|
||||
using Qqq.PrintAgent.Core.Authentication;
|
||||
using Qqq.PrintAgent.Core.Printing;
|
||||
namespace Printing.Development;
|
||||
|
||||
|
||||
|
||||
/// <summary>Runs real Core network workers against synthetic Java services without a physical printer.</summary>
|
||||
internal static class Program
|
||||
{
|
||||
private static readonly JsonSerializerOptions s_reportOptions = new() { WriteIndented = true };
|
||||
|
||||
|
||||
|
||||
private static readonly string[] s_capabilities = ["realtime-v1", "REFRESH_INVENTORY", "CANCEL_SPOOL"];
|
||||
|
||||
|
||||
|
||||
private static int s_completed;
|
||||
|
||||
|
||||
|
||||
private static readonly byte[] s_expected = Encoding.ASCII.GetBytes("^XA^FO20,20^FDSYNTHETIC NOT PRINTED^FS" + new string(' ', 980) + "^XZ");
|
||||
|
||||
|
||||
|
||||
/// <summary>Run the bounded workload or fake-HTTP checks and always signal completion to the launcher.</summary>
|
||||
private static async Task<int> Main(string[] args)
|
||||
{
|
||||
if(args is ["--check-discovery"])
|
||||
{
|
||||
await DiscoveryChecks.RunAsync();
|
||||
return 0;
|
||||
}
|
||||
string folder = Path.GetFullPath(args[0]);
|
||||
string stage = "input";
|
||||
using var timeout = new CancellationTokenSource(TimeSpan.FromMinutes(18));
|
||||
List<Lane> lanes = [];
|
||||
long peak = 0;
|
||||
var timer = Stopwatch.StartNew();
|
||||
try
|
||||
{
|
||||
using var input = JsonDocument.Parse(await File.ReadAllTextAsync(Path.Combine(folder, "input.json")));
|
||||
stage = "native_login_and_channels";
|
||||
bool idle = input.RootElement.GetProperty("idle").GetBoolean();
|
||||
int perLane = input.RootElement.GetProperty("jobsPerLane").GetInt32();
|
||||
int total = perLane * 8;
|
||||
await OpenLanesAsync(input.RootElement, lanes, folder, perLane, timeout.Token);
|
||||
bool denied = await RejectForeignProofAsync(input.RootElement, timeout.Token);
|
||||
stage = "workload";
|
||||
peak = await RunLanesAsync(lanes, folder, total, timeout.Token);
|
||||
stage = "logout";
|
||||
foreach(Lane lane in lanes)
|
||||
{
|
||||
await lane.Client.SignOutAsync(timeout.Token);
|
||||
}
|
||||
await WriteSuccessAsync(folder, lanes, total, idle, denied, peak, timer.Elapsed.TotalSeconds);
|
||||
Console.WriteLine("PASS real Core/Java network lifecycles; fake printer only");
|
||||
return 0;
|
||||
}
|
||||
catch(Exception error)
|
||||
{
|
||||
await File.WriteAllTextAsync(Path.Combine(folder, "result.json"), JsonSerializer.Serialize(new
|
||||
{
|
||||
success = false,
|
||||
stage,
|
||||
error = error.GetType().Name,
|
||||
reason = error is InvalidDataException ? error.Message : null,
|
||||
completed = lanes.Sum(l => l.Printer.Count)
|
||||
}));
|
||||
Console.Error.WriteLine("FAIL " + stage + ": " + error.GetType().Name);
|
||||
return 1;
|
||||
}
|
||||
finally
|
||||
{
|
||||
foreach(Lane lane in lanes)
|
||||
{
|
||||
await lane.DisposeAsync();
|
||||
}
|
||||
await File.WriteAllTextAsync(Path.Combine(folder, "done"), "done");
|
||||
}
|
||||
internal static class Program {
|
||||
static int Completed; static readonly byte[] Expected=Encoding.ASCII.GetBytes("^XA^FO20,20^FDSYNTHETIC NOT PRINTED^FS"+new string(' ',980)+"^XZ");
|
||||
static async Task<int> Main(string[] args) {
|
||||
if(args is ["--check-discovery"]) { await DiscoveryChecks.RunAsync(); return 0; }
|
||||
string folder=Path.GetFullPath(args[0]); string stage="input";
|
||||
using var timeout=new CancellationTokenSource(TimeSpan.FromMinutes(18));
|
||||
List<Lane> lanes=[]; long peak=0; var timer=Stopwatch.StartNew();
|
||||
try {
|
||||
using JsonDocument input=JsonDocument.Parse(await File.ReadAllTextAsync(Path.Combine(folder,"input.json")));
|
||||
stage="native_login_and_channels";
|
||||
bool idle=input.RootElement.GetProperty("idle").GetBoolean(); int perLane=input.RootElement.GetProperty("jobsPerLane").GetInt32(); int total=perLane*8; int index=0;
|
||||
foreach(var value in input.RootElement.GetProperty("lanes").EnumerateArray()) {
|
||||
Uri origin=new(value.GetProperty("origin").GetString()!);
|
||||
Require(origin.IsLoopback && origin.Port is not (18081 or 18086),"disposable origin");
|
||||
var client=new QqqSessionClient(origin,allowLoopbackHttp:true);
|
||||
await WorkloadDiscovery.DiscoverRealtimeAsync(client,timeout.Token);
|
||||
await client.GetAuthenticationMetadataAsync(timeout.Token);
|
||||
await client.SignInWithPasswordAsync(value.GetProperty("username").GetString()!,value.GetProperty("password").GetString()!,timeout.Token);
|
||||
await client.BindDeviceAsync(new(value.GetProperty("deviceId").GetString()!,value.GetProperty("deviceToken").GetString()!),cancellationToken:timeout.Token);
|
||||
var binding=await client.GetSessionIdentityAsync(timeout.Token);
|
||||
Require(binding.TenantId==value.GetProperty("tenant").GetString(),"authoritative tenant");
|
||||
var connection=await Connection.Open(client,timeout.Token);
|
||||
lanes.Add(new(client,connection,Path.Combine(folder,"lane-"+index++),perLane,folder));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Authenticate and bind eight synthetic lanes before admitting fixture work.</summary>
|
||||
private static async Task OpenLanesAsync(JsonElement input, List<Lane> lanes, string folder, int perLane, CancellationToken token)
|
||||
{
|
||||
int index = 0;
|
||||
foreach(JsonElement value in input.GetProperty("lanes").EnumerateArray())
|
||||
{
|
||||
Uri origin = new(value.GetProperty("origin").GetString()!);
|
||||
Require(origin.IsLoopback && origin.Port is not (18081 or 18086), "disposable origin");
|
||||
var client = new QqqSessionClient(origin, allowLoopbackHttp: true);
|
||||
await WorkloadDiscovery.DiscoverRealtimeAsync(client, token);
|
||||
await client.GetAuthenticationMetadataAsync(token);
|
||||
await client.SignInWithPasswordAsync(value.GetProperty("username").GetString()!, value.GetProperty("password").GetString()!, token);
|
||||
await client.BindDeviceAsync(new(value.GetProperty("deviceId").GetString()!, value.GetProperty("deviceToken").GetString()!), cancellationToken: token);
|
||||
QqqSessionBinding binding = await client.GetSessionIdentityAsync(token);
|
||||
Require(string.Equals(binding.TenantId, value.GetProperty("tenant").GetString(), StringComparison.Ordinal), "authoritative tenant");
|
||||
Connection connection = await Connection.Open(client, token);
|
||||
lanes.Add(new(client, connection, Path.Combine(folder, "lane-" + index++), perLane, folder));
|
||||
}
|
||||
Require(lanes.Count == 8, "eight lanes");
|
||||
Require(lanes.Count==8,"eight lanes");
|
||||
// Authoritative native proof check: tenant A cannot bind a real tenant B device.
|
||||
var foreign=input.RootElement.GetProperty("lanes")[4]; bool denied=false;
|
||||
using(var outsider=new QqqSessionClient(new Uri(input.RootElement.GetProperty("lanes")[0].GetProperty("origin").GetString()!),allowLoopbackHttp:true)) {
|
||||
await outsider.DiscoverAsync(timeout.Token);await outsider.GetAuthenticationMetadataAsync(timeout.Token);
|
||||
await outsider.SignInWithPasswordAsync("operator",input.RootElement.GetProperty("lanes")[0].GetProperty("password").GetString()!,timeout.Token);
|
||||
try {await outsider.BindDeviceAsync(new(foreign.GetProperty("deviceId").GetString()!,foreign.GetProperty("deviceToken").GetString()!),cancellationToken:timeout.Token);}catch(QqqSessionException){denied=true;}
|
||||
Require(denied,"cross tenant proof refused");await outsider.SignOutAsync(timeout.Token);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Verify that authenticated tenant A cannot adopt tenant B's device proof.</summary>
|
||||
private static async Task<bool> RejectForeignProofAsync(JsonElement input, CancellationToken token)
|
||||
{
|
||||
// Authoritative native proof check: tenant A cannot bind a real tenant B device.
|
||||
JsonElement foreign = input.GetProperty("lanes")[4];
|
||||
bool denied = false;
|
||||
using(var outsider = new QqqSessionClient(new Uri(input.GetProperty("lanes")[0].GetProperty("origin").GetString()!), allowLoopbackHttp: true))
|
||||
{
|
||||
await outsider.DiscoverAsync(token);
|
||||
await outsider.GetAuthenticationMetadataAsync(token);
|
||||
await outsider.SignInWithPasswordAsync("operator", input.GetProperty("lanes")[0].GetProperty("password").GetString()!, token);
|
||||
try
|
||||
{
|
||||
await outsider.BindDeviceAsync(new(foreign.GetProperty("deviceId").GetString()!, foreign.GetProperty("deviceToken").GetString()!), cancellationToken: token);
|
||||
}
|
||||
catch(QqqSessionException) { denied = true; }
|
||||
Require(denied, "cross tenant proof refused");
|
||||
await outsider.SignOutAsync(token);
|
||||
}
|
||||
return denied;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Write only aggregate network, accounting, and fake-printer evidence.</summary>
|
||||
private static async Task WriteSuccessAsync(string folder, List<Lane> lanes, int total, bool idle, bool denied, long peak, double elapsedSeconds)
|
||||
{
|
||||
double[] latencies = lanes.SelectMany(l => l.Latencies).Order().ToArray();
|
||||
await File.WriteAllTextAsync(Path.Combine(folder, "result.json"), JsonSerializer.Serialize(new
|
||||
{
|
||||
success = true,
|
||||
jobs = total,
|
||||
idle,
|
||||
tenants = 2,
|
||||
devices = 8,
|
||||
elapsedSeconds = elapsedSeconds,
|
||||
jobsPerSecond = total / elapsedSeconds,
|
||||
peakClientWorkingSetBytes = peak,
|
||||
p50EnqueueToAckMillis = latencies[total / 2],
|
||||
p95EnqueueToAckMillis = latencies[(int)(total * 0.95)],
|
||||
p99EnqueueToAckMillis = latencies[(int)(total * 0.99)],
|
||||
realCoreWorker = true,
|
||||
fakePrinterBackend = true,
|
||||
fixtureJournal = true,
|
||||
serverReceiptsDurable = true,
|
||||
crossTenantProofRefused = denied,
|
||||
submissionReplays = idle ? 0 : 400,
|
||||
receiptReplays = idle ? 0 : 400,
|
||||
notificationToClaimMillis = lanes.SelectMany(l => l.ClaimLatency).ToArray(),
|
||||
notificationToDownloadCompletedMillis = lanes.SelectMany(l => l.DownloadLatency).ToArray(),
|
||||
periodicJobPolling = false,
|
||||
transport = "HTTP/WS loopback; no TLS qualification",
|
||||
realPrinterCalls = 0,
|
||||
runtime = Environment.Version.ToString(),
|
||||
coreVersion = typeof(PrintWorker).Assembly.GetName().Version?.ToString()
|
||||
}, s_reportOptions));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Drain only event-triggered work and measure the peak client working set.</summary>
|
||||
private static async Task<long> RunLanesAsync(List<Lane> lanes, string folder, int total, CancellationToken token)
|
||||
{
|
||||
long peak = 0;
|
||||
Task[] tasks = lanes.Select(lane => lane.Run(token)).ToArray();
|
||||
await File.WriteAllTextAsync(Path.Combine(folder, "ready"), "ready", token);
|
||||
var all = Task.WhenAll(tasks);
|
||||
while(!all.IsCompleted)
|
||||
{
|
||||
peak = Math.Max(peak, Process.GetCurrentProcess().WorkingSet64);
|
||||
await Task.WhenAny(all, Task.Delay(1000, token));
|
||||
token.ThrowIfCancellationRequested();
|
||||
}
|
||||
await all;
|
||||
Require(lanes.Sum(l => l.Printer.Count) == total, "exact fake submission count");
|
||||
Require(lanes.All(l => l.Journal.Pending().Count == 0), "no unacknowledged receipts");
|
||||
return peak;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Stop the fixture when an invariant fails, retaining a fixed diagnostic reason.</summary>
|
||||
private static void Require(bool ok, string reason)
|
||||
{
|
||||
if(!ok)
|
||||
{
|
||||
throw new InvalidDataException(reason);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Own one authenticated worker, its synthetic journal, and notification latency measurements.</summary>
|
||||
private sealed class Lane : IAsyncDisposable
|
||||
{
|
||||
public QqqSessionClient Client
|
||||
{
|
||||
get;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public Connection Connection
|
||||
{
|
||||
get;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public FakePrinter Printer { get; } = new();
|
||||
|
||||
|
||||
|
||||
public Journal Journal
|
||||
{
|
||||
get;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public List<double> Latencies { get; } = [];
|
||||
|
||||
|
||||
|
||||
private readonly PrintApiClient _api;
|
||||
|
||||
|
||||
|
||||
private readonly PrintWorker _worker;
|
||||
|
||||
|
||||
|
||||
private readonly int _target;
|
||||
|
||||
|
||||
|
||||
private readonly string _root;
|
||||
|
||||
|
||||
|
||||
private long _wakeAt;
|
||||
|
||||
|
||||
|
||||
public List<double> ClaimLatency { get; } = [];
|
||||
|
||||
|
||||
|
||||
public List<double> DownloadLatency { get; } = [];
|
||||
|
||||
|
||||
|
||||
/// <summary>Own one authenticated worker, its synthetic journal, and notification latency measurements.</summary>
|
||||
public Lane(QqqSessionClient client, Connection connection, string folder, int targetJobs, string rootDirectory)
|
||||
{
|
||||
Client = client;
|
||||
Connection = connection;
|
||||
_target = targetJobs;
|
||||
_root = rootDirectory;
|
||||
Printer.OnDownload = () => DownloadLatency.Add(Stopwatch.GetElapsedTime(_wakeAt).TotalMilliseconds);
|
||||
Directory.CreateDirectory(folder);
|
||||
Journal = new(folder);
|
||||
_api = PrintApiClient.ForSession(client).WithRealtime(connection.Channel, connection.Settings);
|
||||
_worker = new PrintWorker(_api, Printer, Journal, options: new PrintWorkerOptions
|
||||
{
|
||||
Settings = connection.Settings,
|
||||
StagingDirectory = Path.Combine(folder, "staging"),
|
||||
SynchronizeInventory = false,
|
||||
RecoverIncomplete = false,
|
||||
ActiveJobChanged = job =>
|
||||
{
|
||||
if(job is not null)
|
||||
{
|
||||
ClaimLatency.Add(Stopwatch.GetElapsedTime(_wakeAt).TotalMilliseconds);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Drain notified jobs and await durable receipts without periodic job polling.</summary>
|
||||
public async Task Run(CancellationToken token)
|
||||
{
|
||||
using var stop = CancellationTokenSource.CreateLinkedTokenSource(token);
|
||||
Task ping = Liveness(stop.Token);
|
||||
try
|
||||
{
|
||||
while(Printer.Count < _target)
|
||||
{
|
||||
_wakeAt = await Connection.Wakes.Reader.ReadAsync(token);
|
||||
while(Printer.Count < _target && await _worker.RunOnceAsync(token))
|
||||
{
|
||||
Require(string.Equals(Journal.Last.Event.Status, "SPOOLED", StringComparison.Ordinal), "synthetic job terminal status");
|
||||
Latencies.Add((DateTimeOffset.UtcNow - DateTimeOffset.Parse(Journal.LastJob!.CreatedAt, CultureInfo.InvariantCulture)).TotalMilliseconds);
|
||||
await File.WriteAllTextAsync(Path.Combine(_root, "completed-" + Interlocked.Increment(ref s_completed)), "acknowledged", token);
|
||||
if(Printer.Count % 25 == 0)
|
||||
{
|
||||
await _api.EventAsync(Journal.Last.JobId, Journal.Last.Event, token);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
finally
|
||||
{
|
||||
await stop.CancelAsync();
|
||||
try
|
||||
{
|
||||
await ping;
|
||||
}
|
||||
catch(OperationCanceledException)
|
||||
{
|
||||
// Cancellation ends only the owned liveness task.
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Send transport liveness frames without querying for jobs.</summary>
|
||||
private async Task Liveness(CancellationToken token)
|
||||
{
|
||||
using var tick = new PeriodicTimer(TimeSpan.FromSeconds(Connection.Settings.HeartbeatIntervalSeconds));
|
||||
while(await tick.WaitForNextTickAsync(token))
|
||||
{
|
||||
await Connection.Channel.SendAsync("PING", new
|
||||
{
|
||||
}, token: token);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Stop owned background work and dispose this fixture lane or channel.</summary>
|
||||
public async ValueTask DisposeAsync()
|
||||
{
|
||||
_api.Dispose();
|
||||
await Connection.DisposeAsync();
|
||||
Client.Dispose();
|
||||
Journal.Dispose();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Verify payload bytes and reject duplicate actions without calling a spooler.</summary>
|
||||
private sealed class FakePrinter : IFilePrinterBackend
|
||||
{
|
||||
private readonly HashSet<string> _seen = new(StringComparer.Ordinal);
|
||||
|
||||
|
||||
|
||||
public int Count => _seen.Count;
|
||||
|
||||
|
||||
|
||||
public Action? OnDownload
|
||||
{
|
||||
get; set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Expose only the fixed synthetic ZPL destination.</summary>
|
||||
public IReadOnlyList<PrinterInfo> Discover() => [new("synthetic", "No physical printer", "fixture", "none", "READY", ["ZPL"])];
|
||||
|
||||
|
||||
|
||||
/// <summary>Record download completion and validate the staged synthetic payload.</summary>
|
||||
public async Task<string> PrintFileAsync(PrintJob job, string path, CancellationToken token)
|
||||
{
|
||||
OnDownload?.Invoke();
|
||||
return await PrintAsync(job, await File.ReadAllBytesAsync(path, token), token);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Check exact bytes and allow each synthetic job to be submitted once.</summary>
|
||||
public Task<string> PrintAsync(PrintJob job, byte[] content, CancellationToken token)
|
||||
{
|
||||
Require(content.AsSpan().SequenceEqual(s_expected), "downloaded bytes exact");
|
||||
Require(_seen.Add(job.JobId), "no duplicate physical action");
|
||||
return Task.FromResult("synthetic-" + Count);
|
||||
}
|
||||
}
|
||||
// Fixture journal is deliberately separate from the installed Windows SQLite journal.
|
||||
|
||||
|
||||
|
||||
/// <summary>Track fixture-only receipt state separately from the installed SQLite journal.</summary>
|
||||
private sealed class Journal : IJobJournal, IDisposable
|
||||
{
|
||||
private readonly Dictionary<string, string> _states = new(StringComparer.Ordinal);
|
||||
|
||||
|
||||
|
||||
private readonly Dictionary<string, (string, PrintEvent)> _pending = new(StringComparer.Ordinal);
|
||||
|
||||
|
||||
|
||||
private readonly StreamWriter _log;
|
||||
|
||||
|
||||
|
||||
public PrintJob? LastJob
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public (string JobId, PrintEvent Event) Last
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Track fixture-only receipt state separately from the installed SQLite journal.</summary>
|
||||
public Journal(string folder)
|
||||
{
|
||||
_log = new StreamWriter(new FileStream(Path.Combine(folder, "synthetic-receipts.jsonl"), FileMode.CreateNew, FileAccess.Write, FileShare.Read)) { AutoFlush = true };
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Retain accepted job metadata for latency and status assertions.</summary>
|
||||
public void TrackJob(PrintJob job, string? printer)
|
||||
{
|
||||
LastJob = job;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Return the last recorded state for the synthetic job.</summary>
|
||||
public string? GetState(string id) => _states.GetValueOrDefault(id);
|
||||
|
||||
|
||||
|
||||
/// <summary>Flush a receipt before adding it to the pending set.</summary>
|
||||
public void Record(string id, PrintEvent evt)
|
||||
{
|
||||
_log.WriteLine(JsonSerializer.Serialize(new
|
||||
{
|
||||
jobId = id,
|
||||
@event = evt
|
||||
}));
|
||||
_states[id] = evt.Status;
|
||||
_pending.Add(evt.EventId, (id, evt));
|
||||
Last = (id, evt);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Snapshot unacknowledged synthetic receipts for the real worker.</summary>
|
||||
public IReadOnlyList<(string JobId, PrintEvent Event)> Pending() => _pending.Values.ToList();
|
||||
|
||||
|
||||
|
||||
/// <summary>Remove only the specifically acknowledged receipt.</summary>
|
||||
public void Acknowledge(string id)
|
||||
{
|
||||
_pending.Remove(id);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Declare no recovered jobs because each fixture journal starts fresh.</summary>
|
||||
public IReadOnlyList<(string JobId, string State)> Incomplete() => [];
|
||||
|
||||
|
||||
|
||||
/// <summary>Close the fixture receipt log.</summary>
|
||||
public void Dispose() => _log.Dispose();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Own the realtime reader, bounded notifications, and negotiated settings.</summary>
|
||||
private sealed class Connection : IAsyncDisposable
|
||||
{
|
||||
public required PrintingRealtimeChannel Channel
|
||||
{
|
||||
get; init;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public required Task Reader
|
||||
{
|
||||
get; init;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public required CancellationTokenSource Lifetime
|
||||
{
|
||||
get; init;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public required Channel<RealtimeEnvelope> Messages
|
||||
{
|
||||
get; init;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public required Channel<long> Wakes
|
||||
{
|
||||
get; init;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public RealtimeSettings Settings
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
} = new();
|
||||
|
||||
|
||||
|
||||
/// <summary>Open an authenticated channel and acknowledge its initial authoritative state.</summary>
|
||||
public static async Task<Connection> Open(QqqSessionClient client, CancellationToken token)
|
||||
{
|
||||
var lifetime = CancellationTokenSource.CreateLinkedTokenSource(token);
|
||||
WebSocket socket = await client.ConnectPrintingAsync(TimeSpan.FromSeconds(20), TimeSpan.FromSeconds(60), token);
|
||||
var channel = new PrintingRealtimeChannel(socket, new RealtimeSettings());
|
||||
var messages = System.Threading.Channels.Channel.CreateBounded<RealtimeEnvelope>(8);
|
||||
var wakes = System.Threading.Channels.Channel.CreateBounded<long>(new BoundedChannelOptions(1) { FullMode = BoundedChannelFullMode.DropWrite });
|
||||
Task reader = channel.RunAsync(e =>
|
||||
{
|
||||
if(string.Equals(e.Type, "JOB_AVAILABLE", StringComparison.Ordinal))
|
||||
{
|
||||
wakes.Writer.TryWrite(Stopwatch.GetTimestamp());
|
||||
return;
|
||||
}
|
||||
if(e.Type is "SETTINGS" or "DESIRED_STATE")
|
||||
{
|
||||
long revision = e.Payload.GetProperty("revision").GetInt64();
|
||||
if(revision != 0)
|
||||
{
|
||||
throw new InvalidDataException("Unexpected policy change");
|
||||
}
|
||||
return;
|
||||
}
|
||||
if(e.Type is "PONG" or "ACK")
|
||||
{
|
||||
return;
|
||||
}
|
||||
if(!messages.Writer.TryWrite(e))
|
||||
{
|
||||
throw new IOException("Fixture envelope inbox full");
|
||||
}
|
||||
}, lifetime.Token);
|
||||
_ = reader.ContinueWith(t => { wakes.Writer.TryComplete(t.Exception); messages.Writer.TryComplete(t.Exception); }, TaskScheduler.Default);
|
||||
var result = new Connection { Channel = channel, Reader = reader, Lifetime = lifetime, Messages = messages, Wakes = wakes };
|
||||
await channel.SendAsync("HELLO", new
|
||||
{
|
||||
agentVersion = PrintApiClient.AgentVersion,
|
||||
capabilities = s_capabilities,
|
||||
lastAppliedRevision = 0,
|
||||
lastSettingsRevision = 0,
|
||||
limits = RealtimeSettings.ClientLimits
|
||||
}, token: token);
|
||||
RealtimeEnvelope welcome = await messages.Reader.ReadAsync(token);
|
||||
Require(string.Equals(welcome.Type, "WELCOME", StringComparison.Ordinal), "welcome");
|
||||
result.Settings = welcome.Payload.GetProperty("settings").Deserialize<RealtimeSettings>(PrintApiClient.JsonOptions)!;
|
||||
result.Settings.Validate();
|
||||
channel.UpdateSettings(result.Settings);
|
||||
await channel.SendAsync("STATE_APPLIED", new
|
||||
{
|
||||
lastAppliedRevision = welcome.Payload.GetProperty("desiredState").GetProperty("revision").GetInt64(),
|
||||
lastSettingsRevision = result.Settings.Revision
|
||||
}, acknowledged: true, token: token);
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Stop owned background work and dispose this fixture lane or channel.</summary>
|
||||
public async ValueTask DisposeAsync()
|
||||
{
|
||||
await Lifetime.CancelAsync();
|
||||
try
|
||||
{
|
||||
await Reader;
|
||||
}
|
||||
catch(Exception e) when(e is OperationCanceledException or IOException or WebSocketException)
|
||||
{
|
||||
// Cancelling the owned reader normally ends it with one of these; disposal must still finish.
|
||||
}
|
||||
Channel.Dispose();
|
||||
Lifetime.Dispose();
|
||||
}
|
||||
stage="workload";
|
||||
var tasks=lanes.Select(lane=>lane.Run(timeout.Token)).ToArray();
|
||||
await File.WriteAllTextAsync(Path.Combine(folder,"ready"),"ready",timeout.Token);
|
||||
Task all=Task.WhenAll(tasks);
|
||||
while(!all.IsCompleted) {
|
||||
peak=Math.Max(peak,Process.GetCurrentProcess().WorkingSet64);
|
||||
await Task.WhenAny(all,Task.Delay(1000,timeout.Token));timeout.Token.ThrowIfCancellationRequested();
|
||||
}
|
||||
await all;
|
||||
Require(lanes.Sum(l=>l.Printer.Count)==total,"exact fake submission count");
|
||||
Require(lanes.All(l=>l.Journal.Pending().Count==0),"no unacknowledged receipts");
|
||||
stage="logout";foreach(var lane in lanes)await lane.Client.SignOutAsync(timeout.Token);
|
||||
double[] latencies=lanes.SelectMany(l=>l.Latencies).Order().ToArray();
|
||||
await File.WriteAllTextAsync(Path.Combine(folder,"result.json"),JsonSerializer.Serialize(new {
|
||||
success=true,jobs=total,idle,tenants=2,devices=8,elapsedSeconds=timer.Elapsed.TotalSeconds,jobsPerSecond=total/timer.Elapsed.TotalSeconds,
|
||||
peakClientWorkingSetBytes=peak,p50EnqueueToAckMillis=latencies[total/2],p95EnqueueToAckMillis=latencies[(int)(total*0.95)],p99EnqueueToAckMillis=latencies[(int)(total*0.99)],
|
||||
realCoreWorker=true,fakePrinterBackend=true,fixtureJournal=true,serverReceiptsDurable=true,crossTenantProofRefused=denied,
|
||||
submissionReplays=idle?0:400,receiptReplays=idle?0:400,notificationToClaimMillis=lanes.SelectMany(l=>l.ClaimLatency).ToArray(),notificationToDownloadCompletedMillis=lanes.SelectMany(l=>l.DownloadLatency).ToArray(),periodicJobPolling=false,transport="HTTP/WS loopback; no TLS qualification",realPrinterCalls=0,
|
||||
runtime=Environment.Version.ToString(),coreVersion=typeof(PrintWorker).Assembly.GetName().Version?.ToString()
|
||||
},new JsonSerializerOptions{WriteIndented=true}));
|
||||
Console.WriteLine("PASS real Core/Java network lifecycles; fake printer only");return 0;
|
||||
} catch(Exception error) {
|
||||
await File.WriteAllTextAsync(Path.Combine(folder,"result.json"),JsonSerializer.Serialize(new{success=false,stage,error=error.GetType().Name,reason=error is InvalidDataException?error.Message:null,completed=lanes.Sum(l=>l.Printer.Count)}));
|
||||
Console.Error.WriteLine("FAIL "+stage+": "+error.GetType().Name);return 1;
|
||||
} finally {
|
||||
foreach(var lane in lanes)await lane.DisposeAsync();
|
||||
await File.WriteAllTextAsync(Path.Combine(folder,"done"),"done");
|
||||
}
|
||||
}
|
||||
static void Require(bool ok,string reason){if(!ok)throw new InvalidDataException(reason);}
|
||||
sealed class Lane: IAsyncDisposable {
|
||||
public QqqSessionClient Client{get;} public Connection Connection{get;}
|
||||
public FakePrinter Printer{get;}=new(); public Journal Journal{get;} public List<double> Latencies{get;}=[];
|
||||
readonly PrintApiClient api;readonly PrintWorker worker; readonly int target; readonly string root; long wakeAt; public List<double> ClaimLatency{get;}=[]; public List<double> DownloadLatency{get;}=[];
|
||||
public Lane(QqqSessionClient client,Connection connection,string folder,int target,string root) {
|
||||
Client=client;Connection=connection;this.target=target;this.root=root;Printer.OnDownload=()=>DownloadLatency.Add(Stopwatch.GetElapsedTime(wakeAt).TotalMilliseconds);Directory.CreateDirectory(folder);Journal=new(folder);
|
||||
api=PrintApiClient.ForSession(client).WithRealtime(connection.Channel,connection.Settings);
|
||||
worker=new PrintWorker(api,Printer,Journal,options:new PrintWorkerOptions{Settings=connection.Settings,StagingDirectory=Path.Combine(folder,"staging"),SynchronizeInventory=false,RecoverIncomplete=false,ActiveJobChanged=job=>{if(job is not null)ClaimLatency.Add(Stopwatch.GetElapsedTime(wakeAt).TotalMilliseconds);}});
|
||||
}
|
||||
public async Task Run(CancellationToken token) {
|
||||
using var stop=CancellationTokenSource.CreateLinkedTokenSource(token);
|
||||
Task ping=Liveness(stop.Token);
|
||||
try {
|
||||
while(Printer.Count<target) {
|
||||
wakeAt=await Connection.Wakes.Reader.ReadAsync(token);
|
||||
while(Printer.Count<target && await worker.RunOnceAsync(token)) {
|
||||
Require(Journal.Last.Event.Status=="SPOOLED","synthetic job terminal status");
|
||||
Latencies.Add((DateTimeOffset.UtcNow-DateTimeOffset.Parse(Journal.LastJob!.CreatedAt,CultureInfo.InvariantCulture)).TotalMilliseconds);
|
||||
await File.WriteAllTextAsync(Path.Combine(root,"completed-"+Interlocked.Increment(ref Completed)),"acknowledged",token);
|
||||
if(Printer.Count%25==0)await api.EventAsync(Journal.Last.JobId,Journal.Last.Event,token);
|
||||
}
|
||||
}
|
||||
} finally {await stop.CancelAsync();try{await ping;}catch(OperationCanceledException){}}
|
||||
}
|
||||
async Task Liveness(CancellationToken token) {
|
||||
using var tick=new PeriodicTimer(TimeSpan.FromSeconds(Connection.Settings.HeartbeatIntervalSeconds));
|
||||
while(await tick.WaitForNextTickAsync(token))await Connection.Channel.SendAsync("PING",new{},token:token);
|
||||
}
|
||||
public async ValueTask DisposeAsync(){api.Dispose();await Connection.DisposeAsync();Client.Dispose();Journal.Dispose();}
|
||||
}
|
||||
sealed class FakePrinter:IFilePrinterBackend {
|
||||
readonly HashSet<string> seen=new(StringComparer.Ordinal);public int Count=>seen.Count; public Action? OnDownload{get;set;}
|
||||
public IReadOnlyList<PrinterInfo> Discover()=>[new("synthetic","No physical printer","fixture","none","READY",["ZPL"])];
|
||||
public async Task<string> PrintFileAsync(PrintJob job,string path,CancellationToken token) {OnDownload?.Invoke();return await PrintAsync(job,await File.ReadAllBytesAsync(path,token),token);}
|
||||
public Task<string> PrintAsync(PrintJob job,byte[] content,CancellationToken token) {
|
||||
Require(content.AsSpan().SequenceEqual(Expected),"downloaded bytes exact");Require(seen.Add(job.JobId),"no duplicate physical action");return Task.FromResult("synthetic-"+Count);
|
||||
}
|
||||
}
|
||||
// Fixture journal is deliberately separate from the installed Windows SQLite journal.
|
||||
sealed class Journal: IJobJournal,IDisposable {
|
||||
readonly Dictionary<string,string> states=new(StringComparer.Ordinal);readonly Dictionary<string,(string,PrintEvent)> pending=new(StringComparer.Ordinal);readonly StreamWriter log;
|
||||
public PrintJob? LastJob{get;private set;}public (string JobId,PrintEvent Event) Last{get;private set;}
|
||||
public Journal(string folder){log=new StreamWriter(new FileStream(Path.Combine(folder,"synthetic-receipts.jsonl"),FileMode.CreateNew,FileAccess.Write,FileShare.Read)){AutoFlush=true};}
|
||||
public void TrackJob(PrintJob job,string? printer){LastJob=job;}
|
||||
public string? GetState(string id)=>states.GetValueOrDefault(id);
|
||||
public void Record(string id,PrintEvent evt){log.WriteLine(JsonSerializer.Serialize(new{jobId=id,@event=evt}));states[id]=evt.Status;pending.Add(evt.EventId,(id,evt));Last=(id,evt);}
|
||||
public IReadOnlyList<(string JobId,PrintEvent Event)> Pending()=>pending.Values.ToList();
|
||||
public void Acknowledge(string id){pending.Remove(id);}
|
||||
public IReadOnlyList<(string JobId,string State)> Incomplete()=>[];
|
||||
public void Dispose()=>log.Dispose();
|
||||
}
|
||||
sealed class Connection:IAsyncDisposable {
|
||||
public required PrintingRealtimeChannel Channel{get;init;}public required Task Reader{get;init;}public required CancellationTokenSource Lifetime{get;init;}
|
||||
public required Channel<RealtimeEnvelope> Messages{get;init;}public required Channel<long> Wakes{get;init;}public RealtimeSettings Settings{get;private set;}=new();
|
||||
public static async Task<Connection> Open(QqqSessionClient client,CancellationToken token) {
|
||||
var lifetime=CancellationTokenSource.CreateLinkedTokenSource(token);WebSocket socket=await client.ConnectPrintingAsync(TimeSpan.FromSeconds(20),TimeSpan.FromSeconds(60),token);
|
||||
var channel=new PrintingRealtimeChannel(socket,new RealtimeSettings());var messages=System.Threading.Channels.Channel.CreateBounded<RealtimeEnvelope>(8);
|
||||
var wakes=System.Threading.Channels.Channel.CreateBounded<long>(new BoundedChannelOptions(1){FullMode=BoundedChannelFullMode.DropWrite});
|
||||
Task reader=channel.RunAsync(e=>{
|
||||
if(e.Type=="JOB_AVAILABLE"){wakes.Writer.TryWrite(Stopwatch.GetTimestamp());return;}
|
||||
if(e.Type is "SETTINGS" or "DESIRED_STATE") {long revision=e.Payload.GetProperty("revision").GetInt64();if(revision!=0)throw new InvalidDataException("Unexpected policy change");return;}
|
||||
if(e.Type is "PONG" or "ACK")return;
|
||||
if(!messages.Writer.TryWrite(e))throw new IOException("Fixture envelope inbox full");
|
||||
},lifetime.Token);
|
||||
_=reader.ContinueWith(t=>{wakes.Writer.TryComplete(t.Exception);messages.Writer.TryComplete(t.Exception);},TaskScheduler.Default);
|
||||
var result=new Connection{Channel=channel,Reader=reader,Lifetime=lifetime,Messages=messages,Wakes=wakes};
|
||||
await channel.SendAsync("HELLO",new{agentVersion=PrintApiClient.AgentVersion,capabilities=new[]{"realtime-v1","REFRESH_INVENTORY","CANCEL_SPOOL"},lastAppliedRevision=0,lastSettingsRevision=0,limits=RealtimeSettings.ClientLimits},token:token);
|
||||
RealtimeEnvelope welcome=await messages.Reader.ReadAsync(token);Require(welcome.Type=="WELCOME","welcome");
|
||||
result.Settings=welcome.Payload.GetProperty("settings").Deserialize<RealtimeSettings>(PrintApiClient.JsonOptions)!;result.Settings.Validate();channel.UpdateSettings(result.Settings);
|
||||
await channel.SendAsync("STATE_APPLIED",new{lastAppliedRevision=welcome.Payload.GetProperty("desiredState").GetProperty("revision").GetInt64(),lastSettingsRevision=result.Settings.Revision},acknowledged:true,token:token);return result;
|
||||
}
|
||||
public async ValueTask DisposeAsync(){await Lifetime.CancelAsync();try{await Reader;}catch(Exception e)when(e is OperationCanceledException or IOException or WebSocketException){}Channel.Dispose();Lifetime.Dispose();}
|
||||
}
|
||||
}
|
||||
@@ -2,14 +2,14 @@
|
||||
Copyright 2026 Kingsrook, LLC
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFramework>net10.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<Reference Include="Qqq.PrintAgent.Core">
|
||||
<HintPath>$(CoreAssemblyPath)</HintPath>
|
||||
</Reference>
|
||||
</ItemGroup>
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType><TargetFramework>net10.0</TargetFramework>
|
||||
<ImplicitUsings>enable</ImplicitUsings><Nullable>enable</Nullable>
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<Reference Include="Qqq.PrintAgent.Core"><HintPath>/core/Qqq.PrintAgent.Core.dll</HintPath></Reference>
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -1,14 +1,10 @@
|
||||
// Copyright 2026 Kingsrook, LLC
|
||||
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
using Qqq.PrintAgent.Core.Authentication;
|
||||
namespace Printing.Development;
|
||||
|
||||
|
||||
|
||||
/// <summary>Applies production Core discovery rules before any fixture credentials are sent.</summary>
|
||||
internal static class WorkloadDiscovery
|
||||
{
|
||||
/// <summary>Require a compatible realtime extension after strict production discovery validation.</summary>
|
||||
internal static async Task<QqqApiDiscovery> DiscoverRealtimeAsync(QqqSessionClient client, CancellationToken cancellationToken)
|
||||
{
|
||||
QqqApiDiscovery discovery = await client.DiscoverAsync(cancellationToken);
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"version": 2,
|
||||
"dependencies": {
|
||||
"net10.0": {
|
||||
"Meziantou.Analyzer": {
|
||||
"type": "Direct",
|
||||
"requested": "[3.0.296, )",
|
||||
"resolved": "3.0.296",
|
||||
"contentHash": "1Yp/6OK/Ev66hE2YLe9UvIgtJrKOX/xvoGDe0UbdtuG2ZxUoDoyONdEn+HWCDuy02Mu8SmglHEd/9SGPrM1qYg=="
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"sdk": {
|
||||
"version": "10.0.403",
|
||||
"rollForward": "latestPatch"
|
||||
}
|
||||
}
|
||||
+12
-41
@@ -19,11 +19,8 @@
|
||||
*/
|
||||
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package com.kingsrook.qbits.printing;
|
||||
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URI;
|
||||
import java.net.http.HttpClient;
|
||||
import java.net.http.HttpRequest;
|
||||
@@ -44,30 +41,17 @@ import software.amazon.awssdk.services.s3.model.CreateBucketRequest;
|
||||
import software.amazon.awssdk.services.s3.model.HeadBucketRequest;
|
||||
import software.amazon.awssdk.services.s3.model.S3Exception;
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Docker-only developer host. Compose publishes its port to host loopback only.
|
||||
***************************************************************************/
|
||||
/** Docker-only developer host. Compose publishes its port to host loopback only. */
|
||||
public final class DevHost extends PrintingLocalHost
|
||||
{
|
||||
private static final String TABLE = "printing_documents";
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Configure the isolated developer database and synthetic account from its private environment.
|
||||
***************************************************************************/
|
||||
private DevHost() throws Exception
|
||||
{
|
||||
super(new PrintingLocalSettings("jdbc:h2:file:/data/printing", "sa", required("QQQ_DATABASE_PASSWORD"), "development",
|
||||
Integer.parseInt(required("QQQ_HTTP_PORT")), required("QQQ_MANAGEMENT_TOKEN"), "developer", required("QQQ_ADMIN_PASSWORD")));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Wait for owned storage and launch the loopback-published developer host.
|
||||
***************************************************************************/
|
||||
public static void main(String[] args) throws Exception
|
||||
{
|
||||
waitStorage();
|
||||
@@ -89,11 +73,6 @@ public final class DevHost extends PrintingLocalHost
|
||||
}));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Add the isolated MinIO-backed document table and make sure its bucket exists.
|
||||
***************************************************************************/
|
||||
@Override
|
||||
public QInstance defineQInstance() throws QException
|
||||
{
|
||||
@@ -108,17 +87,19 @@ public final class DevHost extends PrintingLocalHost
|
||||
.withBackendDetails(new S3TableBackendDetails().withCardinality(Cardinality.ONE).withFileNameFieldName("id").withContentsFieldName("content"))
|
||||
.withPrimaryKeyField("id").withField(new QFieldMetaData("id", QFieldType.STRING)).withField(new QFieldMetaData("content", QFieldType.BLOB)));
|
||||
var storage = S3ClientFactory.getClient(backend);
|
||||
try
|
||||
{
|
||||
storage.headBucket(HeadBucketRequest.builder().bucket("printing-development").build());
|
||||
}
|
||||
catch(S3Exception missing)
|
||||
{
|
||||
if(missing.statusCode() != 404)
|
||||
try
|
||||
{
|
||||
throw missing;
|
||||
storage.headBucket(HeadBucketRequest.builder().bucket("printing-development").build());
|
||||
}
|
||||
catch(S3Exception missing)
|
||||
{
|
||||
if(missing.statusCode() != 404)
|
||||
{
|
||||
throw missing;
|
||||
}
|
||||
storage.createBucket(CreateBucketRequest.builder().bucket("printing-development").build());
|
||||
}
|
||||
storage.createBucket(CreateBucketRequest.builder().bucket("printing-development").build());
|
||||
}
|
||||
PrintingQBitConfig config = instance.getQBits().values().stream().map(value -> value.getConfig())
|
||||
.filter(PrintingQBitConfig.class::isInstance).map(PrintingQBitConfig.class::cast).findFirst().orElseThrow();
|
||||
@@ -127,11 +108,6 @@ public final class DevHost extends PrintingLocalHost
|
||||
return instance;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Bound startup retries to the owned MinIO health endpoint.
|
||||
***************************************************************************/
|
||||
private static void waitStorage() throws Exception
|
||||
{
|
||||
try(HttpClient client = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(2)).build())
|
||||
@@ -147,7 +123,7 @@ public final class DevHost extends PrintingLocalHost
|
||||
return;
|
||||
}
|
||||
}
|
||||
catch(IOException notReady)
|
||||
catch(java.io.IOException notReady)
|
||||
{
|
||||
// Only the fixture startup window retries; application work is never retried here.
|
||||
}
|
||||
@@ -157,11 +133,6 @@ public final class DevHost extends PrintingLocalHost
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Read a required fixture setting without exposing its value.
|
||||
***************************************************************************/
|
||||
private static String required(String name)
|
||||
{
|
||||
String value = System.getenv(name);
|
||||
|
||||
@@ -19,423 +19,202 @@
|
||||
*/
|
||||
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.security.MessageDigest;
|
||||
import java.time.Instant;
|
||||
import java.util.Arrays;
|
||||
import java.util.Base64;
|
||||
import java.util.HashMap;
|
||||
import java.util.HexFormat;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
import com.kingsrook.qbits.printing.DriverDataSource;
|
||||
import com.kingsrook.qbits.printing.PrintingException;
|
||||
import com.kingsrook.qbits.printing.PrintingService;
|
||||
import com.kingsrook.qbits.printing.PrintingTestDocuments;
|
||||
import com.kingsrook.qbits.printing.*;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.*;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.authentication.QAuthenticationMetaData;
|
||||
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.fields.*;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.kingsrook.qqq.backend.module.filesystem.s3.model.metadata.*;
|
||||
import com.kingsrook.qqq.backend.module.filesystem.base.model.metadata.Cardinality;
|
||||
import com.kingsrook.qqq.backend.module.filesystem.s3.model.metadata.S3BackendMetaData;
|
||||
import com.kingsrook.qqq.backend.module.filesystem.s3.model.metadata.S3TableBackendDetails;
|
||||
import com.kingsrook.qqq.backend.module.filesystem.s3.utils.S3ClientFactory;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONObject;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.*;
|
||||
import java.security.MessageDigest;
|
||||
import java.sql.*;
|
||||
import java.time.Instant;
|
||||
import java.util.*;
|
||||
import org.json.*;
|
||||
import software.amazon.awssdk.core.sync.RequestBody;
|
||||
import software.amazon.awssdk.services.s3.S3Client;
|
||||
import software.amazon.awssdk.services.s3.model.CreateBucketRequest;
|
||||
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
|
||||
import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
|
||||
import software.amazon.awssdk.services.s3.model.HeadObjectResponse;
|
||||
import software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest;
|
||||
import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
|
||||
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
|
||||
import software.amazon.awssdk.services.s3.model.S3Exception;
|
||||
import software.amazon.awssdk.services.s3.model.S3Object;
|
||||
import software.amazon.awssdk.services.s3.model.*;
|
||||
|
||||
/** Non-listening synthetic harness. Never routes work to a Windows device. */
|
||||
public final class S3PrintingQualification {
|
||||
private static final String TABLE = "printing_documents";
|
||||
private static final JSONArray CHECKS = new JSONArray();
|
||||
private static final JSONArray DOCUMENTS = new JSONArray();
|
||||
private static final Map<String, String> OBJECT_KEYS = new HashMap<>();
|
||||
private static DriverDataSource database;
|
||||
private static S3Client s3;
|
||||
private static String bucket;
|
||||
private static String otherBucket;
|
||||
|
||||
/***************************************************************************
|
||||
** Non-listening synthetic harness. Never routes work to a Windows device.
|
||||
***************************************************************************/
|
||||
public final class S3PrintingQualification
|
||||
{
|
||||
private static final String TABLE = "printing_documents";
|
||||
private static final JSONArray CHECKS = new JSONArray();
|
||||
private static final JSONArray DOCUMENTS = new JSONArray();
|
||||
private static final Map<String, String> OBJECT_KEYS = new HashMap<>();
|
||||
private static DriverDataSource database;
|
||||
private static S3Client s3;
|
||||
private static String bucket;
|
||||
private static String otherBucket;
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Exercise real storage operations against dedicated synthetic buckets without dispatching to a printer.
|
||||
***************************************************************************/
|
||||
public static void main(String[] args) throws Exception
|
||||
{
|
||||
Path output = Path.of(args[0]).toAbsolutePath();
|
||||
Files.createDirectories(output);
|
||||
String run = args[2];
|
||||
bucket = "printing-fixture-" + run;
|
||||
otherBucket = "printing-canary-" + run;
|
||||
S3BackendMetaData backend = new S3BackendMetaData().withName("printing_s3_" + run)
|
||||
.withBucketName(bucket).withEndpoint(args[1]).withPathStyleAccess(true).withRegion("us-east-1")
|
||||
.withAccessKey(System.getenv("MINIO_ROOT_USER")).withSecretKey(System.getenv("MINIO_ROOT_PASSWORD"));
|
||||
backend.setConnectTimeoutMillis(3000);
|
||||
backend.setSocketTimeoutMillis(15000);
|
||||
QInstance instance = new QInstance();
|
||||
// Required metadata only: this harness opens no HTTP endpoint or user session.
|
||||
instance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("fixture").withType(QAuthenticationType.MOCK));
|
||||
instance.addBackend(backend);
|
||||
instance.addTable(new QTableMetaData().withName(TABLE).withBackendName(backend.getName())
|
||||
.withBackendDetails(new S3TableBackendDetails().withCardinality(Cardinality.ONE)
|
||||
.withFileNameFieldName("id").withContentsFieldName("content")).withPrimaryKeyField("id")
|
||||
.withField(new QFieldMetaData("id", QFieldType.STRING)).withField(new QFieldMetaData("content", QFieldType.BLOB)));
|
||||
database = new DriverDataSource("jdbc:h2:file:" + output.resolve("synthetic-data").toString().replace('\\', '/'), "sa", "");
|
||||
try
|
||||
{
|
||||
s3 = S3ClientFactory.getClient(backend);
|
||||
s3.createBucket(CreateBucketRequest.builder().bucket(bucket).build());
|
||||
s3.createBucket(CreateBucketRequest.builder().bucket(otherBucket).build());
|
||||
s3.putObject(PutObjectRequest.builder().bucket(bucket).key("unrelated/canary.txt").build(), RequestBody.fromString("synthetic unrelated object"));
|
||||
s3.putObject(PutObjectRequest.builder().bucket(otherBucket).key("canary.txt").build(), RequestBody.fromString("synthetic separate bucket"));
|
||||
PrintingService a = service(instance, "fixture-tenant-a");
|
||||
PrintingService b = service(instance, "fixture-tenant-b");
|
||||
String deviceA = enroll(a);
|
||||
String deviceB = enroll(b);
|
||||
byte[] pdf = PrintingTestDocuments.pdf();
|
||||
byte[] zpl = "^XA^FO20,20^ADN,30,18^FDSYNTHETIC STORAGE TEST ONLY^FS^XZ".getBytes(StandardCharsets.US_ASCII);
|
||||
byte[] large = new byte[6 * 1024 * 1024 + 71];
|
||||
Arrays.fill(large, (byte) 'A');
|
||||
System.arraycopy("^XA^FX".getBytes(StandardCharsets.US_ASCII), 0, large, 0, 6);
|
||||
System.arraycopy("^FS^XZ".getBytes(StandardCharsets.US_ASCII), 0, large, large.length - 6, 6);
|
||||
String pdfJob = submitCheck(a, deviceA, "small-pdf", "PDF", pdf, false);
|
||||
finish(a, deviceA, pdfJob, "SPOOLED");
|
||||
String zplJob = submitCheck(a, deviceA, "small-zpl", "ZPL", zpl, false);
|
||||
finish(a, deviceA, zplJob, "SPOOLED");
|
||||
String largeJob = submitCheck(a, deviceA, "multipart-zpl", "ZPL", large, true);
|
||||
finish(a, deviceA, largeJob, "SPOOLED");
|
||||
String foreignJob = submitCheck(b, deviceB, "foreign-zpl", "ZPL", zpl, false);
|
||||
finish(b, deviceB, foreignJob, "SPOOLED");
|
||||
String foreignRef = reference(foreignJob);
|
||||
String ownRef = reference(pdfJob);
|
||||
check(!ownRef.split("/")[1].equals(foreignRef.split("/")[1]), "tenant prefixes differ");
|
||||
expectStatus(404, () -> a.content(deviceA, foreignJob), "foreign tenant job download denied");
|
||||
expectStatus(404, () -> a.content(deviceB, foreignJob), "foreign tenant device rejected");
|
||||
execute("UPDATE printing_job SET content_reference=? WHERE id=?", foreignRef, pdfJob);
|
||||
expectStatus(409, () -> a.content(deviceA, pdfJob), "foreign stored reference rejected");
|
||||
execute("UPDATE printing_job SET content_reference=? WHERE id=?", ownRef, pdfJob);
|
||||
check(Arrays.equals(zpl, b.content(deviceB, foreignJob)), "foreign object unchanged after rejection");
|
||||
String failed = submitCheck(a, deviceA, "protected-failed", "ZPL", zpl, false);
|
||||
finish(a, deviceA, failed, "FAILED");
|
||||
String unknown = submitCheck(a, deviceA, "protected-unknown", "ZPL", zpl, false);
|
||||
finish(a, deviceA, unknown, "OUTCOME_UNKNOWN");
|
||||
String active = a.submit(request(deviceA, "protected-queued", "ZPL", zpl)).getString("jobId");
|
||||
String old = Instant.now().minusSeconds(400L * 86400).toString();
|
||||
for(String id : List.of(pdfJob, largeJob, foreignJob, failed, unknown, active))
|
||||
{
|
||||
execute("UPDATE printing_job SET created_at=?,completed_at=? WHERE id=?", old, old, id);
|
||||
}
|
||||
int before = objectCount();
|
||||
check(a.runRetention() == 2, "tenant A retention removes exactly two aged successful documents");
|
||||
check(objectCount() == before - 2, "object count reflects exact two removals");
|
||||
missing(OBJECT_KEYS.get(ownRef));
|
||||
missing(OBJECT_KEYS.get(reference(largeJob)));
|
||||
expectStatus(410, () -> a.content(deviceA, pdfJob), "expired document returns 410");
|
||||
check(a.submit(request(deviceA, "small-pdf", "PDF", pdf)).getString("jobId").equals(pdfJob), "idempotent replay survives retention without reupload");
|
||||
check(objectCount() == before - 2, "post-retention replay creates no object");
|
||||
for(String id : List.of(zplJob, foreignJob, failed, unknown, active))
|
||||
{
|
||||
check(s3.headObject(HeadObjectRequest.builder().bucket(bucket).key(objectKey(reference(id))).build()).contentLength() == zpl.length,
|
||||
"protected object retained: " + status(id));
|
||||
}
|
||||
check(s3.getObjectAsBytes(GetObjectRequest.builder().bucket(bucket).key("unrelated/canary.txt").build()).asUtf8String().equals("synthetic unrelated object"), "unrelated same-bucket canary preserved");
|
||||
check(s3.getObjectAsBytes(GetObjectRequest.builder().bucket(otherBucket).key("canary.txt").build()).asUtf8String().equals("synthetic separate bucket"), "separate bucket canary preserved");
|
||||
check(a.runRetention() == 0, "repeated cleanup is idempotent");
|
||||
check(b.runRetention() == 1, "tenant B cleanup independently removes its one eligible document");
|
||||
check(s3.listMultipartUploads(ListMultipartUploadsRequest.builder().bucket(bucket).build()).uploads().isEmpty(), "no incomplete multipart uploads remain");
|
||||
check(QContext.getQSession() == null, "storage restores original absent QQQ session");
|
||||
JSONObject result = new JSONObject().put("passed", true).put("timestamp", Instant.now().toString())
|
||||
.put("checks", CHECKS).put("documents", DOCUMENTS).put("runtimeJarCount", 204)
|
||||
.put("appRevision", System.getenv("PRINTING_SOURCE_COMMIT"))
|
||||
.put("h2Version", org.h2.engine.Constants.VERSION).put("retentionDays", a.getRetentionSettings().getInt("days"))
|
||||
.put("transport", "loopback HTTP S3-compatible only").put("hardwarePrinting", false)
|
||||
.put("qualifies", "QQQ StorageAction / AWS SDK v2 S3 data-plane behavior against disposable MinIO")
|
||||
.put("doesNotQualify", new JSONArray(List.of("AWS IAM", "remote TLS", "production bucket ownership", "Object Lock/version lifecycle", "remote deployment", "hardware printing")));
|
||||
Files.writeString(output.resolve("results.json"), result.toString(2) + "\n");
|
||||
System.out.println("PASS " + CHECKS.length() + " checks; " + DOCUMENTS.length() + " synthetic document round trips");
|
||||
public static void main(String[] args) throws Exception {
|
||||
Path output = Path.of(args[0]).toAbsolutePath();
|
||||
Files.createDirectories(output);
|
||||
String run = args[2];
|
||||
bucket = "printing-fixture-" + run;
|
||||
otherBucket = "printing-canary-" + run;
|
||||
S3BackendMetaData backend = new S3BackendMetaData().withName("printing_s3_" + run)
|
||||
.withBucketName(bucket).withEndpoint(args[1]).withPathStyleAccess(true).withRegion("us-east-1")
|
||||
.withAccessKey(System.getenv("MINIO_ROOT_USER")).withSecretKey(System.getenv("MINIO_ROOT_PASSWORD"));
|
||||
backend.setConnectTimeoutMillis(3000);
|
||||
backend.setSocketTimeoutMillis(15000);
|
||||
QInstance instance = new QInstance();
|
||||
// Required metadata only: this harness opens no HTTP endpoint or user session.
|
||||
instance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("fixture").withType(QAuthenticationType.MOCK));
|
||||
instance.addBackend(backend);
|
||||
instance.addTable(new QTableMetaData().withName(TABLE).withBackendName(backend.getName())
|
||||
.withBackendDetails(new S3TableBackendDetails().withCardinality(Cardinality.ONE)
|
||||
.withFileNameFieldName("id").withContentsFieldName("content")).withPrimaryKeyField("id")
|
||||
.withField(new QFieldMetaData("id", QFieldType.STRING)).withField(new QFieldMetaData("content", QFieldType.BLOB)));
|
||||
database = new DriverDataSource("jdbc:h2:file:" + output.resolve("synthetic-data").toString().replace('\\', '/'), "sa", "");
|
||||
try {
|
||||
s3 = S3ClientFactory.getClient(backend);
|
||||
s3.createBucket(CreateBucketRequest.builder().bucket(bucket).build());
|
||||
s3.createBucket(CreateBucketRequest.builder().bucket(otherBucket).build());
|
||||
s3.putObject(PutObjectRequest.builder().bucket(bucket).key("unrelated/canary.txt").build(), RequestBody.fromString("synthetic unrelated object"));
|
||||
s3.putObject(PutObjectRequest.builder().bucket(otherBucket).key("canary.txt").build(), RequestBody.fromString("synthetic separate bucket"));
|
||||
PrintingService a = service(instance, "fixture-tenant-a");
|
||||
PrintingService b = service(instance, "fixture-tenant-b");
|
||||
String deviceA = enroll(a);
|
||||
String deviceB = enroll(b);
|
||||
byte[] pdf = PrintingTestDocuments.pdf();
|
||||
byte[] zpl = "^XA^FO20,20^ADN,30,18^FDSYNTHETIC STORAGE TEST ONLY^FS^XZ".getBytes(StandardCharsets.US_ASCII);
|
||||
byte[] large = new byte[6 * 1024 * 1024 + 71];
|
||||
Arrays.fill(large, (byte)'A');
|
||||
System.arraycopy("^XA^FX".getBytes(StandardCharsets.US_ASCII), 0, large, 0, 6);
|
||||
System.arraycopy("^FS^XZ".getBytes(StandardCharsets.US_ASCII), 0, large, large.length - 6, 6);
|
||||
String pdfJob = submitCheck(a, deviceA, "small-pdf", "PDF", pdf, false);
|
||||
finish(a, deviceA, pdfJob, "SPOOLED");
|
||||
String zplJob = submitCheck(a, deviceA, "small-zpl", "ZPL", zpl, false);
|
||||
finish(a, deviceA, zplJob, "SPOOLED");
|
||||
String largeJob = submitCheck(a, deviceA, "multipart-zpl", "ZPL", large, true);
|
||||
finish(a, deviceA, largeJob, "SPOOLED");
|
||||
String foreignJob = submitCheck(b, deviceB, "foreign-zpl", "ZPL", zpl, false);
|
||||
finish(b, deviceB, foreignJob, "SPOOLED");
|
||||
String foreignRef = reference(foreignJob);
|
||||
String ownRef = reference(pdfJob);
|
||||
check(!ownRef.split("/")[1].equals(foreignRef.split("/")[1]), "tenant prefixes differ");
|
||||
expectStatus(404, () -> a.content(deviceA, foreignJob), "foreign tenant job download denied");
|
||||
expectStatus(404, () -> a.content(deviceB, foreignJob), "foreign tenant device rejected");
|
||||
execute("UPDATE printing_job SET content_reference=? WHERE id=?", foreignRef, pdfJob);
|
||||
expectStatus(409, () -> a.content(deviceA, pdfJob), "foreign stored reference rejected");
|
||||
execute("UPDATE printing_job SET content_reference=? WHERE id=?", ownRef, pdfJob);
|
||||
check(Arrays.equals(zpl, b.content(deviceB, foreignJob)), "foreign object unchanged after rejection");
|
||||
String failed = submitCheck(a, deviceA, "protected-failed", "ZPL", zpl, false);
|
||||
finish(a, deviceA, failed, "FAILED");
|
||||
String unknown = submitCheck(a, deviceA, "protected-unknown", "ZPL", zpl, false);
|
||||
finish(a, deviceA, unknown, "OUTCOME_UNKNOWN");
|
||||
String active = a.submit(request(deviceA, "protected-queued", "ZPL", zpl)).getString("jobId");
|
||||
String old = Instant.now().minusSeconds(400L * 86400).toString();
|
||||
for(String id : List.of(pdfJob, largeJob, foreignJob, failed, unknown, active)) {
|
||||
execute("UPDATE printing_job SET created_at=?,completed_at=? WHERE id=?", old, old, id);
|
||||
}
|
||||
finally
|
||||
{
|
||||
Files.writeString(output.resolve("completed-checks.json"), new JSONObject().put("checks", CHECKS).put("documents", DOCUMENTS).toString(2) + "\n");
|
||||
S3ClientFactory.clearCache();
|
||||
QContext.clear();
|
||||
int before = objectCount();
|
||||
check(a.runRetention() == 2, "tenant A retention removes exactly two aged successful documents");
|
||||
check(objectCount() == before - 2, "object count reflects exact two removals");
|
||||
missing(OBJECT_KEYS.get(ownRef));
|
||||
missing(OBJECT_KEYS.get(reference(largeJob)));
|
||||
expectStatus(410, () -> a.content(deviceA, pdfJob), "expired document returns 410");
|
||||
check(a.submit(request(deviceA, "small-pdf", "PDF", pdf)).getString("jobId").equals(pdfJob), "idempotent replay survives retention without reupload");
|
||||
check(objectCount() == before - 2, "post-retention replay creates no object");
|
||||
for(String id : List.of(zplJob, foreignJob, failed, unknown, active)) {
|
||||
check(s3.headObject(HeadObjectRequest.builder().bucket(bucket).key(objectKey(reference(id))).build()).contentLength() == zpl.length,
|
||||
"protected object retained: " + status(id));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Initialize a tenant-scoped service using the shared synthetic storage metadata.
|
||||
***************************************************************************/
|
||||
private static PrintingService service(QInstance instance, String tenant) throws Exception
|
||||
{
|
||||
PrintingService service = new PrintingService(database, tenant);
|
||||
service.initialize();
|
||||
service.configureStorage(instance, TABLE);
|
||||
return service;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Create and approve a synthetic storage-only destination.
|
||||
***************************************************************************/
|
||||
private static String enroll(PrintingService service) throws Exception
|
||||
{
|
||||
String id = service.enroll(service.createEnrollment("fixture", "Synthetic station")
|
||||
.put("deviceName", "Synthetic station").put("agentVersion", "isolated-storage-fixture")).getString("deviceId");
|
||||
service.inventory(id, new JSONArray().put(new JSONObject().put("printerId", "synthetic-never-dispatched")
|
||||
.put("name", "Synthetic storage-only destination").put("status", "READY").put("formats", new JSONArray(List.of("PDF", "ZPL")))));
|
||||
service.enablePrinter(id, "synthetic-never-dispatched", true);
|
||||
return id;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Build a repeatable submission containing synthetic document bytes.
|
||||
***************************************************************************/
|
||||
private static JSONObject request(String device, String key, String format, byte[] bytes)
|
||||
{
|
||||
return new JSONObject().put("deviceId", device).put("printerId", "synthetic-never-dispatched").put("title", "Synthetic storage qualification")
|
||||
.put("format", format).put("contentBase64", Base64.getEncoder().encodeToString(bytes)).put("idempotencyKey", key);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Verify submission replay, download integrity, and the actual external object representation.
|
||||
***************************************************************************/
|
||||
private static String submitCheck(PrintingService service, String device, String key, String format, byte[] bytes, boolean multipart) throws Exception
|
||||
{
|
||||
JSONObject request = request(device, key, format, bytes);
|
||||
String id = service.submit(request).getString("jobId");
|
||||
int count = objectCount();
|
||||
check(id.equals(service.submit(request).getString("jobId")) && count == objectCount(), key + " stable replay creates no object");
|
||||
check(service.claim(device).getJSONObject("job").getString("jobId").equals(id), key + " claimed through production service");
|
||||
byte[] actual = service.content(device, id);
|
||||
check(Arrays.equals(bytes, actual) && sha(bytes).equals(sha(actual)), key + " download bytes and SHA256 match");
|
||||
String ref = reference(id);
|
||||
String actualKey = objectKey(ref);
|
||||
HeadObjectResponse head = s3.headObject(HeadObjectRequest.builder().bucket(bucket).key(actualKey).build());
|
||||
check(head.contentLength() == bytes.length, key + " object length exact");
|
||||
check(head.contentType().equals(format.equals("PDF") ? "application/pdf" : "application/vnd.zebra-zpl"), key + " content type correct");
|
||||
check(head.eTag().contains("-2") == multipart, key + " expected single/multipart object ETag");
|
||||
try(var c = database.getConnection(); var statement = c.prepareStatement("SELECT content_base64,content_storage_table FROM printing_job WHERE id=?"))
|
||||
{
|
||||
statement.setString(1, id);
|
||||
try(var rows = statement.executeQuery())
|
||||
{
|
||||
check(rows.next() && rows.getString(1) == null && TABLE.equals(rows.getString(2)), key + " payload external, no inline database copy");
|
||||
}
|
||||
}
|
||||
DOCUMENTS.put(new JSONObject().put("case", key).put("format", format).put("bytes", bytes.length).put("sha256", sha(bytes)).put("multipart", multipart).put("etag", head.eTag())
|
||||
.put("objectKeyEqualsStoredReference", actualKey.equals(ref)).put("objectKeyPrefixBeforeReference", actualKey.substring(0, actualKey.length() - ref.length())));
|
||||
return id;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Record synthetic lifecycle events without invoking a physical spooler.
|
||||
***************************************************************************/
|
||||
private static void finish(PrintingService service, String device, String id, String status) throws Exception
|
||||
{
|
||||
for(String phase : List.of("RECEIVED", "SUBMITTING", status))
|
||||
{
|
||||
service.event(device, id, new JSONObject().put("eventId", UUID.randomUUID().toString()).put("status", phase).put("message", "Synthetic receipt; no physical device or spooler used"));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Compute the document digest used for round-trip assertions.
|
||||
***************************************************************************/
|
||||
private static String sha(byte[] bytes) throws Exception
|
||||
{
|
||||
return HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(bytes));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Count objects in the dedicated synthetic bucket.
|
||||
***************************************************************************/
|
||||
private static int objectCount()
|
||||
{
|
||||
return s3.listObjectsV2(ListObjectsV2Request.builder().bucket(bucket).build()).contents().size();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Resolve and cache the physical key corresponding to a persisted document reference.
|
||||
***************************************************************************/
|
||||
private static String objectKey(String reference)
|
||||
{
|
||||
String known = OBJECT_KEYS.get(reference);
|
||||
if(known != null)
|
||||
{
|
||||
return known;
|
||||
}
|
||||
List<String> matches = s3.listObjectsV2(ListObjectsV2Request.builder().bucket(bucket).build()).contents().stream()
|
||||
.map(S3Object::key).filter(key -> key.endsWith(reference)).toList();
|
||||
if(matches.size() != 1)
|
||||
{
|
||||
throw new AssertionError("Expected exactly one synthetic object for stored reference");
|
||||
}
|
||||
String key = matches.getFirst();
|
||||
String prefix = key.substring(0, key.length() - reference.length());
|
||||
if(!prefix.isEmpty() && !prefix.matches("\\\\+"))
|
||||
{
|
||||
throw new AssertionError("Unexpected physical S3 key prefix");
|
||||
}
|
||||
OBJECT_KEYS.put(reference, key);
|
||||
return key;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Read the accepted external reference for a synthetic job.
|
||||
***************************************************************************/
|
||||
private static String reference(String id) throws Exception
|
||||
{
|
||||
return field(id, "content_reference");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Read the lifecycle state of a synthetic job.
|
||||
***************************************************************************/
|
||||
private static String status(String id) throws Exception
|
||||
{
|
||||
return field(id, "status");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Read a fixture-selected field from a synthetic job.
|
||||
***************************************************************************/
|
||||
private static String field(String id, String field) throws Exception
|
||||
{
|
||||
try(var c = database.getConnection(); var statement = c.prepareStatement("SELECT " + field + " FROM printing_job WHERE id=?"))
|
||||
{
|
||||
statement.setString(1, id);
|
||||
try(var rows = statement.executeQuery())
|
||||
{
|
||||
if(!rows.next())
|
||||
{
|
||||
throw new AssertionError("Missing synthetic job");
|
||||
}
|
||||
return rows.getString(1);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Apply a bounded synthetic fixture adjustment with bound values.
|
||||
***************************************************************************/
|
||||
private static void execute(String sql, String... args) throws Exception
|
||||
{
|
||||
try(var c = database.getConnection(); var statement = c.prepareStatement(sql))
|
||||
{
|
||||
for(int i = 0; i < args.length; i++)
|
||||
{
|
||||
statement.setString(i + 1, args[i]);
|
||||
}
|
||||
statement.executeUpdate();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Record a successful assertion or stop qualification immediately.
|
||||
***************************************************************************/
|
||||
private static void check(boolean pass, String label)
|
||||
{
|
||||
if(!pass)
|
||||
{
|
||||
throw new AssertionError(label);
|
||||
}
|
||||
CHECKS.put(label);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Verify an eligible object is absent after retention.
|
||||
***************************************************************************/
|
||||
private static void missing(String ref)
|
||||
{
|
||||
try
|
||||
{
|
||||
s3.headObject(HeadObjectRequest.builder().bucket(bucket).key(ref).build());
|
||||
throw new AssertionError("Expected removed object");
|
||||
}
|
||||
catch(S3Exception exception)
|
||||
{
|
||||
check(exception.statusCode() == 404, "eligible object absent from S3 after cleanup");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Operation that can surface a checked storage or service failure.
|
||||
***************************************************************************/
|
||||
@FunctionalInterface
|
||||
private interface Checked
|
||||
{
|
||||
/***************************************************************************
|
||||
** Execute an operation whose expected HTTP-domain failure is checked by the caller.
|
||||
***************************************************************************/
|
||||
void run() throws Exception;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Require the exact domain rejection while allowing unrelated failures to surface.
|
||||
***************************************************************************/
|
||||
private static void expectStatus(int status, Checked operation, String label) throws Exception
|
||||
{
|
||||
try
|
||||
{
|
||||
operation.run();
|
||||
throw new AssertionError(label);
|
||||
}
|
||||
catch(PrintingException exception)
|
||||
{
|
||||
check(exception.getStatus() == status, label);
|
||||
}
|
||||
}
|
||||
check(s3.getObjectAsBytes(GetObjectRequest.builder().bucket(bucket).key("unrelated/canary.txt").build()).asUtf8String().equals("synthetic unrelated object"), "unrelated same-bucket canary preserved");
|
||||
check(s3.getObjectAsBytes(GetObjectRequest.builder().bucket(otherBucket).key("canary.txt").build()).asUtf8String().equals("synthetic separate bucket"), "separate bucket canary preserved");
|
||||
check(a.runRetention() == 0, "repeated cleanup is idempotent");
|
||||
check(b.runRetention() == 1, "tenant B cleanup independently removes its one eligible document");
|
||||
check(s3.listMultipartUploads(ListMultipartUploadsRequest.builder().bucket(bucket).build()).uploads().isEmpty(), "no incomplete multipart uploads remain");
|
||||
check(QContext.getQSession() == null, "storage restores original absent QQQ session");
|
||||
JSONObject result = new JSONObject().put("passed", true).put("timestamp", Instant.now().toString())
|
||||
.put("checks", CHECKS).put("documents", DOCUMENTS).put("runtimeJarCount", 204)
|
||||
.put("appRevision", System.getenv("PRINTING_SOURCE_COMMIT"))
|
||||
.put("h2Version", org.h2.engine.Constants.VERSION).put("retentionDays", a.getRetentionSettings().getInt("days"))
|
||||
.put("transport", "loopback HTTP S3-compatible only").put("hardwarePrinting", false)
|
||||
.put("qualifies", "QQQ StorageAction / AWS SDK v2 S3 data-plane behavior against disposable MinIO")
|
||||
.put("doesNotQualify", new JSONArray(List.of("AWS IAM", "remote TLS", "production bucket ownership", "Object Lock/version lifecycle", "remote deployment", "hardware printing")));
|
||||
Files.writeString(output.resolve("results.json"), result.toString(2) + "\n");
|
||||
System.out.println("PASS " + CHECKS.length() + " checks; " + DOCUMENTS.length() + " synthetic document round trips");
|
||||
} finally {
|
||||
Files.writeString(output.resolve("completed-checks.json"), new JSONObject().put("checks", CHECKS).put("documents", DOCUMENTS).toString(2) + "\n");
|
||||
S3ClientFactory.clearCache();
|
||||
QContext.clear();
|
||||
}
|
||||
}
|
||||
private static PrintingService service(QInstance instance, String tenant) throws Exception {
|
||||
PrintingService service = new PrintingService(database, tenant);
|
||||
service.initialize(); service.configureStorage(instance, TABLE); return service;
|
||||
}
|
||||
private static String enroll(PrintingService service) throws Exception {
|
||||
String id = service.enroll(service.createEnrollment("fixture", "Synthetic station")
|
||||
.put("deviceName", "Synthetic station").put("agentVersion", "isolated-storage-fixture")).getString("deviceId");
|
||||
service.inventory(id, new JSONArray().put(new JSONObject().put("printerId", "synthetic-never-dispatched")
|
||||
.put("name", "Synthetic storage-only destination").put("status", "READY").put("formats", new JSONArray(List.of("PDF", "ZPL")))));
|
||||
service.enablePrinter(id, "synthetic-never-dispatched", true); return id;
|
||||
}
|
||||
private static JSONObject request(String device, String key, String format, byte[] bytes) {
|
||||
return new JSONObject().put("deviceId", device).put("printerId", "synthetic-never-dispatched").put("title", "Synthetic storage qualification")
|
||||
.put("format", format).put("contentBase64", Base64.getEncoder().encodeToString(bytes)).put("idempotencyKey", key);
|
||||
}
|
||||
private static String submitCheck(PrintingService service, String device, String key, String format, byte[] bytes, boolean multipart) throws Exception {
|
||||
JSONObject request = request(device, key, format, bytes);
|
||||
String id = service.submit(request).getString("jobId");
|
||||
int count = objectCount();
|
||||
check(id.equals(service.submit(request).getString("jobId")) && count == objectCount(), key + " stable replay creates no object");
|
||||
check(service.claim(device).getJSONObject("job").getString("jobId").equals(id), key + " claimed through production service");
|
||||
byte[] actual = service.content(device, id);
|
||||
check(Arrays.equals(bytes, actual) && sha(bytes).equals(sha(actual)), key + " download bytes and SHA256 match");
|
||||
String ref = reference(id);
|
||||
String actualKey = objectKey(ref);
|
||||
HeadObjectResponse head = s3.headObject(HeadObjectRequest.builder().bucket(bucket).key(actualKey).build());
|
||||
check(head.contentLength() == bytes.length, key + " object length exact");
|
||||
check(head.contentType().equals(format.equals("PDF") ? "application/pdf" : "application/vnd.zebra-zpl"), key + " content type correct");
|
||||
check(head.eTag().contains("-2") == multipart, key + " expected single/multipart object ETag");
|
||||
try(var c = database.getConnection(); var statement = c.prepareStatement("SELECT content_base64,content_storage_table FROM printing_job WHERE id=?")) {
|
||||
statement.setString(1, id); try(var rows = statement.executeQuery()) { check(rows.next() && rows.getString(1) == null && TABLE.equals(rows.getString(2)), key + " payload external, no inline database copy"); }
|
||||
}
|
||||
DOCUMENTS.put(new JSONObject().put("case", key).put("format", format).put("bytes", bytes.length).put("sha256", sha(bytes)).put("multipart", multipart).put("etag", head.eTag())
|
||||
.put("objectKeyEqualsStoredReference", actualKey.equals(ref)).put("objectKeyPrefixBeforeReference", actualKey.substring(0, actualKey.length() - ref.length())));
|
||||
return id;
|
||||
}
|
||||
private static void finish(PrintingService service, String device, String id, String status) throws Exception {
|
||||
for(String phase : List.of("RECEIVED", "SUBMITTING", status)) service.event(device, id, new JSONObject().put("eventId", UUID.randomUUID().toString()).put("status", phase).put("message", "Synthetic receipt; no physical device or spooler used"));
|
||||
}
|
||||
private static String sha(byte[] bytes) throws Exception { return HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(bytes)); }
|
||||
private static int objectCount() { return s3.listObjectsV2(ListObjectsV2Request.builder().bucket(bucket).build()).contents().size(); }
|
||||
private static String objectKey(String reference) {
|
||||
String known = OBJECT_KEYS.get(reference);
|
||||
if(known != null) return known;
|
||||
List<String> matches = s3.listObjectsV2(ListObjectsV2Request.builder().bucket(bucket).build()).contents().stream()
|
||||
.map(S3Object::key).filter(key -> key.endsWith(reference)).toList();
|
||||
if(matches.size() != 1) throw new AssertionError("Expected exactly one synthetic object for stored reference");
|
||||
String key = matches.getFirst();
|
||||
String prefix = key.substring(0, key.length() - reference.length());
|
||||
if(!prefix.isEmpty() && !prefix.matches("\\\\+")) throw new AssertionError("Unexpected physical S3 key prefix");
|
||||
OBJECT_KEYS.put(reference, key);
|
||||
return key;
|
||||
}
|
||||
private static String reference(String id) throws Exception { return field(id, "content_reference"); }
|
||||
private static String status(String id) throws Exception { return field(id, "status"); }
|
||||
private static String field(String id, String field) throws Exception {
|
||||
try(var c = database.getConnection(); var statement = c.prepareStatement("SELECT " + field + " FROM printing_job WHERE id=?")) {
|
||||
statement.setString(1,id); try(var rows=statement.executeQuery()) { if(!rows.next()) throw new AssertionError("Missing synthetic job"); return rows.getString(1); }
|
||||
}
|
||||
}
|
||||
private static void execute(String sql, String... args) throws Exception {
|
||||
try(var c = database.getConnection(); var statement = c.prepareStatement(sql)) { for(int i=0; i<args.length; i++) statement.setString(i+1,args[i]); statement.executeUpdate(); }
|
||||
}
|
||||
private static void check(boolean pass, String label) { if(!pass) throw new AssertionError(label); CHECKS.put(label); }
|
||||
private static void missing(String ref) {
|
||||
try { s3.headObject(HeadObjectRequest.builder().bucket(bucket).key(ref).build()); throw new AssertionError("Expected removed object"); }
|
||||
catch(S3Exception exception) { check(exception.statusCode()==404,"eligible object absent from S3 after cleanup"); }
|
||||
}
|
||||
@FunctionalInterface private interface Checked { void run() throws Exception; }
|
||||
private static void expectStatus(int status, Checked operation, String label) throws Exception {
|
||||
try { operation.run(); throw new AssertionError(label); } catch(PrintingException exception) { check(exception.getStatus()==status,label); }
|
||||
}
|
||||
}
|
||||
+82
-217
@@ -19,229 +19,94 @@
|
||||
*/
|
||||
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package com.kingsrook.qbits.printing;
|
||||
|
||||
|
||||
import java.nio.file.*;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.sql.Connection;
|
||||
import java.sql.DriverManager;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.Statement;
|
||||
import java.time.Duration;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Base64;
|
||||
import java.util.List;
|
||||
import java.util.UUID;
|
||||
import java.util.concurrent.Executors;
|
||||
import java.util.concurrent.Future;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
import java.util.concurrent.TimeoutException;
|
||||
import java.sql.*;
|
||||
import java.time.*;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.*;
|
||||
import java.util.concurrent.atomic.AtomicReference;
|
||||
import com.kingsrook.qqq.middleware.javalin.QApplicationLauncher;
|
||||
import com.kingsrook.qqq.middleware.javalin.QApplicationLauncherConfig;
|
||||
import com.kingsrook.qqq.middleware.javalin.*;
|
||||
import io.javalin.Javalin;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONObject;
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Fixture only: real checkout host, synthetic SDK producer, no physical printer.
|
||||
***************************************************************************/
|
||||
public final class WorkloadFixture
|
||||
{
|
||||
/***************************************************************************
|
||||
** Drive two synthetic tenants through real network workers and verify durable receipts and accounting.
|
||||
***************************************************************************/
|
||||
public static void main(String[] args) throws Exception
|
||||
{
|
||||
Path dir = Path.of(args[0]).toAbsolutePath();
|
||||
if(!dir.getFileName().toString().startsWith("run-"))
|
||||
{
|
||||
throw new IllegalArgumentException("Owned run directory required");
|
||||
}
|
||||
String jdbc = "jdbc:h2:file:" + dir.resolve("synthetic").toString().replace('\\', '/') + ";DB_CLOSE_DELAY=-1";
|
||||
String password = "synthetic-" + UUID.randomUUID();
|
||||
List<QApplicationLauncher> launches = new ArrayList<>();
|
||||
List<PrintingService> services = new ArrayList<>();
|
||||
List<String> devices = new ArrayList<>();
|
||||
JSONArray inputs = new JSONArray();
|
||||
boolean idle = args.length > 1 && args[1].equals("idle");
|
||||
int total = idle ? 40 : 10000;
|
||||
long started = System.nanoTime();
|
||||
int exit = 1;
|
||||
try
|
||||
{
|
||||
for(int tenant = 0; tenant < 2; tenant++)
|
||||
{
|
||||
PrintingLocalHost host = new PrintingLocalHost(new PrintingLocalSettings(jdbc, "sa", "", "tenant-" + tenant, 0, "fixture-only-management-token-123456", "operator", password));
|
||||
AtomicReference<Javalin> app = new AtomicReference<>();
|
||||
QApplicationLauncher launch = QApplicationLauncher.run(host, new QApplicationLauncherConfig().withRegisterShutdownHook(false).withServerCustomizer(server ->
|
||||
{
|
||||
host.configure(server, false);
|
||||
server.withJavalinConfigurationCustomizer(app::set);
|
||||
}));
|
||||
launches.add(launch);
|
||||
PrintingService service = launch.getQInstance().getQBits().values().stream().map(v -> v.getConfig()).filter(PrintingQBitConfig.class::isInstance).map(PrintingQBitConfig.class::cast).findFirst().orElseThrow().getService();
|
||||
services.add(service);
|
||||
for(int lane = 0; lane < 4; lane++)
|
||||
{
|
||||
JSONObject enrolled = service.enrollForUser(service.createEnrollment("default", "Synthetic lane").put("deviceName", "Synthetic lane").put("agentVersion", "qualification"), "operator");
|
||||
String device = enrolled.getString("deviceId");
|
||||
devices.add(device);
|
||||
service.inventory(device, new JSONArray().put(new JSONObject().put("printerId", "synthetic").put("name", "No physical printer").put("status", "READY").put("formats", new JSONArray().put("ZPL"))));
|
||||
service.enablePrinter(device, "synthetic", true);
|
||||
inputs.put(new JSONObject().put("origin", "http://127.0.0.1:" + app.get().port() + "/").put("username", "operator").put("password", password).put("tenant", "tenant-" + tenant).put("deviceId", device).put("deviceToken", enrolled.getString("deviceToken")));
|
||||
}
|
||||
}
|
||||
// Only synthetic credentials inside the already protected run directory.
|
||||
Files.writeString(dir.resolve("input.json"), new JSONObject().put("lanes", inputs).put("idle", idle).put("jobsPerLane", total / 8).toString());
|
||||
await(dir.resolve("ready"), Duration.ofMinutes(2));
|
||||
byte[] payload = ("^XA^FO20,20^FDSYNTHETIC NOT PRINTED^FS" + " ".repeat(980) + "^XZ").getBytes(StandardCharsets.US_ASCII);
|
||||
String encoded = Base64.getEncoder().encodeToString(payload);
|
||||
long producing = System.nanoTime();
|
||||
if(idle)
|
||||
{
|
||||
for(int job = 0; job < total; job++)
|
||||
{
|
||||
int lane = job % 8;
|
||||
PrintingService service = services.get(lane / 4);
|
||||
JSONObject request = new JSONObject().put("deviceId", devices.get(lane)).put("printerId", "synthetic").put("title", "Synthetic idle workload").put("format", "ZPL").put("contentBase64", encoded).put("idempotencyKey", "idle-" + job);
|
||||
service.submit(request);
|
||||
await(dir.resolve("completed-" + (job + 1)), Duration.ofSeconds(30));
|
||||
Thread.sleep(200);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
try(var executor = Executors.newFixedThreadPool(8))
|
||||
{
|
||||
List<Future<?>> futures = new ArrayList<>();
|
||||
for(int lane = 0; lane < 8; lane++)
|
||||
{
|
||||
final int index = lane;
|
||||
futures.add(executor.submit(() ->
|
||||
{
|
||||
try
|
||||
{
|
||||
PrintingService service = services.get(index / 4);
|
||||
for(int job = 0; job < 1250; job++)
|
||||
{
|
||||
JSONObject request = new JSONObject().put("deviceId", devices.get(index)).put("printerId", "synthetic").put("title", "Synthetic workload " + job).put("format", "ZPL").put("contentBase64", encoded).put("idempotencyKey", "lane-" + index + "-" + job);
|
||||
JSONObject submitted = service.submit(request);
|
||||
if(job % 25 == 0 && !submitted.getString("jobId").equals(service.submit(request).getString("jobId")))
|
||||
{
|
||||
throw new IllegalStateException("Replay duplicated job");
|
||||
}
|
||||
}
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
}));
|
||||
}
|
||||
for(var future : futures)
|
||||
{
|
||||
future.get(15, TimeUnit.MINUTES);
|
||||
}
|
||||
}
|
||||
}
|
||||
double producerSeconds = (System.nanoTime() - producing) / 1e9;
|
||||
Files.writeString(dir.resolve("producer-done"), "done");
|
||||
await(dir.resolve("done"), Duration.ofMinutes(15));
|
||||
JSONObject client = new JSONObject(Files.readString(dir.resolve("result.json")));
|
||||
if(!client.getBoolean("success"))
|
||||
{
|
||||
throw new IllegalStateException("Client reported failure");
|
||||
}
|
||||
JSONObject report = new JSONObject().put("success", true).put("jobs", total).put("receipts", total * 3).put("idle", idle).put("producerSeconds", producerSeconds).put("elapsedSeconds", (System.nanoTime() - started) / 1e9).put("realPrinterCalls", 0);
|
||||
try(Connection connection = DriverManager.getConnection(jdbc, "sa", ""); Statement query = connection.createStatement())
|
||||
{
|
||||
require(query, "SELECT COUNT(*) FROM printing_job", total);
|
||||
require(query, "SELECT COUNT(*) FROM printing_job WHERE status='SPOOLED'", total);
|
||||
require(query, "SELECT COUNT(*) FROM printing_event", total * 3);
|
||||
require(query, "SELECT COUNT(*) FROM printing_document_orphan", 0);
|
||||
for(int tenant = 0; tenant < 2; tenant++)
|
||||
{
|
||||
require(query, "SELECT COUNT(*) FROM printing_job WHERE tenant_id='tenant-" + tenant + "'", total / 2);
|
||||
require(query, "SELECT retained_bytes FROM printing_resource_usage WHERE tenant_id='tenant-" + tenant + "' AND device_id=''", (total / 2L) * payload.length);
|
||||
}
|
||||
JSONArray cross = new JSONArray();
|
||||
for(int tenant = 0; tenant < 2; tenant++)
|
||||
{
|
||||
String foreign = services.get(1 - tenant).jobsPage(1, null).getJSONArray("jobs").getJSONObject(0).getString("jobId");
|
||||
try
|
||||
{
|
||||
services.get(tenant).getJob(foreign);
|
||||
throw new IllegalStateException("Foreign job visible");
|
||||
}
|
||||
catch(PrintingException denied)
|
||||
{
|
||||
if(denied.getStatus() != 404)
|
||||
{
|
||||
throw denied;
|
||||
}
|
||||
}
|
||||
cross.put(true);
|
||||
}
|
||||
report.put("tenantIsolation", cross).put("retainedAccountingVerified", true).put("bytesPerDocument", payload.length);
|
||||
}
|
||||
Files.writeString(dir.resolve("server-result.json"), report.toString(2));
|
||||
exit = 0;
|
||||
}
|
||||
catch(Throwable failure)
|
||||
{
|
||||
Files.writeString(dir.resolve("server-error.json"), new JSONObject().put("error", failure.getClass().getName()).put("cause", failure.getCause() == null ? "" : failure.getCause().getClass().getName()).toString());
|
||||
}
|
||||
finally
|
||||
{
|
||||
for(int i = launches.size() - 1; i >= 0; i--)
|
||||
{
|
||||
launches.get(i).stop();
|
||||
}
|
||||
try(Connection connection = DriverManager.getConnection(jdbc, "sa", ""); Statement query = connection.createStatement())
|
||||
{
|
||||
query.execute("SHUTDOWN");
|
||||
}
|
||||
Files.writeString(dir.resolve("stopped.json"), new JSONObject().put("normalStop", true).put("exitCode", exit).toString());
|
||||
}
|
||||
System.exit(exit);
|
||||
import org.json.*;
|
||||
/** Fixture only: real checkout host, synthetic SDK producer, no physical printer. */
|
||||
public final class WorkloadFixture {
|
||||
public static void main(String[] args) throws Exception {
|
||||
Path dir=Path.of(args[0]).toAbsolutePath();
|
||||
if(!dir.getFileName().toString().startsWith("run-"))throw new IllegalArgumentException("Owned run directory required");
|
||||
String jdbc="jdbc:h2:file:"+dir.resolve("synthetic").toString().replace('\\','/')+";DB_CLOSE_DELAY=-1";
|
||||
String password="synthetic-"+UUID.randomUUID();
|
||||
List<QApplicationLauncher> launches=new ArrayList<>(); List<PrintingService> services=new ArrayList<>();
|
||||
List<String> devices=new ArrayList<>(); JSONArray inputs=new JSONArray();
|
||||
boolean idle=args.length>1 && args[1].equals("idle"); int total=idle?40:10000; long started=System.nanoTime(); int exit=1;
|
||||
try {
|
||||
for(int tenant=0;tenant<2;tenant++) {
|
||||
PrintingLocalHost host=new PrintingLocalHost(new PrintingLocalSettings(jdbc,"sa","","tenant-"+tenant,0,"fixture-only-management-token-123456","operator",password));
|
||||
AtomicReference<Javalin> app=new AtomicReference<>();
|
||||
QApplicationLauncher launch=QApplicationLauncher.run(host,new QApplicationLauncherConfig().withRegisterShutdownHook(false).withServerCustomizer(server->{host.configure(server,false);server.withJavalinConfigurationCustomizer(app::set);}));
|
||||
launches.add(launch);
|
||||
PrintingService service=launch.getQInstance().getQBits().values().stream().map(v->v.getConfig()).filter(PrintingQBitConfig.class::isInstance).map(PrintingQBitConfig.class::cast).findFirst().orElseThrow().getService();
|
||||
services.add(service);
|
||||
for(int lane=0;lane<4;lane++) {
|
||||
JSONObject enrolled=service.enrollForUser(service.createEnrollment("default","Synthetic lane").put("deviceName","Synthetic lane").put("agentVersion","qualification"),"operator");
|
||||
String device=enrolled.getString("deviceId");devices.add(device);
|
||||
service.inventory(device,new JSONArray().put(new JSONObject().put("printerId","synthetic").put("name","No physical printer").put("status","READY").put("formats",new JSONArray().put("ZPL"))));service.enablePrinter(device,"synthetic",true);
|
||||
inputs.put(new JSONObject().put("origin","http://127.0.0.1:"+app.get().port()+"/").put("username","operator").put("password",password).put("tenant","tenant-"+tenant).put("deviceId",device).put("deviceToken",enrolled.getString("deviceToken")));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Wait for a private coordination marker with a monotonic deadline.
|
||||
***************************************************************************/
|
||||
static void await(Path file, Duration limit) throws Exception
|
||||
{
|
||||
long deadline = System.nanoTime() + limit.toNanos();
|
||||
while(!Files.exists(file))
|
||||
{
|
||||
if(System.nanoTime() > deadline)
|
||||
{
|
||||
throw new TimeoutException("Fixture deadline");
|
||||
}
|
||||
Thread.sleep(100);
|
||||
// Only synthetic credentials inside the already protected run directory.
|
||||
Files.writeString(dir.resolve("input.json"),new JSONObject().put("lanes",inputs).put("idle",idle).put("jobsPerLane",total/8).toString());
|
||||
await(dir.resolve("ready"),Duration.ofMinutes(2));
|
||||
byte[] payload=("^XA^FO20,20^FDSYNTHETIC NOT PRINTED^FS"+" ".repeat(980)+"^XZ").getBytes(StandardCharsets.US_ASCII);
|
||||
String encoded=Base64.getEncoder().encodeToString(payload);
|
||||
long producing=System.nanoTime();
|
||||
if(idle) { for(int job=0;job<total;job++) { int lane=job%8; PrintingService service=services.get(lane/4); JSONObject request=new JSONObject().put("deviceId",devices.get(lane)).put("printerId","synthetic").put("title","Synthetic idle workload").put("format","ZPL").put("contentBase64",encoded).put("idempotencyKey","idle-"+job); service.submit(request); await(dir.resolve("completed-"+(job+1)),Duration.ofSeconds(30)); Thread.sleep(200); } } else try(var executor=Executors.newFixedThreadPool(8)) {
|
||||
List<Future<?>> futures=new ArrayList<>();
|
||||
for(int lane=0;lane<8;lane++) { final int index=lane;
|
||||
futures.add(executor.submit(()->{try{
|
||||
PrintingService service=services.get(index/4);
|
||||
for(int job=0;job<1250;job++) {
|
||||
JSONObject request=new JSONObject().put("deviceId",devices.get(index)).put("printerId","synthetic").put("title","Synthetic workload "+job).put("format","ZPL").put("contentBase64",encoded).put("idempotencyKey","lane-"+index+"-"+job);
|
||||
JSONObject submitted=service.submit(request);
|
||||
if(job%25==0 && !submitted.getString("jobId").equals(service.submit(request).getString("jobId")))throw new IllegalStateException("Replay duplicated job");
|
||||
}
|
||||
}catch(Exception e){throw new RuntimeException(e);}}));
|
||||
}
|
||||
for(var future:futures)future.get(15,TimeUnit.MINUTES);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Verify a synthetic database aggregate without emitting row values.
|
||||
***************************************************************************/
|
||||
static void require(Statement query, String sql, long expected) throws Exception
|
||||
{
|
||||
try(ResultSet rows = query.executeQuery(sql))
|
||||
{
|
||||
if(!rows.next() || rows.getLong(1) != expected)
|
||||
{
|
||||
throw new IllegalStateException("Synthetic count/accounting mismatch");
|
||||
}
|
||||
}
|
||||
double producerSeconds=(System.nanoTime()-producing)/1e9;
|
||||
Files.writeString(dir.resolve("producer-done"),"done");
|
||||
await(dir.resolve("done"),Duration.ofMinutes(15));
|
||||
JSONObject client=new JSONObject(Files.readString(dir.resolve("result.json")));
|
||||
if(!client.getBoolean("success"))throw new IllegalStateException("Client reported failure");
|
||||
JSONObject report=new JSONObject().put("success",true).put("jobs",total).put("receipts",total*3).put("idle",idle).put("producerSeconds",producerSeconds).put("elapsedSeconds",(System.nanoTime()-started)/1e9).put("realPrinterCalls",0);
|
||||
try(Connection connection=DriverManager.getConnection(jdbc,"sa","");Statement query=connection.createStatement()) {
|
||||
require(query,"SELECT COUNT(*) FROM printing_job",total);
|
||||
require(query,"SELECT COUNT(*) FROM printing_job WHERE status='SPOOLED'",total);
|
||||
require(query,"SELECT COUNT(*) FROM printing_event",total*3);
|
||||
require(query,"SELECT COUNT(*) FROM printing_document_orphan",0);
|
||||
for(int tenant=0;tenant<2;tenant++) {
|
||||
require(query,"SELECT COUNT(*) FROM printing_job WHERE tenant_id='tenant-"+tenant+"'",total/2);
|
||||
require(query,"SELECT retained_bytes FROM printing_resource_usage WHERE tenant_id='tenant-"+tenant+"' AND device_id=''",(total/2L)*payload.length);
|
||||
}
|
||||
JSONArray cross=new JSONArray();for(int tenant=0;tenant<2;tenant++) {
|
||||
String foreign=services.get(1-tenant).jobsPage(1,null).getJSONArray("jobs").getJSONObject(0).getString("jobId");
|
||||
try {services.get(tenant).getJob(foreign);throw new IllegalStateException("Foreign job visible");}catch(PrintingException denied){if(denied.getStatus()!=404)throw denied;}
|
||||
cross.put(true);
|
||||
}
|
||||
report.put("tenantIsolation",cross).put("retainedAccountingVerified",true).put("bytesPerDocument",payload.length);
|
||||
}
|
||||
Files.writeString(dir.resolve("server-result.json"),report.toString(2));exit=0;
|
||||
} catch(Throwable failure) {
|
||||
Files.writeString(dir.resolve("server-error.json"),new JSONObject().put("error",failure.getClass().getName()).put("cause",failure.getCause()==null?"":failure.getCause().getClass().getName()).toString());
|
||||
} finally {
|
||||
for(int i=launches.size()-1;i>=0;i--)launches.get(i).stop();
|
||||
try(Connection connection=DriverManager.getConnection(jdbc,"sa","");Statement query=connection.createStatement()){query.execute("SHUTDOWN");}
|
||||
Files.writeString(dir.resolve("stopped.json"),new JSONObject().put("normalStop",true).put("exitCode",exit).toString());
|
||||
}
|
||||
System.exit(exit);
|
||||
}
|
||||
static void await(Path file,Duration limit)throws Exception {long deadline=System.nanoTime()+limit.toNanos();while(!Files.exists(file)){if(System.nanoTime()>deadline)throw new TimeoutException("Fixture deadline");Thread.sleep(100);}}
|
||||
static void require(Statement query,String sql,long expected)throws Exception {try(ResultSet rows=query.executeQuery(sql)){if(!rows.next()||rows.getLong(1)!=expected)throw new IllegalStateException("Synthetic count/accounting mismatch");}}
|
||||
}
|
||||
@@ -7,12 +7,10 @@ ADD --checksum=sha256:82fcdbf7240760939a63b219aeb15a2333b3a8a02b52307a8a328500fc
|
||||
RUN mkdir /client && tar -xzf /tmp/client.tar.gz -C /client --strip-components=1 && rm /tmp/client.tar.gz
|
||||
RUN dotnet build /client/src/Qqq.PrintAgent.Core/Qqq.PrintAgent.Core.csproj -c Release -p:Platform=x64 -p:Version=0.3.1-rc.1 -p:RestoreLockedMode=true --nologo
|
||||
RUN mkdir /core && cp /client/src/Qqq.PrintAgent.Core/bin/x64/Release/net10.0/Qqq.PrintAgent.Core.dll /core/
|
||||
COPY dev/Directory.Build.props dev/Directory.Packages.props dev/.editorconfig dev/global.json /fixture/dev/
|
||||
WORKDIR /fixture/dev/native-auth/client
|
||||
COPY dev/native-auth/client .
|
||||
COPY dev/client/WorkloadDiscovery.cs /fixture/dev/client/WorkloadDiscovery.cs
|
||||
RUN dotnet build -c Release -p:RestoreLockedMode=true --nologo -o /out
|
||||
RUN dotnet format --verify-no-changes --severity warn --no-restore
|
||||
RUN dotnet build -c Release --nologo -o /out
|
||||
RUN dotnet /out/NativeAuth.dll --check-discovery
|
||||
|
||||
FROM mcr.microsoft.com/dotnet/sdk:10.0@sha256:de4fe90a98845d75910b9769662465c84de1a934665c431279d1382b2bddc02b
|
||||
|
||||
@@ -12,11 +12,10 @@ COPY pom.xml mvnw ./
|
||||
COPY .mvn .mvn
|
||||
COPY checkstyle checkstyle
|
||||
COPY src src
|
||||
COPY dev/java dev/java
|
||||
COPY dev/native-auth/java dev/native-auth/java
|
||||
COPY LICENSE NOTICE ./
|
||||
RUN chmod +x mvnw && ./mvnw -B -Dmaven.repo.local=/candidate-maven -Dqqq.version=4.1.0-native-dev-ecf0f550 -Dmaven.test.skip=true package dependency:copy-dependencies -DincludeScope=runtime -DoutputDirectory=target/runtime
|
||||
RUN mkdir /fixture-classes && javac -proc:none -cp 'target/classes:target/runtime/*' -d /fixture-classes dev/native-auth/java/*.java
|
||||
COPY dev/native-auth/java /fixture-src
|
||||
RUN mkdir /fixture-classes && javac -proc:none -cp 'target/classes:target/runtime/*' -d /fixture-classes /fixture-src/*.java
|
||||
|
||||
FROM eclipse-temurin:21-jdk-jammy@sha256:742daacb9316be4b6fc60258f6e4ac2a11882f6c597373c92290a57bfad0d2e0
|
||||
WORKDIR /app
|
||||
|
||||
@@ -1,9 +1,7 @@
|
||||
# Experimental native Authentik qualification
|
||||
|
||||
This optional profile preserves a **historical upstream candidate** for reproducible
|
||||
qualification. The normal application now uses published QQQ RC.21 with native
|
||||
session login; this profile still builds its explicit older source pin. It does
|
||||
not replace the default TABLE/MinIO development environment,
|
||||
This optional profile tests an **unreleased upstream QQQ candidate**. It does
|
||||
not replace the default released RC.20 TABLE/MinIO development environment,
|
||||
install a connector, or qualify the Windows browser callback UI.
|
||||
|
||||
From the repository root, with Docker and PowerShell 7.4 or later:
|
||||
@@ -79,10 +77,9 @@ private input/result files, rather than a host home or credential directory.
|
||||
The QQQ fixture uses fresh standard session, redirect-state and encrypted
|
||||
refresh-token tables. Its customizer maps the verified provider's synthetic
|
||||
`printing_admin` group to the existing native permission. It creates no device
|
||||
pairing, job, print operation or fabricated user session. RC.20 lacked the
|
||||
native-session grant; RC.21 now supplies it in the ordinary application. This
|
||||
fixture remains opt-in and pinned to its recorded source rather than silently
|
||||
substituting a different runtime into historical results.
|
||||
pairing, job, print operation or fabricated user session. Released RC.20 lacks
|
||||
the native-session grant; this experiment must stay opt-in until an appropriate
|
||||
immutable upstream tuple is published and separately adopted.
|
||||
|
||||
## Recorded local qualification
|
||||
|
||||
@@ -96,4 +93,4 @@ probe compatibility correction also passed all eight checks on 2026-11-01.
|
||||
All source files matched the pre-run hash manifest through completion, and
|
||||
independent cleanup again found no owned containers, volumes or networks.
|
||||
The native image's 12 discovery checks and default workload's nine checks pass.
|
||||
The historical source pin and installed-browser limitations above still apply.
|
||||
The unreleased upstream and installed-browser limitations above still apply.
|
||||
@@ -1,27 +1,18 @@
|
||||
// Copyright 2026 Kingsrook, LLC
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
using System.Net;
|
||||
using System.Threading.Channels;
|
||||
|
||||
namespace Printing.NativeAuth;
|
||||
|
||||
|
||||
|
||||
/// <summary>Receives the actual HTTPS-proxied callback only inside this test network.</summary>
|
||||
internal sealed class CallbackReceiver : IDisposable
|
||||
{
|
||||
private readonly HttpListener _listener = new();
|
||||
|
||||
|
||||
|
||||
private readonly Channel<Uri> _callbacks = Channel.CreateBounded<Uri>(1);
|
||||
|
||||
|
||||
|
||||
private readonly Uri _callback;
|
||||
|
||||
|
||||
|
||||
/// <summary>Receive callbacks only inside the owned native-auth container.</summary>
|
||||
internal CallbackReceiver(Uri callback)
|
||||
{
|
||||
_callback = callback;
|
||||
@@ -30,9 +21,6 @@ internal sealed class CallbackReceiver : IDisposable
|
||||
_ = ReceiveAsync();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Accept only the configured callback path and publish one bounded result.</summary>
|
||||
private async Task ReceiveAsync()
|
||||
{
|
||||
try
|
||||
@@ -41,12 +29,10 @@ internal sealed class CallbackReceiver : IDisposable
|
||||
{
|
||||
HttpListenerContext context = await _listener.GetContextAsync();
|
||||
Uri? request = context.Request.Url;
|
||||
bool valid = request is not null
|
||||
&& string.Equals(request.AbsolutePath, _callback.AbsolutePath, StringComparison.Ordinal)
|
||||
&& string.Equals(context.Request.Headers["Host"], _callback.Authority, StringComparison.Ordinal)
|
||||
&& string.Equals(context.Request.Headers["X-Forwarded-Proto"], "https", StringComparison.Ordinal)
|
||||
&& string.Equals(context.Request.HttpMethod, "GET", StringComparison.Ordinal)
|
||||
&& request.Query.Length is > 0 and < 16384;
|
||||
bool valid = request is not null && request.AbsolutePath == _callback.AbsolutePath
|
||||
&& context.Request.Headers["Host"] == _callback.Authority
|
||||
&& context.Request.Headers["X-Forwarded-Proto"] == "https"
|
||||
&& context.Request.HttpMethod == "GET" && request.Query.Length is > 0 and < 16384;
|
||||
if(valid)
|
||||
{
|
||||
var actual = new UriBuilder(_callback) { Query = request!.Query.TrimStart('?') };
|
||||
@@ -63,13 +49,6 @@ internal sealed class CallbackReceiver : IDisposable
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Await the actual provider callback under the caller deadline.</summary>
|
||||
internal ValueTask<Uri> ReadAsync(CancellationToken token) => _callbacks.Reader.ReadAsync(token);
|
||||
|
||||
|
||||
|
||||
/// <summary>Close the owned callback listener.</summary>
|
||||
public void Dispose() => _listener.Close();
|
||||
}
|
||||
@@ -1,69 +1,26 @@
|
||||
// Copyright 2026 Kingsrook, LLC
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
using System.Net;
|
||||
using System.Net.Http.Headers;
|
||||
using System.Text;
|
||||
using System.Text.Json.Nodes;
|
||||
|
||||
namespace Printing.NativeAuth;
|
||||
|
||||
|
||||
|
||||
/// <summary>Small bounded fixture transport; no redirects, proxy or response-body diagnostics.</summary>
|
||||
internal sealed class FixtureHttp : IDisposable
|
||||
{
|
||||
/// <summary>Carry only the parsed bounded response and optional redirect location.</summary>
|
||||
internal sealed record Reply(HttpStatusCode Status, JsonObject? Json, Uri? Location);
|
||||
|
||||
|
||||
|
||||
/// <summary>Record fixed classifications without credentials, URLs, or response bodies.</summary>
|
||||
internal sealed record TraceEntry(string Kind, int Status, bool HasQuery, string? LocationKind, bool LocationHasQuery);
|
||||
|
||||
|
||||
|
||||
internal static List<TraceEntry> Trace { get; } = [];
|
||||
|
||||
|
||||
|
||||
internal static string? LastRequestKind
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
internal static int? LastStatus
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
internal static string? LastRequestKind { get; private set; }
|
||||
internal static int? LastStatus { get; private set; }
|
||||
private readonly HttpClient _client;
|
||||
|
||||
|
||||
|
||||
private readonly CookieContainer _cookies = new();
|
||||
|
||||
|
||||
|
||||
private readonly Uri _origin;
|
||||
|
||||
|
||||
|
||||
private readonly string? _adminToken;
|
||||
|
||||
|
||||
|
||||
/// <summary>Configure bounded same-origin HTTP with redirects and proxies disabled.</summary>
|
||||
internal FixtureHttp(Uri origin, bool cookies = false, string? adminToken = null)
|
||||
{
|
||||
_origin = origin;
|
||||
@@ -75,12 +32,9 @@ internal sealed class FixtureHttp : IDisposable
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Send one origin-confined request and retain bounded sanitized diagnostics.</summary>
|
||||
internal async Task<Reply> SendAsync(string method, Uri uri, JsonObject? body, CancellationToken cancellationToken)
|
||||
{
|
||||
if(!string.Equals(uri.Scheme, "https", StringComparison.Ordinal) || !string.Equals(uri.GetLeftPart(UriPartial.Authority), _origin.GetLeftPart(UriPartial.Authority), StringComparison.Ordinal))
|
||||
if(uri.Scheme != "https" || uri.GetLeftPart(UriPartial.Authority) != _origin.GetLeftPart(UriPartial.Authority))
|
||||
{
|
||||
throw new InvalidOperationException("A fixture request left its configured HTTPS origin.");
|
||||
}
|
||||
@@ -90,10 +44,7 @@ internal sealed class FixtureHttp : IDisposable
|
||||
LastStatus = null;
|
||||
if(_adminToken is not null)
|
||||
{
|
||||
if(!uri.AbsolutePath.StartsWith("/api/v3/", StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("Administrative credential scope refused.");
|
||||
}
|
||||
if(!uri.AbsolutePath.StartsWith("/api/v3/", StringComparison.Ordinal)) { throw new InvalidOperationException("Administrative credential scope refused."); }
|
||||
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", _adminToken);
|
||||
}
|
||||
if(body is not null)
|
||||
@@ -101,57 +52,36 @@ internal sealed class FixtureHttp : IDisposable
|
||||
request.Content = new StringContent(body.ToJsonString(), Encoding.UTF8, "application/json");
|
||||
request.Headers.Add("Origin", _origin.GetLeftPart(UriPartial.Authority));
|
||||
request.Headers.Referrer = _origin;
|
||||
Cookie? csrf = _cookies.GetCookies(_origin).Cast<Cookie>().SingleOrDefault(cookie => string.Equals(cookie.Name, "authentik_csrf", StringComparison.Ordinal));
|
||||
csrf ??= _cookies.GetCookies(_origin).Cast<Cookie>().SingleOrDefault(cookie => string.Equals(cookie.Name, "csrftoken", StringComparison.Ordinal));
|
||||
if(csrf is not null)
|
||||
{
|
||||
request.Headers.Add("X-authentik-CSRF", csrf.Value);
|
||||
}
|
||||
Cookie? csrf = _cookies.GetCookies(_origin).Cast<Cookie>().SingleOrDefault(cookie => cookie.Name == "authentik_csrf");
|
||||
csrf ??= _cookies.GetCookies(_origin).Cast<Cookie>().SingleOrDefault(cookie => cookie.Name == "csrftoken");
|
||||
if(csrf is not null) { request.Headers.Add("X-authentik-CSRF", csrf.Value); }
|
||||
}
|
||||
using HttpResponseMessage response = await _client.SendAsync(request, cancellationToken);
|
||||
LastStatus = (int)response.StatusCode;
|
||||
Uri? location = response.Headers.Location is null ? null : new Uri(_origin, response.Headers.Location);
|
||||
if(Trace.Count == 32)
|
||||
{
|
||||
Trace.RemoveAt(0);
|
||||
}
|
||||
if(Trace.Count == 32) { Trace.RemoveAt(0); }
|
||||
Trace.Add(new TraceEntry(LastRequestKind, (int)response.StatusCode, uri.Query.Length != 0,
|
||||
location is null ? null : Classify(location, "GET"), location?.Query.Length > 0));
|
||||
string content = await response.Content.ReadAsStringAsync(cancellationToken);
|
||||
JsonObject? json = string.Equals(response.Content.Headers.ContentType?.MediaType, "application/json", StringComparison.Ordinal) && content.Length != 0
|
||||
JsonObject? json = response.Content.Headers.ContentType?.MediaType == "application/json" && content.Length != 0
|
||||
? JsonNode.Parse(content)?.AsObject() : null;
|
||||
return new Reply(response.StatusCode, json, response.Headers.Location);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Send one origin-confined request and retain bounded sanitized diagnostics.</summary>
|
||||
internal Task<Reply> SendAsync(string method, string path, JsonObject? body, CancellationToken cancellationToken)
|
||||
=> SendAsync(method, new Uri(_origin, path), body, cancellationToken);
|
||||
|
||||
|
||||
|
||||
/// <summary>Map an endpoint to a fixed label without exposing its path or query.</summary>
|
||||
private static string Classify(Uri uri, string method) => string.Equals(uri.Host, "callback.printing.internal", StringComparison.Ordinal) ? "callback"
|
||||
private static string Classify(Uri uri, string method) => uri.Host == "callback.printing.internal" ? "callback"
|
||||
: uri.AbsolutePath.StartsWith("/application/o/authorize", StringComparison.Ordinal) ? "provider-authorization"
|
||||
: uri.AbsolutePath.StartsWith("/if/flow/", StringComparison.Ordinal) ? "provider-flow-page"
|
||||
: uri.AbsolutePath.StartsWith("/api/v3/flows/executor/", StringComparison.Ordinal) ? "provider-flow-executor-" + method
|
||||
: "fixture-api";
|
||||
|
||||
|
||||
|
||||
/// <summary>Require the expected status and a parsed JSON object.</summary>
|
||||
internal static JsonObject RequireJson(Reply reply, HttpStatusCode expected)
|
||||
{
|
||||
if(reply.Status != expected || reply.Json is null)
|
||||
{
|
||||
throw new InvalidOperationException("Unexpected fixture API status or document shape.");
|
||||
}
|
||||
if(reply.Status != expected || reply.Json is null) { throw new InvalidOperationException("Unexpected fixture API status or document shape."); }
|
||||
return reply.Json;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Dispose the owned HTTP client and handler.</summary>
|
||||
public void Dispose() => _client.Dispose();
|
||||
}
|
||||
@@ -2,15 +2,17 @@
|
||||
Copyright 2026 Kingsrook, LLC
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFramework>net10.0</TargetFramework>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<Reference Include="Qqq.PrintAgent.Core">
|
||||
<HintPath>$(CoreAssemblyPath)</HintPath>
|
||||
</Reference>
|
||||
<Compile Include="../../client/WorkloadDiscovery.cs" Link="WorkloadDiscovery.cs" />
|
||||
</ItemGroup>
|
||||
<PropertyGroup>
|
||||
<OutputType>Exe</OutputType>
|
||||
<TargetFramework>net10.0</TargetFramework>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
<Nullable>enable</Nullable>
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<Reference Include="Qqq.PrintAgent.Core"><HintPath>/core/Qqq.PrintAgent.Core.dll</HintPath></Reference>
|
||||
<Compile Include="../../client/WorkloadDiscovery.cs" Link="WorkloadDiscovery.cs" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -2,12 +2,11 @@
|
||||
* Copyright 2026 Kingsrook, LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
using Printing.Development;
|
||||
|
||||
using Qqq.PrintAgent.Core.Authentication;
|
||||
|
||||
namespace Printing.NativeAuth;
|
||||
|
||||
|
||||
|
||||
/// <summary>Requires the pinned experimental native grant before provider authentication.</summary>
|
||||
internal static class NativeAuthDiscovery
|
||||
{
|
||||
@@ -15,7 +14,7 @@ internal static class NativeAuthDiscovery
|
||||
internal static async Task DiscoverAsync(QqqSessionClient client, CancellationToken token)
|
||||
{
|
||||
QqqApiDiscovery discovery = await WorkloadDiscovery.DiscoverRealtimeAsync(client, token);
|
||||
if(!string.Equals(discovery.ApiVersion, "1.9.0", StringComparison.Ordinal) || !discovery.Features.Contains("nativeSessionLogin", StringComparer.Ordinal))
|
||||
if(discovery.ApiVersion != "1.9.0" || !discovery.Features.Contains("nativeSessionLogin", StringComparer.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("The actual server did not advertise the pinned native-session API.");
|
||||
}
|
||||
|
||||
@@ -2,22 +2,17 @@
|
||||
* Copyright 2026 Kingsrook, LLC
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
using System.Net;
|
||||
using System.Text.Json;
|
||||
using Qqq.PrintAgent.Core.Authentication;
|
||||
|
||||
namespace Printing.NativeAuth;
|
||||
|
||||
|
||||
|
||||
/// <summary>Exercises the real native probe gate against bounded, credential-free HTTP responses.</summary>
|
||||
internal static class NativeAuthDiscoveryChecks
|
||||
{
|
||||
/// <summary>Accepts compatible printing releases while preserving the exact upstream grant requirement.</summary>
|
||||
private static readonly string[] s_channels = ["api"];
|
||||
|
||||
|
||||
|
||||
/// <summary>Check the native grant and compatible extension using fake discovery responses.</summary>
|
||||
internal static async Task RunAsync()
|
||||
{
|
||||
(string PrintingVersion, string ApiVersion, bool NativeGrant, bool Accepted)[] cases =
|
||||
@@ -47,15 +42,12 @@ internal static class NativeAuthDiscoveryChecks
|
||||
}
|
||||
catch(QqqSessionException error) when(error.Failure == QqqSessionException.FailureKind.ConfigurationRequired)
|
||||
{
|
||||
// Expected for incompatible discovery: the case stays rejected and the comparison below judges it.
|
||||
}
|
||||
catch(InvalidDataException)
|
||||
{
|
||||
// Expected for malformed discovery values: the case stays rejected and the comparison below judges it.
|
||||
}
|
||||
catch(InvalidOperationException)
|
||||
{
|
||||
// Expected when native-session discovery is absent: the case stays rejected and judged below.
|
||||
}
|
||||
if(accepted != expected || handler.Requests != 1)
|
||||
{
|
||||
@@ -71,24 +63,15 @@ internal static class NativeAuthDiscoveryChecks
|
||||
private sealed class DiscoveryHandler(string printingVersion, string apiVersion, bool nativeGrant) : HttpMessageHandler
|
||||
{
|
||||
/// <summary>Ensures rejected metadata still traversed the public HTTP discovery boundary.</summary>
|
||||
internal int Requests
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
internal int Requests { get; private set; }
|
||||
|
||||
|
||||
|
||||
/// <summary>Refuses any credential or request outside the public discovery boundary.</summary>
|
||||
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
|
||||
{
|
||||
if(request.Method != HttpMethod.Get
|
||||
|| !string.Equals(request.RequestUri?.AbsoluteUri, "https://printing.example.invalid/qqq/v1/version", StringComparison.Ordinal)
|
||||
|| request.Headers.Contains("Cookie")
|
||||
|| request.Headers.Contains("Authorization")
|
||||
if(request.Method != HttpMethod.Get || request.RequestUri?.AbsoluteUri != "https://printing.example.invalid/qqq/v1/version"
|
||||
|| request.Headers.Contains("Cookie") || request.Headers.Contains("Authorization")
|
||||
|| request.Headers.Contains("X-QQQ-Device-Id") || request.Headers.Contains("X-QQQ-Device-Token"))
|
||||
{
|
||||
throw new InvalidOperationException("Native discovery must precede authentication and device proof.");
|
||||
@@ -101,7 +84,7 @@ internal static class NativeAuthDiscoveryChecks
|
||||
{
|
||||
apiVersion,
|
||||
features,
|
||||
clientChannels = s_channels,
|
||||
clientChannels = new[] { "api" },
|
||||
extensions = new[] { new { name = "printing", version = printingVersion, pathPrefix = "/qbit/printing" } }
|
||||
});
|
||||
return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK) { Content = new StringContent(json) });
|
||||
|
||||
@@ -1,55 +1,26 @@
|
||||
// Copyright 2026 Kingsrook, LLC
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
using System.Net;
|
||||
using System.Security.Authentication;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Nodes;
|
||||
using System.Text.RegularExpressions;
|
||||
using Qqq.PrintAgent.Core.Authentication;
|
||||
|
||||
namespace Printing.NativeAuth;
|
||||
|
||||
|
||||
|
||||
/// <summary>Qualify real provider sessions only in the selected experimental environment.</summary>
|
||||
internal static class Program
|
||||
{
|
||||
private const string CoreSource = "ecf0f550a0357cec6387c2b54efca128a405a629";
|
||||
|
||||
|
||||
|
||||
private const string ClientSource = "346fc285198908c47a2ee9db7b9adb53d5e88c3c";
|
||||
|
||||
|
||||
|
||||
private const string InputPath = "/work/input.json";
|
||||
|
||||
|
||||
|
||||
private const string ResultPath = "/work/result.json";
|
||||
|
||||
|
||||
|
||||
private const string TlsMarker = "/tmp/printing-native-untrusted-tls-passed";
|
||||
private static readonly List<string> Checks = [];
|
||||
private static string _stage = "input";
|
||||
private static bool? _authorizationRequestMatches;
|
||||
|
||||
|
||||
|
||||
private static readonly JsonSerializerOptions s_reportOptions = new() { WriteIndented = true };
|
||||
|
||||
|
||||
|
||||
private static readonly List<string> s_checks = [];
|
||||
|
||||
|
||||
|
||||
private static string s_stage = "input";
|
||||
|
||||
|
||||
|
||||
private static bool? s_authorizationRequestMatches;
|
||||
|
||||
|
||||
|
||||
/// <summary>Validate synthetic input and record bounded evidence without credential output.</summary>
|
||||
public static async Task<int> Main(string[] arguments)
|
||||
{
|
||||
if(arguments is ["--check-discovery"])
|
||||
@@ -61,28 +32,21 @@ internal static class Program
|
||||
try
|
||||
{
|
||||
if(arguments.Length != 1 || arguments[0] is not ("assert-untrusted" or "test"))
|
||||
{
|
||||
throw new InvalidOperationException("An explicit fixture action is required.");
|
||||
}
|
||||
{ throw new InvalidOperationException("An explicit fixture action is required."); }
|
||||
if(new FileInfo(InputPath).Length is <= 0 or > 65536)
|
||||
{
|
||||
throw new InvalidOperationException("Fixture input size is invalid.");
|
||||
}
|
||||
{ throw new InvalidOperationException("Fixture input size is invalid."); }
|
||||
input = JsonNode.Parse(await File.ReadAllTextAsync(InputPath))!.AsObject();
|
||||
ValidateInput(input);
|
||||
using var deadline = new CancellationTokenSource(TimeSpan.FromMinutes(5));
|
||||
if(string.Equals(arguments[0], "assert-untrusted", StringComparison.Ordinal))
|
||||
if(arguments[0] == "assert-untrusted")
|
||||
{
|
||||
s_stage = "untrusted-tls";
|
||||
_stage = "untrusted-tls";
|
||||
await AssertUntrustedAsync(new Uri(ProviderSetup.Text(input, "providerOrigin")), deadline.Token);
|
||||
await File.WriteAllTextAsync(TlsMarker, "passed", deadline.Token);
|
||||
return 0;
|
||||
}
|
||||
if(!File.Exists(TlsMarker))
|
||||
{
|
||||
throw new InvalidOperationException("The ordinary TLS negative control did not run.");
|
||||
}
|
||||
s_checks.Add("untrusted-tls-refused");
|
||||
if(!File.Exists(TlsMarker)) { throw new InvalidOperationException("The ordinary TLS negative control did not run."); }
|
||||
Checks.Add("untrusted-tls-refused");
|
||||
await QualifyAsync(input, deadline.Token);
|
||||
await WriteResultAsync(input, "PASS", null, null);
|
||||
Console.WriteLine("Experimental native Authentik qualification passed; development-only unpublished core.");
|
||||
@@ -93,221 +57,158 @@ internal static class Program
|
||||
// Exception messages, response bodies, callback URLs and credentials are deliberately withheld.
|
||||
await WriteResultAsync(input, "FAILED", exception.GetType().Name,
|
||||
exception is QqqSessionException sessionException ? sessionException.Failure.ToString() : null);
|
||||
Console.Error.WriteLine("Experimental native Authentik qualification failed at " + s_stage + " (" + exception.GetType().Name + ").");
|
||||
Console.Error.WriteLine("Experimental native Authentik qualification failed at " + _stage + " (" + exception.GetType().Name + ").");
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Refuse fixture identities, origins, or source tuples outside the pinned contract.</summary>
|
||||
private static void ValidateInput(JsonObject input)
|
||||
{
|
||||
if(!Regex.IsMatch(ProviderSetup.Text(input, "project"), "^qbit-printing-dev-[a-f0-9]{32}$", RegexOptions.CultureInvariant | RegexOptions.NonBacktracking)
|
||||
|| !string.Equals(ProviderSetup.Text(input, "coreSource"), CoreSource, StringComparison.Ordinal)
|
||||
|| !string.Equals(ProviderSetup.Text(input, "clientSource"), ClientSource, StringComparison.Ordinal)
|
||||
|| !string.Equals(ProviderSetup.Text(input, "providerOrigin"), "https://auth.printing.internal", StringComparison.Ordinal)
|
||||
|| !string.Equals(ProviderSetup.Text(input, "qqqOrigin"), "https://qqq.printing.internal", StringComparison.Ordinal)
|
||||
|| !string.Equals(ProviderSetup.Text(input, "callback"), "https://callback.printing.internal/oauth/callback", StringComparison.Ordinal)
|
||||
|| !string.Equals(ProviderSetup.Text(input, "issuer"), "https://auth.printing.internal/application/o/" + ProviderSetup.Text(input, "project") + "/", StringComparison.Ordinal)
|
||||
|| !string.Equals(ProviderSetup.Text(input, "clientId"), ProviderSetup.Text(input, "project"), StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("Fixture identity or destination differs from the pinned local contract.");
|
||||
}
|
||||
if(!Regex.IsMatch(ProviderSetup.Text(input, "project"), "^qbit-printing-dev-[a-f0-9]{32}$", RegexOptions.CultureInvariant)
|
||||
|| ProviderSetup.Text(input, "coreSource") != CoreSource || ProviderSetup.Text(input, "clientSource") != ClientSource
|
||||
|| ProviderSetup.Text(input, "providerOrigin") != "https://auth.printing.internal"
|
||||
|| ProviderSetup.Text(input, "qqqOrigin") != "https://qqq.printing.internal"
|
||||
|| ProviderSetup.Text(input, "callback") != "https://callback.printing.internal/oauth/callback"
|
||||
|| ProviderSetup.Text(input, "issuer") != "https://auth.printing.internal/application/o/" + ProviderSetup.Text(input, "project") + "/"
|
||||
|| ProviderSetup.Text(input, "clientId") != ProviderSetup.Text(input, "project"))
|
||||
{ throw new InvalidOperationException("Fixture identity or destination differs from the pinned local contract."); }
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Create the production session client with redirects, cookies, and proxies controlled.</summary>
|
||||
private static QqqSessionClient Session(Uri origin) => new(origin,
|
||||
new HttpClientHandler { AllowAutoRedirect = false, UseCookies = false, UseProxy = false });
|
||||
|
||||
|
||||
|
||||
/// <summary>Require TLS to reject the private CA before scoped trust is installed.</summary>
|
||||
private static async Task AssertUntrustedAsync(Uri origin, CancellationToken token)
|
||||
{
|
||||
using var transport = new FixtureHttp(origin);
|
||||
try
|
||||
{
|
||||
await transport.SendAsync("GET", "/-/health/live/", null, token);
|
||||
}
|
||||
try { await transport.SendAsync("GET", "/-/health/live/", null, token); }
|
||||
catch(HttpRequestException exception)
|
||||
{
|
||||
for(Exception? cause = exception; cause is not null; cause = cause.InnerException)
|
||||
{
|
||||
if(cause is AuthenticationException)
|
||||
{
|
||||
return;
|
||||
}
|
||||
if(cause is AuthenticationException) { return; }
|
||||
}
|
||||
throw new InvalidOperationException("The negative TLS control failed for a reason other than certificate authentication.", exception);
|
||||
throw new InvalidOperationException("The negative TLS control failed for a reason other than certificate authentication.");
|
||||
}
|
||||
throw new InvalidOperationException("The test unexpectedly trusted its private CA before scoped installation.");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Exercise real discovery, authorization, origin enforcement, logout, renewal, and revocation.</summary>
|
||||
private static async Task QualifyAsync(JsonObject input, CancellationToken token)
|
||||
{
|
||||
var origin = new Uri(ProviderSetup.Text(input, "qqqOrigin"));
|
||||
var providerOrigin = new Uri(ProviderSetup.Text(input, "providerOrigin"));
|
||||
var callback = new Uri(ProviderSetup.Text(input, "callback"));
|
||||
s_stage = "readiness";
|
||||
_stage = "readiness";
|
||||
await WaitForQqqAsync(origin, token);
|
||||
using var provider = new ProviderSetup(input);
|
||||
s_stage = "provider-readiness";
|
||||
_stage = "provider-readiness";
|
||||
await provider.WaitReadyAsync(token);
|
||||
s_stage = "provider-configuration";
|
||||
_stage = "provider-configuration";
|
||||
await provider.ConfigureAsync(token);
|
||||
using var receiver = new CallbackReceiver(callback);
|
||||
using QqqSessionClient first = Session(origin);
|
||||
s_stage = "typed-native-discovery";
|
||||
using var first = Session(origin);
|
||||
_stage = "typed-native-discovery";
|
||||
await NativeAuthDiscovery.DiscoverAsync(first, token);
|
||||
QqqAuthenticationMetadata metadata = await first.GetAuthenticationMetadataAsync(token);
|
||||
if(!string.Equals(metadata.Values?.ClientId, ProviderSetup.Text(input, "clientId"), StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("Native metadata did not retain the configured client identifier.");
|
||||
}
|
||||
s_checks.Add("typed-native-grant");
|
||||
s_stage = "real-provider-login";
|
||||
if(metadata.Values?.ClientId != ProviderSetup.Text(input, "clientId"))
|
||||
{ throw new InvalidOperationException("Native metadata did not retain the configured client identifier."); }
|
||||
Checks.Add("typed-native-grant");
|
||||
|
||||
_stage = "real-provider-login";
|
||||
await LoginAsync(first, receiver, input, providerOrigin, callback, authorized: true, token);
|
||||
s_stage = "authorized-native-identity";
|
||||
_stage = "authorized-native-identity";
|
||||
QqqSessionBinding identity = await first.GetSessionIdentityAsync(token);
|
||||
if(string.IsNullOrWhiteSpace(identity.PrincipalId) || !string.Equals(identity.TenantId, "printing-native-dev", StringComparison.Ordinal) || identity.DeviceId is not null)
|
||||
{
|
||||
throw new InvalidOperationException("The native subject did not receive the intended server-derived identity.");
|
||||
}
|
||||
s_checks.Add("real-provider-login");
|
||||
s_stage = "wrong-origin-cookie";
|
||||
if(string.IsNullOrWhiteSpace(identity.PrincipalId) || identity.TenantId != "printing-native-dev" || identity.DeviceId is not null)
|
||||
{ throw new InvalidOperationException("The native subject did not receive the intended server-derived identity."); }
|
||||
Checks.Add("real-provider-login");
|
||||
_stage = "wrong-origin-cookie";
|
||||
await AssertWrongOriginAsync(origin, first.ExportCredential(), token);
|
||||
await first.GetSessionIdentityAsync(token);
|
||||
s_checks.Add("wrong-origin-cookie-denied");
|
||||
s_stage = "permission-denied-user";
|
||||
using(QqqSessionClient denied = Session(origin))
|
||||
Checks.Add("wrong-origin-cookie-denied");
|
||||
|
||||
_stage = "permission-denied-user";
|
||||
using(var denied = Session(origin))
|
||||
{
|
||||
await LoginAsync(denied, receiver, input, providerOrigin, callback, authorized: false, token);
|
||||
await ExpectFailureAsync(() => denied.GetSessionIdentityAsync(token), QqqSessionException.FailureKind.PermissionDenied);
|
||||
await denied.SignOutAsync(token);
|
||||
}
|
||||
s_checks.Add("permission-denied-user");
|
||||
await AssertLogoutReplayAsync(first, origin, token);
|
||||
await QualifyRenewalAsync(input, provider, receiver, origin, providerOrigin, callback, token);
|
||||
}
|
||||
Checks.Add("permission-denied-user");
|
||||
|
||||
|
||||
|
||||
/// <summary>Verify that signing out invalidates the exact previously exported native cookie.</summary>
|
||||
private static async Task AssertLogoutReplayAsync(QqqSessionClient first, Uri origin, CancellationToken token)
|
||||
{
|
||||
s_stage = "logout-replay";
|
||||
_stage = "logout-replay";
|
||||
QqqSessionCredential retired = first.ExportCredential();
|
||||
await first.SignOutAsync(token);
|
||||
using(QqqSessionClient replay = Session(origin))
|
||||
{
|
||||
await ExpectFailureAsync(() => replay.RestoreSessionAsync(retired, token), QqqSessionException.FailureKind.AuthenticationRequired);
|
||||
}
|
||||
s_checks.Add("logout-replay-denied");
|
||||
}
|
||||
using(var replay = Session(origin))
|
||||
{ await ExpectFailureAsync(() => replay.RestoreSessionAsync(retired, token), QqqSessionException.FailureKind.AuthenticationRequired); }
|
||||
Checks.Add("logout-replay-denied");
|
||||
|
||||
|
||||
|
||||
/// <summary>Cross real provider expiry and revocation while preserving the authenticated subject.</summary>
|
||||
private static async Task QualifyRenewalAsync(JsonObject input, ProviderSetup provider, CallbackReceiver receiver,
|
||||
Uri origin, Uri providerOrigin, Uri callback, CancellationToken token)
|
||||
{
|
||||
s_stage = "fresh-login-for-renewal";
|
||||
using QqqSessionClient renewable = Session(origin);
|
||||
_stage = "fresh-login-for-renewal";
|
||||
using var renewable = Session(origin);
|
||||
await LoginAsync(renewable, receiver, input, providerOrigin, callback, authorized: true, token);
|
||||
QqqSessionBinding before = await renewable.GetSessionIdentityAsync(token);
|
||||
HashSet<string> previousGrants = await provider.AccessGrantIdsAsync(token);
|
||||
s_stage = "server-refresh-after-expiry";
|
||||
_stage = "server-refresh-after-expiry";
|
||||
await Task.Delay(TimeSpan.FromSeconds(22), token);
|
||||
await renewable.ResumeSessionAsync(token);
|
||||
QqqSessionBinding after = await renewable.GetSessionIdentityAsync(token);
|
||||
HashSet<string> refreshedGrants = await provider.AccessGrantIdsAsync(token);
|
||||
if(before != after || !refreshedGrants.Except(previousGrants, StringComparer.Ordinal).Any())
|
||||
{
|
||||
throw new InvalidOperationException("Renewal did not preserve the identity and obtain a new actual provider grant.");
|
||||
}
|
||||
s_checks.Add("server-refresh-after-expiry");
|
||||
s_stage = "provider-revocation-after-expiry";
|
||||
{ throw new InvalidOperationException("Renewal did not preserve the identity and obtain a new actual provider grant."); }
|
||||
Checks.Add("server-refresh-after-expiry");
|
||||
|
||||
_stage = "provider-revocation-after-expiry";
|
||||
await provider.RevokeRefreshGrantsAsync(token);
|
||||
await Task.Delay(TimeSpan.FromSeconds(22), token);
|
||||
await ExpectFailureAsync(() => renewable.ResumeSessionAsync(token), QqqSessionException.FailureKind.AuthenticationRequired);
|
||||
s_checks.Add("provider-revocation-denied");
|
||||
s_stage = "complete";
|
||||
Checks.Add("provider-revocation-denied");
|
||||
_stage = "complete";
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Use the real PKCE attempt and provider callback without synthesizing identity.</summary>
|
||||
private static async Task LoginAsync(QqqSessionClient client, CallbackReceiver receiver, JsonObject input,
|
||||
Uri providerOrigin, Uri callback, bool authorized, CancellationToken token)
|
||||
{
|
||||
string role = authorized ? "authorized" : "denied";
|
||||
s_stage = role + "-begin-pkce";
|
||||
_stage = role + "-begin-pkce";
|
||||
QqqBrowserLogin attempt = await client.BeginBrowserLoginAsync(callback, token);
|
||||
s_stage = role + "-generated-authorization-request";
|
||||
var parameters = attempt.AuthorizationUri.Query.TrimStart('?').Split('&')
|
||||
_stage = role + "-generated-authorization-request";
|
||||
Dictionary<string, string> parameters = attempt.AuthorizationUri.Query.TrimStart('?').Split('&')
|
||||
.Select(entry => entry.Split('=', 2)).ToDictionary(pair => Uri.UnescapeDataString(pair[0]), pair => Uri.UnescapeDataString(pair[1]), StringComparer.Ordinal);
|
||||
s_authorizationRequestMatches = string.Equals(attempt.AuthorizationUri.AbsolutePath, "/application/o/authorize/", StringComparison.Ordinal)
|
||||
&& string.Equals(parameters.GetValueOrDefault("client_id"), ProviderSetup.Text(input, "clientId"), StringComparison.Ordinal)
|
||||
&& string.Equals(parameters.GetValueOrDefault("redirect_uri"), callback.AbsoluteUri, StringComparison.Ordinal)
|
||||
&& string.Equals(parameters.GetValueOrDefault("response_type"), "code", StringComparison.Ordinal)
|
||||
&& string.Equals(parameters.GetValueOrDefault("code_challenge_method"), "S256", StringComparison.Ordinal)
|
||||
_authorizationRequestMatches = attempt.AuthorizationUri.AbsolutePath == "/application/o/authorize/"
|
||||
&& parameters.GetValueOrDefault("client_id") == ProviderSetup.Text(input, "clientId")
|
||||
&& parameters.GetValueOrDefault("redirect_uri") == callback.AbsoluteUri
|
||||
&& parameters.GetValueOrDefault("response_type") == "code"
|
||||
&& parameters.GetValueOrDefault("code_challenge_method") == "S256"
|
||||
&& parameters.GetValueOrDefault("state")?.Length == 43;
|
||||
if(s_authorizationRequestMatches != true)
|
||||
{
|
||||
throw new InvalidOperationException("The generated authorization request differs from the exact provider registration.");
|
||||
}
|
||||
s_stage = role + "-provider-flow";
|
||||
if(_authorizationRequestMatches != true)
|
||||
{ throw new InvalidOperationException("The generated authorization request differs from the exact provider registration."); }
|
||||
_stage = role + "-provider-flow";
|
||||
await ProviderFlow.AuthenticateAsync(attempt.AuthorizationUri, providerOrigin, callback,
|
||||
ProviderSetup.Text(input, role + "Username"), ProviderSetup.Text(input, role + "Password"), token);
|
||||
s_stage = role + "-callback";
|
||||
_stage = role + "-callback";
|
||||
Uri actualCallback = await receiver.ReadAsync(token);
|
||||
s_stage = role + "-exchange";
|
||||
_stage = role + "-exchange";
|
||||
await client.CompleteBrowserLoginAsync(attempt, actualCallback, token);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Require the precise native authentication or permission failure.</summary>
|
||||
private static async Task ExpectFailureAsync(Func<Task> operation, QqqSessionException.FailureKind expected)
|
||||
{
|
||||
try
|
||||
{
|
||||
await operation();
|
||||
}
|
||||
try { await operation(); }
|
||||
catch(QqqSessionException exception) when(exception.Failure == expected) { return; }
|
||||
throw new InvalidOperationException("The expected native authentication or permission denial did not occur.");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Verify the authenticated native boundary rejects a foreign Origin.</summary>
|
||||
private static async Task AssertWrongOriginAsync(Uri origin, QqqSessionCredential credential, CancellationToken token)
|
||||
{
|
||||
using var http = new HttpClient(new HttpClientHandler { AllowAutoRedirect = false, UseCookies = false, UseProxy = false })
|
||||
{
|
||||
Timeout = TimeSpan.FromSeconds(15),
|
||||
MaxResponseContentBufferSize = 65536
|
||||
};
|
||||
{ Timeout = TimeSpan.FromSeconds(15), MaxResponseContentBufferSize = 65536 };
|
||||
using var request = new HttpRequestMessage(HttpMethod.Get, new Uri(origin, "/qqq/v1/qbit/printing/session"));
|
||||
request.Headers.Add("X-QQQ-Client", QqqSessionClient.ClientChannel);
|
||||
request.Headers.Add("Cookie", "sessionUUID=" + credential.SessionToken);
|
||||
request.Headers.Add("Origin", "https://wrong-origin.invalid");
|
||||
using HttpResponseMessage response = await http.SendAsync(request, token);
|
||||
if(response.StatusCode != HttpStatusCode.Forbidden)
|
||||
{
|
||||
throw new InvalidOperationException("The fixture did not reject a wrong-Origin cookie request.");
|
||||
}
|
||||
{ throw new InvalidOperationException("The fixture did not reject a wrong-Origin cookie request."); }
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Bound startup readiness reads to the owned QQQ host.</summary>
|
||||
private static async Task WaitForQqqAsync(Uri origin, CancellationToken token)
|
||||
{
|
||||
using var http = new FixtureHttp(origin);
|
||||
@@ -316,45 +217,25 @@ internal static class Program
|
||||
try
|
||||
{
|
||||
FixtureHttp.Reply response = await http.SendAsync("GET", "/qqq/v1/version", null, token);
|
||||
if(response.Status == HttpStatusCode.OK && response.Json is not null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
}
|
||||
catch(HttpRequestException)
|
||||
{
|
||||
// The owned host is still starting; the bounded attempt loop retries and then fails explicitly.
|
||||
if(response.Status == HttpStatusCode.OK && response.Json is not null) { return; }
|
||||
}
|
||||
catch(HttpRequestException) { }
|
||||
await Task.Delay(TimeSpan.FromSeconds(2), token);
|
||||
}
|
||||
throw new InvalidOperationException("The owned native host did not become ready.");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Write only allowlisted classifications and results to the private report.</summary>
|
||||
private static Task WriteResultAsync(JsonObject? input, string status, string? failureType, string? sessionFailure)
|
||||
=> File.WriteAllTextAsync(ResultPath, JsonSerializer.Serialize(new
|
||||
{
|
||||
status,
|
||||
scope = "DEVELOPMENT_ONLY_UNRELEASED",
|
||||
coreSource = CoreSource,
|
||||
clientSource = ClientSource,
|
||||
project = input?["project"]?.ToString(),
|
||||
observedUtc = DateTimeOffset.UtcNow,
|
||||
stage = s_stage,
|
||||
failureType,
|
||||
sessionFailure,
|
||||
lastRequestKind = FixtureHttp.LastRequestKind,
|
||||
lastHttpStatus = FixtureHttp.LastStatus,
|
||||
status, scope = "DEVELOPMENT_ONLY_UNRELEASED", coreSource = CoreSource, clientSource = ClientSource,
|
||||
project = input?["project"]?.ToString(), observedUtc = DateTimeOffset.UtcNow, stage = _stage, failureType,
|
||||
sessionFailure, lastRequestKind = FixtureHttp.LastRequestKind, lastHttpStatus = FixtureHttp.LastStatus,
|
||||
lastProviderComponent = ProviderFlow.LastComponent,
|
||||
authorizationRequestMatches = s_authorizationRequestMatches,
|
||||
authorizationRequestMatches = _authorizationRequestMatches,
|
||||
requestClassifications = FixtureHttp.Trace,
|
||||
providerLookupKind = ProviderSetup.LastLookupKind,
|
||||
providerLookupCount = ProviderSetup.LastLookupCount,
|
||||
providerLookupKind = ProviderSetup.LastLookupKind, providerLookupCount = ProviderSetup.LastLookupCount,
|
||||
providerReadinessCounts = ProviderSetup.ReadinessCounts,
|
||||
checks = s_checks,
|
||||
installedUiAcceptance = false,
|
||||
providerRefreshTokensInClient = false,
|
||||
}, s_reportOptions));
|
||||
checks = Checks, installedUiAcceptance = false, providerRefreshTokensInClient = false,
|
||||
}, new JsonSerializerOptions { WriteIndented = true }));
|
||||
}
|
||||
@@ -1,26 +1,15 @@
|
||||
// Copyright 2026 Kingsrook, LLC
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
using System.Net;
|
||||
using System.Text.Json.Nodes;
|
||||
|
||||
namespace Printing.NativeAuth;
|
||||
|
||||
|
||||
|
||||
/// <summary>Uses Authentik's real synthetic-user login stages; never fabricates a session or code.</summary>
|
||||
internal static class ProviderFlow
|
||||
{
|
||||
internal static string? LastComponent
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Follow bounded provider navigation while confining redirects to fixture origins.</summary>
|
||||
internal static string? LastComponent { get; private set; }
|
||||
internal static async Task AuthenticateAsync(Uri authorization, Uri origin, Uri callback, string username, string password, CancellationToken token)
|
||||
{
|
||||
using var browser = new FixtureHttp(origin, cookies: true);
|
||||
@@ -28,23 +17,15 @@ internal static class ProviderFlow
|
||||
Uri next = authorization;
|
||||
for(int hop = 0; hop < 24; hop++)
|
||||
{
|
||||
if(string.Equals(next.GetLeftPart(UriPartial.Authority), callback.GetLeftPart(UriPartial.Authority), StringComparison.Ordinal))
|
||||
if(next.GetLeftPart(UriPartial.Authority) == callback.GetLeftPart(UriPartial.Authority))
|
||||
{
|
||||
if(!string.Equals(next.AbsolutePath, callback.AbsolutePath, StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("Unexpected callback path.");
|
||||
}
|
||||
if(next.AbsolutePath != callback.AbsolutePath) { throw new InvalidOperationException("Unexpected callback path."); }
|
||||
FixtureHttp.Reply result = await callbackHttp.SendAsync("GET", next, null, token);
|
||||
if(result.Status != HttpStatusCode.OK)
|
||||
{
|
||||
throw new InvalidOperationException("The HTTPS callback receiver refused the provider redirect.");
|
||||
}
|
||||
if(result.Status != HttpStatusCode.OK) { throw new InvalidOperationException("The HTTPS callback receiver refused the provider redirect."); }
|
||||
return;
|
||||
}
|
||||
if(!string.Equals(next.GetLeftPart(UriPartial.Authority), origin.GetLeftPart(UriPartial.Authority), StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("A provider redirect left the fixture.");
|
||||
}
|
||||
if(next.GetLeftPart(UriPartial.Authority) != origin.GetLeftPart(UriPartial.Authority))
|
||||
{ throw new InvalidOperationException("A provider redirect left the fixture."); }
|
||||
FixtureHttp.Reply page = await browser.SendAsync("GET", next, null, token);
|
||||
if(page.Status is HttpStatusCode.Redirect or HttpStatusCode.SeeOther or HttpStatusCode.TemporaryRedirect)
|
||||
{
|
||||
@@ -52,82 +33,61 @@ internal static class ProviderFlow
|
||||
continue;
|
||||
}
|
||||
if(page.Status != HttpStatusCode.OK || !next.AbsolutePath.StartsWith("/if/flow/", StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("Unexpected provider login navigation.");
|
||||
}
|
||||
{ throw new InvalidOperationException("Unexpected provider login navigation."); }
|
||||
string slug = next.AbsolutePath["/if/flow/".Length..].Trim('/');
|
||||
if(slug.Length == 0 || slug.Any(character => !char.IsAsciiLetterOrDigit(character) && character != '-'))
|
||||
{
|
||||
throw new InvalidOperationException("Unexpected provider flow identifier.");
|
||||
}
|
||||
{ throw new InvalidOperationException("Unexpected provider flow identifier."); }
|
||||
var executor = new Uri(origin, "/api/v3/flows/executor/" + slug + "/?query=" + Uri.EscapeDataString(next.Query.TrimStart('?')));
|
||||
next = await CompleteStagesAsync(browser, executor, origin, username, password, token);
|
||||
JsonObject challenge = await ChallengeAsync(browser, executor, await browser.SendAsync("GET", executor, null, token), token);
|
||||
bool redirected = false;
|
||||
for(int stage = 0; stage < 10; stage++)
|
||||
{
|
||||
string component = ProviderSetup.Text(challenge, "component");
|
||||
LastComponent = component switch
|
||||
{
|
||||
"ak-stage-identification" => "identification",
|
||||
"ak-stage-password" => "password",
|
||||
"ak-stage-consent" => "consent",
|
||||
"xak-flow-redirect" => "redirect",
|
||||
"ak-stage-access-denied" => "access-denied",
|
||||
"ak-stage-flow-error" => "flow-error",
|
||||
_ => "unsupported",
|
||||
};
|
||||
if(component == "xak-flow-redirect")
|
||||
{
|
||||
next = new Uri(origin, ProviderSetup.Text(challenge, "to"));
|
||||
redirected = true;
|
||||
break;
|
||||
}
|
||||
JsonObject response = component switch
|
||||
{
|
||||
"ak-stage-identification" => new JsonObject { ["component"] = component, ["uid_field"] = username },
|
||||
"ak-stage-password" => new JsonObject { ["component"] = component, ["password"] = password },
|
||||
"ak-stage-consent" => new JsonObject { ["component"] = component, ["consent"] = true },
|
||||
_ => throw new InvalidOperationException("The provider requested an unsupported test login stage."),
|
||||
};
|
||||
challenge = await ChallengeAsync(browser, executor, await browser.SendAsync("POST", executor, response, token), token);
|
||||
if(challenge["response_errors"] is JsonObject errors && errors.Count != 0)
|
||||
{ throw new InvalidOperationException("The real provider rejected the synthetic login response."); }
|
||||
}
|
||||
if(!redirected) { throw new InvalidOperationException("Provider stage bound exceeded."); }
|
||||
}
|
||||
throw new InvalidOperationException("Provider redirect bound exceeded.");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Answer at most ten real provider challenges and return its declared redirect.</summary>
|
||||
private static async Task<Uri> CompleteStagesAsync(FixtureHttp browser, Uri executor, Uri origin, string username, string password, CancellationToken token)
|
||||
{
|
||||
JsonObject challenge = await ChallengeAsync(browser, executor, await browser.SendAsync("GET", executor, null, token), token);
|
||||
for(int stage = 0; stage < 10; stage++)
|
||||
{
|
||||
string component = ProviderSetup.Text(challenge, "component");
|
||||
LastComponent = component switch
|
||||
{
|
||||
"ak-stage-identification" => "identification",
|
||||
"ak-stage-password" => "password",
|
||||
"ak-stage-consent" => "consent",
|
||||
"xak-flow-redirect" => "redirect",
|
||||
"ak-stage-access-denied" => "access-denied",
|
||||
"ak-stage-flow-error" => "flow-error",
|
||||
_ => "unsupported",
|
||||
};
|
||||
if(string.Equals(component, "xak-flow-redirect", StringComparison.Ordinal))
|
||||
{
|
||||
return new Uri(origin, ProviderSetup.Text(challenge, "to"));
|
||||
}
|
||||
JsonObject response = component switch
|
||||
{
|
||||
"ak-stage-identification" => new JsonObject { ["component"] = component, ["uid_field"] = username },
|
||||
"ak-stage-password" => new JsonObject { ["component"] = component, ["password"] = password },
|
||||
"ak-stage-consent" => new JsonObject { ["component"] = component, ["consent"] = true },
|
||||
_ => throw new InvalidOperationException("The provider requested an unsupported test login stage."),
|
||||
};
|
||||
challenge = await ChallengeAsync(browser, executor, await browser.SendAsync("POST", executor, response, token), token);
|
||||
if(challenge["response_errors"] is JsonObject errors && errors.Count != 0)
|
||||
{
|
||||
throw new InvalidOperationException("The real provider rejected the synthetic login response.");
|
||||
}
|
||||
}
|
||||
throw new InvalidOperationException("Provider stage bound exceeded.");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Follow only same-executor POST/redirect/GET responses and require a JSON challenge.</summary>
|
||||
private static async Task<JsonObject> ChallengeAsync(FixtureHttp browser, Uri executor, FixtureHttp.Reply response, CancellationToken token)
|
||||
{
|
||||
// Authentik uses POST/redirect/GET when a real stage accepts its answer.
|
||||
// Follow only that same HTTPS executor; other navigation uses typed flow redirects.
|
||||
for(int redirect = 0; redirect < 8; redirect++)
|
||||
{
|
||||
if(response.Status == HttpStatusCode.OK)
|
||||
{
|
||||
return FixtureHttp.RequireJson(response, HttpStatusCode.OK);
|
||||
}
|
||||
if(response.Status == HttpStatusCode.OK) { return FixtureHttp.RequireJson(response, HttpStatusCode.OK); }
|
||||
if(response.Status is not (HttpStatusCode.Redirect or HttpStatusCode.SeeOther) || response.Location is null)
|
||||
{
|
||||
throw new InvalidOperationException("Unexpected provider stage response.");
|
||||
}
|
||||
{ throw new InvalidOperationException("Unexpected provider stage response."); }
|
||||
var location = new Uri(executor, response.Location);
|
||||
if(!string.Equals(location.GetLeftPart(UriPartial.Authority), executor.GetLeftPart(UriPartial.Authority), StringComparison.Ordinal)
|
||||
|| !string.Equals(location.AbsolutePath, executor.AbsolutePath, StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("A stage redirect left its exact HTTPS executor.");
|
||||
}
|
||||
if(location.GetLeftPart(UriPartial.Authority) != executor.GetLeftPart(UriPartial.Authority)
|
||||
|| location.AbsolutePath != executor.AbsolutePath)
|
||||
{ throw new InvalidOperationException("A stage redirect left its exact HTTPS executor."); }
|
||||
response = await browser.SendAsync("GET", location, null, token);
|
||||
}
|
||||
throw new InvalidOperationException("Provider stage redirect bound exceeded.");
|
||||
|
||||
@@ -1,93 +1,43 @@
|
||||
// Copyright 2026 Kingsrook, LLC
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
using System.Net;
|
||||
using System.Text.Json.Nodes;
|
||||
|
||||
namespace Printing.NativeAuth;
|
||||
|
||||
|
||||
|
||||
/// <summary>Configures only the fresh project's synthetic provider and subjects.</summary>
|
||||
internal sealed class ProviderSetup : IDisposable
|
||||
{
|
||||
internal static string? LastLookupKind
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
internal static int? LastLookupCount
|
||||
{
|
||||
get;
|
||||
|
||||
|
||||
|
||||
private set;
|
||||
}
|
||||
|
||||
|
||||
|
||||
internal static string? LastLookupKind { get; private set; }
|
||||
internal static int? LastLookupCount { get; private set; }
|
||||
internal static Dictionary<string, int> ReadinessCounts { get; } = new(StringComparer.Ordinal);
|
||||
|
||||
|
||||
|
||||
private readonly JsonObject _input;
|
||||
|
||||
|
||||
|
||||
private readonly FixtureHttp _admin;
|
||||
|
||||
|
||||
|
||||
private string _provider = "";
|
||||
|
||||
|
||||
|
||||
private string _authorizedUser = "";
|
||||
|
||||
|
||||
|
||||
/// <summary>Use the private bootstrap token only with the configured provider origin.</summary>
|
||||
internal ProviderSetup(JsonObject input)
|
||||
{
|
||||
_input = input;
|
||||
_admin = new FixtureHttp(new Uri(Text(input, "providerOrigin")), adminToken: Text(input, "adminToken"));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Read required synthetic input without disclosing its value in failures.</summary>
|
||||
internal static string Text(JsonObject document, string key) => document[key]?.ToString() ?? throw new InvalidOperationException("Required fixture field is absent.");
|
||||
|
||||
|
||||
|
||||
/// <summary>Require one provider metadata object and retain only its lookup classification.</summary>
|
||||
private async Task<JsonObject> ExactAsync(string path, CancellationToken token)
|
||||
{
|
||||
JsonObject page = FixtureHttp.RequireJson(await _admin.SendAsync("GET", path, null, token), HttpStatusCode.OK);
|
||||
JsonArray records = page["results"]!.AsArray();
|
||||
LastLookupKind = LookupKind(path);
|
||||
LastLookupCount = records.Count;
|
||||
if(records.Count != 1)
|
||||
{
|
||||
throw new InvalidOperationException("Required provider object is absent or ambiguous.");
|
||||
}
|
||||
if(records.Count != 1) { throw new InvalidOperationException("Required provider object is absent or ambiguous."); }
|
||||
return records[0]!.AsObject();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Create one synthetic object and require its successful JSON response.</summary>
|
||||
private async Task<JsonObject> CreateAsync(string path, JsonObject body, CancellationToken token)
|
||||
=> FixtureHttp.RequireJson(await _admin.SendAsync("POST", path, body, token), HttpStatusCode.Created);
|
||||
|
||||
|
||||
|
||||
/// <summary>Wait for complete default flows and scopes before configuring the provider.</summary>
|
||||
internal async Task WaitReadyAsync(CancellationToken token)
|
||||
{
|
||||
string[] paths = ["/api/v3/flows/instances/?slug=default-authentication-flow",
|
||||
@@ -108,34 +58,20 @@ internal sealed class ProviderSetup : IDisposable
|
||||
JsonArray? records = reply.Status == HttpStatusCode.OK ? reply.Json?["results"] as JsonArray : null;
|
||||
string kind = LookupKind(path);
|
||||
ReadinessCounts[kind] = records?.Count ?? -1;
|
||||
if(records?.Count > 1)
|
||||
{
|
||||
throw new InvalidOperationException("An owned provider bootstrap dependency is ambiguous.");
|
||||
}
|
||||
if(records?.Count > 1) { throw new InvalidOperationException("An owned provider bootstrap dependency is ambiguous."); }
|
||||
bool present = records is { Count: 1 };
|
||||
if(string.Equals(kind, "authentication-flow", StringComparison.Ordinal))
|
||||
{
|
||||
present &= records is { Count: 1 } && records[0]?["stages"] is JsonArray { Count: >= 4 };
|
||||
}
|
||||
if(kind == "authentication-flow")
|
||||
{ present &= records is { Count: 1 } && records[0]?["stages"] is JsonArray { Count: >= 4 }; }
|
||||
ready &= present;
|
||||
}
|
||||
if(ready)
|
||||
{
|
||||
return;
|
||||
}
|
||||
}
|
||||
catch(HttpRequestException)
|
||||
{
|
||||
// The owned provider is still starting; the bounded attempt loop retries and then fails explicitly.
|
||||
if(ready) { return; }
|
||||
}
|
||||
catch(HttpRequestException) { }
|
||||
await Task.Delay(TimeSpan.FromSeconds(2), token);
|
||||
}
|
||||
throw new InvalidOperationException("The owned provider bootstrap did not become ready.");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Classify prerequisite lookups using fixed diagnostic names.</summary>
|
||||
private static string LookupKind(string path) => path switch
|
||||
{
|
||||
"/api/v3/flows/instances/?slug=default-authentication-flow" => "authentication-flow",
|
||||
@@ -148,9 +84,6 @@ internal sealed class ProviderSetup : IDisposable
|
||||
_ => "other",
|
||||
};
|
||||
|
||||
|
||||
|
||||
/// <summary>Register the synthetic OAuth provider and authorized and denied users.</summary>
|
||||
internal async Task ConfigureAsync(CancellationToken token)
|
||||
{
|
||||
JsonObject authentication = await ExactAsync("/api/v3/flows/instances/?slug=default-authentication-flow", token);
|
||||
@@ -192,97 +125,60 @@ internal sealed class ProviderSetup : IDisposable
|
||||
["include_claims_in_id_token"] = true,
|
||||
}, token);
|
||||
_provider = Text(provider, "pk");
|
||||
if(!string.Equals(Text(provider, "client_id"), Text(_input, "clientId"), StringComparison.Ordinal) || !string.Equals(Text(provider, "authentication_flow"), Text(authentication, "pk"), StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("The real provider did not retain the configured client identifier.");
|
||||
}
|
||||
if(Text(provider, "client_id") != Text(_input, "clientId")
|
||||
|| Text(provider, "authentication_flow") != Text(authentication, "pk"))
|
||||
{ throw new InvalidOperationException("The real provider did not retain the configured client identifier."); }
|
||||
JsonObject application = await CreateAsync("/api/v3/core/applications/", new JsonObject
|
||||
{
|
||||
["name"] = Text(_input, "project"),
|
||||
["slug"] = Text(_input, "project"),
|
||||
["provider"] = provider["pk"]!.DeepClone(),
|
||||
["policy_engine_mode"] = "all",
|
||||
["name"] = Text(_input, "project"), ["slug"] = Text(_input, "project"),
|
||||
["provider"] = provider["pk"]!.DeepClone(), ["policy_engine_mode"] = "all",
|
||||
}, token);
|
||||
if(!string.Equals(Text(application, "provider"), _provider, StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("The real provider application binding differs from the configured provider.");
|
||||
}
|
||||
if(Text(application, "provider") != _provider)
|
||||
{ throw new InvalidOperationException("The real provider application binding differs from the configured provider."); }
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Create a synthetic user with configured groups and its private password.</summary>
|
||||
private async Task<JsonObject> CreateUserAsync(string usernameKey, string passwordKey, JsonArray groups, CancellationToken token)
|
||||
{
|
||||
JsonObject user = await CreateAsync("/api/v3/core/users/", new JsonObject
|
||||
{
|
||||
["username"] = Text(_input, usernameKey),
|
||||
["name"] = "Synthetic native qualification subject",
|
||||
["email"] = Text(_input, usernameKey) + "@example.invalid",
|
||||
["is_active"] = true,
|
||||
["type"] = "internal",
|
||||
["groups"] = groups,
|
||||
["username"] = Text(_input, usernameKey), ["name"] = "Synthetic native qualification subject",
|
||||
["email"] = Text(_input, usernameKey) + "@example.invalid", ["is_active"] = true,
|
||||
["type"] = "internal", ["groups"] = groups,
|
||||
}, token);
|
||||
FixtureHttp.Reply response = await _admin.SendAsync("POST", "/api/v3/core/users/" + Text(user, "pk") + "/set_password/",
|
||||
new JsonObject { ["password"] = Text(_input, passwordKey) }, token);
|
||||
if(response.Status != HttpStatusCode.NoContent)
|
||||
{
|
||||
throw new InvalidOperationException("Synthetic account password configuration failed.");
|
||||
}
|
||||
if(response.Status != HttpStatusCode.NoContent) { throw new InvalidOperationException("Synthetic account password configuration failed."); }
|
||||
return user;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Read bounded provider token metadata scoped to this synthetic application.</summary>
|
||||
private async Task<JsonArray> GrantsAsync(string kind, CancellationToken token)
|
||||
{
|
||||
JsonObject page = FixtureHttp.RequireJson(await _admin.SendAsync("GET", "/api/v3/oauth2/" + kind + "/?provider=" + _provider + "&user=" + _authorizedUser, null, token), HttpStatusCode.OK);
|
||||
JsonArray records = page["results"]!.AsArray();
|
||||
if(records.Count is 0 or > 20)
|
||||
{
|
||||
throw new InvalidOperationException("The synthetic provider grant set is missing or unexpectedly large.");
|
||||
}
|
||||
if(records.Count is 0 or > 20) { throw new InvalidOperationException("The synthetic provider grant set is missing or unexpectedly large."); }
|
||||
foreach(JsonNode? node in records)
|
||||
{
|
||||
JsonObject record = node!.AsObject();
|
||||
string provider = record["provider"] is JsonObject nested ? Text(nested, "pk") : Text(record, "provider");
|
||||
if(!string.Equals(provider, _provider, StringComparison.Ordinal) || !string.Equals(Text(record["user"]!.AsObject(), "pk"), _authorizedUser, StringComparison.Ordinal))
|
||||
{
|
||||
throw new InvalidOperationException("The provider grant escaped the synthetic subject scope.");
|
||||
}
|
||||
if(provider != _provider || Text(record["user"]!.AsObject(), "pk") != _authorizedUser)
|
||||
{ throw new InvalidOperationException("The provider grant escaped the synthetic subject scope."); }
|
||||
}
|
||||
return records;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Snapshot actual access-grant identities for the renewal assertion.</summary>
|
||||
internal async Task<HashSet<string>> AccessGrantIdsAsync(CancellationToken token)
|
||||
=> (await GrantsAsync("access_tokens", token)).Select(node => Text(node!.AsObject(), "pk")).ToHashSet(StringComparer.Ordinal);
|
||||
|
||||
|
||||
|
||||
/// <summary>Revoke only refresh grants belonging to the owned synthetic provider.</summary>
|
||||
internal async Task RevokeRefreshGrantsAsync(CancellationToken token)
|
||||
{
|
||||
foreach(JsonNode? node in await GrantsAsync("refresh_tokens", token))
|
||||
{
|
||||
string id = Text(node!.AsObject(), "pk");
|
||||
if(!Guid.TryParse(id, out _) && !long.TryParse(id, System.Globalization.CultureInfo.InvariantCulture, out _))
|
||||
{
|
||||
throw new InvalidOperationException("Unexpected provider grant identifier.");
|
||||
}
|
||||
if(!Guid.TryParse(id, out _) && !long.TryParse(id, out _)) { throw new InvalidOperationException("Unexpected provider grant identifier."); }
|
||||
FixtureHttp.Reply response = await _admin.SendAsync("DELETE", "/api/v3/oauth2/refresh_tokens/" + id + "/", null, token);
|
||||
if(response.Status != HttpStatusCode.NoContent)
|
||||
{
|
||||
throw new InvalidOperationException("Synthetic provider revocation failed.");
|
||||
}
|
||||
if(response.Status != HttpStatusCode.NoContent) { throw new InvalidOperationException("Synthetic provider revocation failed."); }
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>Dispose the private provider administration transport.</summary>
|
||||
public void Dispose() => _admin.Dispose();
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"version": 2,
|
||||
"dependencies": {
|
||||
"net10.0": {
|
||||
"Meziantou.Analyzer": {
|
||||
"type": "Direct",
|
||||
"requested": "[3.0.296, )",
|
||||
"resolved": "3.0.296",
|
||||
"contentHash": "1Yp/6OK/Ev66hE2YLe9UvIgtJrKOX/xvoGDe0UbdtuG2ZxUoDoyONdEn+HWCDuy02Mu8SmglHEd/9SGPrM1qYg=="
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -19,10 +19,8 @@
|
||||
*/
|
||||
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package com.kingsrook.qbits.printing;
|
||||
|
||||
|
||||
import java.net.URI;
|
||||
import java.sql.Connection;
|
||||
import java.util.List;
|
||||
@@ -56,28 +54,22 @@ import io.javalin.http.ForbiddenResponse;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONObject;
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Opt-in container fixture for the pinned upstream native-session candidate.
|
||||
** Standard OAuth2 code exchange, session storage and encrypted renewal are used
|
||||
** unchanged. No installed pairing, password authentication double or printer.
|
||||
***************************************************************************/
|
||||
/**
|
||||
* Opt-in container fixture for the pinned upstream native-session candidate.
|
||||
* Standard OAuth2 code exchange, session storage and encrypted renewal are used
|
||||
* unchanged. No installed pairing, password authentication double or printer.
|
||||
*/
|
||||
public final class NativeAuthHost extends AbstractQQQApplication
|
||||
{
|
||||
private static final String TENANT = "printing-native-dev";
|
||||
private final String backendName = "printing-native-auth-" + UUID.randomUUID();
|
||||
private final String jdbcUrl = "jdbc:h2:file:/data/printing-native-auth";
|
||||
private final String databasePassword = required("NATIVE_QQQ_DATABASE_PASSWORD");
|
||||
private final URI origin = httpsOrigin(required("NATIVE_QQQ_ORIGIN"));
|
||||
private final int port = Integer.parseInt(required("NATIVE_QQQ_PORT"));
|
||||
private final DriverDataSource source = new DriverDataSource(jdbcUrl, "sa", databasePassword);
|
||||
private final PrintingService service = new PrintingService(source, TENANT);
|
||||
private static final String TENANT = "printing-native-dev";
|
||||
private final String backendName = "printing-native-auth-" + UUID.randomUUID();
|
||||
private final String jdbcUrl = "jdbc:h2:file:/data/printing-native-auth";
|
||||
private final String databasePassword = required("NATIVE_QQQ_DATABASE_PASSWORD");
|
||||
private final URI origin = httpsOrigin(required("NATIVE_QQQ_ORIGIN"));
|
||||
private final int port = Integer.parseInt(required("NATIVE_QQQ_PORT"));
|
||||
private final DriverDataSource source = new DriverDataSource(jdbcUrl, "sa", databasePassword);
|
||||
private final PrintingService service = new PrintingService(source, TENANT);
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Initialize only the private fixture database and native session tables.
|
||||
***************************************************************************/
|
||||
private NativeAuthHost() throws Exception
|
||||
{
|
||||
if(port < 1024 || port > 65535)
|
||||
@@ -93,11 +85,6 @@ public final class NativeAuthHost extends AbstractQQQApplication
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Launch the experimental provider host inside its owned container network.
|
||||
***************************************************************************/
|
||||
public static void main(String[] args) throws Exception
|
||||
{
|
||||
NativeAuthHost host = new NativeAuthHost();
|
||||
@@ -105,11 +92,6 @@ public final class NativeAuthHost extends AbstractQQQApplication
|
||||
.withServerCustomizer(host::configure));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Define the private fixture backend, native OAuth2 provider and printing QBit.
|
||||
***************************************************************************/
|
||||
@Override
|
||||
public QInstance defineQInstance() throws QException
|
||||
{
|
||||
@@ -123,8 +105,8 @@ public final class NativeAuthHost extends AbstractQQQApplication
|
||||
instance.addTable(new RedirectStateMetaDataProducer(backendName).produce(instance));
|
||||
instance.addTable(new UserSessionRefreshTokenMetaDataProducer(backendName).produce(instance));
|
||||
|
||||
String issuer = required("NATIVE_AUTH_ISSUER");
|
||||
URI issuerUri = URI.create(issuer);
|
||||
String issuer = required("NATIVE_AUTH_ISSUER");
|
||||
URI issuerUri = URI.create(issuer);
|
||||
if(!"https".equals(issuerUri.getScheme()) || issuerUri.getHost() == null
|
||||
|| issuerUri.getRawUserInfo() != null || issuerUri.getRawQuery() != null || issuerUri.getRawFragment() != null || !issuer.endsWith("/"))
|
||||
{
|
||||
@@ -160,11 +142,6 @@ public final class NativeAuthHost extends AbstractQQQApplication
|
||||
return instance;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Register printing routes behind the fixture TLS proxy.
|
||||
***************************************************************************/
|
||||
private void configure(QApplicationJavalinServer server)
|
||||
{
|
||||
// Only the owned TLS proxy is published; this HTTP listener remains inside
|
||||
@@ -179,11 +156,6 @@ public final class NativeAuthHost extends AbstractQQQApplication
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Require the configured HTTPS proxy and same-origin cookie mutations.
|
||||
***************************************************************************/
|
||||
private void guardOrigin(Context context)
|
||||
{
|
||||
if(!origin.getRawAuthority().equalsIgnoreCase(context.header("Host"))
|
||||
@@ -209,16 +181,9 @@ public final class NativeAuthHost extends AbstractQQQApplication
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Only maps claims after the unchanged standard OAuth2 module authenticates.
|
||||
***************************************************************************/
|
||||
/** Only maps claims after the unchanged standard OAuth2 module authenticates. */
|
||||
public static final class PrintingPermissions implements QAuthenticationModuleCustomizerInterface
|
||||
{
|
||||
/***************************************************************************
|
||||
** Grant the printing admin permission only for the fixture group claim.
|
||||
***************************************************************************/
|
||||
@Override
|
||||
public void customizeSession(QInstance instance, QSession session, Map<String, Object> context)
|
||||
{
|
||||
@@ -236,11 +201,6 @@ public final class NativeAuthHost extends AbstractQQQApplication
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Validate the exact root HTTPS origin used by the private TLS fixture.
|
||||
***************************************************************************/
|
||||
private static URI httpsOrigin(String value)
|
||||
{
|
||||
URI parsed = URI.create(value);
|
||||
@@ -252,11 +212,6 @@ public final class NativeAuthHost extends AbstractQQQApplication
|
||||
return parsed;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Read a required synthetic fixture setting without logging its value.
|
||||
***************************************************************************/
|
||||
private static String required(String name)
|
||||
{
|
||||
String value = System.getenv(name);
|
||||
|
||||
@@ -1,56 +0,0 @@
|
||||
# Java compiler safety
|
||||
|
||||
The repository compiler runs Error Prone 2.51.0 and NullAway 0.14.3 for
|
||||
`com.kingsrook.qbits.printing`, including test sources. NullAway findings are
|
||||
errors; compiler warnings fail through `-Werror` and Maven `failOnWarning`.
|
||||
This implements K22-CODE-JV-06 and the compiler portion of K22-CODE-02. It is
|
||||
not a claim that every unrelated coding-standard requirement is complete.
|
||||
|
||||
The configuration retains Java 21, compiler plugin 3.14.1, `proc:none`, the
|
||||
existing parent and the frozen QQQ dependency tuple. The explicit compiler
|
||||
plugin path loads the analyzers even with annotation processing disabled.
|
||||
JSpecify 1.0.0 is declared directly for nullable contracts; it was already in
|
||||
the runtime closure. NullAway's contract annotations are provided-only.
|
||||
Neither analyzer implementation is an application runtime dependency.
|
||||
|
||||
Run the usual quality gate:
|
||||
|
||||
```sh
|
||||
./mvnw -B -ntp -Pui-demo verify
|
||||
```
|
||||
|
||||
For a compiler-configuration change, also run the existing bounded guard locally:
|
||||
|
||||
```sh
|
||||
python3 .github/scripts/check-java-compiler.py
|
||||
```
|
||||
|
||||
The guard copies the actual POM compiler block into fresh, isolated modules
|
||||
under `target/compiler-guard`. Both main and test sources have a positive
|
||||
probe and negative probes for NullAway, Error Prone's `DeadException`, and a
|
||||
deprecated call rejected by warnings-as-errors. A random Maven failure does
|
||||
not satisfy a negative probe: the expected diagnostic must be present.
|
||||
Logs and a result manifest are written under `target/compiler-guard`. The former GitHub workflow ran this probe explicitly; primary Gitea verification enforces the POM compiler checks during the Maven build.
|
||||
No artifact is installed or published. Optional `--maven`, `--settings`,
|
||||
`--local-repository` and `--offline` arguments support an isolated local cache.
|
||||
|
||||
Null annotations describe existing optional inputs and transitions; they do
|
||||
not convert absent data into required configuration. Existing lifecycle
|
||||
checks provide checked initializer contracts. HELLO-dependent work receives
|
||||
the validated payload explicitly. Scheduled retention captures its service
|
||||
under the existing missing-configuration error contract. A missing realtime
|
||||
QQQ instance now fails descriptively at revalidation, without moving host
|
||||
registration timing or caching user authority.
|
||||
|
||||
Narrow member suppressions retain required framework override return types,
|
||||
exact socket identity fencing and the framework's ordered presentation enum.
|
||||
Two private accessors document the storage/page lifecycle invariants that
|
||||
cannot be inferred from separate nullable fields. They preserve the existing
|
||||
use-after-finish or misconfigured-storage failure rather than inventing valid
|
||||
null operations. Suppressions are not package-wide, and tests remain analyzed.
|
||||
|
||||
The migration separates redundant return-expression parentheses from null
|
||||
contracts and compiler configuration for review. Public JVM descriptors and
|
||||
the resolved runtime JAR set are verified against the unchanged baseline.
|
||||
The ordinary test suite intentionally skips the separately opt-in 10,000-job
|
||||
qualification unless `printing.qualification.load=true` is supplied.
|
||||
+4
-4
@@ -10,7 +10,7 @@
|
||||
| `PrintingUiDemo` | Isolated in-memory synthetic data, mock administrator, no device routes | Native UI demonstration only |
|
||||
| `PrintingLocalHost` | Durable H2 shared by native QQQ and device routes, real password/session authentication | Authenticated local application |
|
||||
|
||||
The local host adds its own `printing_admin_user` and `printing_admin_session` tables. It preserves existing printing tables, device credential hashes, receipt history and tenant identity. Physical table/column names are mapped to the existing H2 case convention; it does not rename an uppercase database or change `DATABASE_TO_UPPER`. Every host instance uses a distinct internal backend name to avoid cross-instance provider-cache collisions observed during RC.20 development.
|
||||
The local host adds its own `printing_admin_user` and `printing_admin_session` tables. It preserves existing printing tables, device credential hashes, receipt history and tenant identity. Physical table/column names are mapped to the existing H2 case convention; it does not rename an uppercase database or change `DATABASE_TO_UPPER`. Every host instance uses a distinct internal backend name to avoid cross-instance provider-cache collisions in QQQ RC20.
|
||||
|
||||
## Required configuration
|
||||
|
||||
@@ -36,7 +36,7 @@ $dependencies = (Get-Content target/local-host-classpath.txt -Raw).Trim()
|
||||
& "$env:JAVA_HOME/bin/java.exe" -cp "target/classes;$dependencies" com.kingsrook.qbits.printing.PrintingLocalHost
|
||||
```
|
||||
|
||||
Set the required environment values securely before launch. Maven contract tests require the documented sibling protocol fixture checkout or `printing.protocol.fixtures` override. Browse to `http://localhost:18081/` (or the configured port) and use the native username/password screen. Configure that origin in the Windows connector Connection settings and sign in through the discovered QQQ authentication flow. Preserve an existing pairing when upgrading; the native path requires the current user session as well as device proof. The connector does not receive the management token.
|
||||
Set the required environment values securely before launch. Maven contract tests require the documented sibling protocol fixture checkout or `printing.protocol.fixtures` override. Browse to `http://localhost:18081/` (or the configured port) and use the native username/password screen. The existing Windows connector continues using the same server origin and device token; it does not receive the browser password or management token.
|
||||
|
||||
This command runs the host in the foreground. `QApplicationLauncher` owns graceful HTTP/scheduler shutdown. It does not install an operating-system service or auto-start registration; the deploying operator must provide supervision, protected credential loading, logs and backups for unattended use.
|
||||
|
||||
@@ -60,7 +60,7 @@ Existing facility IDs are retained. The standalone enrollment form offers the na
|
||||
|
||||
QQQ supplies password verification, failed-sign-in throttling, HttpOnly sessions, session expiry and logout. The local authorization subclass calls native verification first and maps only the configured account to printing permissions. Other valid accounts cannot gain those permissions. Native QQQ permission and tenant checks still apply to every table/process.
|
||||
|
||||
The host rejects non-loopback Host headers, cross-origin Origin headers and cross-site browser requests. Cookie-authenticated unsafe requests require an exact same-origin Origin header, including logout and native process actions. Explicit API calls without ambient cookies still require their normal route credentials; native bound devices use QQQ session authentication plus device proof. Use one loopback hostname consistently in the browser; `localhost` and `127.0.0.1` are different browser origins. These controls do not turn a local HTTP host into an Internet-facing service.
|
||||
The host rejects non-loopback Host headers, cross-origin Origin headers and cross-site browser requests. Cookie-authenticated unsafe requests require an exact same-origin Origin header, including logout and native process actions. Explicit bearer/device API calls without ambient cookies remain usable from the connector. Use one loopback hostname consistently in the browser; `localhost` and `127.0.0.1` are different browser origins. These controls do not turn a local HTTP host into an Internet-facing service.
|
||||
|
||||
## Retention, storage and remaining deployment work
|
||||
|
||||
@@ -68,4 +68,4 @@ The native Quartz scheduler runs the existing bounded cleanup process every five
|
||||
|
||||
This local host deliberately leaves the S3 binding unconfigured. Native settings report legacy database storage. New and existing documents therefore remain in the database; merely running this host does not move documents to S3. A deployed application must supply its existing dedicated `printing_*` S3 table/backend and scheduler configuration, with bucket/IAM/tenant separation described in [storage and retention](STORAGE-AND-RETENTION.md). The host must retain historical storage bindings when changing configuration.
|
||||
|
||||
Remote HTTPS deployment, real S3/IAM, production OAuth roles, PostgreSQL and operating-system supervision remain separate qualification work. The optional [retained-source facade](RETAINED-PRINT-FACADE.md) requires a host-supplied source authority; standalone printing delivery storage must not own or delete canonical attachments.
|
||||
Remote HTTPS deployment, real S3/IAM, production OAuth roles, PostgreSQL and operating-system supervision remain separate qualification work. Record Files source-version/actor integration remains pending its concrete public contract; standalone printing delivery storage must not own or delete canonical attachments.
|
||||
+8
-12
@@ -24,7 +24,7 @@ Normal progression is QUEUED → CLAIMED → RECEIVED → SUBMITTING → SPOOLED
|
||||
|
||||
Use a stable business idempotency key for retries of the same request. A changed target/document/options with the same key is a conflict. A deliberately new print requires a new key. The initial implementation does not automatically reclaim RECEIVED/SUBMITTING jobs or resend ambiguous output; inspect the queue and physical result before deciding to print again.
|
||||
|
||||
Version 1.0.0 stores new documents through the host's configured dedicated QQQ S3 storage table; existing inline database content remains readable. Administration defaults to 365 days after server-observed successful completion, with bounded scheduled cleanup when a host scheduler is configured. Active, failed, uncertain and unknown-completion legacy jobs remain protected. See [storage and retention](STORAGE-AND-RETENTION.md) for bucket separation, recovery and versioning details. No live storage migration or cleanup is implied by a source upgrade.
|
||||
The pending 0.1.4 implementation stores new documents through the host's configured dedicated QQQ S3 storage table; existing inline database content remains readable. Administration defaults to 365 days after server-observed successful completion, with bounded scheduled cleanup when a host scheduler is configured. Active, failed, uncertain and unknown-completion legacy jobs remain protected. See [storage and retention](STORAGE-AND-RETENTION.md) for bucket separation, recovery and versioning details. No live storage migration or cleanup is implied by a source upgrade.
|
||||
|
||||
## Admission capacity and inventory history
|
||||
|
||||
@@ -49,17 +49,16 @@ Inventory snapshots remain limited to 200 entries. Rotating IDs cannot bypass cu
|
||||
## Device controls and durable action receipts
|
||||
|
||||
The native client API is the registered `printing` extension, semantic version
|
||||
`2.4.0`, under `/qqq/v1/qbit/printing`. Discover it through QQQ's version endpoint;
|
||||
`1.0.0`, under `/qqq/v1/qbit/printing`. Discover it through QQQ's version endpoint;
|
||||
its generated OpenAPI fragment is `src/main/resources/openapi/qqq-v1/printing.yaml`.
|
||||
The contract test checks this fragment against the registered endpoint specs and
|
||||
the initial semantic compatibility baseline. Core QQQ session authentication and
|
||||
credential scopes run before printing operations; the application does not issue
|
||||
another kind of user login token.
|
||||
|
||||
Native administration and device operations require the authenticated QQQ principal,
|
||||
`printing_admin`, the configured tenant security key, and applicable native table,
|
||||
process and row access. The separate [operator catalog and submission API](OPERATOR-CATALOG.md)
|
||||
also permits `printing_operator`, with its narrower destination/process checks. Device operations additionally require `X-QQQ-Device-Id` and
|
||||
Every native operation requires the authenticated QQQ principal, `printing_admin`,
|
||||
the configured tenant security key, and applicable native table, process and row
|
||||
access. Device operations additionally require `X-QQQ-Device-Id` and
|
||||
`X-QQQ-Device-Token` as secondary proof. Enrollment at `/devices/enroll` validates
|
||||
the user's facility access before consuming the enrollment code and atomically
|
||||
binds the device to the core user's stable identity. A legacy unbound device can
|
||||
@@ -95,7 +94,7 @@ reach that context; printing does not assert that an upstream cached session is
|
||||
fresh. Cookie-authenticated unsafe calls must also satisfy the host's Origin/CSRF
|
||||
policy. The local host requires its canonical same-origin authority.
|
||||
|
||||
In the recorded RC.20 authentication qualification, OAuth2 `sessionStoreEnabled` defaults
|
||||
In the qualified QQQ 4.1.0-RC.20 runtime, OAuth2 `sessionStoreEnabled` defaults
|
||||
to `false`. Ordinary requests and session resume rerun the configured
|
||||
`QAuthenticationModuleCustomizerInterface` hooks; the host can load current
|
||||
permissions, tenant keys, and account status from its authoritative directory.
|
||||
@@ -152,8 +151,7 @@ seven days; an unchanged old request still expires after its receipt is removed.
|
||||
|
||||
Remote inventory refresh and owned spool cancellation require advertised agent
|
||||
capabilities, expire after 15 minutes, and have a limit of 100 pending commands
|
||||
per device. Control delivery is bounded to 20 commands per batch over the real-time
|
||||
channel; there is no timed job/control polling fallback. The retained action history is
|
||||
per device. Polls deliver at most 20 commands. The retained action history is
|
||||
limited to 1,000 records per device, with one additional reserved revocation;
|
||||
eligible old terminal records are reclaimed before admission. Capacity returns
|
||||
429 explicitly. History pages contain at most 200 records and use the preceding
|
||||
@@ -182,6 +180,4 @@ cancellation request, not that paper was withdrawn or a physical print was undon
|
||||
|
||||
## Release qualification
|
||||
|
||||
The stable 1.0.0 library and its matching release/registry bytes are published; see [release evidence](RELEASES.md). Local checks cover H2 persistence, native QQQ operations, real HTTP/WebSocket transport, S3-compatible storage and bounded job histories. User-confirmed physical output includes laser PDF and Zebra ZPL/PDF.
|
||||
|
||||
A deployment still supplies and validates its own database, S3/IAM, authentication mapping, supervision and printer drivers. PostgreSQL and multiple-node operation are not qualified by the local H2/MinIO fixture. The default real-time bus is in-process; consult [host integration](REALTIME.md) before scaling hosts. These are deployment boundaries, not pending 1.0 publication tasks.
|
||||
Prior released checks include user-confirmed laser PDF and Zebra ZPL/PDF output with correct machine driver settings. Audit source checks cover H2, native processes, host HTTP registration, synthetic storage and small real connection pools. Follow-up qualification includes live S3/IAM, PostgreSQL, production host authentication, upgrade/migration paths, multiple QQQ nodes, prolonged disconnects and a broader printer/driver set. Current prerelease artifacts must not be described as certifying those scenarios.
|
||||
@@ -1,72 +0,0 @@
|
||||
# Operator catalog and queue media
|
||||
|
||||
QQQ Printing 1.0.0 includes native printing extension 2.3.0, paired with Windows
|
||||
connector 1.0.1. Extension 2.2.0 introduced rendering; 2.3.0 adds this operator/media API. Existing administrator and device routes keep
|
||||
their permissions; this is an additive operator API, not a device bearer API.
|
||||
|
||||
Hosts grant `printing_operator` and the `printing_tenant` security key. The native
|
||||
`printingSubmit` process remains the domain write permission. Current device and
|
||||
printer table/record security, credential scopes and client-channel ceilings apply
|
||||
on every operation. Since 1.2.0 an operator also reads the tenant's print jobs
|
||||
through the native table (read only, every job of the tenant; see the changelog).
|
||||
Command and deletion history, table writes, enrollment and device management
|
||||
remain administrator-only. Hosts may add destination locks.
|
||||
Native callbacks cannot replace the initiating actor, session, instance, service
|
||||
or row-security context. Submission rechecks current process, credential, channel
|
||||
and destination authority after loading/storage callbacks and before commit.
|
||||
The backend process is hidden and has no base64-entry form. Echo obtains its user
|
||||
selections from the catalog; backend metadata also references native printer and
|
||||
format possible-value sources.
|
||||
|
||||
- `GET /qqq/v1/qbit/printing/operator/printers?limit=50&after=...` returns at most
|
||||
200 authorized approved/exposed printers, in stable printer-row-ID order. The
|
||||
opaque next cursor advances over at most `limit` candidate rows even if parent
|
||||
device security hides every candidate. Continue until `nextCursor` is null.
|
||||
- `POST /qqq/v1/qbit/printing/operator/jobs` accepts `requestId`, `printerRowId`,
|
||||
`title`, `format` (`PDF` or `ZPL`), `contentBase64` and optional `options`. The
|
||||
native printer row determines the device and opaque Windows queue identity.
|
||||
`requestId` is 1–128 characters from letters, digits, `.`, `_`, `:`, `-`.
|
||||
The authenticated actor and tenant scope the stable key; callers cannot supply
|
||||
actor identity or an internal idempotency key. The response is the existing job
|
||||
receipt after durable commit. Changed requests conflict instead of reprinting.
|
||||
- `GET /qqq/v1/qbit/printing/operator/requests/{requestId}` returns only that
|
||||
actor's exact accepted request, or 404. It does not enqueue, read document bytes,
|
||||
or initialize settings. Current destination read authority remains required;
|
||||
later loss of exposure alone does not erase the acceptance receipt.
|
||||
Lookup checks the original accepted native printer-row ID. Deleting that row
|
||||
and creating another with the same device/queue pair does not transfer history.
|
||||
|
||||
Each catalog entry has `printerRowId`, `deviceId`, `printerId`, effective `name`,
|
||||
`deviceName`, `status`, `formats`, `mediaProfiles`, and optional `description` and
|
||||
`location`. These names are presentation; the stable row identity selects a queue.
|
||||
|
||||
Media profiles report actual Windows queue defaults. Their typed facts are `id`,
|
||||
`revision` (lowercase SHA-256), `name`, `widthMicrons`, `heightMicrons`, `dpiX`,
|
||||
`dpiY`, `source: WINDOWS_QUEUE_DEFAULT`, `applyMode: DRIVER_DEFAULT`. Unknown or
|
||||
unsupported driver facts produce an empty list. The initial client reports one
|
||||
configured default; the wire bound is 32. Dimensions are 1–2,000,000 microns and
|
||||
DPI is 1–9600. Names are at most 512 characters. Unknown additive reported facts
|
||||
are ignored when canonicalizing; known required facts remain validated. Arbitrary
|
||||
page-size values are never interpreted as a Windows stock change.
|
||||
Profile and selection IDs share the protocol's 128-character URL-safe ID bound.
|
||||
|
||||
Select exact reported media with `options.mediaProfile: {id, revision}`. The
|
||||
selection is immutable job intent and accepts no extra fields. New submissions
|
||||
reject stale/missing profiles before admission/storage writes; exact accepted
|
||||
replays remain accepted. The capable Windows agent rechecks its actual current
|
||||
default before spooling. Selected-media dispatch requires the current agent
|
||||
capability `printer-media-v1`, including after reconnect/downgrade. Legacy
|
||||
inventory without profiles clears stale media facts. Omitted selection preserves
|
||||
ordinary existing queue behavior. An explicit job paper size instead uses both
|
||||
`paperWidthMm` and `paperHeightMm` (positive, at most 2000 mm); it cannot be
|
||||
combined with `mediaProfile`. The matching connector applies that job paper
|
||||
without changing the machine-wide queue defaults. Select media matching the
|
||||
loaded stock and calibrate the physical printer after changing label sizes.
|
||||
|
||||
Generated/retained source authorization belongs to the configured source owner.
|
||||
The retained facade shares this operator permission and destination boundary; it
|
||||
preserves its atomic accepted source/actor/request binding. Barcode fit and
|
||||
encoding remain the renderer's job.
|
||||
|
||||
`QUEUED` is durable acceptance; `SPOOLED` means spooler acceptance. Neither is
|
||||
physical output confirmation. These tests use synthetic bytes and no real printer.
|
||||
+7
-29
@@ -1,10 +1,9 @@
|
||||
# Real-time printing host integration
|
||||
|
||||
QQQ Printing 1.1.2 (the released library is [1.1.2](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.1.2))
|
||||
implements native printing extension **2.4.0** (wire envelope v1), paired with Windows
|
||||
connector **1.2.1**; connector 1.0.1 remains compatible. Upgrade the server before the connector; a real-time connector
|
||||
rejects a server that advertises only extension 1.x. There is no timed job/control
|
||||
polling fallback.
|
||||
Release candidate [0.3.0-rc.1](https://github.com/QRun-IO/qbit-printing/releases/tag/v0.3.0-rc.1)
|
||||
implements printing extension **2.0.0** (wire envelope v1). Upgrade the server
|
||||
before the matching Windows connector; a real-time connector rejects a server that advertises only extension
|
||||
1.x. There is no timed job/control polling fallback.
|
||||
|
||||
## Connection and authorization
|
||||
|
||||
@@ -98,34 +97,13 @@ notifications to one another.
|
||||
The existing `/printing/v1` routes remain explicit legacy diagnostic compatibility.
|
||||
They are not a real-time fallback and cannot authorize a native bound device.
|
||||
The full message and settings contract is in
|
||||
[the shared protocol](https://git.kof22.com/QRun-IO/qqq-print-protocol).
|
||||
[the shared protocol](https://github.com/QRun-IO/qqq-print-protocol).
|
||||
|
||||
## Printing API major upgrade
|
||||
|
||||
Extension **2.0.0** introduced the major-version change because native HTTP claims require a synchronized
|
||||
The extension is **2.0.0** because native HTTP claims now require a synchronized
|
||||
WebSocket. A published 1.0 HTTP-only connector no longer meets that precondition;
|
||||
this is a breaking behavior change even though request bodies remain wire v1.
|
||||
The QQQ framework API `/qqq/v1`, extension path `/qbit/printing` and WebSocket
|
||||
subprotocol `qqq-printing.v1` remain unchanged. Upgrade server and client together;
|
||||
an incompatible older client must report upgrade-required instead of using polling fallback.
|
||||
Extension 2.3.0 retained that requirement and added operator/media support; 2.4.0
|
||||
adds printer approval over the socket (below). The product/library version is
|
||||
independently 1.1.0.
|
||||
|
||||
## Printer approval (extension 2.4.0)
|
||||
|
||||
A HELLO may carry up to five capabilities; the fifth, `printer-approval-v1`, is
|
||||
also accepted and stored by the HTTP control poll. Only on a connection that
|
||||
advertised it, the server sends a `PRINTERS` frame
|
||||
(`{ "printers": [ { "printerId", "enabled" } ] }`) with the complete approval
|
||||
state of every printer in the device's latest accepted inventory: after the ACK
|
||||
of each accepted INVENTORY, and whenever a printer's `enabled` changes for that
|
||||
device through any path (the admin route, the native approve/disable/set-approval
|
||||
processes or application code calling `enablePrinter`). Every approval path
|
||||
publishes the existing commit wakeup; the connection's serialized writer compares
|
||||
the current state with the last frame it sent and resends only on a change, so an
|
||||
unrelated job wakeup does not repeat it. An empty inventory yields
|
||||
`{ "printers": [] }`. A printer removed in QQQ (`removed_at` set) is left out and
|
||||
the frame is pushed again; it reappears, not approved, once the device shares the
|
||||
queue again. The client does not acknowledge the frame; it carries no job
|
||||
or document data. Connections without the capability never receive it.
|
||||
an older client must report upgrade-required instead of using polling fallback.
|
||||
@@ -1,56 +0,0 @@
|
||||
# Installation and release operations
|
||||
|
||||
The stable server library is [QQQ Printing 1.1.2](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.1.2) (1.1.1 is the same code on QQQ RC.21 from Maven Central; 1.1.0 is superseded: its realtime upgrade fails behind an ingress that lowercases header names), paired with protocol 1.1.0 and Windows connector 1.2.1 (1.0.x/1.1.x connectors keep working on the unchanged 2.3 behaviour). It requires Java 21 and the QQQ 4.1.0-RC.22 dependency tuple, which is published only in the QRun-IO Gitea Maven registry. Its native printing extension is 2.4.0; the WebSocket subprotocol remains `qqq-printing.v1`. The previous stable library, [1.0.0](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.0.0), remains available for rollback.
|
||||
|
||||
Gitea is primary for source, pull requests, CI, packages and server releases. This forge requires sign-in even for download links on public repositories. An HTML sign-in page is not an artifact. Use your existing approved forge identity; never commit its token or put it in a command line.
|
||||
|
||||
## Use the Maven registry
|
||||
|
||||
Configure the consuming application's existing Maven repository setup with repository ID `qrun-io` and URL `https://git.kof22.com/api/packages/QRun-IO/maven`. Enable releases and disable snapshots. Match that ID to a `<server>` entry in your private Maven `settings.xml`, using your existing managed username/token or encrypted Maven credentials. For example, environment references keep literal credentials out of the configuration:
|
||||
|
||||
```xml
|
||||
<servers>
|
||||
<server>
|
||||
<id>qrun-io</id>
|
||||
<username>${env.GITEA_USERNAME}</username>
|
||||
<password>${env.GITEA_TOKEN}</password>
|
||||
</server>
|
||||
</servers>
|
||||
```
|
||||
|
||||
Merge this entry into the existing settings; preserve other servers, mirrors and profiles. Supply the environment through your approved credential loader. The credential needs package read access. Add `com.kingsrook.qbits:qbit-printing:1.1.1` as shown in the [README](../README.md#add-to-a-qqq-application). QQQ 4.1.0-RC.22 and the printing library both resolve from this registry; third-party dependencies still come from the Maven Central mirror until the registry proxies them.
|
||||
|
||||
## Download and verify release files
|
||||
|
||||
Sign in to Gitea and download all three assets from the stable release: `qbit-printing-1.1.2.jar`, `qbit-printing-1.1.2.pom` and `SHA256SUMS`. In their download directory:
|
||||
|
||||
```powershell
|
||||
Get-Content ./SHA256SUMS | ForEach-Object {
|
||||
$hash, $name = $_ -split ' ', 2
|
||||
if((Get-FileHash -LiteralPath $name -Algorithm SHA256).Hash -ine $hash) {
|
||||
throw "Checksum mismatch: $name"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
On Linux, use `sha256sum -c SHA256SUMS`; on macOS, use `shasum -a 256 -c SHA256SUMS`. Install the verified JAR/POM locally with the README's `install:install-file` command if your application does not consume the registry directly. The library needs its normal Maven runtime dependencies; copying the JAR alone does not deploy a complete host.
|
||||
|
||||
## Maintainer release path
|
||||
|
||||
Since 1.1.2 the repository builds on the shared `KofTwentyTwo/ci-workflows` Maven workflow (`.gitea/workflows/build.yaml`, pinned to `@v1`): every push runs `-Pui-demo verify`; a `vX.Y.Z` tag runs the same tests once and deploys the JAR/POM to the QRun-IO Gitea Maven registry under exactly that version. The former caller's pinned protocol checkout is gone; `PrintingContractTest` reads the vendored copy in `src/test/resources/protocol-fixtures` (kept byte-identical to the reviewed protocol commit named in its README), which is also what local `verify` uses. Earlier releases (1.0.0, 1.1.0, 1.1.1) went through the protected `qrun-release-v1` channel and the trusted publisher; their evidence below stands.
|
||||
|
||||
1. Update the POM version (the tag must equal it), `qqq.version` if the runtime moves, and active documentation on a branch in Gitea. Open a normal pull request; the push build must be green.
|
||||
2. Merge normally and wait for the green main build (verify only; main never publishes).
|
||||
3. Create `v<POM version>` at the qualified main commit without moving an existing tag and push it. The tag build tests and deploys `com.kingsrook.qbits:qbit-printing:<version>` to the registry; a tag build that fails publishes nothing and the next attempt is the next patch version (tags are immutable).
|
||||
4. Read the registry JAR/POM back with the approved forge identity, create the Gitea release on the tag, attach the same JAR/POM and a flat `SHA256SUMS`, read them back, then publish. Never replace different bytes under a released version.
|
||||
5. Record the source, tag build, release and verified hashes here. Publication is separate from installing a host or accepting physical printer output.
|
||||
|
||||
For 1.1.2, source `f5639a98be9a2f15d4c61cf0955fe4ecef85824f` (main; merge of PR 33: QQQ 4.1.0-RC.22 from the Gitea registry, shared ci-workflows pipeline), push build `6435` (`-Pui-demo verify`, 200 tests, 0 failures, 0 errors, 1 skipped, Checkstyle clean), tag build `6475` (tests again, deploy to the registry), release `v1.1.2`. Registry files and release assets match byte-for-byte on authenticated readback. The JAR SHA-256 is `786e6e570c5df29b01529562efb246a4f4562bb1d9fff6bea77d264e0d7536ce`; the POM SHA-256 is `7691a4e1cb7b03c7a559b0e2b92eacd92f86545b98bddafac86fc70f8602b03d`. RC.22 is not on Maven Central, so the green builds prove resolution from the registry.
|
||||
|
||||
For 1.1.1, source `2a561815fcec8b7c95e76bb4b36fba314f512027` (main; merge of PR 30, the realtime upgrade header-case fix), main run `5976` (verify, secrets scan, gate and post-publish succeeded), reactor artifact `4426`. The trusted publisher first refused the run because the 1.1.0 documentation merge had re-pinned the protocol fixture in `qrun-release.yaml`, changing the caller hash its enrollment verifies; the enrollment was re-reviewed in cluster-gitops (PRs 283 and 285) and the capture was then published unchanged. Registry files and release assets match the capture byte-for-byte. The JAR SHA-256 is `156720da6928f62d77101521a2953f6e1026d58d02e7fc7815a8c8fcbcedaefa`; the POM SHA-256 is `2fa451260a26f5b5ede30800d46c78050e223694d3d8dda640f9ca875d120ab0`.
|
||||
|
||||
For 1.1.0, source `eb2c16785d0723a47d4a22c68b8b04503108fc58` (main; merges of PR 25 printer approval and PR 28 printer/device removal), main run `5473` (verify, secrets scan, gate and post-publish all succeeded after the CI quota incident of the same afternoon), reactor artifact `4306`, release assets read back by the approved forge identity and matching the registry files byte-for-byte. The JAR SHA-256 is `3a51b7e7cf457cce5db16f138c4cc65b901730bda17ccaf1d3c714cf11d2bbf4`; the POM SHA-256 is `52e5a588e788bbe123dad574455493aea0a7df6cc473c78f15be09343048a5d4`.
|
||||
|
||||
For 1.0.0, source `2906c2bd5049924abd2114c8ef51a0ac9aac325e`, main run `3594`, reactor artifact `2741` and release `1356` were verified. Release assets and registry files matched byte-for-byte on authenticated readback. The JAR SHA-256 is `7ecb00e1f49272d6e885dc5f515bd4832aa52dd84e0613d9b6751f9e235a0961`; the POM SHA-256 is `8be7c30208a7fbb875dcebedb0ba6baf0e172aa0e7cf478a3d2863d1316ddf5f`.
|
||||
|
||||
GitHub remains a shadow/archive. GitHub Actions for this server repository and the protocol repository were retired on 2026-11-04. Their checked-in workflows and older release evidence are historical. The Windows repository retains its separate signing/update-feed workflow. Do not restart shadow workflows to publish a server release, claim GitHub attestations for 1.0.0, or imply the QBit was published to Maven Central.
|
||||
@@ -1,116 +0,0 @@
|
||||
# Retained print acceptance
|
||||
|
||||
Included in QQQ Printing 1.0.0, this optional Java integration preserves the existing native generation print
|
||||
process and the existing printing queue. It adds no device wire fields or REST
|
||||
routes. It is disabled until the host supplies
|
||||
`PrintingQBitConfig.withRetainedSourceAuthority`. Current `printing_operator`
|
||||
(or administrator) authority and native tenant/device/printer record checks
|
||||
remain mandatory. Submission also requires the shared `printingSubmit` process
|
||||
permission. The facade grants no device management. Reading print jobs is the
|
||||
table's own read rule: since 1.2.0 a holder of `printing_operator` reads the
|
||||
tenant's job rows, which carry no retained binding, actor or accepted event.
|
||||
|
||||
## Public contract
|
||||
|
||||
`RetainedPrintFacade.Request(requestId, sourceLocator, printerRecordId, title,
|
||||
optionsJson)` contains no actor or asserted source binding. Request IDs use
|
||||
`[A-Za-z0-9._:-]{1,128}`, including owner namespaces such as `echo:<scanId>`.
|
||||
`submit` derives the signed-in native actor and returns an immutable
|
||||
`Acceptance`; it includes the exact source, job/event identities, tenant,
|
||||
initiating actor, destination, title and normalized options JSON, including any
|
||||
`mediaProfile` ID/revision. `find` authorizes the same complete request and
|
||||
returns that acceptance, null for observed absence, or a conflict for an
|
||||
unresolved upload reservation. Reuse the same request identity after a lost
|
||||
response. Never convert an unavailable lookup into absence or create another
|
||||
intent automatically.
|
||||
|
||||
The host-configured `RetainedPrintSourceAuthority.resolve(locator, requestId)`
|
||||
must authorize the current native actor, source association and currently
|
||||
eligible immutable version. It returns `SourceReference(owner, opaqueReference,
|
||||
sha256, sizeBytes, mediaType)`. `opaqueReference` is at most 4000 Java
|
||||
characters, stable and canonical under that owner's rules; printing does not
|
||||
parse owner-specific fields. The optional Record Files adapter must encode its
|
||||
complete version/source/generation-request/initiating-actor/tenant tuple and
|
||||
compare generation's committed receipt. Accepted MIME types are
|
||||
`application/pdf` and `application/vnd.zebra-zpl`; the current configured
|
||||
PDF/ZPL limits apply before the byte read, within the existing integer-length
|
||||
storage ceiling. `read(reference, requestId)` must enforce the same current
|
||||
permissions and return only those exact bytes. Hash/length verification remains
|
||||
in printing's existing submission path. Do not supply arbitrary source
|
||||
authorities per request or reconstruct a user session.
|
||||
|
||||
Source admission remains the owner's policy. An explicitly configured published
|
||||
template may qualify generated output without a per-label release dialog;
|
||||
external-upload quarantine is unchanged. Printing performs no automatic release
|
||||
and creates no human-release audit. `resolve` must be read-only and must not
|
||||
invoke a generation reconciliation operation that can generate or dispatch work.
|
||||
|
||||
Source/destination checks surround owner callbacks and precede acceptance.
|
||||
Submission refuses an ambient QQQ transaction: queue acceptance is independently
|
||||
committed and cannot be rolled back by a caller's transaction. Submission also
|
||||
enforces the native job-table credential and channel mutation ceilings; lookup
|
||||
uses the corresponding read ceilings without granting generic table access.
|
||||
`find` calls no byte reader, submission or event writer, and its option
|
||||
normalization cannot initialize settings. It reauthorizes the source and
|
||||
destination records, then compares the exact accepted intent; a later exposure,
|
||||
media inventory or dispatch-limit change does not reinterpret that historical
|
||||
intent. A later permission loss may deny returning a receipt whose job already
|
||||
committed; it never authorizes a replacement job.
|
||||
|
||||
## Persistence and replay
|
||||
|
||||
Existing `printing_job` gains nullable `retained_actor_id`,
|
||||
`retained_binding_json`, and `accepted_event_id`. Existing `printing_event`
|
||||
gains nullable `event_origin`. `initialize` applies additive upgrades; old
|
||||
jobs/events remain unbound/unclassified. None of these internal fields are added
|
||||
to the device `JOB_COLUMNS` DTO or native table metadata.
|
||||
|
||||
Submission and exact lookup both use the existing tenant admission lock, so an
|
||||
in-flight inline acceptance cannot be mistaken for absence. The unique
|
||||
`(tenant_id, idempotency_key)` serialize submissions. Retained keys use
|
||||
`retained:` plus the request ID. Ordinary/bound collisions refuse. Complete
|
||||
normalized intent includes actor, owner reference, content hash/length/media,
|
||||
destination, title, options and tenant. The existing storage reservation/orphan
|
||||
path is reused; it may commit an upload reservation before writing object
|
||||
storage. The final job, retained binding, and server acceptance event commit
|
||||
together. Failed acceptance-event insertion rolls back the job. Rollback or
|
||||
orphan-cleanup failures are suppressed onto the original failure rather than
|
||||
replacing it. Existing initialization widens legacy 300-character titles to
|
||||
1024; the bound title preserves exact whitespace and Unicode and is compared on
|
||||
replay. Acceptance-event JSON has `type=ACCEPTED`, `origin=SERVER_ACCEPTANCE`,
|
||||
`status=QUEUED`; it does not claim device receipt or physical output.
|
||||
|
||||
This is atomic acceptance binding inside printing, not a distributed transaction
|
||||
over the retained owner's authorization database. Deployment still owns durable
|
||||
database/storage settings, bounded provider calls and current session policy.
|
||||
|
||||
## Committed observations
|
||||
|
||||
`observation(requestId, eventId)` reads only an exact committed event joined to
|
||||
the accepted job. New ordinary device events are stamped `DEVICE_OBSERVATION`;
|
||||
pre-upgrade unclassified events and server acceptance events cannot be returned
|
||||
as device evidence. The current native operator must have current device/printer
|
||||
row authority and satisfy the job credential/channel read ceiling. Before
|
||||
returning any source metadata, printing calls the configured owner's
|
||||
`authorizeObservation(source, requestId)` under the current reporter session,
|
||||
then rechecks the current ceiling and destination authority. Its default
|
||||
implementation refuses; adapters must explicitly implement their current
|
||||
source-observation policy. This callback does not grant content access or
|
||||
impersonate the initiating actor. This is an operator-authorized observation
|
||||
lookup, not device enrollment or permission to forge reporter identity. The
|
||||
optional RF authority adapter must preserve initiating actor separately from
|
||||
current reporting actor and map only supported stored states. Neither `SPOOLED`
|
||||
nor `SPOOLER_COMPLETED` proves physical output.
|
||||
|
||||
## Verification scope
|
||||
|
||||
The tests use real H2 transactions and native QQQ row authorization with
|
||||
synthetic printers. They never contact a device or emit physical output.
|
||||
Coverage includes commit-then-throw acknowledgment loss, concurrent exact
|
||||
replay, held-admission-lock lookup, mutation ceilings, owner observation
|
||||
refusal, callback revocation, exact content hash/length, configured document
|
||||
bounds, title upgrade/replay, read-only historical lookup and original-error
|
||||
preservation when rollback fails. The library is released; [release evidence](RELEASES.md) identifies its source
|
||||
and artifacts. Configuring and qualifying a cross-QBit source authority remains
|
||||
the integrating host's responsibility. Merely upgrading the library does not
|
||||
enable an adapter, migrate stored source bindings or grant source access.
|
||||
+1
-105
@@ -1,108 +1,4 @@
|
||||
# Session state — 2026-11-06
|
||||
|
||||
## Current — 1.1.2 released (2026-11-06)
|
||||
|
||||
[QQQ Printing 1.1.2](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.1.2) is published in the QRun-IO Gitea Maven registry (`com.kingsrook.qbits:qbit-printing:1.1.2`) and as a Gitea release. It is the 1.1.1 code built on QQQ **4.1.0-RC.22**, which exists only in that registry (James's direction: everything moves to Gitea, no more Maven Central), on the shared `ci-workflows` Maven pipeline (`build.yaml@v1`, `-Pui-demo`; the protected `qrun-release` caller and the trusted-publisher enrollment are retired, cluster-gitops PR 288). `qqq-frontend-next` 1.0.0-RC.37 was mirrored into the registry byte-for-byte from Central so the ui-demo profile resolves from Gitea too; only third-party libraries still come through the Central mirror. Source `f5639a98be9a2f15d4c61cf0955fe4ecef85824f` (PR 33), push build 6435 (200 tests, 0 failures), tag build 6475 (deploy); JAR `786e6e570c5df29b01529562efb246a4f4562bb1d9fff6bea77d264e0d7536ce`, POM `7691a4e1cb7b03c7a559b0e2b92eacd92f86545b98bddafac86fc70f8602b03d`. No printing contract change.
|
||||
|
||||
## Superseded — 1.1.1 released (2026-11-06)
|
||||
|
||||
[QQQ Printing 1.1.1](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.1.1) is published on primary Gitea and its Maven registry (`com.kingsrook.qbits:qbit-printing:1.1.1`). It supersedes 1.1.0: Forge's adoption qualification of 1.1.0 (`~/.cache/gg-forge-printing-cohort-20261106/HANDOFF.md`) reproduced a connection failure before WELCOME when the WebSocket upgrade headers arrive lowercase, because the socket callbacks read `X-QQQ-Device-Id` from the WebSocket context, whose header lookup is case-sensitive. 1.1.1 resolves the device once on the authorized HTTP upgrade and carries it as a connection attribute; `PrintingRealtimeTest.lowercaseUpgradeHeadersReachWelcomeAndFrames` fails on the old code and passes on the fix. No contract change: extension 2.4.0, wire v1, subprotocol unchanged. Source `2a561815fcec8b7c95e76bb4b36fba314f512027` (PR 30), main run `5976`, reactor artifact `4426`, release `1381`; JAR `156720da6928f62d77101521a2953f6e1026d58d02e7fc7815a8c8fcbcedaefa`, POM `2fa451260a26f5b5ede30800d46c78050e223694d3d8dda640f9ca875d120ab0`, read back against the capture and the registry. The publisher had refused the run until its enrollment hash was re-reviewed (cluster-gitops PRs 283 and 285) after the 1.1.0 docs merge re-pinned the protocol fixture in the release caller.
|
||||
|
||||
## Superseded — 1.1.0 released (2026-11-05)
|
||||
|
||||
[QQQ Printing 1.1.0](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.1.0) is published on primary Gitea and its Maven registry: native printing extension **2.4.0** (`printer-approval-v1` capability and the `PRINTERS` frame) and the Remove printers / Remove device archives purged by retention. Source `eb2c16785d0723a47d4a22c68b8b04503108fc58`, main run `5473`, reactor artifact `4306`; JAR/POM hashes in [release operations](RELEASES.md). Pairs with [protocol 1.1.0](https://git.kof22.com/QRun-IO/qqq-print-protocol/releases/tag/v1.1.0); the Windows connector 1.2.1 is published (https://git.kof22.com/QRun-IO/qqq-print-agent/releases/tag/v1.2.1). The CI fixture pin now follows protocol 1.1.0 source `5005f3c9e27053b6c327bb923695012832c0fdcc`. Forge adoption is a separate, coordinated step; 1.0.0 stays available for rollback.
|
||||
|
||||
## Current — 1.0.0 released
|
||||
|
||||
[QQQ Printing 1.0.0](https://git.kof22.com/QRun-IO/qbit-printing/releases/tag/v1.0.0) is published on primary Gitea and its Maven registry. Source `2906c2bd5049924abd2114c8ef51a0ac9aac325e` passed main run `3594`; reactor artifact `2741`, release `1356` and both registry files were verified against the captured bytes by authenticated readback. Gitea requires sign-in. See [release operations and hashes](RELEASES.md).
|
||||
|
||||
Windows connector 1.0.1 and protocol 1.0.0 are published. The server uses QQQ 4.1.0-RC.21, native printing 2.3.0, wire v1 and client-initiated WebSocket control with separate HTTPS documents. The release preparation's existing `-Pui-demo verify` reported 193 tests, zero failures/errors, one opt-in workload skip and zero Checkstyle violations; the normal hosted main checks subsequently passed.
|
||||
|
||||
GitHub is a shadow/archive; server and protocol Actions were retired on 2026-11-04. Windows signing/update-feed workflows remain separate. Current setup, operator, storage and release documentation now describe this released state. This documentation closeout changes no application code or workflows and performs no new hardware/provider qualification. No server 1.0 publication task remains open.
|
||||
|
||||
## Historical checkpoints
|
||||
|
||||
The entries below are dated development evidence, including superseded pending tasks and older versions. They are not the current release status; use the section above and [current tasks](TODO.md).
|
||||
|
||||
## Standards and small-label release cohort — 2026-11-01
|
||||
|
||||
The strict standards tree (commit `43253f6`) combines the 2.3.0 operator/media/retained source with the
|
||||
Error Prone 2.51.0 / NullAway / `-Werror` compiler gate, null contracts, strict headers, the development
|
||||
fixture style gates and the official-npm Pyright script gates. Observed locally on that tree: main and test
|
||||
compile clean and the full `-Pui-demo verify` passed (189 reported, 0 failures, 0 errors, one intentional
|
||||
opt-in 10,000-job skip, 0 Checkstyle violations). This qualifies that integrated source only.
|
||||
|
||||
The 4 x 1 and 4 x 2 inch label work (compact layouts, explicit PDF job paper in millimetres that never mixes
|
||||
with a media profile, and the 4 x 6 path unchanged) is being merged onto it in the release-integration tree.
|
||||
Its four conflicts (`PrintingProcesses`, `PrintingService`, `PrintingTestDocuments`, `TestPrintProfile`) were
|
||||
resolved by keeping all label behavior and tests and layering the strict contracts: `jobOptions` is
|
||||
`@Nullable` (null means the queue default applies), `validPaperMillimetres` accepts a missing value, redundant
|
||||
return wrappers are removed, and no suppression or rule change was added. Submission, authority, retained
|
||||
binding, replay and queue code paths were not edited.
|
||||
|
||||
**Local gate passed (observed):** on the merged cohort, main and test compile clean under the strict compiler and
|
||||
the full `-Pui-demo verify` passed with 193 tests, 0 failures, 0 errors, one intentional opt-in 10,000-job skip and
|
||||
0 Checkstyle violations. CI and the README pin the final protocol commit
|
||||
`42c0d249f81395f00408ec0f92638dcbbf5deb03` (merged Gitea protocol PR 2); earlier pins elsewhere in this file are
|
||||
historical. **Still pending, not observed:** hosted Gitea CI, publication, installation and any physical print. The
|
||||
installed printer default is untouched; no printing was performed.
|
||||
|
||||
**Release version:** the project version is now the immutable prerelease `0.4.0-rc.1` (it was `0.4.0-SNAPSHOT`, which the
|
||||
tag workflow cannot release). The release tag must be exactly `v0.4.0-rc.1`. The QQQ `4.1.0-RC.20` dependency tuple, the
|
||||
parent and all code are unchanged. Maven Central publication and deployment remain separate operations.
|
||||
|
||||
## Echo operator/media and retained-source candidate — 2026-11-01
|
||||
|
||||
The isolated Echo candidate adds native printing extension **2.3.0** (after the protected-main 2.2.0 rendering extension) on the
|
||||
unchanged product `0.4.0-SNAPSHOT` and QQQ `4.1.0-RC.20` dependency tuple.
|
||||
`printing_operator` permits the authorized printer/media catalog and exact-actor
|
||||
submission/reconciliation without device administration or general job history.
|
||||
Reported Windows queue-default media is revision-bound; clients without the current
|
||||
`printer-media-v1` capability cannot claim jobs carrying a media selection.
|
||||
|
||||
The opt-in retained-source facade shares that boundary and commits immutable
|
||||
source/actor/destination/intent plus its server acceptance event inside the existing
|
||||
queue transaction. Its owner adapter is required and default-deny; read-only lookup
|
||||
never generates content or submits a replacement job. See
|
||||
[operator catalog](OPERATOR-CATALOG.md) and
|
||||
[retained acceptance](RETAINED-PRINT-FACADE.md) for exact contracts and limits.
|
||||
|
||||
Protected main advanced to a rendering release at printing 2.2.0 (header/footer
|
||||
chrome, content sections, render-to-PDF) while this candidate was qualified, so the
|
||||
operator/media/retained feature was merged onto it and moved to 2.3.0. The earlier
|
||||
183-test gate is historical evidence of the pre-merge source only.
|
||||
|
||||
Observed after the merge, locally: the OpenAPI contract was regenerated with the
|
||||
existing explicit update switch and its 1.0.0 compatibility baseline hash was
|
||||
unchanged. A sandbox full verify reported 188 tests with 11 loopback setup errors and
|
||||
no assertion failures (environmental). The first actual-user full verify reported 188
|
||||
tests, no assertion failures and **one error**:
|
||||
`PrintingRealtimeTest.mediaCapabilityIsReplacedOnEveryAuthenticatedHello` failed
|
||||
only when JUnit removed its temporary directory. Cause: `PrintingRealtimeRoutes.close()`
|
||||
shut its executor down without waiting, so a channel drain still running after the
|
||||
host stopped queried a deleted file database and recreated it empty. The fix waits
|
||||
(bounded) for running drains, with regression
|
||||
`closeWaitsForChannelWorkersAlreadyRunning`. After it, five consecutive focused
|
||||
`PrintingRealtimeTest` runs passed (4 tests each, no empty-database warnings) and the
|
||||
full `-Pui-demo verify` passed: **189 reported, 188 executed, one intentional opt-in
|
||||
workload skip, zero failures/errors, zero Checkstyle violations**; the source-header
|
||||
guard over 146 tracked files and staged whitespace checks passed. The earlier failing
|
||||
logs are preserved. This is local evidence only: hosted CI on the signed candidate
|
||||
head, publication and cross-QBit consumer qualification are pending. The suite runs
|
||||
against synthetic H2 fixtures; no live database, connector, printer or shared
|
||||
artifact has been changed. The
|
||||
experimental API 1.10 used by Echo is a separate owner-controlled tuple and has not
|
||||
been substituted for this candidate's qualified RC.20 dependencies. Publication,
|
||||
cross-QBit consumer qualification and any physical output remain separate gates.
|
||||
|
||||
Native destination and storage callbacks cannot carry stale actor, session,
|
||||
credential, channel or row authority into admission, replay or commit. Receipt
|
||||
lookup authorizes the original stored printer-row ID; a replacement row with the
|
||||
same device/queue pair cannot inherit earlier acceptance history. The regressions
|
||||
reproduce both prior paths, verify denial and rollback, and preserve authorized
|
||||
read-only observation after the original queue loses exposure. Media IDs are
|
||||
bounded to the shared 128-character contract; long device display names remain
|
||||
supported without truncation.
|
||||
# Session state — 2026-10-31
|
||||
|
||||
## Local Docker development — 2026-11-01
|
||||
|
||||
|
||||
@@ -13,5 +13,5 @@ Only leading language comments count. Copyright text in a string, Python docstri
|
||||
|
||||
JSON/schema/fixture/lock data, explicit generated output directories, vendor legal assets and upstream Maven wrappers are excluded with reasons in the policy. Solution/activation/test-runner metadata and `.editorconfig` remain outside this completed pass; their applicable root LICENSE/NOTICE remains authoritative. No broad claim about third-party licensing follows from this check. New owned file types or provenance must be reviewed before changing the allowlist; do not add blanket exclusions to make a failure disappear.
|
||||
|
||||
The implementation and its negative tests are intentionally maintained copies across the three printing repositories, with each repository's own copyright/license header and independently reviewed scope. They do not fetch policy or execute source. The former GitHub jobs invoked them using the runner's available Python; the scripts remain usable locally without a new package or workflow context. Existing native C# IDE0073 and Java Checkstyle conventions remain unchanged.
|
||||
This repository accepts Kingsrook, LLC / Apache-2.0 for its reviewed source/build/config families. Run these checks locally when modifying owned notices; the primary shared CI channel owns its current check selection. The old `.github` workflow invocation is retained as history.
|
||||
The implementation and its negative tests are intentionally maintained copies across the three printing repositories, with each repository's own copyright/license header and independently reviewed scope. They do not fetch policy or execute source. CI invokes them in existing jobs using the runner's available Python, with no new package or workflow context. Existing native C# IDE0073 and Java Checkstyle conventions remain unchanged.
|
||||
This repository accepts Kingsrook, LLC / Apache-2.0 for its reviewed source/build/config families. The existing CI verify job runs the guard.
|
||||
@@ -1,6 +1,6 @@
|
||||
# Print document storage and retention
|
||||
|
||||
Included in the released QQQ Printing 1.0.0 library. QQQ 4.1+ hosts provide the existing storage and scheduler metadata; this module does not create buckets or copy credentials into printing settings.
|
||||
Status: audit implementation pending final verification and release. QQQ 4.1+ hosts provide the existing storage and scheduler metadata; this module does not create buckets or copy credentials into printing settings.
|
||||
|
||||
## Deployment boundary
|
||||
|
||||
@@ -10,15 +10,15 @@ Keep access keys, role credentials and endpoint configuration in the host's esta
|
||||
|
||||
The code validates the selected S3 metadata, detects conflicting bucket bindings within the QQQ instance and uses tenant-specific object namespaces. Each job retains its storage table, destination identity and exact document reference. Retrieval and cleanup validate those values and fail closed if metadata is retargeted or the reference belongs to another tenant/job. Cleanup deletes exact eligible objects; it never lists and wipes a prefix. Tenant prefixes are an application isolation control, not a substitute for separately scoped IAM roles or separate customer buckets.
|
||||
|
||||
Application metadata cannot prove that a bucket is unused by another application or that deployed IAM/bucket policies are correct. Deployment qualification must check those external controls, public-access blocking, transport/encryption policy and the intended customer/environment boundary. The QBit does not create or change bucket policies.
|
||||
Application metadata cannot prove that a bucket is unused by another application or that deployed IAM/bucket policies are correct. Deployment qualification must check those external controls, public-access blocking, transport/encryption policy and the intended customer/environment boundary. No live bucket has been created or changed by the audit.
|
||||
|
||||
## S3 key layout and migration
|
||||
|
||||
The reviewed `qqq-s3-filesystem-v1` layout uses the host filesystem separator; the original platform comparison was recorded against QQQ 4.1.0-RC.20. With empty base paths, Windows writes two leading backslashes before the logical `printing/<tenant-hash>/<job>.ext` reference; Linux writes the canonical reference. Same-platform object operations have been qualified in isolated S3-compatible storage. The logical reference alone is therefore insufficient for IAM prefix rules or migration between platforms.
|
||||
QQQ filesystem 4.1.0-RC.20 builds S3 keys with the host filesystem separator. With empty base paths, Windows writes two leading backslashes before the logical `printing/<tenant-hash>/<job>.ext` reference; Linux writes the canonical reference. Same-platform object operations have been qualified in isolated S3-compatible storage. The logical reference alone is therefore insufficient for IAM prefix rules or migration between platforms.
|
||||
|
||||
Printing fingerprints the reviewed `qqq-s3-filesystem-v1` layout and the actual `File.separatorChar` code point (47 or 92), alongside the endpoint, bucket, region, path-style setting and backend/table base paths. Ordered JSON encoding preserves the identity component boundaries, including valid multiline base paths. A different layout rejects historical reads, new retries and cleanup with a destination-mismatch error before accessing those objects. New retries whose source binding is already incompatible fail before reserving another upload; the document loader also rechecks the binding when reading. An already-created retry still returns its idempotent receipt. Cleanup preserves content availability, retained-byte accounting and orphan reservations on mismatch.
|
||||
|
||||
The released storage implementation requires this layout marker. Old experimental fingerprints without the layout marker are deliberately rejected, even on their original platform. Startup never rewrites those bindings or moves/deletes their objects. Preserve the original database and objects until an explicitly reviewed migration or disposal; do not replace hashes merely to bypass the guard. Inline database documents remain readable and can be explicitly retried into the configured destination without any automatic storage migration.
|
||||
This S3 feature is unreleased. Old experimental fingerprints without the layout marker are deliberately rejected, even on their original platform. Startup never rewrites those bindings or moves/deletes their objects. Preserve the original database and objects until an explicitly reviewed migration or disposal; do not replace hashes merely to bypass the guard. Inline database documents remain readable and can be explicitly retried into the configured destination without any automatic storage migration.
|
||||
|
||||
This guard does not make QQQ keys portable. The upstream owner must provide portable key construction and legacy-key handling. Adopting that change, including a change on the same operating system, requires an explicit layout-marker review and a migration plan for historical bindings and exact objects. The marker is a reviewed compatibility contract, not automatic detection of dependency implementation changes. Cross-platform migration and production IAM remain separate qualification work.
|
||||
|
||||
@@ -26,9 +26,9 @@ This guard does not make QQQ keys portable. The upstream owner must provide port
|
||||
|
||||
Record Files owns original versions and attachments; document generation owns rendering. Printing owns a separate delivery payload and queue receipts. Never bind printing cleanup to a Record Files bucket or pass an original's storage key as a printing-owned reference. Printing expiration must not remove a source attachment or weaken its retention policy.
|
||||
|
||||
Direct submission accepts bytes and a stable business idempotency key. The optional [retained-source facade](RETAINED-PRINT-FACADE.md) additionally binds an authorized immutable source, actor, destination and acceptance receipt. It is disabled until the host supplies its source authority; this repository does not configure a Record Files adapter automatically. Printing checks device/destination authorization at dispatch, not later revocation of the source attachment's permissions. The integrating owner must define that boundary before promising revocation propagation.
|
||||
The current independent integration seam accepts bytes and a stable business idempotency key. An authorized immutable-version reader and source/job correlation contract are being coordinated with Record Files; that API is not yet implemented or assumed here. Printing currently checks device/destination authorization at dispatch, not later revocation of the source attachment's permissions. A shared adapter must define that boundary before promising revocation propagation.
|
||||
|
||||
The existing `PrintEnqueueEffectTarget` accepts base64 document bytes in the host's durable outbox. That outbox may retain another delivery copy outside this module's S3 cleanup policy. Hosts must manage its retention separately; do not claim that configuring printing S3 moves existing outbox payloads or all upstream copies into the printing bucket. A host-provided retained-version adapter should carry authorized opaque source IDs/hash/length/media type and actor/correlation, not bucket URLs or duplicated document bytes. Direct byte submission stores the printing-owned payload through the configured storage backend without adding this host-outbox copy.
|
||||
The existing `PrintEnqueueEffectTarget` accepts base64 document bytes in the host's durable outbox. That outbox may retain another delivery copy outside this module's S3 cleanup policy. Hosts must manage its retention separately; do not claim that configuring printing S3 moves existing outbox payloads or all upstream copies into the printing bucket. The future retained-version adapter should carry authorized opaque source IDs/hash/length/media type and actor/correlation, not bucket URLs or duplicated document bytes. Direct byte submission stores the printing-owned payload through the configured storage backend without adding this host-outbox copy.
|
||||
|
||||
## Administration and scheduled cleanup
|
||||
|
||||
@@ -36,8 +36,6 @@ Printing administration exposes retention settings and a reviewed **Run cleanup*
|
||||
|
||||
When the host supplies a scheduler, maintenance runs every five minutes in bounded batches of at most 200. That permits a nominal 57,600 eligible documents per day before storage latency or failures; it is not measured production throughput. Changing a retention setting does not itself purge documents. Disabling cleanup preserves content. Without a configured scheduler there is no automatic job; the administration screen must show that condition.
|
||||
|
||||
**Delete printers** and **Delete print stations** delete the record at once and keep every job (see the [walkthrough](UI-WALKTHROUGH.md#delete-a-print-station-or-a-printer)); a deleted station's retained-byte counter stays until cleanup has removed its last stored document, then cleanup deletes the counter. The same run purges archived inventory. The **Remove printers** and **Remove print station** actions (retired in 1.2.0) and the service methods `removePrinter` / `removeDevice` never delete rows; they set `removed_at` (shown as **Removed at**) so the rows leave the default views, selectors, catalog, claims and the realtime `PRINTERS` frame while job history keeps resolving to them. After the document step, each cleanup run hard-deletes, within the remaining batch allowance, removed printers that no `printing_job` references (neither by `printer_row_id` nor by device and queue identity) and then removed devices that have no jobs and no printer rows left; a removed device's control receipts and resource accounting go with it. Anything a job references is never deleted, so a removed printer or device stays, hidden, for as long as its jobs exist. The purge counts toward the run's reported total and is logged with the printer and device counts; disabling cleanup pauses it together with document removal. Cleanup never deletes an active (non-removed) printer or device, and never deletes a job.
|
||||
|
||||
Only eligible successful terminal jobs lose their document content. Active, failed or uncertain work remains protected. Job metadata, document hashes, receipts and idempotency records remain available for auditing and duplicate prevention. Legacy completion times are recovered only from durable successful events; unknown completion dates remain protected. Existing inline database documents remain readable; the initial storage integration does not silently migrate old bytes to S3. Reprinting a job whose document has been removed returns an explicit unavailable-document result.
|
||||
|
||||
## Failure and versioning behavior
|
||||
|
||||
@@ -1,63 +1,5 @@
|
||||
# Follow-up
|
||||
|
||||
## Current — release closeout (2026-11-04)
|
||||
|
||||
- [x] Adopt published QQQ 4.1.0-RC.21 and complete the existing local verification.
|
||||
- [x] Pass normal primary CI, publish qbit-printing 1.0.0 and verify the release/registry bytes.
|
||||
- [x] Publish protocol 1.0.0 and Windows connector 1.0.1; keep their distinct API/product versions documented.
|
||||
- [x] Update active setup, operating, security and release documentation for Gitea and the released features.
|
||||
|
||||
No server 1.0 release task remains open. Deployment-specific database, IAM/provider policy and optional cross-QBit adapters remain the integrating application's responsibilities, described in the operating guides. The legacy optional Authentik diagnostic is documented as an RC.20-era fixture; updating it is not part of this release closeout.
|
||||
|
||||
## Historical checklists
|
||||
|
||||
Everything below records earlier development checkpoints. Unchecked historical items do not reopen completed or excluded release work.
|
||||
|
||||
## Echo integration candidate
|
||||
|
||||
- [x] Implement authorized operator catalog, native submission/process permission,
|
||||
exact actor/request lookup and reported driver-default media revisions.
|
||||
- [x] Integrate the opt-in atomic retained-source facade using the same queue,
|
||||
current authority, immutable acceptance and exact device-event observation.
|
||||
- [x] Close native callback authority changes and preserve the exact accepted
|
||||
printer-row identity during read-only request reconciliation.
|
||||
- [x] Complete local combined verification on the merged 2.3.0 candidate: 189
|
||||
reported, 188 executed, one opt-in workload skip, zero failures/errors and
|
||||
Checkstyle violations (the earlier 183-test gate was pre-merge). Preserve exact
|
||||
source, draft protocol fixtures and frozen runtime hashes.
|
||||
- [ ] Pass hosted CI on the final signed candidate head; local results do not
|
||||
replace it.
|
||||
- [ ] Qualify Echo/Generation's exact core tuple and configured source authority;
|
||||
do not silently adopt experimental core or bypass external-upload admission.
|
||||
- [ ] Publish the reviewed additive contract and coordinate client/runtime adoption
|
||||
before owner-operated end-to-end physical acceptance.
|
||||
|
||||
## Script quality gates
|
||||
|
||||
- [x] Pin Ruff and strict Pyright (official npm package) with locked restores; reject Python outside `.github/scripts/` and zero-file Pyright runs; negative tool probes pass locally.
|
||||
- [ ] Observe the new `verify` job steps pass on hosted CI before relying on them.
|
||||
|
||||
## Integrated compiler, standards and fixture gates
|
||||
|
||||
- [x] Layer the reviewed Error Prone/NullAway compiler gate, null contracts and
|
||||
style corrections over the merged 2.3.0 source without relaxing any security check.
|
||||
- [x] Integrated source compiles clean under Error Prone 2.51.0/NullAway/-Werror for
|
||||
main and test sources (R27), and the full local verify passed: 189 reported, 0
|
||||
failures, 0 errors, one intentional 10k-workload opt-in skip, zero Checkstyle
|
||||
violations (R28). This qualifies the integrated source only; the earlier
|
||||
133-test/204-jar results describe the old baseline.
|
||||
- [ ] Observe the `development-clients` and `development-servers` jobs, the compiler
|
||||
guard and the script-quality gates pass on hosted CI.
|
||||
|
||||
## Small-label release cohort
|
||||
|
||||
- [x] Merge the 4 x 1 / 4 x 2 label profiles, compact PDF/ZPL layouts, explicit PDF job paper and their tests
|
||||
onto the strict standards tree, keeping the strict headers, null contracts and Error Prone fixes.
|
||||
- [x] Cohort gate passed locally on the merged tree: strict main/test compile and full `-Pui-demo verify`, 193 tests,
|
||||
0 failures, 0 errors, one intentional opt-in skip, 0 Checkstyle violations.
|
||||
- [x] CI and the README pin the final protocol commit `42c0d249f81395f00408ec0f92638dcbbf5deb03` (merged Gitea PR 2).
|
||||
- [ ] Observe hosted Gitea CI, then publish and install; physical confirmation of the short labels stays an owner step (4 x 6 stock is loaded).
|
||||
|
||||
## Current local development qualification
|
||||
|
||||
- [x] Reuse production discovery and the shared major-2 gate in the optional
|
||||
|
||||
+4
-23
@@ -10,34 +10,15 @@ Open **Printing** in the navigation. The home presents the current tenant and re
|
||||
|
||||
## Enroll a facility computer
|
||||
|
||||
Choose **Enroll a print station** from Printing home or the Print stations table. A print station is the computer that runs the print client. Use the resulting short-lived enrollment code in the Windows companion's Connection settings. Once enrolled, select the installed printer queues to expose in the companion. Exposure is opt-in and persists in the service.
|
||||
Choose **Enroll a print device** from Printing home or the Print devices table. Use the resulting short-lived enrollment code in the Windows companion's Connection settings. Once enrolled, select the installed printer queues to expose in the companion. Exposure is opt-in and persists in the service.
|
||||
|
||||
Open **Printers** in QQQ. The operational columns show the printer name, named print station, status, approval, local exposure, and last contact. Approval and exposure are independent: a printer must be both approved in QQQ and exposed on the computer before new jobs can be dispatched.
|
||||
Open **Printers** in QQQ. The operational columns show the printer name, named print device, status, approval, local exposure, and last contact. Approval and exposure are independent: a printer must be both approved in QQQ and exposed on the computer before new jobs can be dispatched.
|
||||
|
||||
|
||||
|
||||
## Act on one printer or a selection
|
||||
|
||||
Select one or more printer rows and open **Actions**, or open an individual printer record and use its actions. Available operations include **Approve printers**, **Disable printers**, **Delete printers**, **Print a test page**, and **Print a test label**. The standard QQQ review screen describes the selection; reviewing does not print. Submitting a test action queues one job per selected eligible printer.
|
||||
|
||||
## Records archived by the retired Remove actions
|
||||
|
||||
Before 1.2.0 the actions **Remove printers** and **Remove print station** archived a record instead of deleting it. They are retired; use **Delete printers** and **Delete print stations** (below). A record archived earlier still has a **Removed at** time, has no approval or exposure, and is absent from the operator catalog, the connector's approval frame and the station/printer choices in the setup and test-print forms; its job history stays. The Printers and Print stations tables have no server-side default filter, so add **Removed at is empty** to the views you keep (the screenshots above predate this field) to hide archived rows; clear it to audit them, and delete them when you no longer want them listed. If the Windows companion shares an archived queue again, the next inventory brings the printer back as exposed but not approved, so approve it again before it can print. An archived station cannot be brought back; enroll the computer again to create a new station. Retention cleanup eventually hard-deletes archived stations and printers that no job references.
|
||||
|
||||
## Delete a print station or a printer
|
||||
|
||||
Deleting needs the `printing_delete` permission in addition to `printing_admin`; without it the two actions are not offered.
|
||||
|
||||
Open a Print stations record, or select rows in Print stations, and choose **Delete print stations**. Tick the confirmation and continue. The review screen then says exactly what will happen for the selection: how many stations are deleted, how many printers go with them, how many queued jobs are canceled, how many jobs already sent to a station are closed as outcome unknown, and how many finished jobs keep their history. It also lists, by name, every record that will not be deleted and why. Nothing has changed yet. Submit to delete.
|
||||
|
||||
- The station's access is revoked first. The computer cannot connect as that station again; enroll it again to print, and it is then a new station.
|
||||
- Its printers are deleted with it.
|
||||
- Queued jobs become **Failed** with the message "Canceled before dispatch: its print station was deleted". Jobs that were already sent to the station and had not reported a result become **Outcome unknown**: check the printer before printing them again.
|
||||
- Finished jobs stay in Print jobs. Their **Print station**, **Computer name**, **Printer** and **Windows queue name** columns show the names they were printed under.
|
||||
- A station that is connected (status Online or Paused) and printing is refused. Wait for the jobs to finish, or use **Disconnect print stations** or **Revoke print station access** first.
|
||||
- **Deletion history** in the Printing app records who deleted what and when.
|
||||
|
||||
**Delete printers** works the same way on Printers. The printer's station stays in service. If the station still shares that Windows queue, its next inventory reports it again and it comes back as a new printer that is exposed and not approved; stop sharing it in the print client on that computer to keep it away.
|
||||
Select one or more printer rows and open **Actions**, or open an individual printer record and use its actions. Available operations include **Approve printers**, **Disable printers**, **Print a test page**, and **Print a test label**. The standard QQQ review screen describes the selection; reviewing does not print. Submitting a test action queues one job per selected eligible printer.
|
||||
|
||||
|
||||
|
||||
@@ -57,4 +38,4 @@ The Windows companion shows recent jobs and a persistent status footer. **View s
|
||||
|
||||
## Preview acceptance and limits
|
||||
|
||||
The live preview was inspected with frontend 1.0.0-RC.37: the six operational printer columns, named device relationship, disabled generic write actions, and dashboard-to-filtered-table navigation were observed. Selecting the synthetic Zebra, opening Print a test label, reviewing and submitting completed with one printer processed. No physical printer was connected to this demo. Native process authorization and multi-printer execution are also covered by Java tests. These are historical preview observations, not evidence for every browser size or deployed printer driver. Current release status is in the [README](../README.md) and [release guide](RELEASES.md).
|
||||
The live preview was inspected with frontend 1.0.0-RC.37: the six operational printer columns, named device relationship, disabled generic write actions, and dashboard-to-filtered-table navigation were observed. Selecting the synthetic Zebra, opening Print a test label, reviewing and submitting completed with one printer processed. No physical printer was connected to this demo. Native process authorization and multi-printer execution are also covered by Java tests. A broad browser/accessibility run and final elevated companion interaction run remain separate acceptance tasks; see the README and the Windows repository's UX review.
|
||||
Generated
-51
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"name": "@qrun-io/qbit-printing-script-quality",
|
||||
"version": "0.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@qrun-io/qbit-printing-script-quality",
|
||||
"version": "0.0.0",
|
||||
"license": "Apache-2.0",
|
||||
"devDependencies": {
|
||||
"pyright": "1.1.414"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
}
|
||||
},
|
||||
"node_modules/fsevents": {
|
||||
"version": "2.3.3",
|
||||
"resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
|
||||
"integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
|
||||
"dev": true,
|
||||
"hasInstallScript": true,
|
||||
"license": "MIT",
|
||||
"optional": true,
|
||||
"os": [
|
||||
"darwin"
|
||||
],
|
||||
"engines": {
|
||||
"node": "^8.16.0 || ^10.6.0 || >=11.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/pyright": {
|
||||
"version": "1.1.414",
|
||||
"resolved": "https://registry.npmjs.org/pyright/-/pyright-1.1.414.tgz",
|
||||
"integrity": "sha512-FPZZb51jepDX4eP7TEYDeNFtmE3WgwkkEcJpvH3/QmUSsj0EAy3LXu+xB4T/FWDejtsXlCfFr/rbWFjwuwuXww==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"bin": {
|
||||
"pyright": "index.js",
|
||||
"pyright-langserver": "langserver.index.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=14.0.0"
|
||||
},
|
||||
"optionalDependencies": {
|
||||
"fsevents": "~2.3.3"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,14 +0,0 @@
|
||||
{
|
||||
"name": "@qrun-io/qbit-printing-script-quality",
|
||||
"version": "0.0.0",
|
||||
"private": true,
|
||||
"description": "Development-only script quality tooling for QBit Printing; no runtime dependency.",
|
||||
"license": "Apache-2.0",
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
},
|
||||
"devDependencies": {
|
||||
"pyright": "1.1.414"
|
||||
},
|
||||
"packageManager": "npm@11.19.1"
|
||||
}
|
||||
@@ -6,16 +6,16 @@
|
||||
|
||||
<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>
|
||||
<parent><groupId>com.kingsrook</groupId><artifactId>qbit-build-parent</artifactId><version>2.2.1</version><relativePath/></parent>
|
||||
<parent><groupId>com.kingsrook</groupId><artifactId>qbit-build-parent</artifactId><version>2.0.0</version><relativePath/></parent>
|
||||
<groupId>com.kingsrook.qbits</groupId>
|
||||
<artifactId>qbit-printing</artifactId>
|
||||
<version>1.1.2</version>
|
||||
<version>0.4.0-SNAPSHOT</version>
|
||||
<name>QQQ Printing</name>
|
||||
<licenses><license><name>Apache License, Version 2.0</name><url>https://www.apache.org/licenses/LICENSE-2.0</url></license></licenses>
|
||||
<properties>
|
||||
<maven.compiler.release>21</maven.compiler.release>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<qqq.version>4.1.0-RC.25</qqq.version>
|
||||
<qqq.version>4.1.0-RC.20</qqq.version>
|
||||
<maven.compiler.proc>none</maven.compiler.proc>
|
||||
</properties>
|
||||
<dependencyManagement><dependencies>
|
||||
@@ -25,9 +25,6 @@
|
||||
<dependency><groupId>org.junit</groupId><artifactId>junit-bom</artifactId><version>6.0.1</version><type>pom</type><scope>import</scope></dependency>
|
||||
</dependencies></dependencyManagement>
|
||||
<dependencies>
|
||||
<dependency><groupId>com.uber.nullaway</groupId><artifactId>nullaway-annotations</artifactId><version>0.14.3</version><scope>provided</scope></dependency>
|
||||
<!-- Direct nullable contracts reuse the already-resolved runtime annotation version. -->
|
||||
<dependency><groupId>org.jspecify</groupId><artifactId>jspecify</artifactId><version>1.0.0</version></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>
|
||||
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-backend-module-filesystem</artifactId><version>${qqq.version}</version></dependency>
|
||||
@@ -37,7 +34,7 @@
|
||||
<dependency><groupId>org.junit.jupiter</groupId><artifactId>junit-jupiter</artifactId><version>6.0.1</version><scope>test</scope></dependency>
|
||||
</dependencies>
|
||||
<profiles><profile><id>ui-demo</id><dependencies>
|
||||
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-frontend-next</artifactId><version>1.0.0-RC.38</version><scope>runtime</scope></dependency>
|
||||
<dependency><groupId>com.kingsrook.qqq</groupId><artifactId>qqq-frontend-next</artifactId><version>1.0.0-RC.37</version><scope>runtime</scope></dependency>
|
||||
</dependencies></profile></profiles>
|
||||
<build>
|
||||
<resources>
|
||||
@@ -52,57 +49,10 @@
|
||||
<plugins>
|
||||
<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>checkstyle/config.xml</configLocation>
|
||||
<!-- Development fixtures use distinct runtime tuples, but share the source style gate. -->
|
||||
<sourceDirectories>
|
||||
<sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
|
||||
<sourceDirectory>${project.basedir}/dev/java</sourceDirectory>
|
||||
<sourceDirectory>${project.basedir}/dev/native-auth/java</sourceDirectory>
|
||||
</sourceDirectories>
|
||||
<includeTestSourceDirectory>true</includeTestSourceDirectory>
|
||||
<consoleOutput>true</consoleOutput>
|
||||
<violationSeverity>warning</violationSeverity>
|
||||
<failOnViolation>true</failOnViolation>
|
||||
</configuration>
|
||||
<configuration><configLocation>checkstyle/config.xml</configLocation><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>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-compiler-plugin</artifactId>
|
||||
<version>3.14.1</version>
|
||||
<configuration>
|
||||
<release>21</release>
|
||||
<proc>none</proc>
|
||||
<fork>true</fork>
|
||||
<executable>${java.home}/bin/javac</executable>
|
||||
<showWarnings>true</showWarnings>
|
||||
<failOnWarning>true</failOnWarning>
|
||||
<compilerArgs>
|
||||
<arg>-Werror</arg>
|
||||
<arg>-Xlint:deprecation</arg>
|
||||
<arg>-Xlint:unchecked</arg>
|
||||
<arg>-XDcompilePolicy=simple</arg>
|
||||
<arg>--should-stop=ifError=FLOW</arg>
|
||||
<arg>-XDaddTypeAnnotationsToSymbol=true</arg>
|
||||
<arg>-Xplugin:ErrorProne -Xep:NullAway:ERROR -XepOpt:NullAway:AnnotatedPackages=com.kingsrook.qbits.printing</arg>
|
||||
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED</arg>
|
||||
<arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED</arg>
|
||||
</compilerArgs>
|
||||
<annotationProcessorPaths>
|
||||
<path><groupId>com.google.errorprone</groupId><artifactId>error_prone_core</artifactId><version>2.51.0</version></path>
|
||||
<path><groupId>com.uber.nullaway</groupId><artifactId>nullaway</artifactId><version>0.14.3</version></path>
|
||||
</annotationProcessorPaths>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.14.1</version></plugin>
|
||||
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><version>3.5.4</version></plugin>
|
||||
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><version>3.4.2</version><configuration><archive><manifestEntries><Implementation-Version>${project.version}</Implementation-Version></manifestEntries></archive></configuration></plugin>
|
||||
<plugin><groupId>org.codehaus.mojo</groupId><artifactId>exec-maven-plugin</artifactId><version>3.6.3</version><configuration><mainClass>com.kingsrook.qbits.printing.PrintingDemo</mainClass></configuration></plugin>
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
# Copyright 2026 Kingsrook, LLC
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
[project]
|
||||
name = "qbit-printing-script-quality"
|
||||
version = "0.0.0"
|
||||
requires-python = ">=3.13"
|
||||
|
||||
[dependency-groups]
|
||||
dev = ["ruff==0.17.3"]
|
||||
|
||||
[tool.uv]
|
||||
package = false
|
||||
@@ -1,56 +0,0 @@
|
||||
# Copyright 2026 Kingsrook, LLC
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# Based on K22 fbfc8d2cf3b5e16ae9750b04cf9de1794f1e7152.
|
||||
# KofTwentyTwo Python lint + format configuration (K22-CODE-PY). Copy to the repo root
|
||||
# (or merge into [tool.ruff] in pyproject.toml). `ruff format --check` and `ruff check`
|
||||
# run in CI and pre-commit with zero findings allowed.
|
||||
target-version = "py313"
|
||||
include = [".github/scripts/*.py"]
|
||||
extend-exclude = [".venv", "node_modules", "dist", "target", "bin", "obj"]
|
||||
# Kingsrook: no practical line-length limit (ruff's maximum is 320).
|
||||
line-length = 320
|
||||
# Kingsrook: 3-space indentation. Ruff's formatter supports it fully; pycodestyle's
|
||||
# "multiple of four" rules (E111/E114) are therefore not selected.
|
||||
indent-width = 3
|
||||
|
||||
[format]
|
||||
quote-style = "double"
|
||||
indent-style = "space"
|
||||
line-ending = "lf"
|
||||
docstring-code-format = true
|
||||
|
||||
[lint]
|
||||
select = [
|
||||
"F", # pyflakes
|
||||
"E4", "E7", "E9", "W", # pycodestyle errors that are layout-independent
|
||||
"I", # isort: no wildcard imports, ordered
|
||||
"N", # pep8-naming
|
||||
"UP", # pyupgrade
|
||||
"B", # bugbear
|
||||
"S", # bandit security
|
||||
"BLE", # blind except
|
||||
"T20", # print statements: use logging (Kingsrook logging rule)
|
||||
"ERA", # commented-out code (Kingsrook: no zombie code)
|
||||
"FIX", # FIXME/TODO must be resolved or tracked
|
||||
"TD", # TODO format: author and issue link
|
||||
"PTH", # pathlib over os.path
|
||||
"RET", "SIM", "C4", "PIE", "PL", "RUF",
|
||||
"ANN", # type annotations on every function
|
||||
"D", # docstrings on modules, classes, functions
|
||||
"LOG", "G", # logging hygiene
|
||||
]
|
||||
ignore = [
|
||||
"D203", # conflicts with D211
|
||||
"D213", # conflicts with D212
|
||||
"TD003", # issue link is enforced by review, not regex
|
||||
]
|
||||
|
||||
[lint.per-file-ignores]
|
||||
".github/scripts/check-*.py" = ["T201"] # CLI diagnostics are the public stdout contract, not application logging.
|
||||
".github/scripts/test-*.py" = ["S101", "PLR2004"] # Synthetic assertions and explicit boundary values.
|
||||
|
||||
[lint.pydocstyle]
|
||||
convention = "pep257"
|
||||
|
||||
[lint.flake8-tidy-imports]
|
||||
ban-relative-imports = "all"
|
||||
@@ -27,7 +27,6 @@ import java.sql.Connection;
|
||||
import java.sql.DriverManager;
|
||||
import java.sql.SQLException;
|
||||
import java.util.logging.Logger;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -38,7 +37,7 @@ public record DriverDataSource(String url, String user, String password) impleme
|
||||
@Override
|
||||
public Connection getConnection() throws SQLException
|
||||
{
|
||||
return DriverManager.getConnection(url, user, password);
|
||||
return (DriverManager.getConnection(url, user, password));
|
||||
}
|
||||
|
||||
|
||||
@@ -46,15 +45,15 @@ public record DriverDataSource(String url, String user, String password) impleme
|
||||
@Override
|
||||
public Connection getConnection(String username, String secret) throws SQLException
|
||||
{
|
||||
return DriverManager.getConnection(url, username, secret);
|
||||
return (DriverManager.getConnection(url, username, secret));
|
||||
}
|
||||
|
||||
|
||||
|
||||
@Override
|
||||
public @Nullable PrintWriter getLogWriter()
|
||||
public PrintWriter getLogWriter()
|
||||
{
|
||||
return null;
|
||||
return (null);
|
||||
}
|
||||
|
||||
|
||||
@@ -78,7 +77,7 @@ public record DriverDataSource(String url, String user, String password) impleme
|
||||
@Override
|
||||
public int getLoginTimeout()
|
||||
{
|
||||
return DriverManager.getLoginTimeout();
|
||||
return (DriverManager.getLoginTimeout());
|
||||
}
|
||||
|
||||
|
||||
@@ -86,7 +85,7 @@ public record DriverDataSource(String url, String user, String password) impleme
|
||||
@Override
|
||||
public Logger getParentLogger()
|
||||
{
|
||||
return Logger.getLogger("com.kingsrook.qbits.printing");
|
||||
return (Logger.getLogger("com.kingsrook.qbits.printing"));
|
||||
}
|
||||
|
||||
|
||||
@@ -96,7 +95,7 @@ public record DriverDataSource(String url, String user, String password) impleme
|
||||
{
|
||||
if(type.isInstance(this))
|
||||
{
|
||||
return type.cast(this);
|
||||
return (type.cast(this));
|
||||
}
|
||||
throw new SQLException("Not a wrapper");
|
||||
}
|
||||
@@ -106,7 +105,7 @@ public record DriverDataSource(String url, String user, String password) impleme
|
||||
@Override
|
||||
public boolean isWrapperFor(Class<?> type)
|
||||
{
|
||||
return type.isInstance(this);
|
||||
return (type.isInstance(this));
|
||||
}
|
||||
|
||||
|
||||
@@ -114,7 +113,7 @@ public record DriverDataSource(String url, String user, String password) impleme
|
||||
@Override
|
||||
public String toString()
|
||||
{
|
||||
return "DriverDataSource[credentials redacted]";
|
||||
return ("DriverDataSource[credentials redacted]");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -48,11 +48,11 @@ public class PrintEnqueueEffectTarget implements EffectTarget
|
||||
try
|
||||
{
|
||||
JSONObject job = serviceForEffect().submit(payload);
|
||||
return EffectResult.sent(job.getString("jobId"));
|
||||
return (EffectResult.sent(job.getString("jobId")));
|
||||
}
|
||||
catch(PrintingException exception)
|
||||
{
|
||||
return EffectResult.failed(exception.getMessage());
|
||||
return (EffectResult.failed(exception.getMessage()));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -65,7 +65,7 @@ public class PrintEnqueueEffectTarget implements EffectTarget
|
||||
public ReconcileResult reconcile(EffectRequest request) throws Exception
|
||||
{
|
||||
JSONObject job = serviceForEffect().findByIdempotencyKey(request.idempotencyKey());
|
||||
return job == null ? ReconcileResult.notFound() : ReconcileResult.found(job.getString("jobId"));
|
||||
return (job == null ? ReconcileResult.notFound() : ReconcileResult.found(job.getString("jobId")));
|
||||
}
|
||||
|
||||
|
||||
@@ -79,13 +79,13 @@ public class PrintEnqueueEffectTarget implements EffectTarget
|
||||
{
|
||||
if(!(QContext.getQSession() instanceof QSystemUserSession))
|
||||
{
|
||||
return PrintingProcesses.currentService();
|
||||
return (PrintingProcesses.currentService());
|
||||
}
|
||||
for(QBitMetaData metadata : QContext.getQInstance().getQBits().values())
|
||||
{
|
||||
if(metadata.getConfig() instanceof PrintingQBitConfig config && config.getService() != null)
|
||||
{
|
||||
return config.getService();
|
||||
return (config.getService());
|
||||
}
|
||||
}
|
||||
throw new QException("Printing QBit is not configured for this effect dispatcher");
|
||||
|
||||
@@ -26,7 +26,6 @@ import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.permissions.MetaDataWithPermissionRules;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -48,11 +47,11 @@ public class PrintingAdminPermission extends UseOtherPermissionNameCustomPermiss
|
||||
** Enforce authorization even for direct backend-step invocation.
|
||||
***************************************************************************/
|
||||
@Override
|
||||
public void checkPermissionsThrowing(AbstractActionInput input, @Nullable MetaDataWithPermissionRules metadata) throws QPermissionDeniedException
|
||||
public void checkPermissionsThrowing(AbstractActionInput input, MetaDataWithPermissionRules metadata) throws QPermissionDeniedException
|
||||
{
|
||||
if(QContext.getQSession() == null || !QContext.getQSession().hasPermission("printing_admin"))
|
||||
{
|
||||
throw new QPermissionDeniedException(PrintingMessages.notAllowed(QContext.getQSession() != null, PrintingMessages.MANAGE_STATIONS, PrintingMessages.ADMIN_GRANT));
|
||||
throw new QPermissionDeniedException("Printing administrator permission is required");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,7 +25,6 @@ import java.sql.Connection;
|
||||
import java.sql.SQLException;
|
||||
import java.time.Instant;
|
||||
import java.util.Set;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -175,7 +174,7 @@ final class PrintingAdmission
|
||||
/***************************************************************************
|
||||
** SQL aggregates stay bounded by active capacity and the rolling hour index.
|
||||
***************************************************************************/
|
||||
private static void checkScope(Connection connection, String tenant, @Nullable String device, int bytes, long jobLimit, long activeByteLimit, long retainedLimit, long hourlyLimit, String cutoff) throws SQLException
|
||||
private static void checkScope(Connection connection, String tenant, String device, int bytes, long jobLimit, long activeByteLimit, long retainedLimit, long hourlyLimit, String cutoff) throws SQLException
|
||||
{
|
||||
String predicate = "tenant_id=?" + (device == null ? "" : " AND device_id=?");
|
||||
String outstanding = "SELECT content_length FROM printing_job WHERE " + predicate + " AND status IN " + ACTIVE
|
||||
@@ -206,11 +205,11 @@ final class PrintingAdmission
|
||||
/***************************************************************************
|
||||
** Failed upload reservations stay charged until exact confirmed removal.
|
||||
***************************************************************************/
|
||||
private static long orphanBytes(Connection connection, String tenant, @Nullable String device) throws SQLException
|
||||
private static long orphanBytes(Connection connection, String tenant, String device) throws SQLException
|
||||
{
|
||||
String sql = "SELECT COALESCE(SUM(COALESCE(content_length,20971520)),0) FROM printing_document_orphan o WHERE tenant_id=?"
|
||||
+ (device == null ? "" : " AND device_id=?") + " AND NOT EXISTS(SELECT 1 FROM printing_job j WHERE j.id=o.id)";
|
||||
return device == null ? number(connection, sql, tenant) : number(connection, sql, tenant, device);
|
||||
return (device == null ? number(connection, sql, tenant) : number(connection, sql, tenant, device));
|
||||
}
|
||||
|
||||
|
||||
@@ -218,7 +217,7 @@ final class PrintingAdmission
|
||||
/***************************************************************************
|
||||
** Release only after deletion; an inconsistent counter fails closed.
|
||||
***************************************************************************/
|
||||
static void release(Connection connection, String tenant, @Nullable String device, long bytes) throws SQLException
|
||||
static void release(Connection connection, String tenant, String device, long bytes) throws SQLException
|
||||
{
|
||||
int expected = device == null ? 1 : 2;
|
||||
String predicate = device == null ? "device_id=''" : "device_id IN ('',?)";
|
||||
@@ -256,7 +255,7 @@ final class PrintingAdmission
|
||||
/***************************************************************************
|
||||
** Read one scalar; never materialize payloads or an unbounded row list.
|
||||
***************************************************************************/
|
||||
private static long number(Connection connection, String sql, @Nullable Object... values) throws SQLException
|
||||
private static long number(Connection connection, String sql, Object... values) throws SQLException
|
||||
{
|
||||
try(var statement = connection.prepareStatement(sql))
|
||||
{
|
||||
@@ -270,7 +269,7 @@ final class PrintingAdmission
|
||||
{
|
||||
throw new SQLException("Missing printing resource accounting row");
|
||||
}
|
||||
return rows.getLong(1);
|
||||
return (rows.getLong(1));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -280,7 +279,7 @@ final class PrintingAdmission
|
||||
/***************************************************************************
|
||||
** All identifiers are fixed SQL; only values come from callers.
|
||||
***************************************************************************/
|
||||
private static int execute(Connection connection, String sql, @Nullable Object... values) throws SQLException
|
||||
private static int execute(Connection connection, String sql, Object... values) throws SQLException
|
||||
{
|
||||
try(var statement = connection.prepareStatement(sql))
|
||||
{
|
||||
@@ -288,7 +287,7 @@ final class PrintingAdmission
|
||||
{
|
||||
statement.setObject(index + 1, values[index]);
|
||||
}
|
||||
return statement.executeUpdate();
|
||||
return (statement.executeUpdate());
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -48,7 +48,7 @@ public record PrintingAdmissionLimits(int deviceOutstandingJobs, int tenantOutst
|
||||
public static PrintingAdmissionLimits defaults()
|
||||
{
|
||||
long gibibyte = 1024L * 1024 * 1024;
|
||||
return new PrintingAdmissionLimits(10_000, 100_000, 10 * gibibyte, 100 * gibibyte,
|
||||
2048 * gibibyte, 20_480 * gibibyte, 2_000, 20_000, 1_000, 20_000);
|
||||
return (new PrintingAdmissionLimits(10_000, 100_000, 10 * gibibyte, 100 * gibibyte,
|
||||
2048 * gibibyte, 20_480 * gibibyte, 2_000, 20_000, 1_000, 20_000));
|
||||
}
|
||||
}
|
||||
@@ -63,7 +63,7 @@ public class PrintingAdmissionSettings
|
||||
{
|
||||
try(Connection connection = source.getConnection())
|
||||
{
|
||||
return json(effective(connection));
|
||||
return (json(effective(connection)));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -85,7 +85,7 @@ public class PrintingAdmissionSettings
|
||||
throw new SQLException("The tenant admission settings row is unavailable");
|
||||
}
|
||||
}
|
||||
return value;
|
||||
return (value);
|
||||
}
|
||||
|
||||
|
||||
@@ -102,10 +102,10 @@ public class PrintingAdmissionSettings
|
||||
{
|
||||
if(!rows.next())
|
||||
{
|
||||
return defaults;
|
||||
return (defaults);
|
||||
}
|
||||
String stored = rows.getString(1);
|
||||
return stored == null ? defaults : parse(new JSONObject(stored));
|
||||
return (stored == null ? defaults : parse(new JSONObject(stored)));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -123,9 +123,9 @@ public class PrintingAdmissionSettings
|
||||
}
|
||||
try
|
||||
{
|
||||
return new PrintingAdmissionLimits(integer(value, "deviceOutstandingJobs"), integer(value, "tenantOutstandingJobs"),
|
||||
return (new PrintingAdmissionLimits(integer(value, "deviceOutstandingJobs"), integer(value, "tenantOutstandingJobs"),
|
||||
number(value, "deviceOutstandingBytes"), number(value, "tenantOutstandingBytes"), number(value, "deviceRetainedBytes"), number(value, "tenantRetainedBytes"),
|
||||
integer(value, "deviceJobsPerHour"), integer(value, "tenantJobsPerHour"), integer(value, "devicePrinters"), integer(value, "tenantPrinters"));
|
||||
integer(value, "deviceJobsPerHour"), integer(value, "tenantJobsPerHour"), integer(value, "devicePrinters"), integer(value, "tenantPrinters")));
|
||||
}
|
||||
catch(ArithmeticException exception)
|
||||
{
|
||||
@@ -140,7 +140,7 @@ public class PrintingAdmissionSettings
|
||||
***************************************************************************/
|
||||
private static int integer(JSONObject value, String field)
|
||||
{
|
||||
return Math.toIntExact(number(value, field));
|
||||
return (Math.toIntExact(number(value, field)));
|
||||
}
|
||||
|
||||
|
||||
@@ -159,7 +159,7 @@ public class PrintingAdmissionSettings
|
||||
{
|
||||
throw new IllegalArgumentException(field + " is outside the supported positive range");
|
||||
}
|
||||
return parsed;
|
||||
return (parsed);
|
||||
}
|
||||
|
||||
|
||||
@@ -169,10 +169,10 @@ public class PrintingAdmissionSettings
|
||||
***************************************************************************/
|
||||
private static JSONObject json(PrintingAdmissionLimits value)
|
||||
{
|
||||
return new JSONObject().put("deviceOutstandingJobs", value.deviceOutstandingJobs()).put("tenantOutstandingJobs", value.tenantOutstandingJobs())
|
||||
return (new JSONObject().put("deviceOutstandingJobs", value.deviceOutstandingJobs()).put("tenantOutstandingJobs", value.tenantOutstandingJobs())
|
||||
.put("deviceOutstandingBytes", value.deviceOutstandingBytes()).put("tenantOutstandingBytes", value.tenantOutstandingBytes())
|
||||
.put("deviceRetainedBytes", value.deviceRetainedBytes()).put("tenantRetainedBytes", value.tenantRetainedBytes())
|
||||
.put("deviceJobsPerHour", value.deviceJobsPerHour()).put("tenantJobsPerHour", value.tenantJobsPerHour())
|
||||
.put("devicePrinters", value.devicePrinters()).put("tenantPrinters", value.tenantPrinters());
|
||||
.put("devicePrinters", value.devicePrinters()).put("tenantPrinters", value.tenantPrinters()));
|
||||
}
|
||||
}
|
||||
@@ -55,7 +55,7 @@ public final class PrintingAgentAuthorization
|
||||
String principal = PrintingControlAuthorization.principal();
|
||||
PrintingControlAuthorization.record(PrintingTables.DEVICE, id);
|
||||
PrintingProcesses.currentService().authorizeAgent(id, token, principal, bind);
|
||||
return id;
|
||||
return (id);
|
||||
}
|
||||
|
||||
|
||||
@@ -69,7 +69,7 @@ public final class PrintingAgentAuthorization
|
||||
{
|
||||
throw new QPermissionDeniedException("Printer is not accessible");
|
||||
}
|
||||
return PrintingControlAuthorization.record(PrintingTables.PRINTER, rows.getFirst().getValueString("id"));
|
||||
return (PrintingControlAuthorization.record(PrintingTables.PRINTER, rows.getFirst().getValueString("id")));
|
||||
}
|
||||
|
||||
|
||||
@@ -93,20 +93,10 @@ public final class PrintingAgentAuthorization
|
||||
cursor = page.isNull("nextCursor") ? null : page.getString("nextCursor");
|
||||
}
|
||||
while(cursor != null);
|
||||
// Removed printers are hidden from the page but still belong to the device's row set: a re-shared queue reactivates one.
|
||||
for(var removed : PrintingControlAuthorization.query(new QueryInput().withTableName(PrintingTables.PRINTER)
|
||||
.withFilter(new QQueryFilter(new QFilterCriteria("device_id", QCriteriaOperator.EQUALS, device)).withCriteria(new QFilterCriteria("removed_at", QCriteriaOperator.IS_NOT_BLANK)).withLimit(10001))).getRecords())
|
||||
{
|
||||
authorized.add(removed.getValueString("id"));
|
||||
if(authorized.size() > 10000)
|
||||
{
|
||||
throw new PrintingException(429, "Inventory exceeds the bounded native review limit");
|
||||
}
|
||||
}
|
||||
// Even an empty inventory must have native table READ access.
|
||||
PrintingControlAuthorization.query(new QueryInput().withTableName(PrintingTables.PRINTER)
|
||||
.withFilter(new QQueryFilter(new QFilterCriteria("device_id", QCriteriaOperator.EQUALS, device)).withLimit(1)));
|
||||
return authorized;
|
||||
return (authorized);
|
||||
}
|
||||
|
||||
|
||||
@@ -134,9 +124,9 @@ public final class PrintingAgentAuthorization
|
||||
JSONObject result = PrintingProcesses.currentService().claimForJob(device, id);
|
||||
if(!result.isNull("job"))
|
||||
{
|
||||
return result;
|
||||
return (result);
|
||||
}
|
||||
}
|
||||
return new JSONObject().put("job", JSONObject.NULL);
|
||||
return (new JSONObject().put("job", JSONObject.NULL));
|
||||
}
|
||||
}
|
||||
@@ -48,19 +48,11 @@ final class PrintingApiSchemas
|
||||
add(schemas, "EnrollmentRequest", fields("enrollmentCode", text(128), "deviceName", text(1024), "agentVersion", text(100)), "enrollmentCode", "deviceName", "agentVersion");
|
||||
add(schemas, "Enrollment", fields("protocolVersion", number(), "deviceId", id(), "deviceToken", text(128).withDescription("Private device proof, returned once; never log."), "pollIntervalSeconds", number()), "protocolVersion", "deviceId", "deviceToken", "pollIntervalSeconds");
|
||||
add(schemas, "Profile", fields("name", text(512).withNullable(true), "description", text(4096).withNullable(true), "location", text(512).withNullable(true)));
|
||||
add(schemas, "MediaSelection", fields("id", id(), "revision", text(64)), "id", "revision");
|
||||
add(schemas, "MediaProfile", fields("id", id(), "revision", text(64), "name", text(512), "widthMicrons", number(), "heightMicrons", number(), "dpiX", number(), "dpiY", number(),
|
||||
"source", enumeration("WINDOWS_QUEUE_DEFAULT"), "applyMode", enumeration("DRIVER_DEFAULT")), "id", "revision", "name", "widthMicrons", "heightMicrons", "dpiX", "dpiY", "source", "applyMode");
|
||||
add(schemas, "OperatorPrinter", fields("printerRowId", id(), "deviceId", id(), "printerId", id(), "name", text(1024), "deviceName", text(1024), "description", text(4096), "location", text(512), "status", text(40), "formats", array(enumeration("PDF", "ZPL")), "mediaProfiles", array(ref("MediaProfile"))),
|
||||
"printerRowId", "deviceId", "printerId", "name", "deviceName", "status", "formats", "mediaProfiles");
|
||||
add(schemas, "OperatorCatalog", fields("printers", array(ref("OperatorPrinter")), "nextCursor", text(200).withNullable(true)), "printers", "nextCursor");
|
||||
add(schemas, "OperatorSubmit", fields("requestId", text(128), "printerRowId", id(), "title", text(1024), "format", enumeration("PDF", "ZPL"), "contentBase64", text(Integer.MAX_VALUE), "options", ref("Options")),
|
||||
"requestId", "printerRowId", "title", "format", "contentBase64");
|
||||
add(schemas, "HeartbeatRequest", fields("agentVersion", text(100), "profile", ref("Profile")), "agentVersion");
|
||||
add(schemas, "Heartbeat", fields("serverTime", time()), "serverTime");
|
||||
add(schemas, "Printer", fields("printerId", id(), "name", text(1024), "driverName", text(1024), "portName", text(1024), "status", enumeration("READY", "OFFLINE", "PAUSED", "ERROR", "UNKNOWN"), "formats", array(enumeration("PDF", "ZPL")), "mediaProfiles", array(ref("MediaProfile")), "displayName", text(512), "description", text(4096), "location", text(512)), "printerId", "name", "formats");
|
||||
add(schemas, "Printer", fields("printerId", id(), "name", text(1024), "driverName", text(1024), "portName", text(1024), "status", enumeration("READY", "OFFLINE", "PAUSED", "ERROR", "UNKNOWN"), "formats", array(enumeration("PDF", "ZPL")), "displayName", text(512), "description", text(4096), "location", text(512)), "printerId", "name", "formats");
|
||||
add(schemas, "InventoryRequest", fields("printers", array(ref("Printer"))), "printers");
|
||||
add(schemas, "Options", fields("copies", number(), "scale", enumeration("ACTUAL_SIZE", "FIT"), "mediaProfile", ref("MediaSelection"), "paperWidthMm", new Schema().withType(Type.NUMBER), "paperHeightMm", new Schema().withType(Type.NUMBER)));
|
||||
add(schemas, "Options", fields("copies", number(), "scale", enumeration("ACTUAL_SIZE", "FIT"), "paperWidthMm", new Schema().withType(Type.NUMBER), "paperHeightMm", new Schema().withType(Type.NUMBER)));
|
||||
add(schemas, "Job", fields("jobId", id(), "deviceId", id(), "printerId", id(), "title", text(1024), "format", enumeration("PDF", "ZPL"), "contentSha256", text(64), "contentLength", number(), "options", ref("Options"), "createdAt", time(), "status", enumeration("QUEUED", "CLAIMED", "RECEIVED", "SUBMITTING", "SPOOLED", "SPOOLER_COMPLETED", "FAILED", "OUTCOME_UNKNOWN"), "message", text(2048), "spoolerJobId", id()), "jobId", "deviceId", "printerId", "title", "format", "contentSha256", "contentLength", "options", "createdAt", "status");
|
||||
add(schemas, "Claim", fields("job", ref("Job").withNullable(true)), "job");
|
||||
add(schemas, "Jobs", fields("jobs", array(ref("Job"))), "jobs");
|
||||
@@ -68,7 +60,7 @@ final class PrintingApiSchemas
|
||||
add(schemas, "TestRequest", fields("requestId", id(), "printerId", id(), "format", enumeration("PDF", "ZPL"), "testProfile", text(40)), "requestId", "printerId", "format");
|
||||
add(schemas, "RetryRequest", fields("requestId", id(), "confirmDuplicateRisk", bool()), "requestId");
|
||||
add(schemas, "DesiredState", fields("revision", number(), "dispatchPaused", bool(), "connectionState", enumeration("CONNECTED", "DISCONNECTED")), "revision", "dispatchPaused", "connectionState");
|
||||
add(schemas, "ControlPollRequest", fields("controlVersion", number(), "agentVersion", text(100), "capabilities", array(enumeration("REFRESH_INVENTORY", "CANCEL_SPOOL", "printer-media-v1", "printer-approval-v1")), "lastAppliedRevision", number()), "controlVersion", "agentVersion", "capabilities", "lastAppliedRevision");
|
||||
add(schemas, "ControlPollRequest", fields("controlVersion", number(), "agentVersion", text(100), "capabilities", array(enumeration("REFRESH_INVENTORY", "CANCEL_SPOOL")), "lastAppliedRevision", number()), "controlVersion", "agentVersion", "capabilities", "lastAppliedRevision");
|
||||
add(schemas, "Command", fields("commandId", id(), "requestId", id(), "action", enumeration("REFRESH_INVENTORY", "CANCEL_SPOOL"), "createdAt", time(), "expiresAt", time(), "jobId", id()), "commandId", "requestId", "action", "createdAt", "expiresAt");
|
||||
add(schemas, "ControlPoll", fields("controlVersion", number(), "serverTime", time(), "pollIntervalSeconds", number(), "desiredState", ref("DesiredState"), "commands", array(ref("Command"))), "controlVersion", "serverTime", "pollIntervalSeconds", "desiredState", "commands");
|
||||
add(schemas, "ReceiptRequest", fields("receiptId", id(), "outcome", enumeration("INVENTORY_REFRESHED", "CANCEL_REQUESTED", "ALREADY_ABSENT", "OWNERSHIP_MISMATCH", "UNSUPPORTED", "FAILED", "EXPIRED", "OUTCOME_UNKNOWN"), "completedAt", time(), "message", text(1024)), "receiptId", "outcome", "completedAt");
|
||||
@@ -76,28 +68,28 @@ final class PrintingApiSchemas
|
||||
add(schemas, "ActionRequest", fields("requestId", id(), "issuedAt", time(), "action", actions, "jobId", id()), "requestId", "issuedAt", "action");
|
||||
add(schemas, "Action", fields("commandId", id(), "requestId", id(), "issuedAt", time(), "deviceId", id(), "action", actions, "status", enumeration("PENDING", "SUCCEEDED", "FAILED", "EXPIRED", "OUTCOME_UNKNOWN"), "createdAt", time(), "expiresAt", time(), "jobId", id(), "resultCode", text(80), "cancelledJobCount", number(), "receipt", ref("ReceiptRequest")), "commandId", "requestId", "issuedAt", "deviceId", "action", "status", "createdAt", "expiresAt");
|
||||
add(schemas, "Actions", fields("commands", array(ref("Action")), "nextCursor", text(128).withNullable(true)), "commands", "nextCursor");
|
||||
return schemas;
|
||||
return (schemas);
|
||||
}
|
||||
|
||||
|
||||
/** Every schema has the extension prefix required by the native registry. */
|
||||
static String name(String shortName)
|
||||
{
|
||||
return "Printing" + shortName + "V1";
|
||||
return ("Printing" + shortName + "V1");
|
||||
}
|
||||
|
||||
|
||||
/** Refer to one typed reusable component. */
|
||||
static Schema ref(String name)
|
||||
{
|
||||
return new Schema().withRefToSchema(name(name));
|
||||
return (new Schema().withRefToSchema(name(name)));
|
||||
}
|
||||
|
||||
|
||||
/** Bounded Unicode text. */
|
||||
static Schema text(int limit)
|
||||
{
|
||||
return new Schema().withType(Type.STRING).withMaxLength(limit);
|
||||
return (new Schema().withType(Type.STRING).withMaxLength(limit));
|
||||
}
|
||||
|
||||
|
||||
@@ -107,7 +99,7 @@ final class PrintingApiSchemas
|
||||
@Override
|
||||
public Schema toSchema()
|
||||
{
|
||||
return new RequiredSchema(required).withType(Type.OBJECT).withProperties(properties);
|
||||
return (new RequiredSchema(required).withType(Type.OBJECT).withProperties(properties));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -126,7 +118,7 @@ final class PrintingApiSchemas
|
||||
/** Published by the core Jackson schema serializer. */
|
||||
public List<String> getRequired()
|
||||
{
|
||||
return required;
|
||||
return (required);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -139,7 +131,7 @@ final class PrintingApiSchemas
|
||||
{
|
||||
fields.put((String) pairs[index], (Schema) pairs[index + 1]);
|
||||
}
|
||||
return fields;
|
||||
return (fields);
|
||||
}
|
||||
|
||||
|
||||
@@ -153,41 +145,41 @@ final class PrintingApiSchemas
|
||||
/** Protocol identifier. */
|
||||
private static Schema id()
|
||||
{
|
||||
return text(128);
|
||||
return (text(128));
|
||||
}
|
||||
|
||||
|
||||
/** UTC wire timestamp. */
|
||||
private static Schema time()
|
||||
{
|
||||
return text(40).withFormat("date-time").withDescription("RFC3339 UTC ending in uppercase Z.");
|
||||
return (text(40).withFormat("date-time").withDescription("RFC3339 UTC ending in uppercase Z."));
|
||||
}
|
||||
|
||||
|
||||
/** Exact JSON integer, never a stringified numeric value. */
|
||||
private static Schema number()
|
||||
{
|
||||
return new Schema().withType(Type.INTEGER);
|
||||
return (new Schema().withType(Type.INTEGER));
|
||||
}
|
||||
|
||||
|
||||
/** Required booleans must never be inferred from missing fields. */
|
||||
private static Schema bool()
|
||||
{
|
||||
return new Schema().withType(Type.BOOLEAN);
|
||||
return (new Schema().withType(Type.BOOLEAN));
|
||||
}
|
||||
|
||||
|
||||
/** Closed action or status vocabulary. */
|
||||
private static Schema enumeration(String... values)
|
||||
{
|
||||
return new Schema().withType(Type.STRING).withEnumValues(List.of(values));
|
||||
return (new Schema().withType(Type.STRING).withEnumValues(List.of(values)));
|
||||
}
|
||||
|
||||
|
||||
/** Homogeneous typed arrays. */
|
||||
private static Schema array(Schema items)
|
||||
{
|
||||
return new Schema().withType(Type.ARRAY).withItems(items);
|
||||
return (new Schema().withType(Type.ARRAY).withItems(items));
|
||||
}
|
||||
}
|
||||
@@ -1,150 +0,0 @@
|
||||
/*
|
||||
* 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.printing;
|
||||
|
||||
|
||||
import java.time.Instant;
|
||||
import java.time.temporal.ChronoUnit;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The header and footer every printed page carries, whatever the document:
|
||||
**
|
||||
** <app> <server> · <user> · <printed at>
|
||||
** <title / breadcrumb>
|
||||
** ...
|
||||
** <footer note: a grid's filter and sort>
|
||||
** <footer: "qqq ui 1.0.0 · server"> Page n of m
|
||||
**
|
||||
** Clients send the fields as process values (headerApp, headerTitle,
|
||||
** headerServer, headerUser, headerPrintedAt, footerLeft, footerNote) so the
|
||||
** text matches what the user saw (their date format, the app's name, the
|
||||
** breadcrumb). Missing fields fall back to the instance's branding name, the
|
||||
** session user, the current instant and "QQQ printing".
|
||||
*******************************************************************************/
|
||||
public record PrintingChrome(String app, String title, String server, String user, String printedAt, String footerLeft, String footerNote)
|
||||
{
|
||||
/***************************************************************************
|
||||
** The fields from process values, with server-side defaults.
|
||||
***************************************************************************/
|
||||
public static PrintingChrome from(RunBackendStepInput input, @Nullable String fallbackTitle)
|
||||
{
|
||||
return new PrintingChrome(
|
||||
value(input, "headerApp", defaultApp()),
|
||||
value(input, "headerTitle", fallbackTitle),
|
||||
value(input, "headerServer", ""),
|
||||
value(input, "headerUser", defaultUser()),
|
||||
value(input, "headerPrintedAt", Instant.now().truncatedTo(ChronoUnit.SECONDS).toString()),
|
||||
value(input, "footerLeft", "QQQ printing"),
|
||||
value(input, "footerNote", ""));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Defaults only (documents rendered outside a process).
|
||||
***************************************************************************/
|
||||
public static PrintingChrome defaults(String title)
|
||||
{
|
||||
return new PrintingChrome(defaultApp(), title == null ? "" : title, "", defaultUser(), Instant.now().truncatedTo(ChronoUnit.SECONDS).toString(), "QQQ printing", "");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The same chrome with a footer note (a grid's filter and sort).
|
||||
***************************************************************************/
|
||||
public PrintingChrome withFooterNote(@Nullable String note)
|
||||
{
|
||||
return new PrintingChrome(app, title, server, user, printedAt, footerLeft, footerNote == null || footerNote.isBlank() ? (note == null ? "" : note) : footerNote);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The same chrome with this title when it has none.
|
||||
***************************************************************************/
|
||||
public PrintingChrome withTitleIfBlank(String fallback)
|
||||
{
|
||||
return (title != null && !title.isBlank() ? this : new PrintingChrome(app, fallback, server, user, printedAt, footerLeft, footerNote));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The right side of the first header line.
|
||||
***************************************************************************/
|
||||
String headerRight()
|
||||
{
|
||||
StringBuilder out = new StringBuilder();
|
||||
for(String part : new String[] {server, user, printedAt})
|
||||
{
|
||||
if(part != null && !part.isBlank())
|
||||
{
|
||||
out.append(out.isEmpty() ? "" : " · ").append(part);
|
||||
}
|
||||
}
|
||||
return out.toString();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** A string value, or the default when absent or blank (bounded length).
|
||||
***************************************************************************/
|
||||
private static String value(RunBackendStepInput input, String name, @Nullable String fallback)
|
||||
{
|
||||
String value = input == null ? null : input.getValueString(name);
|
||||
String chosen = value == null || value.isBlank() ? fallback : value;
|
||||
return (chosen == null ? "" : PrintingRecordDocuments.truncate(chosen.strip(), 300));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The instance's branding name, else "QQQ".
|
||||
***************************************************************************/
|
||||
private static String defaultApp()
|
||||
{
|
||||
try
|
||||
{
|
||||
var branding = QContext.getQInstance() == null ? null : QContext.getQInstance().getBranding();
|
||||
return (branding != null && branding.getAppName() != null ? branding.getAppName() : "QQQ");
|
||||
}
|
||||
catch(RuntimeException exception)
|
||||
{
|
||||
return "QQQ";
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The session user's name, else blank.
|
||||
***************************************************************************/
|
||||
private static String defaultUser()
|
||||
{
|
||||
return (QContext.getQSession() == null || QContext.getQSession().getUser() == null || QContext.getQSession().getUser().getFullName() == null ? "" : QContext.getQSession().getUser().getFullName());
|
||||
}
|
||||
}
|
||||
@@ -59,7 +59,7 @@ public class PrintingCommandStatus implements TableCustomizerInterface
|
||||
Set<String> selected = input instanceof QueryInput query ? query.getFieldNamesToInclude() : null;
|
||||
if(selected != null && !selected.contains("command_status"))
|
||||
{
|
||||
return records;
|
||||
return (records);
|
||||
}
|
||||
if(selected != null && !selected.contains("id"))
|
||||
{
|
||||
@@ -72,7 +72,7 @@ public class PrintingCommandStatus implements TableCustomizerInterface
|
||||
QRecord values = dependencies.getOrDefault(record.getValueString("id"), record);
|
||||
record.setValue("command_status", effective(values, now));
|
||||
}
|
||||
return records;
|
||||
return (records);
|
||||
}
|
||||
|
||||
|
||||
@@ -103,7 +103,7 @@ public class PrintingCommandStatus implements TableCustomizerInterface
|
||||
result.put(row.getValueString("id"), row);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
return (result);
|
||||
}
|
||||
|
||||
|
||||
@@ -116,24 +116,24 @@ public class PrintingCommandStatus implements TableCustomizerInterface
|
||||
String status = record.getValueString("status");
|
||||
if(status != null && TERMINAL.contains(status))
|
||||
{
|
||||
return status;
|
||||
return (status);
|
||||
}
|
||||
if(!"PENDING".equals(status))
|
||||
{
|
||||
return "UNKNOWN";
|
||||
return ("UNKNOWN");
|
||||
}
|
||||
String expiresAt = record.getValueString("expires_at");
|
||||
if(expiresAt == null || expiresAt.isBlank())
|
||||
{
|
||||
return "UNKNOWN";
|
||||
return ("UNKNOWN");
|
||||
}
|
||||
try
|
||||
{
|
||||
return Instant.parse(expiresAt).isBefore(now) ? "EXPIRED" : "PENDING";
|
||||
return (Instant.parse(expiresAt).isBefore(now) ? "EXPIRED" : "PENDING");
|
||||
}
|
||||
catch(DateTimeParseException exception)
|
||||
{
|
||||
return "UNKNOWN";
|
||||
return ("UNKNOWN");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -58,7 +58,7 @@ public final class PrintingControlAuthorization
|
||||
}
|
||||
new PrintingAdminPermission().checkPermissionsThrowing(new RunBackendStepInput(), null);
|
||||
PrintingProcesses.currentService();
|
||||
return QContext.getQSession().getUser().getIdReference();
|
||||
return (QContext.getQSession().getUser().getIdReference());
|
||||
}
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ public final class PrintingControlAuthorization
|
||||
{
|
||||
throw new QPermissionDeniedException("Record is not accessible");
|
||||
}
|
||||
return row;
|
||||
return (row);
|
||||
}
|
||||
|
||||
|
||||
@@ -95,7 +95,7 @@ public final class PrintingControlAuthorization
|
||||
static QueryOutput query(QueryInput input) throws QException
|
||||
{
|
||||
input.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
|
||||
return new QueryAction().execute(input);
|
||||
return (new QueryAction().execute(input));
|
||||
}
|
||||
|
||||
|
||||
@@ -113,7 +113,7 @@ public final class PrintingControlAuthorization
|
||||
{
|
||||
throw new QPermissionDeniedException("Printer is not assigned to this device");
|
||||
}
|
||||
return row;
|
||||
return (row);
|
||||
}
|
||||
|
||||
|
||||
@@ -133,8 +133,7 @@ public final class PrintingControlAuthorization
|
||||
PrintingDeviceProcesses.Action selected = null;
|
||||
for(PrintingDeviceProcesses.Action action : PrintingDeviceProcesses.Action.values())
|
||||
{
|
||||
// Each wire value belongs to exactly one action, and that action's process is the permission the request needs.
|
||||
if(selected == null && action.wire.equals(request.optString("action")))
|
||||
if(action.wire.equals(request.optString("action")))
|
||||
{
|
||||
selected = action;
|
||||
}
|
||||
@@ -153,7 +152,7 @@ public final class PrintingControlAuthorization
|
||||
{
|
||||
job(deviceId, receipt.getValueString("job_id"));
|
||||
}
|
||||
return service.deviceAction(deviceId, request, actor);
|
||||
return (service.deviceAction(deviceId, request, actor));
|
||||
}
|
||||
Set<String> queue = null;
|
||||
if("CLEAR_QUEUE".equals(selected.wire))
|
||||
@@ -182,6 +181,6 @@ public final class PrintingControlAuthorization
|
||||
{
|
||||
job(deviceId, request.optString("jobId"));
|
||||
}
|
||||
return service.deviceAction(deviceId, request, actor, queue);
|
||||
return (service.deviceAction(deviceId, request, actor, queue));
|
||||
}
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
/*
|
||||
* 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.printing;
|
||||
|
||||
|
||||
import com.kingsrook.qqq.backend.core.actions.permissions.UseOtherPermissionNameCustomPermissionChecker;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.permissions.MetaDataWithPermissionRules;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Deleting a print station or a printer needs its own grant, printing_delete,
|
||||
** in addition to printing_admin: an administrator who may pause, approve and
|
||||
** revoke does not delete records unless a host grants this permission too.
|
||||
*******************************************************************************/
|
||||
public class PrintingDeletePermission extends UseOtherPermissionNameCustomPermissionChecker
|
||||
{
|
||||
public static final String NAME = "printing_delete";
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Expose the permission in QQQ's available-permission catalog.
|
||||
***************************************************************************/
|
||||
public PrintingDeletePermission()
|
||||
{
|
||||
withPermissionName(NAME);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Both grants are required; neither implies the other.
|
||||
***************************************************************************/
|
||||
@Override
|
||||
public void checkPermissionsThrowing(AbstractActionInput input, @Nullable MetaDataWithPermissionRules metadata) throws QPermissionDeniedException
|
||||
{
|
||||
if(QContext.getQSession() == null || !QContext.getQSession().hasPermission(NAME) || !QContext.getQSession().hasPermission("printing_admin"))
|
||||
{
|
||||
throw new QPermissionDeniedException(PrintingMessages.notAllowed(QContext.getQSession() != null, PrintingMessages.DELETE, PrintingMessages.DELETE_GRANT));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,431 +0,0 @@
|
||||
/*
|
||||
* 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.printing;
|
||||
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement;
|
||||
import com.kingsrook.qqq.backend.core.actions.processes.BackendStep;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.GetAction;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLine;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLineInterface;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.Status;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
|
||||
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.permissions.PermissionLevel;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QBackendStepMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QComponentType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendComponentMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendStepMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractLoadStep;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractTransformStep;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.ProcessSummaryProviderInterface;
|
||||
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.StreamedETLWithFrontendProcess;
|
||||
import org.json.JSONObject;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Delete print stations and printers from their lists and record screens.
|
||||
**
|
||||
** Both actions need printing_delete as well as printing_admin. They ask for a
|
||||
** confirmation, then show exactly what will happen (printers that go with a
|
||||
** station, queued jobs canceled, jobs closed as outcome unknown, job history
|
||||
** kept) and which records are refused and why. Nothing changes before the
|
||||
** final step; every record is read again there with the caller's access, and
|
||||
** a record that cannot be deleted is reported by name without stopping the
|
||||
** others. PrintingService.deleteDevice and deletePrinter do the work.
|
||||
*******************************************************************************/
|
||||
public final class PrintingDeleteProcesses
|
||||
{
|
||||
public static final String DEVICES = "printingDeleteDevices";
|
||||
public static final String PRINTERS = "printingDeleteSelectedPrinters";
|
||||
public static final String DEVICES_LABEL = "Delete " + PrintingNames.STATIONS_LOWER;
|
||||
public static final String PRINTERS_LABEL = "Delete " + PrintingNames.PRINTERS_LOWER;
|
||||
static final String CONFIRM = "confirmPrintingDelete";
|
||||
static final String DEVICES_PREVIEW = "Each selected " + PrintingNames.STATION_LOWER + " is deleted together with its " + PrintingNames.PRINTERS_LOWER + ". Its access is revoked first, so the computer must be enrolled again before it can print."
|
||||
+ " Queued jobs are canceled, and jobs already sent to it without a reported result are closed as outcome unknown. Finished print jobs are kept, with the " + PrintingNames.STATION_LOWER + " and "
|
||||
+ PrintingNames.PRINTER_LOWER + " names they were printed under. This cannot be undone.";
|
||||
static final String PRINTERS_PREVIEW = "Each selected " + PrintingNames.PRINTER_LOWER + " is deleted; its " + PrintingNames.STATION_LOWER + " stays in service. Queued jobs for it are canceled, and jobs already sent without a reported result are closed as outcome unknown."
|
||||
+ " Finished print jobs are kept, with the " + PrintingNames.PRINTER_LOWER + " and " + PrintingNames.STATION_LOWER + " names they were printed under. A " + PrintingNames.PRINTER_LOWER + " that its " + PrintingNames.STATION_LOWER
|
||||
+ " still shares comes back as a new " + PrintingNames.PRINTER_LOWER + " awaiting approval; stop sharing it in the print client to keep it away. This cannot be undone.";
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Utility class.
|
||||
***************************************************************************/
|
||||
private PrintingDeleteProcesses()
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** One action on each table, for a selection and for one record.
|
||||
***************************************************************************/
|
||||
public static void register(QInstance instance)
|
||||
{
|
||||
add(instance, DEVICES, DEVICES_LABEL, PrintingTables.DEVICE, DEVICES_PREVIEW,
|
||||
"I understand: the selected " + PrintingNames.STATIONS_LOWER + " and their " + PrintingNames.PRINTERS_LOWER + " are deleted, access is revoked and each computer must be enrolled again");
|
||||
add(instance, PRINTERS, PRINTERS_LABEL, PrintingTables.PRINTER, PRINTERS_PREVIEW,
|
||||
"I understand: the selected " + PrintingNames.PRINTERS_LOWER + " are deleted and their queued jobs are canceled");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The grant every step of both actions checks.
|
||||
***************************************************************************/
|
||||
public static QPermissionRules permissionRules()
|
||||
{
|
||||
return new QPermissionRules().withLevel(PermissionLevel.HAS_ACCESS_PERMISSION).withCustomPermissionChecker(new QCodeReference(PrintingDeletePermission.class));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** prepare, confirm, review (what will happen), execute, result.
|
||||
***************************************************************************/
|
||||
private static void add(QInstance instance, String name, String label, String table, String preview, String confirmation)
|
||||
{
|
||||
Map<String, Serializable> values = new HashMap<>();
|
||||
values.put(StreamedETLWithFrontendProcess.FIELD_SOURCE_TABLE, table);
|
||||
values.put(StreamedETLWithFrontendProcess.FIELD_DESTINATION_TABLE, table);
|
||||
values.put(StreamedETLWithFrontendProcess.FIELD_SUPPORTS_FULL_VALIDATION, true);
|
||||
values.put(StreamedETLWithFrontendProcess.FIELD_DO_FULL_VALIDATION, true);
|
||||
values.put(StreamedETLWithFrontendProcess.FIELD_PREVIEW_MESSAGE, preview);
|
||||
QProcessMetaData process = StreamedETLWithFrontendProcess.defineProcessMetaData(PrintingExtract.class, Transform.class, Load.class, values)
|
||||
.withName(name).withLabel(label).withTableName(table).withMinInputRecords(1).withPermissionRules(permissionRules());
|
||||
process.withStep(0, new QBackendStepMetaData().withName("prepareDelete").withCode(new QCodeReference(Prepare.class)));
|
||||
process.withStep(1, new QFrontendStepMetaData().withName("confirmDelete").withLabel(label)
|
||||
.withFormField(new QFieldMetaData(CONFIRM, QFieldType.BOOLEAN).withLabel(confirmation).withDefaultValue(false))
|
||||
.withComponent(new QFrontendComponentMetaData().withType(QComponentType.EDIT_FORM)));
|
||||
instance.addProcess(process);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The signed-in user who holds both grants, in this printing tenant.
|
||||
***************************************************************************/
|
||||
static String actor(RunBackendStepInput input) throws QException
|
||||
{
|
||||
new PrintingDeletePermission().checkPermissionsThrowing(input, null);
|
||||
if(!DEVICES.equals(input.getProcessName()) && !PRINTERS.equals(input.getProcessName()))
|
||||
{
|
||||
throw new QException("Unknown printing delete action");
|
||||
}
|
||||
return PrintingDeviceProcesses.actor(input);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The record as the caller may read it now, or null when it is gone or not
|
||||
** the caller's to see.
|
||||
***************************************************************************/
|
||||
private static @Nullable QRecord current(String table, @Nullable String id) throws QException
|
||||
{
|
||||
if(id == null || id.isBlank())
|
||||
{
|
||||
return null;
|
||||
}
|
||||
GetInput get = new GetInput();
|
||||
get.setTableName(table);
|
||||
get.setPrimaryKey(id);
|
||||
get.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
|
||||
return new GetAction().execute(get).getRecord();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** What a delete of this record would do, or the reason it is refused.
|
||||
***************************************************************************/
|
||||
private static JSONObject plan(RunBackendStepInput input, QRecord record) throws QException
|
||||
{
|
||||
try
|
||||
{
|
||||
PrintingService service = PrintingProcesses.currentService();
|
||||
return DEVICES.equals(input.getProcessName()) ? service.deviceDeletionPlan(record.getValueString("id")) : service.printerDeletionPlan(record.getValueString("id"));
|
||||
}
|
||||
catch(PrintingException exception)
|
||||
{
|
||||
return new JSONObject().put("refusal", exception.getStatus() == 404 ? name(input, record) + " no longer exists" : name(input, record) + ": " + exception.getMessage());
|
||||
}
|
||||
catch(java.sql.SQLException exception)
|
||||
{
|
||||
throw new QException("Could not read what the delete would do", exception);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The words for one record in a message.
|
||||
***************************************************************************/
|
||||
private static String name(RunBackendStepInput input, QRecord record)
|
||||
{
|
||||
return (DEVICES.equals(input.getProcessName()) ? PrintingNames.STATION : PrintingNames.PRINTER) + " " + record.getValueString("name");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The line listing every record that is not deleted, with its reason.
|
||||
***************************************************************************/
|
||||
private static void addRefusals(List<ProcessSummaryLineInterface> lines, List<String> refusals, boolean past)
|
||||
{
|
||||
if(!refusals.isEmpty())
|
||||
{
|
||||
lines.add(new ProcessSummaryLine(Status.ERROR, refusals.size(), refusals.size() == 1 ? (past ? "record was not deleted" : "record will not be deleted") : (past ? "records were not deleted" : "records will not be deleted"))
|
||||
.withBulletsOfText(new ArrayList<>(refusals)));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Keep the selection across the confirmation form.
|
||||
***************************************************************************/
|
||||
public static class Prepare implements BackendStep
|
||||
{
|
||||
/************************************************************************
|
||||
** Nothing is read or changed here beyond the caller's authority.
|
||||
************************************************************************/
|
||||
@Override
|
||||
public void run(RunBackendStepInput input, RunBackendStepOutput output) throws QException
|
||||
{
|
||||
actor(input);
|
||||
PrintingProcesses.keepSelection(input, output);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The review: counts what will happen and names what is refused. Read-only.
|
||||
***************************************************************************/
|
||||
public static class Transform extends AbstractTransformStep implements ProcessSummaryProviderInterface
|
||||
{
|
||||
private final List<String> refusals = new ArrayList<>();
|
||||
private final ProcessSummaryLine ready = new ProcessSummaryLine(Status.OK, 0, null);
|
||||
private boolean devices;
|
||||
private long printers;
|
||||
private long queued;
|
||||
private long inProgress;
|
||||
private long kept;
|
||||
|
||||
|
||||
|
||||
/************************************************************************
|
||||
** Only records that can be deleted now go on to the final step.
|
||||
************************************************************************/
|
||||
@Override
|
||||
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
|
||||
{
|
||||
actor(input);
|
||||
devices = DEVICES.equals(input.getProcessName());
|
||||
for(QRecord selected : input.getRecords())
|
||||
{
|
||||
QRecord record = current(devices ? PrintingTables.DEVICE : PrintingTables.PRINTER, selected.getValueString("id"));
|
||||
if(record == null)
|
||||
{
|
||||
refusals.add("A selected record no longer exists or is not yours to delete");
|
||||
continue;
|
||||
}
|
||||
JSONObject plan = plan(input, record);
|
||||
if(plan.has("refusal"))
|
||||
{
|
||||
refusals.add(plan.getString("refusal"));
|
||||
continue;
|
||||
}
|
||||
printers += plan.optLong("printers", 0);
|
||||
queued += plan.getLong("queuedJobs");
|
||||
inProgress += plan.getLong("jobsInProgress");
|
||||
kept += plan.getLong("jobs") - plan.getLong("queuedJobs") - plan.getLong("jobsInProgress");
|
||||
ready.incrementCountAndAddPrimaryKey(record.getValue("id"));
|
||||
output.getRecords().add(record);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/************************************************************************
|
||||
** The records refused in review, for the final step's result.
|
||||
************************************************************************/
|
||||
List<String> refusals()
|
||||
{
|
||||
return refusals;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/************************************************************************
|
||||
** One line for each consequence that applies, then the refusals.
|
||||
************************************************************************/
|
||||
// QQQ ProcessSummaryProvider requires this concrete return type; retain binary/API compatibility.
|
||||
@SuppressWarnings("NonApiType")
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
|
||||
{
|
||||
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
|
||||
if(devices)
|
||||
{
|
||||
ready.withSingularFutureMessage(PrintingNames.STATION_LOWER + " will be deleted; its access is revoked and the computer must be enrolled again before it can print")
|
||||
.withPluralFutureMessage(PrintingNames.STATIONS_LOWER + " will be deleted; their access is revoked and each computer must be enrolled again before it can print");
|
||||
}
|
||||
else
|
||||
{
|
||||
ready.withSingularFutureMessage(PrintingNames.PRINTER_LOWER + " will be deleted").withPluralFutureMessage(PrintingNames.PRINTERS_LOWER + " will be deleted");
|
||||
}
|
||||
ready.addSelfToListIfAnyCount(lines);
|
||||
add(lines, Status.WARNING, printers, PrintingNames.PRINTER_LOWER + " will be deleted with its " + PrintingNames.STATION_LOWER, PrintingNames.PRINTERS_LOWER + " will be deleted with their " + PrintingNames.STATIONS_LOWER);
|
||||
add(lines, Status.WARNING, queued, "queued job will be canceled", "queued jobs will be canceled");
|
||||
add(lines, Status.WARNING, inProgress, "job already sent without a reported result will be closed as outcome unknown", "jobs already sent without a reported result will be closed as outcome unknown");
|
||||
add(lines, Status.INFO, kept, "finished print job keeps its history and the names it was printed under", "finished print jobs keep their history and the names they were printed under");
|
||||
addRefusals(lines, refusals, false);
|
||||
return lines;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/************************************************************************
|
||||
** A counted consequence, shown only when it applies.
|
||||
************************************************************************/
|
||||
private static void add(List<ProcessSummaryLineInterface> lines, Status status, long count, String singular, String plural)
|
||||
{
|
||||
if(count > 0)
|
||||
{
|
||||
lines.add(new ProcessSummaryLine(status, Math.toIntExact(count), count == 1 ? singular : plural));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The delete itself, after the confirmation and the review.
|
||||
***************************************************************************/
|
||||
public static class Load extends AbstractLoadStep implements ProcessSummaryProviderInterface
|
||||
{
|
||||
private final List<String> refusals = new ArrayList<>();
|
||||
private final ProcessSummaryLine deleted = new ProcessSummaryLine(Status.OK, 0, null);
|
||||
private boolean devices;
|
||||
private long printers;
|
||||
private long cancelled;
|
||||
private long unknown;
|
||||
private long kept;
|
||||
|
||||
|
||||
|
||||
/************************************************************************
|
||||
** Each record is read again with the caller's access and deleted on its
|
||||
** own; a refusal names the record and does not stop the others.
|
||||
************************************************************************/
|
||||
@Override
|
||||
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
|
||||
{
|
||||
String actor = actor(input);
|
||||
if(!Boolean.TRUE.equals(input.getValueBoolean(CONFIRM)))
|
||||
{
|
||||
throw new QException("Confirm the delete before continuing");
|
||||
}
|
||||
devices = DEVICES.equals(input.getProcessName());
|
||||
PrintingService service = PrintingProcesses.currentService();
|
||||
for(QRecord selected : input.getRecords())
|
||||
{
|
||||
QRecord record = current(devices ? PrintingTables.DEVICE : PrintingTables.PRINTER, selected.getValueString("id"));
|
||||
if(record == null)
|
||||
{
|
||||
refusals.add("A selected record no longer exists or is not yours to delete");
|
||||
continue;
|
||||
}
|
||||
try
|
||||
{
|
||||
JSONObject result = devices ? service.deleteDevice(record.getValueString("id"), actor) : service.deletePrinter(record.getValueString("id"), actor);
|
||||
printers += result.optLong("printers", 0);
|
||||
cancelled += result.getLong("cancelledJobs");
|
||||
unknown += result.getLong("unknownJobs");
|
||||
kept += result.getLong("keptJobs") - result.getLong("cancelledJobs") - result.getLong("unknownJobs");
|
||||
deleted.incrementCount();
|
||||
output.getRecords().add(record);
|
||||
}
|
||||
catch(PrintingException exception)
|
||||
{
|
||||
refusals.add(exception.getStatus() == 409 ? exception.getMessage() : exception.getStatus() == 404 ? name(input, record) + " no longer exists" : name(input, record) + ": " + exception.getMessage());
|
||||
}
|
||||
catch(java.sql.SQLException exception)
|
||||
{
|
||||
throw new QException(name(input, record) + " could not be deleted; nothing was changed for it. Earlier records in this selection were deleted.", exception);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/************************************************************************
|
||||
** What was deleted and what went with it, then every refusal, including
|
||||
** the records the review already set aside.
|
||||
************************************************************************/
|
||||
// QQQ ProcessSummaryProvider requires this concrete return type; retain binary/API compatibility.
|
||||
@SuppressWarnings("NonApiType")
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
|
||||
{
|
||||
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
|
||||
if(devices)
|
||||
{
|
||||
deleted.withSingularPastMessage(PrintingNames.STATION_LOWER + " was deleted; its access is revoked").withPluralPastMessage(PrintingNames.STATIONS_LOWER + " were deleted; their access is revoked");
|
||||
}
|
||||
else
|
||||
{
|
||||
deleted.withSingularPastMessage(PrintingNames.PRINTER_LOWER + " was deleted").withPluralPastMessage(PrintingNames.PRINTERS_LOWER + " were deleted");
|
||||
}
|
||||
deleted.addSelfToListIfAnyCount(lines);
|
||||
Transform.add(lines, Status.OK, printers, PrintingNames.PRINTER_LOWER + " was deleted with its " + PrintingNames.STATION_LOWER, PrintingNames.PRINTERS_LOWER + " were deleted with their " + PrintingNames.STATIONS_LOWER);
|
||||
Transform.add(lines, Status.WARNING, cancelled, "queued job was canceled", "queued jobs were canceled");
|
||||
Transform.add(lines, Status.WARNING, unknown, "job was closed as outcome unknown; check the printer for output before printing it again", "jobs were closed as outcome unknown; check the printer for output before printing them again");
|
||||
Transform.add(lines, Status.INFO, kept, "finished print job keeps its history and the names it was printed under", "finished print jobs keep their history and the names they were printed under");
|
||||
List<String> all = new ArrayList<>(refusals);
|
||||
if(getTransformStep() instanceof Transform review)
|
||||
{
|
||||
all.addAll(review.refusals());
|
||||
}
|
||||
addRefusals(lines, all, true);
|
||||
return lines;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -30,7 +30,6 @@ import java.util.Set;
|
||||
import java.util.UUID;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONObject;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
import static com.kingsrook.qbits.printing.PrintingService.query;
|
||||
import static com.kingsrook.qbits.printing.PrintingService.update;
|
||||
|
||||
@@ -89,54 +88,19 @@ final class PrintingDeviceControls
|
||||
{
|
||||
result.put("lastPollAt", row.getString("control_last_poll_at"));
|
||||
}
|
||||
return result;
|
||||
return (result);
|
||||
}
|
||||
|
||||
|
||||
/** Strict action input and original receipt enforce replay before any side effect. */
|
||||
JSONObject action(String deviceId, JSONObject request, String actor) throws SQLException
|
||||
{
|
||||
return action(deviceId, request, actor, null);
|
||||
return (action(deviceId, request, actor, null));
|
||||
}
|
||||
|
||||
|
||||
/** A native authorized queue snapshot must still match after taking the device lock. */
|
||||
JSONObject action(String deviceId, JSONObject request, String actor, @Nullable Set<String> authorizedQueue) throws SQLException
|
||||
{
|
||||
Validated valid = validated(request, actor);
|
||||
try(Connection connection = source.getConnection())
|
||||
{
|
||||
connection.setAutoCommit(false);
|
||||
try
|
||||
{
|
||||
JSONObject response = apply(connection, deviceId, request, valid, actor, authorizedQueue);
|
||||
connection.commit();
|
||||
return response;
|
||||
}
|
||||
catch(Exception exception)
|
||||
{
|
||||
connection.rollback();
|
||||
throw exception;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/** The same action inside a transaction its caller began and will commit or roll back; nothing is committed here. */
|
||||
JSONObject action(Connection connection, String deviceId, JSONObject request, String actor) throws SQLException
|
||||
{
|
||||
return apply(connection, deviceId, request, validated(request, actor), actor, null);
|
||||
}
|
||||
|
||||
|
||||
/** The checked parts of one action request. */
|
||||
private record Validated(String requestId, String action, @Nullable String jobId)
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
/** Strict input is refused before a connection or a lock is taken. */
|
||||
private static Validated validated(JSONObject request, String actor)
|
||||
JSONObject action(String deviceId, JSONObject request, String actor, Set<String> authorizedQueue) throws SQLException
|
||||
{
|
||||
fields(request, Set.of("requestId", "issuedAt", "action", "jobId"));
|
||||
String requestId = text(request, "requestId", 128);
|
||||
@@ -154,136 +118,141 @@ final class PrintingDeviceControls
|
||||
{
|
||||
throw new PrintingException(400, "A bounded authenticated actor is required");
|
||||
}
|
||||
return new Validated(requestId, action, jobId);
|
||||
}
|
||||
|
||||
|
||||
/** Lock the device, replay a retained receipt or apply and record the action; the caller owns the transaction. */
|
||||
private JSONObject apply(Connection connection, String deviceId, JSONObject request, Validated valid, String actor, @Nullable Set<String> authorizedQueue) throws SQLException
|
||||
{
|
||||
String requestId = valid.requestId();
|
||||
String action = valid.action();
|
||||
String jobId = valid.jobId();
|
||||
JSONObject device = lock(connection, deviceId, false);
|
||||
List<JSONObject> old = query(connection, "SELECT * FROM printing_device_command WHERE tenant_id=? AND device_id=? AND request_id=?", tenant, deviceId, requestId);
|
||||
if(!old.isEmpty())
|
||||
try(Connection connection = source.getConnection())
|
||||
{
|
||||
if(!new JSONObject(old.getFirst().getString("request_json")).similar(request))
|
||||
connection.setAutoCommit(false);
|
||||
try
|
||||
{
|
||||
throw new PrintingException(409, "Request identity was already used for a different action");
|
||||
}
|
||||
return record(old.getFirst());
|
||||
}
|
||||
Instant issued;
|
||||
try
|
||||
{
|
||||
issued = Instant.parse(utc(request, "issuedAt"));
|
||||
}
|
||||
catch(java.time.format.DateTimeParseException exception)
|
||||
{
|
||||
throw new PrintingException(400, "Invalid action time");
|
||||
}
|
||||
Instant current = Instant.now();
|
||||
if(issued.isBefore(current.minusSeconds(900)))
|
||||
{
|
||||
throw new PrintingException(410, "Action request expired; review a new action explicitly");
|
||||
}
|
||||
if(issued.isAfter(current.plusSeconds(60)))
|
||||
{
|
||||
throw new PrintingException(400, "Action time is too far in the future");
|
||||
}
|
||||
if(device.getInt("enabled") != 1 || device.has("revoked_at"))
|
||||
{
|
||||
throw new PrintingException(409, "Revoked devices require a new local enrollment");
|
||||
}
|
||||
if(!REMOTE.contains(action) && !Set.of("CLEAR_QUEUE", "REVOKE").contains(action) && device.getLong("control_revision") >= 9007199254740991L)
|
||||
{
|
||||
throw new PrintingException(409, "Control revision capacity reached");
|
||||
}
|
||||
expire(connection, deviceId);
|
||||
update(connection, "DELETE FROM printing_device_command WHERE id IN (SELECT id FROM printing_device_command WHERE tenant_id=? AND device_id=? AND status<>'PENDING' AND created_at<? AND expires_at<? ORDER BY created_at,id LIMIT 200)", tenant, deviceId, Instant.now().minusSeconds(7 * 86400).toString(), Instant.now().toString());
|
||||
long history = count(connection, "SELECT COUNT(*) AS n FROM printing_device_command WHERE tenant_id=? AND device_id=?", tenant, deviceId);
|
||||
if(history >= 1000 && !"REVOKE".equals(action))
|
||||
{
|
||||
throw new PrintingException(429, "Device control receipt capacity reached; receipts are retained and revocation remains available");
|
||||
}
|
||||
String id = UUID.randomUUID().toString();
|
||||
String now = current.toString();
|
||||
String expires = current.plusSeconds(900).toString();
|
||||
String result = null;
|
||||
Integer cancelled = null;
|
||||
if(REMOTE.contains(action))
|
||||
{
|
||||
if(device.getInt("control_version") != 1 || !new JSONArray(device.getString("control_capabilities")).toList().contains(action))
|
||||
{
|
||||
throw new PrintingException(409, "CONTROL_UNSUPPORTED");
|
||||
}
|
||||
if(count(connection, "SELECT COUNT(*) AS n FROM printing_device_command WHERE tenant_id=? AND device_id=? AND status='PENDING'", tenant, deviceId) >= 100)
|
||||
{
|
||||
throw new PrintingException(429, "Too many pending device commands");
|
||||
}
|
||||
if(jobId != null)
|
||||
{
|
||||
List<JSONObject> jobs = query(connection, "SELECT id,status,spooler_job_id FROM printing_job WHERE tenant_id=? AND device_id=? AND id=?", tenant, deviceId, jobId);
|
||||
if(jobs.isEmpty())
|
||||
JSONObject device = lock(connection, deviceId, false);
|
||||
List<JSONObject> old = query(connection, "SELECT * FROM printing_device_command WHERE tenant_id=? AND device_id=? AND request_id=?", tenant, deviceId, requestId);
|
||||
if(!old.isEmpty())
|
||||
{
|
||||
throw new PrintingException(404, "Job not found");
|
||||
if(!new JSONObject(old.getFirst().getString("request_json")).similar(request))
|
||||
{
|
||||
throw new PrintingException(409, "Request identity was already used for a different action");
|
||||
}
|
||||
connection.commit();
|
||||
return (record(old.getFirst()));
|
||||
}
|
||||
if(!Set.of("SPOOLED", "SPOOLER_COMPLETED").contains(jobs.getFirst().getString("status")) || jobs.getFirst().optString("spooler_job_id").isBlank())
|
||||
Instant issued;
|
||||
try
|
||||
{
|
||||
throw new PrintingException(409, "Only an owned job with a recorded spool identity can be canceled");
|
||||
issued = Instant.parse(utc(request, "issuedAt"));
|
||||
}
|
||||
}
|
||||
}
|
||||
else if("CLEAR_QUEUE".equals(action))
|
||||
{
|
||||
if(authorizedQueue != null)
|
||||
{
|
||||
Set<String> currentQueue = new java.util.HashSet<>();
|
||||
for(JSONObject row : query(connection, "SELECT id FROM printing_job WHERE tenant_id=? AND device_id=? AND status='QUEUED' LIMIT 10001", tenant, deviceId))
|
||||
catch(java.time.format.DateTimeParseException exception)
|
||||
{
|
||||
currentQueue.add(row.getString("id"));
|
||||
throw new PrintingException(400, "Invalid action time");
|
||||
}
|
||||
if(!currentQueue.equals(authorizedQueue))
|
||||
Instant current = Instant.now();
|
||||
if(issued.isBefore(current.minusSeconds(900)))
|
||||
{
|
||||
throw new PrintingException(409, "The queue changed; review the current authorized jobs before retrying");
|
||||
throw new PrintingException(410, "Action request expired; review a new action explicitly");
|
||||
}
|
||||
if(issued.isAfter(current.plusSeconds(60)))
|
||||
{
|
||||
throw new PrintingException(400, "Action time is too far in the future");
|
||||
}
|
||||
if(device.getInt("enabled") != 1 || device.has("revoked_at"))
|
||||
{
|
||||
throw new PrintingException(409, "Revoked devices require a new local enrollment");
|
||||
}
|
||||
if(!REMOTE.contains(action) && !Set.of("CLEAR_QUEUE", "REVOKE").contains(action) && device.getLong("control_revision") >= 9007199254740991L)
|
||||
{
|
||||
throw new PrintingException(409, "Control revision capacity reached");
|
||||
}
|
||||
expire(connection, deviceId);
|
||||
update(connection, "DELETE FROM printing_device_command WHERE id IN (SELECT id FROM printing_device_command WHERE tenant_id=? AND device_id=? AND status<>'PENDING' AND created_at<? AND expires_at<? ORDER BY created_at,id LIMIT 200)", tenant, deviceId, Instant.now().minusSeconds(7 * 86400).toString(), Instant.now().toString());
|
||||
long history = count(connection, "SELECT COUNT(*) AS n FROM printing_device_command WHERE tenant_id=? AND device_id=?", tenant, deviceId);
|
||||
if(history >= 1000 && !"REVOKE".equals(action))
|
||||
{
|
||||
throw new PrintingException(429, "Device control receipt capacity reached; receipts are retained and revocation remains available");
|
||||
}
|
||||
String id = UUID.randomUUID().toString();
|
||||
String now = current.toString();
|
||||
String expires = current.plusSeconds(900).toString();
|
||||
String result = null;
|
||||
Integer cancelled = null;
|
||||
if(REMOTE.contains(action))
|
||||
{
|
||||
if(device.getInt("control_version") != 1 || !new JSONArray(device.getString("control_capabilities")).toList().contains(action))
|
||||
{
|
||||
throw new PrintingException(409, "CONTROL_UNSUPPORTED");
|
||||
}
|
||||
if(count(connection, "SELECT COUNT(*) AS n FROM printing_device_command WHERE tenant_id=? AND device_id=? AND status='PENDING'", tenant, deviceId) >= 100)
|
||||
{
|
||||
throw new PrintingException(429, "Too many pending device commands");
|
||||
}
|
||||
if(jobId != null)
|
||||
{
|
||||
List<JSONObject> jobs = query(connection, "SELECT id,status,spooler_job_id FROM printing_job WHERE tenant_id=? AND device_id=? AND id=?", tenant, deviceId, jobId);
|
||||
if(jobs.isEmpty())
|
||||
{
|
||||
throw new PrintingException(404, "Job not found");
|
||||
}
|
||||
if(!Set.of("SPOOLED", "SPOOLER_COMPLETED").contains(jobs.getFirst().getString("status")) || jobs.getFirst().optString("spooler_job_id").isBlank())
|
||||
{
|
||||
throw new PrintingException(409, "Only an owned job with a recorded spool identity can be canceled");
|
||||
}
|
||||
}
|
||||
}
|
||||
else if("CLEAR_QUEUE".equals(action))
|
||||
{
|
||||
if(authorizedQueue != null)
|
||||
{
|
||||
Set<String> currentQueue = new java.util.HashSet<>();
|
||||
for(JSONObject row : query(connection, "SELECT id FROM printing_job WHERE tenant_id=? AND device_id=? AND status='QUEUED' LIMIT 10001", tenant, deviceId))
|
||||
{
|
||||
currentQueue.add(row.getString("id"));
|
||||
}
|
||||
if(!currentQueue.equals(authorizedQueue))
|
||||
{
|
||||
throw new PrintingException(409, "The queue changed; review the current authorized jobs before retrying");
|
||||
}
|
||||
}
|
||||
cancelled = update(connection, "UPDATE printing_job SET status='FAILED',message=? WHERE tenant_id=? AND device_id=? AND status='QUEUED'", PrintingService.CANCELED_BEFORE_DISPATCH, tenant, deviceId);
|
||||
result = "QUEUED_JOBS_CANCELLED";
|
||||
}
|
||||
else if("REVOKE".equals(action))
|
||||
{
|
||||
update(connection, "UPDATE printing_device SET enabled=0,token_hash=?,revoked_at=?,dispatch_paused=1,connection_state='DISCONNECTED',control_revision=? WHERE tenant_id=? AND id=?", UUID.randomUUID().toString(), now, Math.min(9007199254740991L, device.getLong("control_revision") + 1), tenant, deviceId);
|
||||
update(connection, "UPDATE printing_device_command SET status='OUTCOME_UNKNOWN' WHERE tenant_id=? AND device_id=? AND status='PENDING'", tenant, deviceId);
|
||||
result = "CREDENTIAL_REVOKED";
|
||||
}
|
||||
else
|
||||
{
|
||||
int paused = device.getInt("dispatch_paused");
|
||||
String connected = device.getString("connection_state");
|
||||
if("PAUSE_DISPATCH".equals(action))
|
||||
{
|
||||
paused = 1;
|
||||
}
|
||||
if("RESUME_DISPATCH".equals(action))
|
||||
{
|
||||
paused = 0;
|
||||
}
|
||||
if("DISCONNECT".equals(action))
|
||||
{
|
||||
connected = "DISCONNECTED";
|
||||
}
|
||||
if("RECONNECT".equals(action))
|
||||
{
|
||||
connected = "CONNECTED";
|
||||
}
|
||||
update(connection, "UPDATE printing_device SET dispatch_paused=?,connection_state=?,control_revision=control_revision+1 WHERE tenant_id=? AND id=?", paused, connected, tenant, deviceId);
|
||||
result = "DESIRED_STATE_UPDATED";
|
||||
}
|
||||
update(connection, "INSERT INTO printing_device_command (id,tenant_id,device_id,request_id,action,job_id,actor,request_json,status,created_at,expires_at,result_code,cancelled_job_count) VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)",
|
||||
id, tenant, deviceId, requestId, action, jobId, actor, request.toString(), REMOTE.contains(action) ? "PENDING" : "SUCCEEDED", now, expires, result, cancelled);
|
||||
JSONObject response = record(command(connection, deviceId, id));
|
||||
connection.commit();
|
||||
return (response);
|
||||
}
|
||||
catch(Exception exception)
|
||||
{
|
||||
connection.rollback();
|
||||
throw exception;
|
||||
}
|
||||
cancelled = update(connection, "UPDATE printing_job SET status='FAILED',message=? WHERE tenant_id=? AND device_id=? AND status='QUEUED'", PrintingService.CANCELED_BEFORE_DISPATCH, tenant, deviceId);
|
||||
result = "QUEUED_JOBS_CANCELLED";
|
||||
}
|
||||
else if("REVOKE".equals(action))
|
||||
{
|
||||
update(connection, "UPDATE printing_device SET enabled=0,token_hash=?,revoked_at=?,dispatch_paused=1,connection_state='DISCONNECTED',control_revision=? WHERE tenant_id=? AND id=?", UUID.randomUUID().toString(), now, Math.min(9007199254740991L, device.getLong("control_revision") + 1), tenant, deviceId);
|
||||
update(connection, "UPDATE printing_device_command SET status='OUTCOME_UNKNOWN' WHERE tenant_id=? AND device_id=? AND status='PENDING'", tenant, deviceId);
|
||||
result = "CREDENTIAL_REVOKED";
|
||||
}
|
||||
else
|
||||
{
|
||||
int paused = device.getInt("dispatch_paused");
|
||||
String connected = device.getString("connection_state");
|
||||
if("PAUSE_DISPATCH".equals(action))
|
||||
{
|
||||
paused = 1;
|
||||
}
|
||||
if("RESUME_DISPATCH".equals(action))
|
||||
{
|
||||
paused = 0;
|
||||
}
|
||||
if("DISCONNECT".equals(action))
|
||||
{
|
||||
connected = "DISCONNECTED";
|
||||
}
|
||||
if("RECONNECT".equals(action))
|
||||
{
|
||||
connected = "CONNECTED";
|
||||
}
|
||||
update(connection, "UPDATE printing_device SET dispatch_paused=?,connection_state=?,control_revision=control_revision+1 WHERE tenant_id=? AND id=?", paused, connected, tenant, deviceId);
|
||||
result = "DESIRED_STATE_UPDATED";
|
||||
}
|
||||
update(connection, "INSERT INTO printing_device_command (id,tenant_id,device_id,request_id,action,job_id,actor,request_json,status,created_at,expires_at,result_code,cancelled_job_count) VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?)",
|
||||
id, tenant, deviceId, requestId, action, jobId, actor, request.toString(), REMOTE.contains(action) ? "PENDING" : "SUCCEEDED", now, expires, result, cancelled);
|
||||
return record(command(connection, deviceId, id));
|
||||
}
|
||||
|
||||
|
||||
@@ -297,8 +266,8 @@ final class PrintingDeviceControls
|
||||
}
|
||||
String version = text(request, "agentVersion", 100);
|
||||
long applied = integer(request, "lastAppliedRevision");
|
||||
if(!(request.opt("capabilities") instanceof JSONArray capabilities) || capabilities.length() > 4
|
||||
|| capabilities.toList().stream().anyMatch(value -> !REMOTE.contains(value) && !"printer-media-v1".equals(value) && !"printer-approval-v1".equals(value)) || Set.copyOf(capabilities.toList()).size() != capabilities.length())
|
||||
if(!(request.opt("capabilities") instanceof JSONArray capabilities) || capabilities.length() > 2
|
||||
|| capabilities.toList().stream().anyMatch(value -> !REMOTE.contains(value)) || Set.copyOf(capabilities.toList()).size() != capabilities.length())
|
||||
{
|
||||
throw new PrintingException(400, "Invalid control capabilities");
|
||||
}
|
||||
@@ -332,8 +301,8 @@ final class PrintingDeviceControls
|
||||
commands.put(delivery);
|
||||
}
|
||||
connection.commit();
|
||||
return new JSONObject().put("controlVersion", 1).put("serverTime", now).put("pollIntervalSeconds", 5)
|
||||
.put("desiredState", state(device).getJSONObject("desiredState")).put("commands", commands);
|
||||
return (new JSONObject().put("controlVersion", 1).put("serverTime", now).put("pollIntervalSeconds", 5)
|
||||
.put("desiredState", state(device).getJSONObject("desiredState")).put("commands", commands));
|
||||
}
|
||||
catch(Exception exception)
|
||||
{
|
||||
@@ -406,7 +375,7 @@ final class PrintingDeviceControls
|
||||
update(connection, "UPDATE printing_device_command SET status=?,receipt_json=? WHERE id=? AND tenant_id=? AND device_id=?", status, receipt.toString(), commandId, tenant, deviceId);
|
||||
}
|
||||
connection.commit();
|
||||
return new JSONObject().put("accepted", true);
|
||||
return (new JSONObject().put("accepted", true));
|
||||
}
|
||||
catch(Exception exception)
|
||||
{
|
||||
@@ -418,7 +387,7 @@ final class PrintingDeviceControls
|
||||
|
||||
|
||||
/** Management history is bounded and remains readable after revocation. */
|
||||
JSONObject page(String deviceId, int limit, @Nullable String before) throws SQLException
|
||||
JSONObject page(String deviceId, int limit, String before) throws SQLException
|
||||
{
|
||||
if(limit < 1 || limit > 200)
|
||||
{
|
||||
@@ -445,7 +414,7 @@ final class PrintingDeviceControls
|
||||
{
|
||||
commands.put(record(row));
|
||||
}
|
||||
return new JSONObject().put("commands", commands).put("nextCursor", rows.size() > limit ? rows.get(limit - 1).getString("id") : JSONObject.NULL);
|
||||
return (new JSONObject().put("commands", commands).put("nextCursor", rows.size() > limit ? rows.get(limit - 1).getString("id") : JSONObject.NULL));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -455,7 +424,7 @@ final class PrintingDeviceControls
|
||||
{
|
||||
try(Connection connection = source.getConnection())
|
||||
{
|
||||
return record(command(connection, deviceId, commandId));
|
||||
return (record(command(connection, deviceId, commandId)));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -468,7 +437,7 @@ final class PrintingDeviceControls
|
||||
{
|
||||
throw new PrintingException(404, "Device not found");
|
||||
}
|
||||
return rows.getFirst();
|
||||
return (rows.getFirst());
|
||||
}
|
||||
|
||||
|
||||
@@ -487,7 +456,7 @@ final class PrintingDeviceControls
|
||||
{
|
||||
throw new PrintingException(404, "Command not found");
|
||||
}
|
||||
return rows.getFirst();
|
||||
return (rows.getFirst());
|
||||
}
|
||||
|
||||
|
||||
@@ -517,14 +486,14 @@ final class PrintingDeviceControls
|
||||
{
|
||||
value.put("receipt", new JSONObject(row.getString("receipt_json")));
|
||||
}
|
||||
return value;
|
||||
return (value);
|
||||
}
|
||||
|
||||
|
||||
/** Numeric aggregates do not load a receipt history into application memory. */
|
||||
private static long count(Connection connection, String sql, Object... values) throws SQLException
|
||||
{
|
||||
return query(connection, sql, values).getFirst().getLong("n");
|
||||
return (query(connection, sql, values).getFirst().getLong("n"));
|
||||
}
|
||||
|
||||
|
||||
@@ -535,7 +504,7 @@ final class PrintingDeviceControls
|
||||
{
|
||||
throw new PrintingException(400, "Invalid " + field);
|
||||
}
|
||||
return value;
|
||||
return (value);
|
||||
}
|
||||
|
||||
|
||||
@@ -547,7 +516,7 @@ final class PrintingDeviceControls
|
||||
{
|
||||
throw new PrintingException(400, "UTC timestamp required");
|
||||
}
|
||||
return value;
|
||||
return (value);
|
||||
}
|
||||
|
||||
/** Require an exact nonnegative integral JSON value without coercion. */
|
||||
@@ -558,7 +527,7 @@ final class PrintingDeviceControls
|
||||
{
|
||||
throw new PrintingException(400, "Invalid " + field);
|
||||
}
|
||||
return ((Number) value).longValue();
|
||||
return (((Number) value).longValue());
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -56,7 +56,7 @@ import org.json.JSONObject;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Native administration controls use the caller's session and selected rows.
|
||||
** Native administration controls use the caller's QQQ session and selected rows.
|
||||
** Review is read-only; durable service requests execute only in the load step.
|
||||
*******************************************************************************/
|
||||
public final class PrintingDeviceProcesses
|
||||
@@ -75,12 +75,12 @@ public final class PrintingDeviceProcesses
|
||||
PAUSE("printingPauseDevices", "Pause printing", "PAUSE_DISPATCH", false, false,
|
||||
"New work will stop being dispatched. Jobs already received by Windows may still print."),
|
||||
RESUME("printingResumeDevices", "Resume printing", "RESUME_DISPATCH", false, false,
|
||||
"Dispatch will resume for connected, authorized " + PrintingNames.STATIONS_LOWER + ". Administrative disconnect remains unchanged."),
|
||||
DISCONNECT("printingDisconnectDevices", "Disconnect " + PrintingNames.STATIONS_LOWER, "DISCONNECT", false, false,
|
||||
"Dispatch will resume for connected, authorized devices. Administrative disconnect remains unchanged."),
|
||||
DISCONNECT("printingDisconnectDevices", "Disconnect devices", "DISCONNECT", false, false,
|
||||
"Normal printing traffic will stop. The outbound control channel remains available for reconnect."),
|
||||
RECONNECT("printingReconnectDevices", "Reconnect " + PrintingNames.STATIONS_LOWER, "RECONNECT", false, false,
|
||||
RECONNECT("printingReconnectDevices", "Reconnect devices", "RECONNECT", false, false,
|
||||
"Connected agents will be asked to resume normal traffic. An offline computer cannot be reached immediately."),
|
||||
REVOKE("printingRevokeDevices", "Revoke " + PrintingNames.STATION_LOWER + " access", "REVOKE", true, false,
|
||||
REVOKE("printingRevokeDevices", "Revoke device access", "REVOKE", true, false,
|
||||
"Access will be revoked permanently. The old credential cannot be restored; local re-enrollment is required."),
|
||||
REFRESH("printingRefreshDevices", "Refresh printer inventory", "REFRESH_INVENTORY", false, false,
|
||||
"A bounded refresh request will wait for a compatible agent. Acceptance does not mean it has executed."),
|
||||
@@ -162,7 +162,7 @@ public final class PrintingDeviceProcesses
|
||||
{
|
||||
if(action.process.equals(input.getProcessName()))
|
||||
{
|
||||
return action;
|
||||
return (action);
|
||||
}
|
||||
}
|
||||
throw new QException("Unknown printing control action");
|
||||
@@ -180,9 +180,9 @@ public final class PrintingDeviceProcesses
|
||||
if(QContext.getQSession() == null || QContext.getQSession().getUser() == null
|
||||
|| QContext.getQSession().getUser().getIdReference() == null || QContext.getQSession().getUser().getIdReference().isBlank())
|
||||
{
|
||||
throw new QException(PrintingMessages.notAllowed(false, "control a " + PrintingNames.STATION_LOWER, PrintingMessages.ADMIN_GRANT));
|
||||
throw new QException("Sign in with an authorized QQQ user before controlling a print device");
|
||||
}
|
||||
return QContext.getQSession().getUser().getIdReference();
|
||||
return (QContext.getQSession().getUser().getIdReference());
|
||||
}
|
||||
|
||||
|
||||
@@ -200,13 +200,13 @@ public final class PrintingDeviceProcesses
|
||||
QRecord record = new GetAction().execute(get).getRecord();
|
||||
if(record == null)
|
||||
{
|
||||
throw new QException("Choose an accessible " + (action.job ? "print job" : PrintingNames.STATION_LOWER));
|
||||
throw new QException("Choose an accessible print " + (action.job ? "job" : "device"));
|
||||
}
|
||||
if(action.job && "QUEUED".equals(record.getValueString("status")))
|
||||
{
|
||||
throw new QException("Use Cancel queued jobs for work that has not been dispatched to Windows");
|
||||
}
|
||||
return record;
|
||||
return (record);
|
||||
}
|
||||
|
||||
|
||||
@@ -268,12 +268,10 @@ public final class PrintingDeviceProcesses
|
||||
/************************************************************************
|
||||
** Standard summary links preserve the native record/table workflow.
|
||||
************************************************************************/
|
||||
// QQQ ProcessSummaryProvider requires this concrete return type; retain binary/API compatibility.
|
||||
@SuppressWarnings("NonApiType")
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
|
||||
{
|
||||
return new ArrayList<>(List.of(ready));
|
||||
return (new ArrayList<>(List.of(ready)));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -285,8 +283,8 @@ public final class PrintingDeviceProcesses
|
||||
public static class Load extends AbstractLoadStep implements ProcessSummaryProviderInterface
|
||||
{
|
||||
private final ProcessSummaryLine applied = new ProcessSummaryLine(Status.OK, 0, null)
|
||||
.withSingularPastMessage("server control action was applied; what the " + PrintingNames.STATION_LOWER + " reports is shown separately")
|
||||
.withPluralPastMessage("server control actions were applied; what each " + PrintingNames.STATION_LOWER + " reports is shown separately");
|
||||
.withSingularPastMessage("server control action was applied; device observation is shown separately")
|
||||
.withPluralPastMessage("server control actions were applied; device observations are shown separately");
|
||||
private final ProcessSummaryLine pending = new ProcessSummaryLine(Status.WARNING, 0, null)
|
||||
.withSingularPastMessage("agent request is pending; no remote execution is confirmed")
|
||||
.withPluralPastMessage("agent requests are pending; no remote execution is confirmed");
|
||||
@@ -326,7 +324,8 @@ public final class PrintingDeviceProcesses
|
||||
}
|
||||
try
|
||||
{
|
||||
String status = PrintingControlAuthorization.deviceAction(deviceId, request).getString("status");
|
||||
JSONObject result = PrintingControlAuthorization.deviceAction(deviceId, request);
|
||||
String status = result.getString("status");
|
||||
ProcessSummaryLine summary = "PENDING".equals(status) ? pending : ("SUCCEEDED".equals(status) ? applied : unresolved);
|
||||
summary.incrementCountAndAddPrimaryKey(current.getValue("id"));
|
||||
output.getRecords().add(current);
|
||||
@@ -343,12 +342,10 @@ public final class PrintingDeviceProcesses
|
||||
/************************************************************************
|
||||
** Pending requests are never presented as completed Windows operations.
|
||||
************************************************************************/
|
||||
// QQQ ProcessSummaryProvider requires this concrete return type; retain binary/API compatibility.
|
||||
@SuppressWarnings("NonApiType")
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
|
||||
{
|
||||
return new ArrayList<>(List.of(applied, pending, unresolved));
|
||||
return (new ArrayList<>(List.of(applied, pending, unresolved)));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -36,7 +36,6 @@ import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperat
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -57,7 +56,7 @@ public class PrintingDeviceStatus implements TableCustomizerInterface
|
||||
Set<String> selected = input instanceof QueryInput query ? query.getFieldNamesToInclude() : null;
|
||||
if(selected != null && !selected.contains("device_status") && !selected.contains("control_status"))
|
||||
{
|
||||
return records;
|
||||
return (records);
|
||||
}
|
||||
if(selected != null && !selected.contains("id"))
|
||||
{
|
||||
@@ -77,7 +76,7 @@ public class PrintingDeviceStatus implements TableCustomizerInterface
|
||||
record.setValue("control_status", application(values));
|
||||
}
|
||||
}
|
||||
return records;
|
||||
return (records);
|
||||
}
|
||||
|
||||
|
||||
@@ -109,7 +108,7 @@ public class PrintingDeviceStatus implements TableCustomizerInterface
|
||||
result.put(row.getValueString("id"), row);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
return (result);
|
||||
}
|
||||
|
||||
|
||||
@@ -121,24 +120,24 @@ public class PrintingDeviceStatus implements TableCustomizerInterface
|
||||
{
|
||||
if(record.getValueInteger("enabled") != null && record.getValueInteger("enabled") == 0)
|
||||
{
|
||||
return "REVOKED";
|
||||
return ("REVOKED");
|
||||
}
|
||||
if("DISCONNECTED".equals(record.getValueString("connection_state")))
|
||||
{
|
||||
return "DISCONNECTED";
|
||||
return ("DISCONNECTED");
|
||||
}
|
||||
Instant heartbeat = timestamp(record.getValueString("last_seen_at"));
|
||||
Instant control = timestamp(record.getValueString("control_last_poll_at"));
|
||||
Instant seen = heartbeat == null || (control != null && control.isAfter(heartbeat)) ? control : heartbeat;
|
||||
if(seen == null || seen.isAfter(now.plusSeconds(30)))
|
||||
{
|
||||
return "UNKNOWN";
|
||||
return ("UNKNOWN");
|
||||
}
|
||||
if(seen.isBefore(now.minusSeconds(90)))
|
||||
{
|
||||
return "OFFLINE";
|
||||
return ("OFFLINE");
|
||||
}
|
||||
return Integer.valueOf(1).equals(record.getValueInteger("dispatch_paused")) ? "PAUSED" : "ONLINE";
|
||||
return (Integer.valueOf(1).equals(record.getValueInteger("dispatch_paused")) ? "PAUSED" : "ONLINE");
|
||||
}
|
||||
|
||||
|
||||
@@ -150,11 +149,11 @@ public class PrintingDeviceStatus implements TableCustomizerInterface
|
||||
{
|
||||
if(!Integer.valueOf(1).equals(record.getValueInteger("control_version")))
|
||||
{
|
||||
return "UNKNOWN";
|
||||
return ("UNKNOWN");
|
||||
}
|
||||
Long desired = record.getValueLong("control_revision");
|
||||
Long observed = record.getValueLong("control_applied_revision");
|
||||
return desired != null && observed != null && desired.equals(observed) ? "APPLIED" : "PENDING";
|
||||
return (desired != null && observed != null && desired.equals(observed) ? "APPLIED" : "PENDING");
|
||||
}
|
||||
|
||||
|
||||
@@ -162,19 +161,19 @@ public class PrintingDeviceStatus implements TableCustomizerInterface
|
||||
/***************************************************************************
|
||||
** Bad observations must remain unknown rather than imply a healthy device.
|
||||
***************************************************************************/
|
||||
private static @Nullable Instant timestamp(@Nullable String value)
|
||||
private static Instant timestamp(String value)
|
||||
{
|
||||
if(value == null || value.isBlank())
|
||||
{
|
||||
return null;
|
||||
return (null);
|
||||
}
|
||||
try
|
||||
{
|
||||
return Instant.parse(value);
|
||||
return (Instant.parse(value));
|
||||
}
|
||||
catch(DateTimeParseException exception)
|
||||
{
|
||||
return null;
|
||||
return (null);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -95,14 +95,14 @@ public class PrintingDocumentStorage
|
||||
***************************************************************************/
|
||||
public byte[] get(String table, String reference) throws SQLException
|
||||
{
|
||||
return get(table, reference, Math.toIntExact(PrintingRealtimePolicy.defaults().get("maxPdfBytes")));
|
||||
return (get(table, reference, Math.toIntExact(PrintingRealtimePolicy.defaults().get("maxPdfBytes"))));
|
||||
}
|
||||
|
||||
|
||||
/** Internal retry callers supply the exact persisted length, independent of the current format policy. */
|
||||
public byte[] get(String table, String reference, int maximum) throws SQLException
|
||||
{
|
||||
return execute(() ->
|
||||
return (execute(() ->
|
||||
{
|
||||
try(InputStream stream = new StorageAction().getInputStream(input(table, reference)))
|
||||
{
|
||||
@@ -113,14 +113,14 @@ public class PrintingDocumentStorage
|
||||
}
|
||||
return bytes;
|
||||
}
|
||||
});
|
||||
}));
|
||||
}
|
||||
|
||||
|
||||
/** Return the native backend stream; the request owns closing it and enforcing its declared length. */
|
||||
public InputStream open(String table, String reference) throws SQLException
|
||||
{
|
||||
return execute(() -> new StorageAction().getInputStream(input(table, reference)));
|
||||
return (execute(() -> new StorageAction().getInputStream(input(table, reference))));
|
||||
}
|
||||
|
||||
|
||||
@@ -148,7 +148,7 @@ public class PrintingDocumentStorage
|
||||
{
|
||||
throw new IllegalArgumentException("Configured printing storage table does not exist");
|
||||
}
|
||||
return instance.getTable(table).getBackendName();
|
||||
return (instance.getTable(table).getBackendName());
|
||||
}
|
||||
|
||||
|
||||
@@ -166,7 +166,7 @@ public class PrintingDocumentStorage
|
||||
var backend = instance.getBackend(backendName(table));
|
||||
if(allowMemoryTest && "memory".equals(backend.getBackendType()))
|
||||
{
|
||||
return digest(table + ":" + backend.getName());
|
||||
return (digest(table + ":" + backend.getName()));
|
||||
}
|
||||
if(!table.startsWith("printing_") || !(backend instanceof S3BackendMetaData s3) || !(metadata.getBackendDetails() instanceof S3TableBackendDetails details)
|
||||
|| s3.getBucketName() == null || s3.getBucketName().isBlank())
|
||||
@@ -182,9 +182,9 @@ public class PrintingDocumentStorage
|
||||
throw new IllegalArgumentException("Printing bucket is shared with a non-printing table; configure a dedicated bucket");
|
||||
}
|
||||
}
|
||||
return digest(new JSONArray().put(identity).put(java.util.Objects.toString(s3.getRegion(), "")).put(java.util.Objects.toString(s3.getPathStyleAccess(), "false"))
|
||||
return (digest(new JSONArray().put(identity).put(java.util.Objects.toString(s3.getRegion(), "")).put(java.util.Objects.toString(s3.getPathStyleAccess(), "false"))
|
||||
.put(java.util.Objects.toString(s3.getBasePath(), "")).put(java.util.Objects.toString(details.getBasePath(), ""))
|
||||
.put(S3_KEY_LAYOUT).put((int) java.io.File.separatorChar).toString());
|
||||
.put(S3_KEY_LAYOUT).put((int) java.io.File.separatorChar).toString()));
|
||||
}
|
||||
|
||||
|
||||
@@ -195,7 +195,7 @@ public class PrintingDocumentStorage
|
||||
public String bucketName(String table)
|
||||
{
|
||||
var backend = instance.getBackend(backendName(table));
|
||||
return backend instanceof S3BackendMetaData s3 ? s3.getBucketName() : "In-memory test storage";
|
||||
return (backend instanceof S3BackendMetaData s3 ? s3.getBucketName() : "In-memory test storage");
|
||||
}
|
||||
|
||||
|
||||
@@ -205,7 +205,7 @@ public class PrintingDocumentStorage
|
||||
***************************************************************************/
|
||||
public String prefix()
|
||||
{
|
||||
return prefix;
|
||||
return (prefix);
|
||||
}
|
||||
|
||||
|
||||
@@ -241,7 +241,7 @@ public class PrintingDocumentStorage
|
||||
endpoint = uri.getScheme().toLowerCase(java.util.Locale.ROOT) + "://" + uri.getHost().toLowerCase(java.util.Locale.ROOT)
|
||||
+ (uri.getPort() < 0 || ("https".equalsIgnoreCase(uri.getScheme()) && uri.getPort() == 443) || ("http".equalsIgnoreCase(uri.getScheme()) && uri.getPort() == 80) ? "" : ":" + uri.getPort()) + java.util.Objects.toString(uri.getPath(), "").replaceAll("/+$", "");
|
||||
}
|
||||
return new JSONArray().put(endpoint).put(java.util.Objects.toString(backend.getBucketName())).toString();
|
||||
return (new JSONArray().put(endpoint).put(java.util.Objects.toString(backend.getBucketName())).toString());
|
||||
}
|
||||
|
||||
|
||||
@@ -253,7 +253,7 @@ public class PrintingDocumentStorage
|
||||
{
|
||||
try
|
||||
{
|
||||
return HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(value.getBytes(StandardCharsets.UTF_8)));
|
||||
return (HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(value.getBytes(StandardCharsets.UTF_8))));
|
||||
}
|
||||
catch(java.security.NoSuchAlgorithmException exception)
|
||||
{
|
||||
@@ -273,7 +273,7 @@ public class PrintingDocumentStorage
|
||||
{
|
||||
throw new IllegalArgumentException("Invalid owned printing storage reference");
|
||||
}
|
||||
return new StorageInput(table).withReference(reference);
|
||||
return (new StorageInput(table).withReference(reference));
|
||||
}
|
||||
|
||||
|
||||
@@ -288,7 +288,7 @@ public class PrintingDocumentStorage
|
||||
try
|
||||
{
|
||||
QContext.init(instance, new QSystemUserSession(instance));
|
||||
return operation.call();
|
||||
return (operation.call());
|
||||
}
|
||||
catch(PrintingException exception)
|
||||
{
|
||||
|
||||
@@ -60,7 +60,7 @@ final class PrintingDocumentStream extends FilterInputStream
|
||||
public int read() throws IOException
|
||||
{
|
||||
byte[] one = new byte[1];
|
||||
return read(one, 0, 1) == -1 ? -1 : Byte.toUnsignedInt(one[0]);
|
||||
return (read(one, 0, 1) == -1 ? -1 : Byte.toUnsignedInt(one[0]));
|
||||
}
|
||||
|
||||
|
||||
@@ -85,6 +85,6 @@ final class PrintingDocumentStream extends FilterInputStream
|
||||
throw new IOException("Stored print document integrity check failed");
|
||||
}
|
||||
}
|
||||
return read;
|
||||
return (read);
|
||||
}
|
||||
}
|
||||
@@ -46,7 +46,7 @@ public class PrintingException extends RuntimeException
|
||||
***************************************************************************/
|
||||
public int getStatus()
|
||||
{
|
||||
return status;
|
||||
return (status);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -51,6 +51,6 @@ public class PrintingExtract extends ExtractViaQueryStep
|
||||
count.setTableName(input.getValueString(FIELD_SOURCE_TABLE));
|
||||
count.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
|
||||
PermissionsHelper.checkTablePermissionThrowing(count, TablePermissionSubType.READ);
|
||||
return super.doCount(input);
|
||||
return (super.doCount(input));
|
||||
}
|
||||
}
|
||||
@@ -33,7 +33,6 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValue;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSource;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSourceType;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -64,13 +63,13 @@ final class PrintingFacilities
|
||||
{
|
||||
instance.addPossibleValueSource(new QPossibleValueSource().withName(DEFAULT_SOURCE).withType(QPossibleValueSourceType.ENUM)
|
||||
.withEnumValues(List.of(new QPossibleValue<>("default", "Default facility"))));
|
||||
return DEFAULT_SOURCE;
|
||||
return (DEFAULT_SOURCE);
|
||||
}
|
||||
if(instance.getPossibleValueSource(source) == null)
|
||||
{
|
||||
throw new QException("The configured printing facility possible-value source does not exist");
|
||||
}
|
||||
return source;
|
||||
return (source);
|
||||
}
|
||||
|
||||
|
||||
@@ -81,8 +80,8 @@ final class PrintingFacilities
|
||||
static QFieldMetaData field(QInstance instance)
|
||||
{
|
||||
String source = instance.getTable(PrintingTables.DEVICE).getField("facility_id").getPossibleValueSourceName();
|
||||
return new QFieldMetaData("facilityId", QFieldType.STRING).withLabel("Facility").withIsRequired(true).withMaxLength(200)
|
||||
.withPossibleValueSourceName(source).withDefaultValue(DEFAULT_SOURCE.equals(source) ? "default" : null);
|
||||
return (new QFieldMetaData("facilityId", QFieldType.STRING).withLabel("Facility").withIsRequired(true).withMaxLength(200)
|
||||
.withPossibleValueSourceName(source).withDefaultValue(DEFAULT_SOURCE.equals(source) ? "default" : null));
|
||||
}
|
||||
|
||||
|
||||
@@ -90,7 +89,7 @@ final class PrintingFacilities
|
||||
/***************************************************************************
|
||||
** Re-query the selected ID under the caller's session, never a system session.
|
||||
***************************************************************************/
|
||||
static String validate(@Nullable String selected) throws QException
|
||||
static String validate(String selected) throws QException
|
||||
{
|
||||
if(selected == null || selected.isBlank() || selected.length() > 200)
|
||||
{
|
||||
@@ -105,6 +104,6 @@ final class PrintingFacilities
|
||||
{
|
||||
throw new QException("The selected facility is unavailable or is not accessible to this user");
|
||||
}
|
||||
return selected;
|
||||
return (selected);
|
||||
}
|
||||
}
|
||||
@@ -84,11 +84,11 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
{
|
||||
add(instance, app, "printingHomeHeader", "Printing operations", WidgetType.COMPOSITE, "header", 0, 12);
|
||||
add(instance, app, "printingHomeAttention", "Needs attention", WidgetType.TABLE, "systemAttention", 10, 12);
|
||||
add(instance, app, "printingHomeOffline", "Disconnected " + PrintingNames.STATIONS_LOWER, WidgetType.STATISTICS, "systemHealth", 20, 3);
|
||||
add(instance, app, "printingHomePrinters", PrintingNames.PRINTERS + " needing attention", WidgetType.STATISTICS, "systemHealth", 21, 3);
|
||||
add(instance, app, "printingHomeOffline", "Disconnected devices", WidgetType.STATISTICS, "systemHealth", 20, 3);
|
||||
add(instance, app, "printingHomePrinters", "Printers needing attention", WidgetType.STATISTICS, "systemHealth", 21, 3);
|
||||
add(instance, app, "printingHomeFailures", "Failed or uncertain jobs", WidgetType.STATISTICS, "systemHealth", 22, 3);
|
||||
add(instance, app, "printingHomePending", "Pending print jobs", WidgetType.STATISTICS, "systemHealth", 23, 3);
|
||||
add(instance, app, "printingHomeControls", "Pending " + PrintingNames.STATION_LOWER + " commands", WidgetType.STATISTICS, "systemHealth", 24, 12);
|
||||
add(instance, app, "printingHomeControls", "Pending device commands", WidgetType.STATISTICS, "systemHealth", 24, 12);
|
||||
add(instance, app, "printingHomeWork", "Pending and recent print work", WidgetType.TABLE, "queue", 30, 12);
|
||||
}
|
||||
|
||||
@@ -134,12 +134,12 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
case "printingHomeFailures" -> statistic(JOB, failures(now), "Jobs created in last 24 hours · target 0 failed or uncertain");
|
||||
case "printingHomePending" -> statistic(JOB, statuses(PENDING), "Jobs · now · target queue drains after printing");
|
||||
case "printingHomeControls" -> statistic(PrintingTables.COMMAND, statuses(List.of("PENDING"))
|
||||
.withCriteria("expires_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, now.toString()), PrintingNames.STATION + " commands · now · awaiting an agent receipt; not confirmed applied");
|
||||
.withCriteria("expires_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, now.toString()), "Device commands · now · awaiting an agent receipt; not confirmed applied");
|
||||
case "printingHomeWork" -> work(now);
|
||||
default -> throw new QException("Unknown printing home widget");
|
||||
};
|
||||
data.setSublabel("Checked " + DISPLAY_TIME.format(now) + " · current tenant · refresh every 60 seconds");
|
||||
return new RenderWidgetOutput(data);
|
||||
return (new RenderWidgetOutput(data));
|
||||
}
|
||||
|
||||
|
||||
@@ -149,20 +149,19 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static CompositeWidgetData header() throws QException
|
||||
{
|
||||
CompositeWidgetData data = column().withBlock(text("Keep packing slips and shipping labels moving by resolving disconnected " + PrintingNames.STATIONS_LOWER + ", " + PrintingNames.PRINTER_LOWER + " issues and print failures."))
|
||||
.withBlock(text("Scope: current tenant. " + PrintingNames.STATIONS + " and " + PrintingNames.PRINTERS_LOWER + ": now. Job exceptions/recent work: last 24 hours."))
|
||||
.withBlock(text("Enroll a " + PrintingNames.STATION_LOWER).withLink(new BlockLink("/app/printingEnrollDevice/?returnTo=%2Fapp%2Fprinting%2F")))
|
||||
CompositeWidgetData data = column().withBlock(text("Keep packing slips and shipping labels moving by resolving disconnected devices, printer issues and print failures."))
|
||||
.withBlock(text("Scope: current tenant. Devices/printers: now. Job exceptions/recent work: last 24 hours."))
|
||||
.withBlock(text("Enroll a print device").withLink(new BlockLink("/app/printingEnrollDevice/?returnTo=%2Fapp%2Fprinting%2F")))
|
||||
.withBlock(text("Printing retention settings").withLink(new BlockLink("/app/printingRetentionSettings/?returnTo=%2Fapp%2Fprinting%2F")))
|
||||
.withBlock(text("Printing connection and limits").withLink(new BlockLink("/app/printingRealtimeSettings/?returnTo=%2Fapp%2Fprinting%2F")))
|
||||
.withBlock(text("Printing queue and storage limits").withLink(new BlockLink("/app/printingAdmissionSettings/?returnTo=%2Fapp%2Fprinting%2F")))
|
||||
.withBlock(text("Run retention cleanup").withLink(new BlockLink("/app/printingRunRetention/?returnTo=%2Fapp%2Fprinting%2F")))
|
||||
.withBlock(text("Printing setup and help").withLink(new BlockLink("https://github.com/QRun-IO/qbit-printing/blob/main/docs/OPERATIONS.md")));
|
||||
QQueryFilter present = new QQueryFilter().withCriteria("removed_at", QCriteriaOperator.IS_BLANK);
|
||||
if(count(DEVICE, present) == 0)
|
||||
if(count(DEVICE, new QQueryFilter()) == 0)
|
||||
{
|
||||
data.withBlock(text("No " + PrintingNames.STATIONS_LOWER + " are connected. Open " + PrintingNames.STATIONS + " and use Enroll a " + PrintingNames.STATION_LOWER + "; then connect the Windows agent and expose its " + PrintingNames.PRINTERS_LOWER + ".").withLink(new BlockLink(tableUrl(DEVICE, present))));
|
||||
data.withBlock(text("No print devices are connected. Open Print devices and use Enroll a print device; then connect the Windows agent and expose its printers.").withLink(new BlockLink(tableUrl(DEVICE, new QQueryFilter()))));
|
||||
}
|
||||
return data;
|
||||
return (data);
|
||||
}
|
||||
|
||||
|
||||
@@ -181,28 +180,28 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
{
|
||||
boolean disconnected = "DISCONNECTED".equals(device.getValueString("connection_state"));
|
||||
rows.add(issue(DEVICE, device, device.getValueString("name"), disconnected ? "Administratively disconnected" : "No connection for " + freshnessSeconds + " seconds",
|
||||
disconnected ? "Open the " + PrintingNames.STATION_LOWER + " and use Reconnect; review its observed control revision." : "Open the Windows agent and check its service, sign-in and outbound connection.", "last_seen_at"));
|
||||
disconnected ? "Open the device and use Reconnect; review its observed control revision." : "Open the Windows agent and check its service, sign-in and outbound connection.", "last_seen_at"));
|
||||
}
|
||||
for(QRecord device : query(DEVICE, new QQueryFilter().withCriteria("enabled", QCriteriaOperator.EQUALS, 1)
|
||||
.withCriteria("dispatch_paused", QCriteriaOperator.EQUALS, 1).withOrderBy(new QFilterOrderBy("name")).withLimit(10)))
|
||||
{
|
||||
rows.add(issue(DEVICE, device, device.getValueString("name"), "Dispatch paused", "Open the " + PrintingNames.STATION_LOWER + " queue, then use Resume printing when it is ready.", "control_last_poll_at"));
|
||||
rows.add(issue(DEVICE, device, device.getValueString("name"), "Dispatch paused", "Open the device queue, then use Resume dispatch when it is ready.", "control_last_poll_at"));
|
||||
}
|
||||
for(QRecord command : query(PrintingTables.COMMAND, statuses(List.of("PENDING", "FAILED", "EXPIRED", "OUTCOME_UNKNOWN"))
|
||||
.withCriteria("created_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, now.minusSeconds(86400).toString())
|
||||
.withOrderBy(new QFilterOrderBy("created_at", false)).withLimit(10)))
|
||||
{
|
||||
rows.add(issue(PrintingTables.COMMAND, command, command.getValueString("action"), command.getValueString("command_status"),
|
||||
"Review command history and the " + PrintingNames.STATION_LOWER + " connection before submitting another request.", "created_at"));
|
||||
"Review command history and the device connection before submitting another request.", "created_at"));
|
||||
}
|
||||
for(QRecord printer : query(PRINTER, printerIssues().withOrderBy(new QFilterOrderBy("last_seen_at", true)).withLimit(10)))
|
||||
{
|
||||
rows.add(issue(PRINTER, printer, printer.getValueString("name"), printer.getValueString("status"), "Check paper, paused/error state and whether this queue is still exposed by the agent.", "last_seen_at"));
|
||||
}
|
||||
return table(rows, "No issues in this scope. If no " + PrintingNames.STATIONS_LOWER + " are enrolled, start from " + PrintingNames.STATIONS + ".",
|
||||
return (table(rows, "No issues in this scope. If no devices are enrolled, start from Print devices.",
|
||||
new TableData.Column("composite", "Issue / record", "issue", null, "left"),
|
||||
new TableData.Column("default", "Next step", "action", null, "left"),
|
||||
new TableData.Column("default", "Observed at", "observed", null, "left"));
|
||||
new TableData.Column("default", "Observed at", "observed", null, "left")));
|
||||
}
|
||||
|
||||
|
||||
@@ -220,12 +219,12 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
rows.add(Map.of("job", column().withBlock(text(job.getValueString("title")).withLink(new BlockLink(recordUrl(JOB, job)))),
|
||||
"status", job.getValueString("status"), "format", job.getValueString("format"), "created", displayTime(job.getValueString("created_at"))));
|
||||
}
|
||||
return table(rows, "No pending or recent print work. Open Printers to enable an exposed queue and run its test-print action.",
|
||||
return (table(rows, "No pending or recent print work. Open Printers to enable an exposed queue and run its test-print action.",
|
||||
new TableData.Column("composite", "Print job", "job", null, "left"),
|
||||
new TableData.Column("default", "Status", "status", null, "left"),
|
||||
new TableData.Column("default", "Format", "format", null, "left"),
|
||||
new TableData.Column("default", "Created at", "created", null, "left"))
|
||||
.withLinkText("Open all pending and recent jobs").withLinkURL(tableUrl(JOB, filter.withLimit(null)));
|
||||
.withLinkText("Open all pending and recent jobs").withLinkURL(tableUrl(JOB, filter.withLimit(null))));
|
||||
}
|
||||
|
||||
|
||||
@@ -235,7 +234,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static StatisticsData statistic(String table, QQueryFilter filter, String context) throws QException
|
||||
{
|
||||
return new StatisticsData().withCount(count(table, filter)).withCountContext(context).withCountURL(tableUrl(table, filter));
|
||||
return (new StatisticsData().withCount(count(table, filter)).withCountContext(context).withCountURL(tableUrl(table, filter)));
|
||||
}
|
||||
|
||||
|
||||
@@ -247,7 +246,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
{
|
||||
QueryInput input = new QueryInput().withTableName(table).withFilter(filter);
|
||||
input.setPermissionEnforcement(com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement.ENFORCE);
|
||||
return new QueryAction().execute(input).getRecords();
|
||||
return (new QueryAction().execute(input).getRecords());
|
||||
}
|
||||
|
||||
|
||||
@@ -259,7 +258,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
{
|
||||
CountInput input = new CountInput(table).withFilter(filter);
|
||||
input.setPermissionEnforcement(com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement.ENFORCE);
|
||||
return new CountAction().execute(input).getCount();
|
||||
return (new CountAction().execute(input).getCount());
|
||||
}
|
||||
|
||||
|
||||
@@ -271,7 +270,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
{
|
||||
try
|
||||
{
|
||||
return Math.max(90, PrintingProcesses.currentService().realtimePolicy().get("heartbeatTimeoutSeconds"));
|
||||
return (Math.max(90, PrintingProcesses.currentService().realtimePolicy().get("heartbeatTimeoutSeconds")));
|
||||
}
|
||||
catch(java.sql.SQLException exception)
|
||||
{
|
||||
@@ -287,7 +286,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
private static StatisticsData offlineStatistic(Instant now) throws QException
|
||||
{
|
||||
long seconds = freshnessSeconds();
|
||||
return statistic(DEVICE, offline(now, seconds), "Enabled " + PrintingNames.STATIONS_LOWER + " · now · disconnected by an administrator or unseen for " + seconds + " seconds");
|
||||
return (statistic(DEVICE, offline(now, seconds), "Enabled devices · now · disconnected by an administrator or unseen for " + seconds + " seconds"));
|
||||
}
|
||||
|
||||
|
||||
@@ -300,7 +299,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
QQueryFilter unseen = new QQueryFilter().withSubFilter(stale("last_seen_at", now, freshnessSeconds)).withSubFilter(stale("control_last_poll_at", now, freshnessSeconds));
|
||||
QQueryFilter disconnected = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR)
|
||||
.withCriteria("connection_state", QCriteriaOperator.EQUALS, "DISCONNECTED").withSubFilter(unseen);
|
||||
return new QQueryFilter().withCriteria("enabled", QCriteriaOperator.EQUALS, 1).withSubFilter(disconnected);
|
||||
return (new QQueryFilter().withCriteria("enabled", QCriteriaOperator.EQUALS, 1).withSubFilter(disconnected));
|
||||
}
|
||||
|
||||
|
||||
@@ -310,8 +309,8 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static QQueryFilter stale(String field, Instant now, long freshnessSeconds)
|
||||
{
|
||||
return new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR)
|
||||
.withCriteria(field, QCriteriaOperator.IS_BLANK).withCriteria(field, QCriteriaOperator.LESS_THAN, now.minusSeconds(freshnessSeconds).toString());
|
||||
return (new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR)
|
||||
.withCriteria(field, QCriteriaOperator.IS_BLANK).withCriteria(field, QCriteriaOperator.LESS_THAN, now.minusSeconds(freshnessSeconds).toString()));
|
||||
}
|
||||
|
||||
|
||||
@@ -321,8 +320,8 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static QQueryFilter printerIssues()
|
||||
{
|
||||
return new QQueryFilter().withCriteria("enabled", QCriteriaOperator.EQUALS, 1).withSubFilter(new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR)
|
||||
.withCriteria("status", QCriteriaOperator.NOT_EQUALS, "READY").withCriteria("available", QCriteriaOperator.NOT_EQUALS, 1));
|
||||
return (new QQueryFilter().withCriteria("enabled", QCriteriaOperator.EQUALS, 1).withSubFilter(new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR)
|
||||
.withCriteria("status", QCriteriaOperator.NOT_EQUALS, "READY").withCriteria("available", QCriteriaOperator.NOT_EQUALS, 1)));
|
||||
}
|
||||
|
||||
|
||||
@@ -332,7 +331,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static QQueryFilter statuses(List<String> states)
|
||||
{
|
||||
return new QQueryFilter().withCriteria("status", QCriteriaOperator.IN, states);
|
||||
return (new QQueryFilter().withCriteria("status", QCriteriaOperator.IN, states));
|
||||
}
|
||||
|
||||
|
||||
@@ -342,7 +341,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static QQueryFilter failures(Instant now)
|
||||
{
|
||||
return statuses(FAILURES).withCriteria("created_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, now.minusSeconds(86400).toString());
|
||||
return (statuses(FAILURES).withCriteria("created_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, now.minusSeconds(86400).toString()));
|
||||
}
|
||||
|
||||
|
||||
@@ -352,8 +351,8 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static Map<String, Object> issue(String table, QRecord record, String label, String status, String action, String timestamp) throws QException
|
||||
{
|
||||
return Map.of("issue", column().withBlock(text(label + " — " + status).withLink(new BlockLink(recordUrl(table, record)))),
|
||||
"action", action, "observed", displayTime(record.getValueString(timestamp)));
|
||||
return (Map.of("issue", column().withBlock(text(label + " — " + status).withLink(new BlockLink(recordUrl(table, record)))),
|
||||
"action", action, "observed", displayTime(record.getValueString(timestamp))));
|
||||
}
|
||||
|
||||
|
||||
@@ -365,15 +364,15 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
{
|
||||
if(value == null)
|
||||
{
|
||||
return "Unknown time";
|
||||
return ("Unknown time");
|
||||
}
|
||||
try
|
||||
{
|
||||
return DISPLAY_TIME.format(Instant.parse(value));
|
||||
return (DISPLAY_TIME.format(Instant.parse(value)));
|
||||
}
|
||||
catch(DateTimeParseException exception)
|
||||
{
|
||||
return "Unknown time";
|
||||
return ("Unknown time");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -384,7 +383,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static TableData table(List<Map<String, Object>> rows, String empty, TableData.Column... columns)
|
||||
{
|
||||
return new TableData(null, List.of(columns), rows).withRowsPerPage(25).withHidePaginationDropdown(true).withNoRowsFoundHTML(empty);
|
||||
return (new TableData(null, List.of(columns), rows).withRowsPerPage(25).withHidePaginationDropdown(true).withNoRowsFoundHTML(empty));
|
||||
}
|
||||
|
||||
|
||||
@@ -394,7 +393,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static CompositeWidgetData column()
|
||||
{
|
||||
return new CompositeWidgetData().withLayout(CompositeWidgetData.Layout.FLEX_COLUMN);
|
||||
return (new CompositeWidgetData().withLayout(CompositeWidgetData.Layout.FLEX_COLUMN));
|
||||
}
|
||||
|
||||
|
||||
@@ -404,7 +403,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static TextBlockData text(String value)
|
||||
{
|
||||
return new TextBlockData().withValues(new TextValues(value));
|
||||
return (new TextBlockData().withValues(new TextValues(value)));
|
||||
}
|
||||
|
||||
|
||||
@@ -414,7 +413,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static String recordUrl(String table, QRecord record) throws QException
|
||||
{
|
||||
return QContext.getQInstance().getTablePath(table) + "/" + URLEncoder.encode(record.getValueString("id"), StandardCharsets.UTF_8);
|
||||
return (QContext.getQInstance().getTablePath(table) + "/" + URLEncoder.encode(record.getValueString("id"), StandardCharsets.UTF_8));
|
||||
}
|
||||
|
||||
|
||||
@@ -424,7 +423,7 @@ public class PrintingHome extends AbstractWidgetRenderer
|
||||
***************************************************************************/
|
||||
private static String tableUrl(String table, QQueryFilter filter) throws QException
|
||||
{
|
||||
return QContext.getQInstance().getTablePath(table) + "?filter=" + URLEncoder.encode(JsonUtils.toJson(filter), StandardCharsets.UTF_8);
|
||||
return (QContext.getQInstance().getTablePath(table) + "?filter=" + URLEncoder.encode(JsonUtils.toJson(filter), StandardCharsets.UTF_8));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -80,7 +80,7 @@ public class PrintingJobProcesses
|
||||
values.put(StreamedETLWithFrontendProcess.FIELD_DO_FULL_VALIDATION, true);
|
||||
values.put(StreamedETLWithFrontendProcess.FIELD_PREVIEW_MESSAGE, retry
|
||||
? "Each selected job will create a new print job. Previously spooled or uncertain output may print twice. Inspect the printer before continuing."
|
||||
: "Only selected jobs still queued in QQQ will be canceled. Jobs already received by a " + PrintingNames.STATION_LOWER + " must be inspected in the Windows companion.");
|
||||
: "Only selected jobs still queued in QQQ will be canceled. Jobs already received by a device must be inspected in the Windows companion.");
|
||||
QProcessMetaData process = StreamedETLWithFrontendProcess.defineProcessMetaData(PrintingExtract.class, Transform.class, Load.class, values)
|
||||
.withName(name).withLabel(retry ? "Print again" : "Cancel queued jobs").withTableName(PrintingTables.JOB).withMinInputRecords(1)
|
||||
.withPermissionRules(PrintingProcesses.permissionRules());
|
||||
@@ -137,7 +137,7 @@ public class PrintingJobProcesses
|
||||
{
|
||||
throw new QException("Job " + job.getValueString("title") + " is " + state + " and cannot be processed by this action");
|
||||
}
|
||||
return job;
|
||||
return (job);
|
||||
}
|
||||
|
||||
|
||||
@@ -152,7 +152,7 @@ public class PrintingJobProcesses
|
||||
{
|
||||
throw new QException("Unknown print job action");
|
||||
}
|
||||
return PrintingProcesses.currentService();
|
||||
return (PrintingProcesses.currentService());
|
||||
}
|
||||
|
||||
|
||||
@@ -191,12 +191,10 @@ public class PrintingJobProcesses
|
||||
/***************************************************************************
|
||||
** Standard QQQ preview links selected job titles to their records.
|
||||
***************************************************************************/
|
||||
// QQQ ProcessSummaryProvider requires this concrete return type; retain binary/API compatibility.
|
||||
@SuppressWarnings("NonApiType")
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
|
||||
{
|
||||
return new ArrayList<>(List.of(ready, risk));
|
||||
return (new ArrayList<>(List.of(ready, risk)));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -243,10 +241,6 @@ public class PrintingJobProcesses
|
||||
}
|
||||
catch(java.sql.SQLException | PrintingException exception)
|
||||
{
|
||||
if(exception instanceof PrintingException refused && refused.getStatus() == 404 && "Device not found".equals(refused.getMessage()))
|
||||
{
|
||||
throw new QException("Job " + job.getValueString("title") + " cannot be processed: its " + PrintingNames.STATION_LOWER + " was deleted, removed or revoked. Print the document again from where it was printed.", exception);
|
||||
}
|
||||
throw new QException("Print job action failed: " + exception.getMessage(), exception);
|
||||
}
|
||||
}
|
||||
@@ -257,12 +251,10 @@ public class PrintingJobProcesses
|
||||
/***************************************************************************
|
||||
** Standard QQQ results refer to the selected source job records.
|
||||
***************************************************************************/
|
||||
// QQQ ProcessSummaryProvider requires this concrete return type; retain binary/API compatibility.
|
||||
@SuppressWarnings("NonApiType")
|
||||
@Override
|
||||
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
|
||||
{
|
||||
return new ArrayList<>(List.of(done));
|
||||
return (new ArrayList<>(List.of(done)));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -28,13 +28,11 @@ import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.uber.nullaway.annotations.EnsuresNonNull;
|
||||
import org.apache.pdfbox.pdmodel.PDDocument;
|
||||
import org.apache.pdfbox.pdmodel.PDPage;
|
||||
import org.apache.pdfbox.pdmodel.PDPageContentStream;
|
||||
import org.apache.pdfbox.pdmodel.common.PDRectangle;
|
||||
import org.apache.pdfbox.pdmodel.font.PDType0Font;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -52,11 +50,11 @@ final class PrintingLayout implements AutoCloseable
|
||||
private final PDType0Font font;
|
||||
private final PDRectangle size;
|
||||
private final String title;
|
||||
private @Nullable PDPageContentStream content;
|
||||
private PDPageContentStream content;
|
||||
private float y;
|
||||
private List<String> repeatHeader = List.of();
|
||||
private int repeatSize = 8;
|
||||
private PrintingChrome chrome;
|
||||
private String footer = "";
|
||||
private float leading = 1.35f;
|
||||
|
||||
|
||||
@@ -67,17 +65,6 @@ final class PrintingLayout implements AutoCloseable
|
||||
***************************************************************************/
|
||||
PrintingLayout(String pageSize, boolean landscape, String title, String subtitle) throws QException
|
||||
{
|
||||
this(pageSize, landscape, title, subtitle, null);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** With the app's header and footer on every page (defaults when null).
|
||||
***************************************************************************/
|
||||
PrintingLayout(String pageSize, boolean landscape, String title, String subtitle, @Nullable PrintingChrome chrome) throws QException
|
||||
{
|
||||
this.chrome = chrome == null ? PrintingChrome.defaults(title) : chrome;
|
||||
try(InputStream stream = PrintingLayout.class.getResourceAsStream(PrintingTestDocuments.FONT_RESOURCE))
|
||||
{
|
||||
if(stream == null)
|
||||
@@ -113,7 +100,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
***************************************************************************/
|
||||
int columns(float fontSize)
|
||||
{
|
||||
return Math.max(20, (int) ((size.getWidth() - 2 * MARGIN) / (0.6f * fontSize)));
|
||||
return (Math.max(20, (int) ((size.getWidth() - 2 * MARGIN) / (0.6f * fontSize))));
|
||||
}
|
||||
|
||||
|
||||
@@ -130,11 +117,11 @@ final class PrintingLayout implements AutoCloseable
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** A note above the footer of every page (a grid's filter and sort).
|
||||
** Text at the bottom left of every page (who printed it and when).
|
||||
***************************************************************************/
|
||||
void footer(@Nullable String text)
|
||||
void footer(String text)
|
||||
{
|
||||
chrome = chrome.withFooterNote(text);
|
||||
footer = text == null ? "" : text;
|
||||
}
|
||||
|
||||
|
||||
@@ -156,7 +143,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
void line(String text, float fontSize) throws IOException
|
||||
{
|
||||
float step = fontSize * leading;
|
||||
if(y - step < bottom())
|
||||
if(y - step < MARGIN + 14)
|
||||
{
|
||||
newPage();
|
||||
for(String header : repeatHeader)
|
||||
@@ -174,7 +161,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
***************************************************************************/
|
||||
void keep(int lines, int fontSize) throws IOException
|
||||
{
|
||||
if(y - lines * fontSize * leading < bottom())
|
||||
if(y - lines * fontSize * 1.35f < MARGIN + 14)
|
||||
{
|
||||
newPage();
|
||||
}
|
||||
@@ -197,9 +184,9 @@ final class PrintingLayout implements AutoCloseable
|
||||
***************************************************************************/
|
||||
void rule() throws IOException
|
||||
{
|
||||
activeContent().moveTo(MARGIN, y);
|
||||
activeContent().lineTo(size.getWidth() - MARGIN, y);
|
||||
activeContent().stroke();
|
||||
content.moveTo(MARGIN, y);
|
||||
content.lineTo(size.getWidth() - MARGIN, y);
|
||||
content.stroke();
|
||||
y -= 4;
|
||||
}
|
||||
|
||||
@@ -212,7 +199,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
{
|
||||
try
|
||||
{
|
||||
activeContent().close();
|
||||
content.close();
|
||||
content = null;
|
||||
int total = document.getNumberOfPages();
|
||||
for(int i = 0; i < total; i++)
|
||||
@@ -221,22 +208,24 @@ final class PrintingLayout implements AutoCloseable
|
||||
try(PDPageContentStream footer = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.APPEND, true, true))
|
||||
{
|
||||
String text = "Page " + (i + 1) + " of " + total;
|
||||
float base = MARGIN - 14;
|
||||
footer.setLineWidth(0.5f);
|
||||
footer.moveTo(MARGIN, base + (hasNote() ? 20 : 10));
|
||||
footer.lineTo(size.getWidth() - MARGIN, base + (hasNote() ? 20 : 10));
|
||||
footer.stroke();
|
||||
if(hasNote())
|
||||
footer.beginText();
|
||||
footer.setFont(font, 8);
|
||||
footer.newLineAtOffset(size.getWidth() - MARGIN - text.length() * 4.8f, MARGIN - 14);
|
||||
footer.showText(text);
|
||||
footer.endText();
|
||||
if(!this.footer.isEmpty())
|
||||
{
|
||||
at(footer, MARGIN, base + 10, PrintingRecordDocuments.truncate(chrome.footerNote(), columns(7.5f)), 7.5f);
|
||||
footer.beginText();
|
||||
footer.setFont(font, 8);
|
||||
footer.newLineAtOffset(MARGIN, MARGIN - 14);
|
||||
footer.showText(safe(PrintingRecordDocuments.truncate(this.footer, Math.max(10, columns(8) - text.length() - 2))));
|
||||
footer.endText();
|
||||
}
|
||||
at(footer, size.getWidth() - MARGIN - text.length() * 4.8f, base, text, 8);
|
||||
at(footer, MARGIN, base, PrintingRecordDocuments.truncate(chrome.footerLeft(), Math.max(10, columns(8) - text.length() - 2)), 8);
|
||||
}
|
||||
}
|
||||
ByteArrayOutputStream output = new ByteArrayOutputStream();
|
||||
document.save(output);
|
||||
return output.toByteArray();
|
||||
return (output.toByteArray());
|
||||
}
|
||||
catch(IOException exception)
|
||||
{
|
||||
@@ -271,7 +260,6 @@ final class PrintingLayout implements AutoCloseable
|
||||
/***************************************************************************
|
||||
** Start a page; later pages show the running title.
|
||||
***************************************************************************/
|
||||
@EnsuresNonNull("content")
|
||||
private void newPage() throws IOException
|
||||
{
|
||||
if(document.getNumberOfPages() >= MAX_PAGES)
|
||||
@@ -284,10 +272,8 @@ final class PrintingLayout implements AutoCloseable
|
||||
}
|
||||
PDPage page = new PDPage(size);
|
||||
document.addPage(page);
|
||||
PDPageContentStream opened = new PDPageContentStream(document, page);
|
||||
content = opened;
|
||||
y = size.getHeight() - MARGIN + 14;
|
||||
header(opened);
|
||||
content = new PDPageContentStream(document, page);
|
||||
y = size.getHeight() - MARGIN;
|
||||
if(document.getNumberOfPages() > 1)
|
||||
{
|
||||
draw(PrintingRecordDocuments.truncate(title, columns(8)) + " (continued)", 8, 12);
|
||||
@@ -297,92 +283,17 @@ final class PrintingLayout implements AutoCloseable
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The app's header band: the app and server/user/time, then the title or
|
||||
** breadcrumb, then a rule.
|
||||
***************************************************************************/
|
||||
private void header(PDPageContentStream page) throws IOException
|
||||
{
|
||||
String right = chrome.headerRight();
|
||||
int rightChars = Math.min(right.length(), columns(7.5f) / 2 + 10);
|
||||
String rightText = PrintingRecordDocuments.truncate(right, rightChars);
|
||||
y -= 9;
|
||||
at(page, MARGIN, y, PrintingRecordDocuments.truncate(chrome.app(), Math.max(10, columns(9) - rightText.length())), 9);
|
||||
at(page, size.getWidth() - MARGIN - rightText.length() * 4.5f, y, rightText, 7.5f);
|
||||
if(chrome.title() != null && !chrome.title().isBlank())
|
||||
{
|
||||
y -= 10;
|
||||
at(page, MARGIN, y, PrintingRecordDocuments.truncate(chrome.title(), columns(7.5f)), 7.5f);
|
||||
}
|
||||
y -= 4;
|
||||
page.setLineWidth(0.5f);
|
||||
page.moveTo(MARGIN, y);
|
||||
page.lineTo(size.getWidth() - MARGIN, y);
|
||||
page.stroke();
|
||||
page.setLineWidth(1f);
|
||||
y -= 6;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Whether pages carry a footer note.
|
||||
***************************************************************************/
|
||||
private boolean hasNote()
|
||||
{
|
||||
return (chrome.footerNote() != null && !chrome.footerNote().isBlank());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The lowest baseline body text may use, above the footer band.
|
||||
***************************************************************************/
|
||||
private float bottom()
|
||||
{
|
||||
return (MARGIN + (hasNote() ? 22 : 12));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Text at a position on a content stream.
|
||||
***************************************************************************/
|
||||
private void at(PDPageContentStream stream, float x, float baseline, String text, float fontSize) throws IOException
|
||||
{
|
||||
stream.beginText();
|
||||
stream.setFont(font, fontSize);
|
||||
stream.newLineAtOffset(x, baseline);
|
||||
stream.showText(safe(text));
|
||||
stream.endText();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Draw one line at the current position.
|
||||
***************************************************************************/
|
||||
private void draw(String text, float fontSize, float step) throws IOException
|
||||
{
|
||||
y -= step;
|
||||
activeContent().beginText();
|
||||
activeContent().setFont(font, fontSize);
|
||||
activeContent().newLineAtOffset(MARGIN, y);
|
||||
activeContent().showText(safe(PrintingRecordDocuments.truncate(text, columns(fontSize))));
|
||||
activeContent().endText();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Construction/newPage opens content; drawing and finish precede its null
|
||||
** transition. Preserve the existing failure on use after finish, without
|
||||
** imposing a non-null precondition on pure footer formatting operations.
|
||||
***************************************************************************/
|
||||
@SuppressWarnings("NullAway")
|
||||
private PDPageContentStream activeContent()
|
||||
{
|
||||
return content;
|
||||
content.beginText();
|
||||
content.setFont(font, fontSize);
|
||||
content.newLineAtOffset(MARGIN, y);
|
||||
content.showText(safe(PrintingRecordDocuments.truncate(text, columns(fontSize))));
|
||||
content.endText();
|
||||
}
|
||||
|
||||
|
||||
@@ -411,7 +322,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
out.append('?');
|
||||
}
|
||||
});
|
||||
return out.toString();
|
||||
return (out.toString());
|
||||
}
|
||||
|
||||
|
||||
@@ -421,7 +332,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
***************************************************************************/
|
||||
static int[] columnWidths(List<String> headers, List<List<String>> rows, int available)
|
||||
{
|
||||
return fit(naturalWidths(headers, rows), available);
|
||||
return (fit(naturalWidths(headers, rows), available));
|
||||
}
|
||||
|
||||
|
||||
@@ -445,7 +356,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
int typical = lengths.isEmpty() ? 0 : lengths.get(Math.max(0, (int) Math.ceil(lengths.size() * 0.9) - 1));
|
||||
widths[c] = Math.max(4, Math.min(60, Math.max(headers.get(c).length(), typical)));
|
||||
}
|
||||
return widths;
|
||||
return (widths);
|
||||
}
|
||||
|
||||
|
||||
@@ -455,7 +366,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
***************************************************************************/
|
||||
static int lineWidth(int[] widths)
|
||||
{
|
||||
return sum(widths) + Math.max(0, widths.length - 1) * 2;
|
||||
return (sum(widths) + Math.max(0, widths.length - 1) * 2);
|
||||
}
|
||||
|
||||
|
||||
@@ -482,7 +393,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
}
|
||||
widths[widest]--;
|
||||
}
|
||||
return widths;
|
||||
return (widths);
|
||||
}
|
||||
|
||||
|
||||
@@ -497,7 +408,7 @@ final class PrintingLayout implements AutoCloseable
|
||||
{
|
||||
total += value;
|
||||
}
|
||||
return total;
|
||||
return (total);
|
||||
}
|
||||
|
||||
|
||||
@@ -514,6 +425,6 @@ final class PrintingLayout implements AutoCloseable
|
||||
cell = PrintingRecordDocuments.truncate(cell, widths[c]);
|
||||
out.append(c == 0 ? "" : " ").append(String.format("%-" + widths[c] + "s", cell));
|
||||
}
|
||||
return out.toString().stripTrailing();
|
||||
return (out.toString().stripTrailing());
|
||||
}
|
||||
}
|
||||
@@ -53,7 +53,6 @@ import com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendStepMeta
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
|
||||
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -126,14 +125,14 @@ public final class PrintingListProcesses
|
||||
fields.add(PrintingRecordProcesses.printerField());
|
||||
fields.add(new QFieldMetaData(PrintingRecordProcesses.COPIES_FIELD, QFieldType.INTEGER).withLabel("Copies").withIsRequired(true).withDefaultValue(1));
|
||||
fields.add(new QFieldMetaData("pageSize", QFieldType.STRING).withLabel("Paper").withPossibleValueSourceName("printing_pageSize").withDefaultValue("LETTER"));
|
||||
return new QProcessMetaData().withName(name).withLabel(label).withPermissionRules(PrintingProcesses.permissionRules())
|
||||
return (new QProcessMetaData().withName(name).withLabel(label).withPermissionRules(PrintingProcesses.permissionRules())
|
||||
.withStep(new QBackendStepMetaData().withName("prepare").withCode(new QCodeReference(Prepare.class)))
|
||||
.withStep(new QFrontendStepMetaData().withName("options").withLabel("Choose a printer").withFormFields(fields)
|
||||
.withComponent(new QFrontendComponentMetaData().withType(QComponentType.EDIT_FORM)))
|
||||
.withStep(new QBackendStepMetaData().withName("execute").withCode(new QCodeReference(Execute.class)))
|
||||
.withStep(new QFrontendStepMetaData().withName("result").withLabel("Result")
|
||||
.withViewFields(List.of(new QFieldMetaData("result", QFieldType.STRING).withLabel("Result")))
|
||||
.withComponent(new QFrontendComponentMetaData().withType(QComponentType.VIEW_FORM)));
|
||||
.withComponent(new QFrontendComponentMetaData().withType(QComponentType.VIEW_FORM))));
|
||||
}
|
||||
|
||||
|
||||
@@ -169,7 +168,7 @@ public final class PrintingListProcesses
|
||||
{
|
||||
throw new QException(table.getLabel() + " is not printable");
|
||||
}
|
||||
return table;
|
||||
return (table);
|
||||
}
|
||||
|
||||
|
||||
@@ -207,7 +206,7 @@ public final class PrintingListProcesses
|
||||
filter.setLimit(filter.getLimit() == null ? 50 : MAX_ROWS);
|
||||
}
|
||||
}
|
||||
return filter;
|
||||
return (filter);
|
||||
}
|
||||
|
||||
|
||||
@@ -221,7 +220,7 @@ public final class PrintingListProcesses
|
||||
if(given == null || given.isBlank())
|
||||
{
|
||||
table.getFields().values().stream().filter(PrintingRecordProcesses::printable).forEach(out::add);
|
||||
return out;
|
||||
return (out);
|
||||
}
|
||||
for(String name : Arrays.stream(given.split(",")).map(String::trim).filter(n -> !n.isEmpty()).toList())
|
||||
{
|
||||
@@ -239,7 +238,7 @@ public final class PrintingListProcesses
|
||||
{
|
||||
throw new QException("None of the columns can be printed");
|
||||
}
|
||||
return out;
|
||||
return (out);
|
||||
}
|
||||
|
||||
|
||||
@@ -269,7 +268,7 @@ public final class PrintingListProcesses
|
||||
break;
|
||||
}
|
||||
}
|
||||
return out;
|
||||
return (out);
|
||||
}
|
||||
|
||||
|
||||
@@ -281,7 +280,7 @@ public final class PrintingListProcesses
|
||||
{
|
||||
if(filter.getOrderBys() == null)
|
||||
{
|
||||
return "";
|
||||
return ("");
|
||||
}
|
||||
List<String> parts = new ArrayList<>();
|
||||
for(var orderBy : filter.getOrderBys())
|
||||
@@ -290,7 +289,7 @@ public final class PrintingListProcesses
|
||||
QFieldMetaData field = name == null ? null : table.getFields().get(name);
|
||||
parts.add((field == null || field.getLabel() == null ? name : field.getLabel()) + (orderBy.getIsAscending() ? "" : " descending"));
|
||||
}
|
||||
return String.join(", ", parts);
|
||||
return (String.join(", ", parts));
|
||||
}
|
||||
|
||||
|
||||
@@ -298,19 +297,19 @@ public final class PrintingListProcesses
|
||||
/***************************************************************************
|
||||
** The grid's column widths ("12,30,8"), or null.
|
||||
***************************************************************************/
|
||||
static int @Nullable [] widths(@Nullable String text)
|
||||
static int[] widths(String text)
|
||||
{
|
||||
if(text == null || text.isBlank())
|
||||
{
|
||||
return null;
|
||||
return (null);
|
||||
}
|
||||
try
|
||||
{
|
||||
return Arrays.stream(text.split(",")).map(String::trim).mapToInt(Integer::parseInt).toArray();
|
||||
return (Arrays.stream(text.split(",")).map(String::trim).mapToInt(Integer::parseInt).toArray());
|
||||
}
|
||||
catch(NumberFormatException exception)
|
||||
{
|
||||
return null;
|
||||
return (null);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -322,155 +321,7 @@ public final class PrintingListProcesses
|
||||
static String orientation(RunBackendStepInput input)
|
||||
{
|
||||
String value = input.getValueString("orientation");
|
||||
return value == null || value.isBlank() ? "AUTO" : value.toUpperCase(Locale.ROOT);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** A rendered document: its title, the PDF, and a note (rows left out).
|
||||
***************************************************************************/
|
||||
public static final class Rendered
|
||||
{
|
||||
private final String title;
|
||||
private final byte[] bytes;
|
||||
private final @Nullable String message;
|
||||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
** Hold one finished document. The PDF array is handed over, not copied,
|
||||
** exactly as the former record component was.
|
||||
***********************************************************************/
|
||||
public Rendered(String title, byte[] bytes, @Nullable String message)
|
||||
{
|
||||
this.title = title;
|
||||
this.bytes = bytes;
|
||||
this.message = message;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
** The document title.
|
||||
***********************************************************************/
|
||||
public String title()
|
||||
{
|
||||
return title;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
** The PDF bytes (the same array, not a copy).
|
||||
***********************************************************************/
|
||||
public byte[] bytes()
|
||||
{
|
||||
return bytes;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***********************************************************************
|
||||
** A note such as rows left out, or null when nothing was omitted.
|
||||
***********************************************************************/
|
||||
public @Nullable String message()
|
||||
{
|
||||
return message;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Render a table list (list true) or a text page from the process values.
|
||||
***************************************************************************/
|
||||
static Rendered render(RunBackendStepInput input, boolean list) throws QException
|
||||
{
|
||||
String pageSize = input.getValueString("pageSize") == null ? "LETTER" : input.getValueString("pageSize").toUpperCase(Locale.ROOT);
|
||||
if(!list)
|
||||
{
|
||||
String title = input.getValueString("title") == null || input.getValueString("title").isBlank() ? "Screen" : input.getValueString("title");
|
||||
String subtitle = input.getValueString("subtitle");
|
||||
boolean landscape = "LANDSCAPE".equalsIgnoreCase(input.getValueString("orientation"));
|
||||
PrintingChrome chrome = PrintingChrome.from(input, title);
|
||||
String sections = input.getValueString("sections");
|
||||
if(sections != null && !sections.isBlank())
|
||||
{
|
||||
return new Rendered(title, PrintingTextDocuments.sectionsPdf(title, subtitle, sections(sections), pageSize, landscape, chrome), null);
|
||||
}
|
||||
return new Rendered(title, PrintingTextDocuments.pdf(title, subtitle, input.getValueString("text"), pageSize, landscape, chrome), null);
|
||||
}
|
||||
QTableMetaData table = table(input);
|
||||
List<QFieldMetaData> columns = columns(table, input.getValueString("columns"));
|
||||
QQueryFilter filter = filter(input);
|
||||
boolean all = "ALL".equalsIgnoreCase(input.getValueString("scope"));
|
||||
List<QRecord> records = read(table, filter, all);
|
||||
List<List<String>> rows = new ArrayList<>();
|
||||
for(QRecord record : records)
|
||||
{
|
||||
List<String> row = new ArrayList<>();
|
||||
columns.forEach(field -> row.add(PrintingRecordProcesses.text(record, field)));
|
||||
rows.add(row);
|
||||
}
|
||||
String title = input.getValueString("title") != null ? input.getValueString("title") : table.getLabel();
|
||||
Integer total = input.getValueInteger("printingRowCount");
|
||||
if(total == null)
|
||||
{
|
||||
CountInput count = new CountInput();
|
||||
count.setTableName(table.getName());
|
||||
count.setFilter(filter.clone().withSkip(null).withLimit(null));
|
||||
count.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
|
||||
total = new CountAction().execute(count).getCount();
|
||||
}
|
||||
int skip = filter.getSkip() == null ? 0 : filter.getSkip();
|
||||
String scope = all ? (total != null && total > records.size() ? "first " + records.size() + " of " + total + " rows (print limit " + filter.getLimit() + ")" : "all " + records.size() + " rows")
|
||||
: "rows " + (records.isEmpty() ? 0 : skip + 1) + "-" + (skip + records.size()) + (total != null ? " of " + total : "");
|
||||
String described = input.getValueString("filterDescription");
|
||||
String sort = sortText(table, filter);
|
||||
String subtitle = scope + " - " + (described != null && !described.isBlank() ? "filter " + described : "no filter") + (sort.isEmpty() ? "" : " - sort " + sort);
|
||||
String note = (described != null && !described.isBlank() ? "Filter: " + described : "No filter") + (sort.isEmpty() ? "" : " - sort: " + sort);
|
||||
byte[] bytes = PrintingTableDocuments.pdf(title, subtitle, note,
|
||||
columns.stream().map(field -> field.getLabel() == null ? field.getName() : field.getLabel()).toList(), rows, widths(input.getValueString("columnWidths")), pageSize, orientation(input),
|
||||
PrintingChrome.from(input, table.getLabel() == null ? table.getName() : table.getLabel()));
|
||||
String message = all && total != null && total > records.size()
|
||||
? "Printed the first " + records.size() + " of " + total + " rows: the print limit is " + filter.getLimit() + " rows. Narrow the filter to print the rest." : null;
|
||||
return new Rendered(title, bytes, message);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The "sections" value: a JSON array of {title, lines: [..]} (at most 500
|
||||
** sections), as clients send a screen's content.
|
||||
***************************************************************************/
|
||||
static List<PrintingTextDocuments.Section> sections(String json) throws QException
|
||||
{
|
||||
try
|
||||
{
|
||||
org.json.JSONArray array = new org.json.JSONArray(json);
|
||||
if(array.length() > 500)
|
||||
{
|
||||
throw new QException("Too many sections to print (at most 500)");
|
||||
}
|
||||
List<PrintingTextDocuments.Section> out = new ArrayList<>();
|
||||
for(int i = 0; i < array.length(); i++)
|
||||
{
|
||||
org.json.JSONObject section = array.getJSONObject(i);
|
||||
List<String> lines = new ArrayList<>();
|
||||
org.json.JSONArray given = section.optJSONArray("lines");
|
||||
for(int j = 0; given != null && j < given.length(); j++)
|
||||
{
|
||||
lines.add(given.optString(j, ""));
|
||||
}
|
||||
out.add(new PrintingTextDocuments.Section(section.optString("title", ""), lines));
|
||||
}
|
||||
return out;
|
||||
}
|
||||
catch(org.json.JSONException exception)
|
||||
{
|
||||
throw new QException("The sections are not valid: " + exception.getMessage(), exception);
|
||||
}
|
||||
return (value == null || value.isBlank() ? "AUTO" : value.toUpperCase(Locale.ROOT));
|
||||
}
|
||||
|
||||
|
||||
@@ -527,14 +378,45 @@ public final class PrintingListProcesses
|
||||
{
|
||||
throw new QException("Restart the print to obtain a safe request identity");
|
||||
}
|
||||
Rendered rendered = render(input, TABLE_LIST.equals(input.getProcessName()));
|
||||
if(rendered.message() != null)
|
||||
String pageSize = input.getValueString("pageSize") == null ? "LETTER" : input.getValueString("pageSize").toUpperCase(Locale.ROOT);
|
||||
String title;
|
||||
byte[] bytes;
|
||||
if(TABLE_LIST.equals(input.getProcessName()))
|
||||
{
|
||||
output.addValue("printingTruncated", true);
|
||||
output.addValue("printingMessage", rendered.message());
|
||||
QTableMetaData table = table(input);
|
||||
List<QFieldMetaData> columns = columns(table, input.getValueString("columns"));
|
||||
QQueryFilter filter = filter(input);
|
||||
boolean all = "ALL".equalsIgnoreCase(input.getValueString("scope"));
|
||||
List<QRecord> records = read(table, filter, all);
|
||||
List<List<String>> rows = new ArrayList<>();
|
||||
for(QRecord record : records)
|
||||
{
|
||||
List<String> row = new ArrayList<>();
|
||||
columns.forEach(field -> row.add(PrintingRecordProcesses.text(record, field)));
|
||||
rows.add(row);
|
||||
}
|
||||
title = input.getValueString("title") != null ? input.getValueString("title") : table.getLabel();
|
||||
Integer total = input.getValueInteger("printingRowCount");
|
||||
int skip = filter.getSkip() == null ? 0 : filter.getSkip();
|
||||
String scope = all ? (total != null && total > records.size() ? "first " + records.size() + " of " + total + " rows (print limit " + filter.getLimit() + ")" : "all " + records.size() + " rows")
|
||||
: "rows " + (records.isEmpty() ? 0 : skip + 1) + "-" + (skip + records.size()) + (total != null ? " of " + total : "");
|
||||
String described = input.getValueString("filterDescription");
|
||||
String sort = sortText(table, filter);
|
||||
String subtitle = scope + " - " + (described != null && !described.isBlank() ? "filter " + described : "no filter") + (sort.isEmpty() ? "" : " - sort " + sort);
|
||||
bytes = PrintingTableDocuments.pdf(title, subtitle, (table.getLabel() == null ? table.getName() : table.getLabel()) + " - " + PrintingRecordProcesses.printedBy(),
|
||||
columns.stream().map(field -> field.getLabel() == null ? field.getName() : field.getLabel()).toList(), rows, widths(input.getValueString("columnWidths")), pageSize, orientation(input));
|
||||
if(all && total != null && total > records.size())
|
||||
{
|
||||
output.addValue("printingTruncated", true);
|
||||
output.addValue("printingMessage", "Printed the first " + records.size() + " of " + total + " rows: the print limit is " + filter.getLimit() + " rows. Narrow the filter to print the rest.");
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
title = input.getValueString("title") == null || input.getValueString("title").isBlank() ? "Screen" : input.getValueString("title");
|
||||
String subtitle = input.getValueString("subtitle");
|
||||
bytes = PrintingTextDocuments.pdf(title, (subtitle == null || subtitle.isBlank() ? "" : subtitle + " - ") + PrintingRecordProcesses.printedBy(), input.getValueString("text"), pageSize, "LANDSCAPE".equalsIgnoreCase(input.getValueString("orientation")));
|
||||
}
|
||||
String title = rendered.title();
|
||||
byte[] bytes = rendered.bytes();
|
||||
String job = PrintingRecordProcesses.queue(printer, title, bytes, copies, "list-print:" + request + ":" + input.getProcessName() + ":" + printer.getValueString("id"));
|
||||
output.addValue(PrintingRecordProcesses.JOB_IDS, job);
|
||||
output.addValue("result", "Queued print job " + job + ". Check Print jobs for its status." + (output.getValue("printingMessage") != null ? " " + output.getValue("printingMessage") : ""));
|
||||
|
||||
@@ -51,7 +51,7 @@ public class PrintingLocalAuthentication extends TableBasedAuthenticationModule
|
||||
}
|
||||
session.setPermissions(Set.of("printing_admin"));
|
||||
session.withSecurityKeyValue("printing_tenant", metadata.tenant);
|
||||
return session;
|
||||
return (session);
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -44,7 +44,6 @@ import com.kingsrook.qqq.middleware.javalin.QApplicationLauncher;
|
||||
import com.kingsrook.qqq.middleware.javalin.QApplicationLauncherConfig;
|
||||
import io.javalin.http.Context;
|
||||
import io.javalin.http.ForbiddenResponse;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
@@ -118,7 +117,7 @@ public class PrintingLocalHost extends AbstractQQQApplication
|
||||
new PrintingQBitProducer().withConfig(new PrintingQBitConfig().withBackendName(backendName).withService(service)
|
||||
.withSchedulerName(SCHEDULER)).produce(instance, "printing");
|
||||
mapPhysicalNames(instance);
|
||||
return instance;
|
||||
return (instance);
|
||||
}
|
||||
catch(Exception exception)
|
||||
{
|
||||
@@ -192,7 +191,7 @@ public class PrintingLocalHost extends AbstractQQQApplication
|
||||
/***************************************************************************
|
||||
** Add native auth tables; an existing account is never implicitly reset.
|
||||
***************************************************************************/
|
||||
private void initializeAuthentication(@Nullable String initialPassword) throws Exception
|
||||
private void initializeAuthentication(String initialPassword) throws Exception
|
||||
{
|
||||
try(Connection connection = source.getConnection(); var statement = connection.createStatement())
|
||||
{
|
||||
|
||||
@@ -22,14 +22,13 @@ package com.kingsrook.qbits.printing;
|
||||
|
||||
|
||||
import java.util.Map;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Explicit local-host configuration. Never render credentials in diagnostics.
|
||||
*******************************************************************************/
|
||||
record PrintingLocalSettings(String jdbcUrl, String databaseUser, String databasePassword, String tenant,
|
||||
int port, String administratorToken, String username, @Nullable String initialPassword)
|
||||
int port, String administratorToken, String username, String initialPassword)
|
||||
{
|
||||
/***************************************************************************
|
||||
** Environment launch supports a durable local H2 file, never a remote bind.
|
||||
@@ -46,9 +45,9 @@ record PrintingLocalSettings(String jdbcUrl, String databaseUser, String databas
|
||||
{
|
||||
throw new IllegalArgumentException("QQQ_PRINT_PORT must be between 1 and 65535");
|
||||
}
|
||||
return new PrintingLocalSettings(jdbc, environment.getOrDefault("QQQ_PRINT_DB_USER", "sa"),
|
||||
return (new PrintingLocalSettings(jdbc, environment.getOrDefault("QQQ_PRINT_DB_USER", "sa"),
|
||||
environment.getOrDefault("QQQ_PRINT_DB_PASSWORD", ""), environment.getOrDefault("QQQ_PRINT_TENANT", "demo"), port,
|
||||
required(environment, "QQQ_PRINT_ADMIN_TOKEN"), required(environment, "QQQ_PRINT_UI_USERNAME"), environment.get("QQQ_PRINT_UI_INITIAL_PASSWORD"));
|
||||
required(environment, "QQQ_PRINT_ADMIN_TOKEN"), required(environment, "QQQ_PRINT_UI_USERNAME"), environment.get("QQQ_PRINT_UI_INITIAL_PASSWORD")));
|
||||
}
|
||||
|
||||
|
||||
@@ -78,7 +77,7 @@ record PrintingLocalSettings(String jdbcUrl, String databaseUser, String databas
|
||||
{
|
||||
throw new IllegalArgumentException("Set " + name);
|
||||
}
|
||||
return value;
|
||||
return (value);
|
||||
}
|
||||
|
||||
|
||||
@@ -89,6 +88,6 @@ record PrintingLocalSettings(String jdbcUrl, String databaseUser, String databas
|
||||
@Override
|
||||
public String toString()
|
||||
{
|
||||
return "PrintingLocalSettings[loopbackPort=" + port + ", credentials=redacted]";
|
||||
return ("PrintingLocalSettings[loopbackPort=" + port + ", credentials=redacted]");
|
||||
}
|
||||
}
|
||||
@@ -1,162 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2026. 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.printing;
|
||||
|
||||
|
||||
import java.util.HashSet;
|
||||
import java.util.Set;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONObject;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Immutable reported Windows queue defaults; these never change printer stock.
|
||||
*******************************************************************************/
|
||||
public record PrintingMediaProfile(String id, String revision, String name, int widthMicrons, int heightMicrons, int dpiX, int dpiY)
|
||||
{
|
||||
/***************************************************************************
|
||||
** Validate the bounded wire record without coercion or guessed dimensions.
|
||||
***************************************************************************/
|
||||
public static PrintingMediaProfile parse(JSONObject value)
|
||||
{
|
||||
if(!value.keySet().containsAll(Set.of("id", "revision", "name", "widthMicrons", "heightMicrons", "dpiX", "dpiY", "source", "applyMode"))
|
||||
|| !"WINDOWS_QUEUE_DEFAULT".equals(value.opt("source")) || !"DRIVER_DEFAULT".equals(value.opt("applyMode")))
|
||||
{
|
||||
throw new PrintingException(400, "Invalid reported media profile");
|
||||
}
|
||||
String id = text(value, "id", 128);
|
||||
String revision = text(value, "revision", 64);
|
||||
if(!id.matches("[A-Za-z0-9._-]+") || !revision.matches("[0-9a-f]{64}"))
|
||||
{
|
||||
throw new PrintingException(400, "Invalid media profile identity");
|
||||
}
|
||||
return new PrintingMediaProfile(id, revision, text(value, "name", 512), integer(value, "widthMicrons", 2000000),
|
||||
integer(value, "heightMicrons", 2000000), integer(value, "dpiX", 9600), integer(value, "dpiY", 9600));
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Canonical public facts are separate from the immutable job selection.
|
||||
***************************************************************************/
|
||||
public JSONObject json()
|
||||
{
|
||||
return new JSONObject().put("id", id).put("revision", revision).put("name", name).put("widthMicrons", widthMicrons)
|
||||
.put("heightMicrons", heightMicrons).put("dpiX", dpiX).put("dpiY", dpiY)
|
||||
.put("source", "WINDOWS_QUEUE_DEFAULT").put("applyMode", "DRIVER_DEFAULT");
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Missing inventory facts mean no known stock, including older clients.
|
||||
***************************************************************************/
|
||||
static JSONArray inventory(JSONObject printer)
|
||||
{
|
||||
JSONArray values = printer.has("mediaProfiles") ? printer.optJSONArray("mediaProfiles") : new JSONArray();
|
||||
if(values == null || values.length() > 32)
|
||||
{
|
||||
throw new PrintingException(400, "Invalid media profile list");
|
||||
}
|
||||
Set<String> ids = new HashSet<>();
|
||||
JSONArray result = new JSONArray();
|
||||
for(Object item : values)
|
||||
{
|
||||
if(!(item instanceof JSONObject object))
|
||||
{
|
||||
throw new PrintingException(400, "Invalid media profile");
|
||||
}
|
||||
PrintingMediaProfile profile = parse(object);
|
||||
if(!ids.add(profile.id()))
|
||||
{
|
||||
throw new PrintingException(400, "Duplicate media profile identity");
|
||||
}
|
||||
result.put(profile.json());
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Validate a selection independently before comparing it with current facts.
|
||||
***************************************************************************/
|
||||
static void selection(JSONObject options)
|
||||
{
|
||||
if(!options.has("mediaProfile"))
|
||||
{
|
||||
return;
|
||||
}
|
||||
JSONObject selected = options.optJSONObject("mediaProfile");
|
||||
if(selected == null || !selected.keySet().equals(Set.of("id", "revision"))
|
||||
|| !text(selected, "id", 128).matches("[A-Za-z0-9._-]+") || !text(selected, "revision", 64).matches("[0-9a-f]{64}"))
|
||||
{
|
||||
throw new PrintingException(400, "Invalid media profile selection");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Reject changed defaults before admission or document storage writes.
|
||||
***************************************************************************/
|
||||
static void requireCurrent(JSONObject printer, JSONObject options)
|
||||
{
|
||||
if(!options.has("mediaProfile"))
|
||||
{
|
||||
return;
|
||||
}
|
||||
JSONObject selected = options.getJSONObject("mediaProfile");
|
||||
JSONArray profiles = new JSONArray(printer.optString("media_profiles_json", "[]"));
|
||||
for(Object item : profiles)
|
||||
{
|
||||
PrintingMediaProfile profile = parse((JSONObject) item);
|
||||
if(profile.id().equals(selected.getString("id")) && profile.revision().equals(selected.getString("revision")))
|
||||
{
|
||||
return;
|
||||
}
|
||||
}
|
||||
throw new PrintingException(409, "Printer media changed or is unavailable; select the current queue default again");
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Text identities and labels retain their exact value.
|
||||
***************************************************************************/
|
||||
private static String text(JSONObject value, String key, int maximum)
|
||||
{
|
||||
if(!(value.opt(key) instanceof String text) || text.isBlank() || text.length() > maximum)
|
||||
{
|
||||
throw new PrintingException(400, "Invalid media profile " + key);
|
||||
}
|
||||
return text;
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Accept integral JSON values only, within the supported physical bounds.
|
||||
***************************************************************************/
|
||||
private static int integer(JSONObject value, String key, int maximum)
|
||||
{
|
||||
Object raw = value.opt(key);
|
||||
if(!(raw instanceof Integer || raw instanceof Long) || ((Number) raw).longValue() < 1 || ((Number) raw).longValue() > maximum)
|
||||
{
|
||||
throw new PrintingException(400, "Invalid media profile " + key);
|
||||
}
|
||||
return ((Number) raw).intValue();
|
||||
}
|
||||
}
|
||||
@@ -1,114 +0,0 @@
|
||||
/*
|
||||
* 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.printing;
|
||||
|
||||
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaData;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The sentences a person reads when printing refuses them. Each one says what
|
||||
** happened and what to do next, in the words of the application the person is
|
||||
** using: the host supplies its display name (PrintingQBitConfig.withProductName)
|
||||
** and no product or framework name is written here.
|
||||
**
|
||||
** Only wording lives here. The exception type, the HTTP status and the JSON
|
||||
** field that carry a sentence are chosen by the caller and do not change with it.
|
||||
*******************************************************************************/
|
||||
public final class PrintingMessages
|
||||
{
|
||||
public static final String DEFAULT_PRODUCT_NAME = "this application";
|
||||
|
||||
static final String MANAGE_STATIONS = "manage " + PrintingNames.STATIONS_LOWER;
|
||||
static final String ADMIN_GRANT = "printing administrator role";
|
||||
static final String USE_PRINTING = "use printing";
|
||||
static final String OPERATOR_GRANT = "printing operator role";
|
||||
static final String DELETE = "delete " + PrintingNames.STATIONS_LOWER + " and " + PrintingNames.PRINTERS_LOWER;
|
||||
static final String DELETE_GRANT = "permission to delete " + PrintingNames.STATIONS_LOWER + " and " + PrintingNames.PRINTERS_LOWER + ", in addition to the " + ADMIN_GRANT;
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// Returned by HTTP routes, where one sentence must cover every reason for a refusal so //
|
||||
// that the answer does not tell a caller which check failed. No product name: the reader //
|
||||
// may be a program, and the print client shows its own sentence for the same status. //
|
||||
////////////////////////////////////////////////////////////////////////////////////////////
|
||||
static final String HTTP_STATION_REFUSED = "You are signed in, but your account or this " + PrintingNames.STATION_LOWER + " is not allowed to do this. Ask an administrator to check that you have the "
|
||||
+ ADMIN_GRANT + " and that this " + PrintingNames.STATION_LOWER + " still has access.";
|
||||
static final String HTTP_OPERATOR_REFUSED = "You are signed in, but your account is not allowed to print here. Ask an administrator to check that you have the "
|
||||
+ OPERATOR_GRANT + " and that the " + PrintingNames.PRINTER_LOWER + " is approved.";
|
||||
static final String HTTP_ADMIN_REFUSED = "Your account is not allowed to " + MANAGE_STATIONS + ". Ask an administrator to give you the " + ADMIN_GRANT + ".";
|
||||
static final String HTTP_ENROLL_NEEDS_SIGN_IN = "This server enrolls a " + PrintingNames.STATION_LOWER + " only for a signed-in person. Sign in from the print client, then enroll again.";
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Constants and wording only.
|
||||
***************************************************************************/
|
||||
private PrintingMessages()
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** What the host calls its application, or neutral words when the host did
|
||||
** not say or no application is serving this thread.
|
||||
***************************************************************************/
|
||||
public static String productName()
|
||||
{
|
||||
QInstance instance = QContext.getQInstance();
|
||||
if(instance != null && instance.getQBits() != null)
|
||||
{
|
||||
for(QBitMetaData metadata : instance.getQBits().values())
|
||||
{
|
||||
if(metadata.getConfig() instanceof PrintingQBitConfig config)
|
||||
{
|
||||
return config.getProductName();
|
||||
}
|
||||
}
|
||||
}
|
||||
return DEFAULT_PRODUCT_NAME;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The account is signed in and holds no printing access for the tenant this
|
||||
** application prints for (the host did not give it the printing_tenant key).
|
||||
***************************************************************************/
|
||||
static String notSetUpForPrinting()
|
||||
{
|
||||
return "You are signed in to " + productName() + ", but your account is not set up for printing in this organization. Ask an administrator to give your account printing access for your organization.";
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** A person who is not signed in is told to sign in; a person who is signed
|
||||
** in and lacks the grant is told so, and whom to ask for what.
|
||||
***************************************************************************/
|
||||
static String notAllowed(boolean signedIn, String activity, String grant)
|
||||
{
|
||||
return signedIn ? "You are signed in to " + productName() + ", but your account is not allowed to " + activity + ". Ask an administrator to give you the " + grant + "."
|
||||
: "Sign in to " + productName() + " to " + activity + ".";
|
||||
}
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
/*
|
||||
* 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.printing;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The words an administrator reads for the two things printing manages. Every
|
||||
** label, action label, preview and message is built from these constants, so
|
||||
** a different choice of name is one edit here. Table, field and process names
|
||||
** (printing_device, printingEnrollDevice, ...) and the agent wire protocol do
|
||||
** not change with them.
|
||||
**
|
||||
** - Station: the computer that runs the print client (table printing_device).
|
||||
** - Printer: a physical printer, seen as a Windows print queue that a station
|
||||
** shares (table printing_printer).
|
||||
*******************************************************************************/
|
||||
public final class PrintingNames
|
||||
{
|
||||
public static final String STATION = "Print station";
|
||||
public static final String STATIONS = "Print stations";
|
||||
public static final String STATION_LOWER = "print station";
|
||||
public static final String STATIONS_LOWER = "print stations";
|
||||
public static final String PRINTER = "Printer";
|
||||
public static final String PRINTERS = "Printers";
|
||||
public static final String PRINTER_LOWER = "printer";
|
||||
public static final String PRINTERS_LOWER = "printers";
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Constants only.
|
||||
***************************************************************************/
|
||||
private PrintingNames()
|
||||
{
|
||||
}
|
||||
}
|
||||
@@ -1,412 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2026. 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.printing;
|
||||
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.security.MessageDigest;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.HexFormat;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
import java.util.Set;
|
||||
import com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement;
|
||||
import com.kingsrook.qqq.backend.core.actions.permissions.PermissionsHelper;
|
||||
import com.kingsrook.qqq.backend.core.actions.permissions.TablePermissionSubType;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.GetAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QAuthenticationException;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterOrderBy;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
|
||||
import com.kingsrook.qqq.backend.core.model.session.QSession;
|
||||
import com.kingsrook.qqq.backend.core.model.session.QUser;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONObject;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Current-user catalog and submission boundary shared by HTTP and host processes.
|
||||
*******************************************************************************/
|
||||
public final class PrintingOperatorAuthorization
|
||||
{
|
||||
/***************************************************************************
|
||||
** No cached user authority or alternate queue.
|
||||
***************************************************************************/
|
||||
private PrintingOperatorAuthorization()
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Resolve the authenticated actor and current tenant before every operation.
|
||||
***************************************************************************/
|
||||
public static String principal() throws QException
|
||||
{
|
||||
if(QContext.getQSession() == null || QContext.getQSession().getUser() == null
|
||||
|| QContext.getQSession().getUser().getIdReference() == null || QContext.getQSession().getUser().getIdReference().isBlank())
|
||||
{
|
||||
throw new QAuthenticationException("Sign in to continue");
|
||||
}
|
||||
new PrintingOperatorPermission().checkPermissionsThrowing(new RunBackendStepInput(), null);
|
||||
PrintingProcesses.currentService();
|
||||
return QContext.getQSession().getUser().getIdReference();
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Native table and record checks apply even inside another backend process.
|
||||
***************************************************************************/
|
||||
private static QRecord record(String table, String id) throws QException
|
||||
{
|
||||
CallContext caller = capture();
|
||||
QueryInput scoped = new QueryInput().withTableName(table).withFilter(new QQueryFilter(new QFilterCriteria("id", QCriteriaOperator.EQUALS, id))
|
||||
.withCriteria(new QFilterCriteria("tenant_id", QCriteriaOperator.EQUALS, PrintingProcesses.currentService().getTenantId())).withLimit(1));
|
||||
scoped.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
|
||||
if(new QueryAction().execute(scoped).getRecords().isEmpty())
|
||||
{
|
||||
throw new QPermissionDeniedException("Print destination is not accessible");
|
||||
}
|
||||
caller.check();
|
||||
GetInput input = new GetInput();
|
||||
input.setTableName(table);
|
||||
input.setPrimaryKey(id);
|
||||
input.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
|
||||
QRecord row = new GetAction().execute(input).getRecord();
|
||||
PermissionsHelper.checkTablePermissionThrowing(input, TablePermissionSubType.READ);
|
||||
caller.check();
|
||||
if(row == null || !id.equals(row.getValueString("id")))
|
||||
{
|
||||
throw new QPermissionDeniedException("Print destination is not accessible");
|
||||
}
|
||||
return row;
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Authorize the exact native printer row and its enabled device each time.
|
||||
** Callers use the returned wire printer identity only for this operation.
|
||||
***************************************************************************/
|
||||
public static QRecord destination(String printerRowId) throws QException
|
||||
{
|
||||
CallContext caller = capture();
|
||||
QRecord printer = record(PrintingTables.PRINTER, printerRowId);
|
||||
QRecord device = record(PrintingTables.DEVICE, printer.getValueString("device_id"));
|
||||
if(!Integer.valueOf(1).equals(printer.getValueInteger("enabled")) || !Integer.valueOf(1).equals(printer.getValueInteger("available"))
|
||||
|| !Integer.valueOf(1).equals(device.getValueInteger("enabled")))
|
||||
{
|
||||
throw new QPermissionDeniedException("Print destination is not approved and exposed");
|
||||
}
|
||||
requireDestinationRead();
|
||||
caller.check();
|
||||
return printer;
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Shared retained-source boundary also requires the exact supported format.
|
||||
***************************************************************************/
|
||||
public static QRecord printer(String printerRowId, String format) throws QException
|
||||
{
|
||||
QRecord printer = destination(printerRowId);
|
||||
if(!Set.of("PDF", "ZPL").contains(format) || !new JSONArray(printer.getValueString("formats")).toList().contains(format))
|
||||
{
|
||||
throw new PrintingException(400, "Printer does not support this document format");
|
||||
}
|
||||
return printer;
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Reconciliation still checks current row authority after exposure changes.
|
||||
** The caller must first establish its own accepted request/source binding.
|
||||
***************************************************************************/
|
||||
public static QRecord authorizeDestinationHistory(String printerRowId) throws QException
|
||||
{
|
||||
CallContext caller = capture();
|
||||
QRecord printer = record(PrintingTables.PRINTER, printerRowId);
|
||||
record(PrintingTables.DEVICE, printer.getValueString("device_id"));
|
||||
requireDestinationRead();
|
||||
caller.check();
|
||||
return printer;
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Page through authorized rows; hidden parent devices never leak through joins.
|
||||
***************************************************************************/
|
||||
public static JSONObject catalog(int limit, @Nullable String after) throws QException
|
||||
{
|
||||
CallContext caller = capture();
|
||||
if(limit < 1 || limit > 200 || (after != null && !after.matches("[A-Za-z0-9._-]{1,200}")))
|
||||
{
|
||||
throw new PrintingException(400, "Invalid catalog page");
|
||||
}
|
||||
QQueryFilter filter = new QQueryFilter(new QFilterCriteria("enabled", QCriteriaOperator.EQUALS, 1))
|
||||
.withCriteria(new QFilterCriteria("available", QCriteriaOperator.EQUALS, 1))
|
||||
.withCriteria(new QFilterCriteria("removed_at", QCriteriaOperator.IS_BLANK))
|
||||
.withCriteria(new QFilterCriteria("tenant_id", QCriteriaOperator.EQUALS, PrintingProcesses.currentService().getTenantId()))
|
||||
.withOrderBy(new QFilterOrderBy("id", true)).withLimit(limit + 1);
|
||||
if(after != null)
|
||||
{
|
||||
filter.withCriteria(new QFilterCriteria("id", QCriteriaOperator.GREATER_THAN, after));
|
||||
}
|
||||
QueryInput input = new QueryInput().withTableName(PrintingTables.PRINTER).withFilter(filter);
|
||||
input.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
|
||||
List<QRecord> rows = new QueryAction().execute(input).getRecords();
|
||||
caller.check();
|
||||
JSONArray printers = new JSONArray();
|
||||
int consumed = Math.min(limit, rows.size());
|
||||
for(QRecord candidate : rows.subList(0, consumed))
|
||||
{
|
||||
try
|
||||
{
|
||||
QRecord printer = destination(candidate.getValueString("id"));
|
||||
QRecord device = record(PrintingTables.DEVICE, printer.getValueString("device_id"));
|
||||
requireDestinationRead();
|
||||
caller.check();
|
||||
printers.put(new JSONObject().put("printerRowId", printer.getValueString("id")).put("deviceId", printer.getValueString("device_id"))
|
||||
.put("printerId", printer.getValueString("printer_id")).put("name", label(printer, "display_name", "name", "queue_name", "id"))
|
||||
.put("deviceName", label(device, "display_name", "name", "computer_name", "id")).put("description", printer.getValueString("description")).put("location", printer.getValueString("location"))
|
||||
.put("status", printer.getValueString("status")).put("formats", new JSONArray(printer.getValueString("formats")))
|
||||
.put("mediaProfiles", new JSONArray(printer.getValueString("media_profiles_json") == null ? "[]" : printer.getValueString("media_profiles_json"))));
|
||||
}
|
||||
catch(QPermissionDeniedException hidden)
|
||||
{
|
||||
// Native parent-row security can legitimately hide a candidate.
|
||||
}
|
||||
caller.check();
|
||||
}
|
||||
caller.check();
|
||||
return new JSONObject().put("printers", printers)
|
||||
.put("nextCursor", rows.size() > limit ? rows.get(consumed - 1).getValueString("id") : JSONObject.NULL);
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** The process permission remains authoritative for all byte submissions.
|
||||
***************************************************************************/
|
||||
public static JSONObject submit(JSONObject request) throws Exception
|
||||
{
|
||||
CallContext caller = capture();
|
||||
requireSubmission();
|
||||
request = new JSONObject(request.toString());
|
||||
if(!Set.of("requestId", "printerRowId", "title", "format", "contentBase64", "options").containsAll(request.keySet()))
|
||||
{
|
||||
throw new PrintingException(400, "Unknown operator print request field");
|
||||
}
|
||||
QRecord printer = printer(request.getString("printerRowId"), request.getString("format"));
|
||||
caller.check();
|
||||
JSONObject prepared = new JSONObject(request.toString());
|
||||
prepared.put("deviceId", printer.getValueString("device_id")).put("printerId", printer.getValueString("printer_id"))
|
||||
.put("idempotencyKey", requestKey(caller.actor(), request.getString("requestId")));
|
||||
try
|
||||
{
|
||||
return caller.service().submitAuthorized(prepared, request.getString("printerRowId"), () ->
|
||||
{
|
||||
caller.check();
|
||||
requireSubmission();
|
||||
QRecord current = printer(prepared.getString("printerRowId"), prepared.getString("format"));
|
||||
if(!prepared.getString("deviceId").equals(current.getValueString("device_id")) || !prepared.getString("printerId").equals(current.getValueString("printer_id")))
|
||||
{
|
||||
throw new QPermissionDeniedException("Print destination changed during submission");
|
||||
}
|
||||
requireSubmission();
|
||||
caller.check();
|
||||
});
|
||||
}
|
||||
catch(java.sql.SQLException exception)
|
||||
{
|
||||
if(exception.getCause() instanceof QException denied)
|
||||
{
|
||||
throw denied;
|
||||
}
|
||||
throw exception;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Only the current actor's exact request can be reconciled; no job enumeration.
|
||||
***************************************************************************/
|
||||
public static JSONObject observe(String requestId) throws Exception
|
||||
{
|
||||
CallContext caller = capture();
|
||||
requireStorage(false);
|
||||
PrintingService.OperatorAcceptance accepted = caller.service().findOperatorAcceptance(requestKey(caller.actor(), requestId));
|
||||
if(accepted == null)
|
||||
{
|
||||
throw new PrintingException(404, "Print request not found");
|
||||
}
|
||||
JSONObject job = accepted.job();
|
||||
// Historical acceptance remains observable if exposure changes, but current row authority is mandatory.
|
||||
QRecord printer = authorizeDestinationHistory(accepted.printerRowId());
|
||||
if(!job.getString("deviceId").equals(printer.getValueString("device_id")) || !job.getString("printerId").equals(printer.getValueString("printer_id")))
|
||||
{
|
||||
throw new QPermissionDeniedException("Accepted print destination changed");
|
||||
}
|
||||
requireDestinationRead();
|
||||
requireStorage(false);
|
||||
caller.check();
|
||||
return job;
|
||||
}
|
||||
|
||||
|
||||
/** Recheck table, credential and channel permissions after both row customizers. */
|
||||
private static void requireDestinationRead() throws QException
|
||||
{
|
||||
for(String table : List.of(PrintingTables.PRINTER, PrintingTables.DEVICE))
|
||||
{
|
||||
GetInput input = new GetInput();
|
||||
input.setTableName(table);
|
||||
input.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
|
||||
PermissionsHelper.checkTablePermissionThrowing(input, TablePermissionSubType.READ);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Snapshot only authority and routing context, never session credentials.
|
||||
***************************************************************************/
|
||||
private static CallContext capture() throws QException
|
||||
{
|
||||
String actor = principal();
|
||||
QSession session = QContext.getQSession();
|
||||
Map<String, List<Serializable>> keys = new HashMap<>();
|
||||
if(session.getSecurityKeyValues() != null)
|
||||
{
|
||||
session.getSecurityKeyValues().forEach((key, values) -> keys.put(key, values == null ? null : new ArrayList<>(values)));
|
||||
}
|
||||
return new CallContext(QContext.getQInstance(), session, session.getUser(), actor, PrintingProcesses.currentService(), keys,
|
||||
session.getBackendVariants() == null ? null : new HashMap<>(session.getBackendVariants()));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Exact instance identity for the captured caller authority. A replaced
|
||||
** instance, session, user or service must fail even when value equality
|
||||
** would hold, so this is deliberately not equals().
|
||||
***************************************************************************/
|
||||
// Identity of the captured authority objects is the security contract; equals() would weaken it.
|
||||
@SuppressWarnings("ReferenceEquality")
|
||||
private static boolean same(@Nullable Object captured, @Nullable Object current)
|
||||
{
|
||||
return captured == current;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Native customizers cannot replace the caller or its row-security scope.
|
||||
** Permissions and credential/channel ceilings are separately checked live.
|
||||
***************************************************************************/
|
||||
private record CallContext(QInstance instance, QSession session, QUser user, String actor, PrintingService service,
|
||||
Map<String, List<Serializable>> keys, @Nullable Map<String, Serializable> variants)
|
||||
{
|
||||
/** Fail before consuming callback results under a different native authority. */
|
||||
void check() throws QException
|
||||
{
|
||||
if(!same(instance, QContext.getQInstance()) || !same(session, QContext.getQSession()) || !same(user, session.getUser())
|
||||
|| !actor.equals(principal()) || !same(service, PrintingProcesses.currentService())
|
||||
|| !keys.equals(session.getSecurityKeyValues() == null ? Map.of() : session.getSecurityKeyValues())
|
||||
|| !Objects.equals(variants, session.getBackendVariants()))
|
||||
{
|
||||
throw new QPermissionDeniedException("Printing authority changed during the operation");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Trusted domain writes retain process, credential and channel ceilings.
|
||||
***************************************************************************/
|
||||
public static void requireSubmission() throws QException
|
||||
{
|
||||
principal();
|
||||
PermissionsHelper.checkProcessPermissionThrowing(new RunBackendStepInput().withProcessName(PrintingOperatorProcesses.SUBMIT), PrintingOperatorProcesses.SUBMIT);
|
||||
requireStorage(true);
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Scope ceilings do not grant generic job table reads or writes.
|
||||
***************************************************************************/
|
||||
private static void requireStorage(boolean mutation) throws QException
|
||||
{
|
||||
var instance = QContext.getQInstance();
|
||||
var table = instance.getTable(PrintingTables.JOB);
|
||||
if(table == null)
|
||||
{
|
||||
throw new QException("Printing job metadata is unavailable");
|
||||
}
|
||||
var rules = PermissionsHelper.getEffectivePermissionRules(table, instance);
|
||||
if(PermissionsHelper.isDeniedForClientChannel(table, rules)
|
||||
|| (mutation && PermissionsHelper.isWriteDeniedForClientChannel(table, rules))
|
||||
|| PermissionsHelper.isOutsideCredentialScope(table, mutation ? TablePermissionSubType.INSERT : TablePermissionSubType.READ))
|
||||
{
|
||||
throw new QPermissionDeniedException("Current credential or client channel cannot access print acceptance");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Stable actor namespace protects request lookup without storing user credentials.
|
||||
***************************************************************************/
|
||||
private static String requestKey(String actor, String requestId) throws Exception
|
||||
{
|
||||
if(!requestId.matches("[A-Za-z0-9._:-]{1,128}"))
|
||||
{
|
||||
throw new PrintingException(400, "Invalid print request identity");
|
||||
}
|
||||
return "operator:" + HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(actor.getBytes(StandardCharsets.UTF_8))) + ":" + requestId;
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Legacy unnamed rows retain an honest identity fallback, never guessed media.
|
||||
***************************************************************************/
|
||||
private static String label(QRecord record, String... fields)
|
||||
{
|
||||
for(String field : fields)
|
||||
{
|
||||
String value = record.getValueString(field);
|
||||
if(value != null && !value.isBlank())
|
||||
{
|
||||
return value;
|
||||
}
|
||||
}
|
||||
throw new PrintingException(409, "Print destination has no stable identity");
|
||||
}
|
||||
}
|
||||
@@ -1,60 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2026. 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.printing;
|
||||
|
||||
|
||||
import com.kingsrook.qqq.backend.core.actions.permissions.UseOtherPermissionNameCustomPermissionChecker;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.permissions.MetaDataWithPermissionRules;
|
||||
import org.jspecify.annotations.Nullable;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** The operator grant: submit print jobs and read, without changing anything,
|
||||
** the print stations, printers and print jobs of the tenant. It grants no
|
||||
** management of a print station or printer and no read of the control or
|
||||
** deletion history.
|
||||
*******************************************************************************/
|
||||
public class PrintingOperatorPermission extends UseOtherPermissionNameCustomPermissionChecker
|
||||
{
|
||||
/***************************************************************************
|
||||
** Expose the role to standard host permission assignment.
|
||||
***************************************************************************/
|
||||
public PrintingOperatorPermission()
|
||||
{
|
||||
withPermissionName("printing_operator");
|
||||
}
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
** Administrators retain submission access; operators receive no other role.
|
||||
***************************************************************************/
|
||||
@Override
|
||||
public void checkPermissionsThrowing(AbstractActionInput input, @Nullable MetaDataWithPermissionRules metadata) throws QPermissionDeniedException
|
||||
{
|
||||
if(QContext.getQSession() == null || (!QContext.getQSession().hasPermission("printing_operator") && !QContext.getQSession().hasPermission("printing_admin")))
|
||||
{
|
||||
throw new QPermissionDeniedException(PrintingMessages.notAllowed(QContext.getQSession() != null, PrintingMessages.USE_PRINTING, PrintingMessages.OPERATOR_GRANT));
|
||||
}
|
||||
}
|
||||
}
|
||||
Loaded 100 of 180 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user