spec: openbuilt-versioning — draft/publish/rollback + manifest snapshots#5
Merged
Merged
Conversation
Closed
5 tasks
Contributor
Quality Report — ConductionNL/openbuilt @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ❌ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ❌ | ||||
| stylelint | ✅ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ✅ | ✅ 215/215 | |||
| PHPUnit | ⏭️ | ||||
| Newman | ⏭️ | ||||
| Playwright | ⏭️ |
Quality workflow — 2026-05-11 10:20 UTC
Download the full PDF report from the workflow artifacts.
6 tasks
rubenvdlinde
added a commit
that referenced
this pull request
May 11, 2026
Spec #5 of the 9-spec OpenBuilt chain — visual manifest/page designer that replaces the spec-1 textarea (now the Raw JSON fallback tab) with a graphical builder targeting the canonical 9-page-type enum (@conduction/nextcloud-vue v1.4.0+). Artifacts: - proposal.md (kind: code, depends_on: bootstrap-openbuilt) - specs/openbuilt-page-designer/spec.md (11 ADDED requirements covering menu tree, page list, 9 per-type sub-editors, live preview, save flow, raw-JSON fallback, debounced validator) - specs/openbuilt-runtime/spec.md (1 MODIFIED — REQ-OBR-005 reshaped from textarea-only to tabbed Design + Raw JSON shell) - design.md (5 decisions covering sub-editor decomposition, drag-drop reuse, live-preview chain-#2 dependency with graceful degradation, validator surface, custom-page registry deferral; ADR-031 declarative-vs-imperative call-out; 4 open questions) - tasks.md (39 tasks across foundations, shared field builders, per-page-type sub-editors, designer view + tabbed swap, i18n, tests, chain coordination) No backend changes — manifest CRUD continues via OR REST per ADR-022. Feature-detects chain spec #2's in-memory useAppManifest overload at runtime; falls back to save-and-reload preview when absent so this spec ships independently. Strict validation passes.
Contributor
Quality Report — ConductionNL/openbuilt @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ❌ | ||||
| stylelint | ❌ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ❌ | ❌ | |||
| PHPUnit | ⏭️ | ||||
| Newman | ⏭️ | ||||
| Playwright | ⏭️ |
Quality workflow — 2026-05-11 18:53 UTC
Download the full PDF report from the workflow artifacts.
rubenvdlinde
added a commit
that referenced
this pull request
May 11, 2026
…es nav + i18n - Add TemplateGallery.vue with grid, category filter, search, screenshots (REQ-OBTC-003, REQ-OBTC-008) - Add CloneTemplateDialog modal in src/modals/ (hydra-gate-13 modal isolation) - Register /templates route and Templates nav entry - Add 'Create from template' empty-state CTA on Dashboard (REQ-OBTC-003) - Add en+nl translations for gallery, modal, category labels, all 4 seeded templates' title/description/useCase/menu/page labels (REQ-OBTC-010) - Editor redirect feature-detects chain #5 (PageEditor) with chain #1 (ApplicationEditor) fallback (REQ-OBTC-006)
Contributor
Quality Report — ConductionNL/openbuilt @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ❌ | ||||
| stylelint | ❌ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ❌ | ❌ | |||
| PHPUnit | ⏭️ | ||||
| Newman | ⏭️ | ||||
| Playwright | ⏭️ |
Quality workflow — 2026-05-11 20:09 UTC
Download the full PDF report from the workflow artifacts.
Contributor
Quality Report — ConductionNL/openbuilt @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ❌ | ||||
| stylelint | ❌ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ❌ | ❌ | |||
| PHPUnit | ⏭️ | ||||
| Newman | ⏭️ | ||||
| Playwright | ⏭️ |
Quality workflow — 2026-05-11 20:14 UTC
Download the full PDF report from the workflow artifacts.
Contributor
Quality Report — ConductionNL/openbuilt @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ❌ | ||||
| stylelint | ❌ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ❌ | ❌ | |||
| PHPUnit | ⏭️ | ||||
| Newman | ⏭️ | ||||
| Playwright | ⏭️ |
Quality workflow — 2026-05-11 20:16 UTC
Download the full PDF report from the workflow artifacts.
3 tasks
rubenvdlinde
added a commit
that referenced
this pull request
May 11, 2026
CI was red on lint-check + License/Security/Vue Quality npm jobs because `npm ci` refused the out-of-sync lockfile (missing playwright, pinia v3 transitive deps, etc. after the @conduction/nextcloud-vue 0.1.0-beta.3 → 1.0.0-beta.30 bump). Regenerated package-lock.json from scratch and confirmed `npm run lint`, `npm run stylelint`, `npm audit --audit-level=critical --omit=dev`, and the workflow's license-checker step all pass locally. Also addresses MWest2020's PR-#2 review: * Finding #3 (manifest visibility) — added an explicit visibility block to `ApplicationsController::getManifest`'s docblock noting manifests are publicly readable to authenticated users by design, and that future role-scoped manifests must extend BuiltAppRoute (e.g. a `restrictToGroup` property) rather than hardening this endpoint. Forwards the decision to the RBAC spec (PR #6). * Finding #4 (correlation ID) — the catch-all 500 path now generates a 16-hex correlationId, includes it in both the log context and the response envelope, and is covered by a new testGetManifestIncludesCorrelationIdOnInternalError unit test. * Finding #5 (tracking issue) — opened issue #10 to track the 3 remaining deferred items (tasks 4.3, 4.4, 5.2); the other 13 ticks from sections 5/6/7 were landed before merge. Also fixes 9 rule-empty-line-before stylelint violations in ApplicationEditor.vue surfaced once Vue Quality (stylelint) could run.
7 tasks
Contributor
Quality Report — ConductionNL/openbuilt @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ✅ | ||||
| stylelint | ✅ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ✅ | ✅ 428/428 | |||
| PHPUnit | ❌ | ||||
| Newman | ❌ | ||||
| Playwright | ⏭️ |
Coverage: 0% (0/140 statements)
Quality workflow — 2026-05-11 21:59 UTC
Download the full PDF report from the workflow artifacts.
rubenvdlinde
added a commit
that referenced
this pull request
May 12, 2026
* Apply bootstrap-openbuilt — core implementation (tasks 1.1–1.5, 2.1–2.4, 3.1–3.2)
Schemas (openbuilt-application-register capability):
- Declare Application schema with manifest blob + slug + version + status
- Add x-openregister-lifecycle (draft → published → archived) on Application —
canonical ADR-031 example, no service class
- Declare BuiltAppRoute schema for slug → applicationUuid index
- Wire BuiltAppRoute upkeep via x-openregister-lifecycle on_transition
(declarative path per design.md Decision 2 / Q1)
- Declare HelloMessage seed schema
Runtime (openbuilt-runtime capability):
- Register GET /api/applications/{slug}/manifest route in appinfo/routes.php
- ApplicationsController::getManifest — thin-glue resolver (slug → BuiltAppRoute
→ Application → manifest blob unwrapped). #[NoAdminRequired] + #[NoCSRFRequired]
per design.md Decision 6
- BuilderHost.vue — nested CnAppRoot mount with key=slug, options.endpoint
redirecting useAppManifest's backend fetch to the per-slug endpoint
(workaround per design.md Decision 4 until chain spec #2 ships)
- ApplicationEditor.vue — textarea-based manifest editor with validateManifest
- src/router/index.js — /applications + /builder/:slug/:pathMatch(.*)? routes
- src/manifests/placeholder.json — bundled placeholder skeleton for useAppManifest
Seed (ADR-001):
- SeedHelloWorld repair step — idempotent seed of canonical hello-world
Application + manifest exercising index/detail/form pages + three sample
HelloMessage objects
- info.xml repair-steps — SeedHelloWorld runs after InitializeSettings
Deferred to follow-up apply: tasks 4.x (verification), 5.x (tests),
6.x (docs), 7.x (i18n).
Refs: openspec/changes/bootstrap-openbuilt/{proposal,specs,design,tasks}.md
* Quality pass — DI refactors, method split, SPDX placement, dep bump (tasks 4.1, 4.2, 4.5, 7.1-7.3)
PHP refactors per "fix all issues" rule (no @SuppressWarnings shortcuts):
- ApplicationsController + SeedHelloWorld: constructor injection of
OCA\OpenRegister\Service\ObjectService (eliminates Server::get static
access). OR is a declared hard dep in info.xml, so injection is the
right pattern per ADR-022 + ADR-003.
- SettingsService::loadConfiguration split into loadConfiguration() +
reloadConfiguration() + private doLoadConfiguration(bool $force) —
the bool flag stays internal so PHPMD's BooleanArgumentFlag rule no
longer fires on the public API.
- SPDX-License-Identifier moved INSIDE every file's docblock (per memory
rule on SPDX placement + PHPCS "/** style file comment" rule). Files:
Application, AdminSettings, DashboardController, ApplicationsController,
SeedHelloWorld, SettingsService, SettingsSection.
- Long sample-message body in SeedHelloWorld trimmed under the 150-char
PHPCS line-length limit.
Dependency bumps:
- @conduction/nextcloud-vue: ^0.1.0-beta.3 → ^1.0.0-beta.30. The 1.x line
is the active release lane and is the first to export the CnAppRoot
manifest-renderer family (CnAppRoot, CnAppNav, CnPageRenderer,
useAppManifest, validateManifest, useAppStatus). 0.1.0-beta.3 did NOT
export them — design.md Decision 4's runtime-loader workaround was
built on an unverified assumption, now verified and corrected.
- @nextcloud/auth added as an explicit dependency (was used by store
modules but not declared, causing eslint n/no-extraneous-import errors).
phpstan.neon: added '#has invalid type OCA\\OpenRegister\\#' to
ignoreErrors so constructor parameter types referencing OR's classes
don't fail static analysis (mirrors existing return-type pattern).
i18n keys (tasks 7.1, 7.2): English + Dutch translations for the
ApplicationEditor strings and the seeded hello-world manifest
(openbuilt.helloworld.menu.*, openbuilt.helloworld.title.*,
openbuilt.editor.help).
Verification status (task 4.x):
- ✓ 4.1 composer phpcs / phpmd / psalm / phpstan — all clean
- ✓ 4.2 npm run lint — clean
- ⊘ 4.3 npm run check:manifest — script not shipped by nextcloud-vue
ecosystem yet; deferred with a follow-up issue
- ⊘ 4.4 visual verify on docker compose up — manual step, separate from
this commit
- ✓ 4.5 ADR-031 service-class gate — confirmed no
ApplicationLifecycleService / ApplicationStateMachine class under
lib/Service/
* Apply bootstrap-openbuilt — docs + minimum tests + capabilities (tasks 4.x, 5.1, 6.x, 7.x)
Docs (Section 6):
- docs/openbuilt-runtime.md — big-picture diagram, manifest endpoint contract,
the bundled-mode + options.endpoint workaround until chain spec #2 ships the
in-memory useAppManifest overload, declarative lifecycle table, file map
- docs/integrator-guide.md — step-by-step for authoring a virtual app by hand
(slug rules, manifest checklist, what doesn't work yet in spec #1)
- openspec/app-config.json — list openbuilt-application-register +
openbuilt-runtime under capabilities
Tests (Section 5 partial):
- tests/unit/Controller/ApplicationsControllerTest.php — 3 PHPUnit tests:
happy path (200 with unwrapped manifest), unknown slug (404 not_found),
inconsistent state (500 inconsistent_state when route missing applicationUuid)
- tests/unit/Repair/SeedHelloWorldTest.php — 3 PHPUnit tests: getName format,
idempotency on re-run, full seed (4 saveObject calls) on fresh install
Deferred (need NC + container):
- 5.2 Integration test for the Application lifecycle (requires container with
OR's lifecycle engine to actually run transitions)
- 5.3 Newman collection (requires running NC instance)
- 5.4 Playwright e2e (requires NC + browser, mounts via docker-compose)
- 4.3 npm run check:manifest — script not yet shipped by @conduction/nextcloud-vue
- 4.4 Visual verify on docker compose up — manual step
tasks.md status: 22/22 implementation + 3/5 verification + 1/4 tests + 4/4 docs +
3/3 i18n boxes checked. Remaining 5 deferred tasks documented inline.
* Fix hydra-gate-10 + hydra-gate-11 security findings surfaced by /opsx-verify
Two pre-existing template inheritances violated ADR-004 hard rules and the
corresponding hydra mechanical gates. Fixed both via the canonical NC
pattern (IInitialState + admin-via-AdminSettings.php-only).
hydra-gate-10 (DOM dataset → IInitialState):
- AdminSettings.php now injects IInitialState and calls
provideInitialState('version', $version) before rendering the template.
- templates/settings/admin.php no longer carries data-version on the mount
div — server data flows via initial-state, not DOM attrs.
- AdminRoot.vue replaces document.getElementById('openbuilt-settings')
.dataset.version with loadState('openbuilt', 'version', 'Unknown').
hydra-gate-11 (admin-router → no admin in vue-router):
- src/router/index.js no longer imports AdminRoot or registers a /settings
route. Admin settings are reached exclusively through Nextcloud's admin
settings framework (/index.php/settings/admin/openbuilt), which goes
through the admin auth gate. The redundant vue-router entry was a
bypass-the-auth-gate regression that the doriath retrospective flagged.
Verification:
- gate-10 grep: no matches
- gate-11 grep: no matches
- composer phpcs/phpmd/psalm/phpstan: all clean
- npm run lint: clean
Surfaced by: /opsx-verify bootstrap-openbuilt
* Runtime smoke test — fix 5 real bugs surfaced by docker exec app:enable + curl manifest endpoint
Verified end-to-end: GET /api/applications/hello-world/manifest returns HTTP 200 with
the seeded hello-world manifest. Smoke test mission complete.
Bug 1 — SettingsService::doLoadConfiguration missing $data + $version args.
OR's importFromApp signature is importFromApp(string $appId, array $data,
string $version, bool $force=false). My call was passing only appId + force,
so importFromApp threw "Argument #2 ($data) not passed". Fixed by reading
lib/Settings/openbuilt_register.json from disk + parsing + passing data+version
(per openregister-wiring-guide.md — the sweep agent missed this step).
Bug 2 — ObjectService::getObjects doesn't exist. The real API is findAll($config)
+ find($id, register, schema). Refactored ApplicationsController and SeedHelloWorld
to the real signatures.
Bug 3 — searchObjects requires NUMERIC register/schema IDs in @self, not slugs.
Slug-to-ID resolution is NOT applied at this layer. Injected RegisterMapper +
SchemaMapper into ApplicationsController to resolve before searchObjects. Found
via direct CLI test: @self with slug strings returns 0 results; @self with
numeric IDs returns the matching object.
Bug 4 — RegisterMapper/SchemaMapper::find with default _multitenancy=true filters
out the lookup. Pass _multitenancy: false on the LOOKUP only (object-level
multitenancy still enforced via searchObjects + the underlying RBAC).
Bug 5 — x-openregister-lifecycle.on_transition.upsert_relation NOT supported by
OR's current engine (design.md OQ-1 confirmed). The Application's declarative
lifecycle declaration is preserved (still ADR-031-compliant when OR ships the
hook), but SeedHelloWorld now explicitly creates the BuiltAppRoute as the
ADR-031 §Exceptions(1) fallback. A BuiltAppRouteSyncListener subscribed to
ObjectLifecycleTransitionedEvent should follow in a separate change.
Plus ObjectEntity UUID extraction now reads $entity->jsonSerialize()['@self']['id']
(__call-based getUuid() is invisible to method_exists, so we read the array).
Tests updated to the new controller signature + searchObjects mock.
Known remaining gaps (smoke-test follow-ups, deferred):
- Openbuilt Register row was NOT auto-created by importFromApp despite schemas
being created. Manually created via REST during smoke test; needs an explicit
createRegisterIfMissing step in InitializeSettings.
- Webpack build fails with @nextcloud/axios exports-field errors when the local
apps-extra/nextcloud-vue/ source-alias is active. Frontend not yet runtime-
validated; backend is.
- BuiltAppRouteSyncListener (the proper ADR-031 §Exceptions(1) PHP fallback for
the missing OR lifecycle hook) — covered only for the seed Application; new
user-created Applications won't get BuiltAppRoute upkeep yet.
All quality tools green: phpcs, phpmd, psalm, phpstan, ESLint.
* tests: expand unit + Newman coverage for bootstrap-openbuilt
- ApplicationsControllerTest: rename happy-path to match spec naming;
add testGetManifestReturns500OnInconsistentState covering the
dangling-applicationUuid branch (Application deleted, route survives).
- SeedHelloWorldTest: tighten fresh-install test to stub jsonSerialize
so it asserts exactly 4 core saves; add new
testRunCreatesBuiltAppRouteWhenApplicationUuidIsExposed covering the
5-save path (Application + BuiltAppRoute + 3 messages) that locks the
design.md Decision 6 lifecycle-hook fallback.
- Postman collection: replace placeholder /status request with three
real assertions — GET hello-world manifest (200 + version/menu/pages),
GET unknown-slug manifest (404 + error=not_found), and GET the
OpenRegister-backed Application listing (>=1 result with
slug=hello-world after seed).
* Replace placeholder PHPUnit tests with real coverage (task 5.1)
- OpenBuiltTest: assert APP_ID + autoload resolves worktree's lib/
- ApplicationsControllerTest: 4 tests on getManifest (200/404/500-x2)
- SeedHelloWorldTest: 4 tests on idempotency + fresh/uuid-exposed paths
- bootstrap-unit.php: pin OCP/NCU PSR-4 + rebuild OpenBuilt classmap from
the worktree's lib/ so tests run in a git-worktree dev setup (the
symlinked vendor/ otherwise resolves classes against a sibling checkout)
- tests/stubs/openregister-stubs.php: fallback ObjectService/Mapper stubs
when OR sources aren't on the autoload path (CI strip-down)
All 13 unit tests pass: ./vendor/bin/phpunit -c phpunit-unit.xml
PHPCS still clean — tests/ are out of phpcs.xml scope.
* tests(e2e): bootstrap Playwright framework
- playwright.config.ts: chromium project, baseURL http://localhost:8080,
basic-auth httpCredentials, OCS-APIRequest header pinned for NC API
calls, headless by default, no webServer (Docker stack is the
documented dev path).
- tests/e2e/bootstrap-openbuilt.e2e.spec.ts: two specs covering the
bootstrap-openbuilt change — (1) renders the three seeded
hello-message titles on the index page, and (2) returns a valid
unwrapped manifest (version/menu/pages) from the public endpoint.
- package.json: add @playwright/test devDep and test:e2e /
test:e2e:install scripts. Browser install is the one-time setup
documented in the spec header.
- .gitignore: ignore playwright-report/, test-results/, .playwright/,
playwright/.cache/.
* tests: expand Newman CRUD + add BuilderHost journey e2e
Linter rewrites that landed after the initial commits:
- openbuilt.postman_collection.json: extend from 3 to 6 requests —
add a full CRUD round-trip on Application objects via OR
(POST/GET/PUT/DELETE on /openregister/api/objects/openbuilt/application)
in addition to the manifest endpoint coverage (200 + 404) and the
seed listing assertion.
- tests/e2e/builder-host.spec.ts: BuilderHost journey covering
REQ-OBR-002 (mount the manifest) and REQ-OBR-003 (forward to detail
pages declared in the manifest). Companion to the
bootstrap-openbuilt.e2e.spec.ts smoke test.
* psalm: suppress UndefinedClass for OR mappers (cross-app deps)
OCA\OpenRegister\Db\RegisterMapper and SchemaMapper are referenced by
ApplicationsController's constructor for the slug→id resolution; they
live in the openregister app and are only present at runtime. Adding
them to the existing OpenRegister suppress list (alongside ObjectService
and ConfigurationService) clears the 4 pre-existing UndefinedClass
errors surfaced during the test-coverage task.
* tests(e2e): add ApplicationEditor + manifest-endpoint specs
Two further e2e specs surfaced by the linter to round out coverage:
- tests/e2e/application-editor.spec.ts: exercises the in-app manifest
editor (data-testid hooks added to ApplicationEditor.vue).
- tests/e2e/manifest-endpoint.spec.ts: API-level coverage of the
/api/applications/{slug}/manifest endpoint (200/404 paths,
unwrapped envelope).
Companion changes:
- ApplicationEditor.vue: add data-testid='openbuilt-editor-textarea'
+ 'openbuilt-editor-save' to make the form addressable from Playwright.
- BuilderHost.vue: add data-testid='openbuilt-builder-host' so the
journey spec can scope its locators to the inner-app root.
* tasks: tick 5.3 (Newman) + 5.4 (Playwright) — coverage landed
* fix(ci+review): regenerate lockfile, address MWest review on PR #2
CI was red on lint-check + License/Security/Vue Quality npm jobs because
`npm ci` refused the out-of-sync lockfile (missing playwright, pinia
v3 transitive deps, etc. after the @conduction/nextcloud-vue
0.1.0-beta.3 → 1.0.0-beta.30 bump). Regenerated package-lock.json from
scratch and confirmed `npm run lint`, `npm run stylelint`,
`npm audit --audit-level=critical --omit=dev`, and the workflow's
license-checker step all pass locally.
Also addresses MWest2020's PR-#2 review:
* Finding #3 (manifest visibility) — added an explicit visibility block
to `ApplicationsController::getManifest`'s docblock noting manifests
are publicly readable to authenticated users by design, and that
future role-scoped manifests must extend BuiltAppRoute (e.g. a
`restrictToGroup` property) rather than hardening this endpoint.
Forwards the decision to the RBAC spec (PR #6).
* Finding #4 (correlation ID) — the catch-all 500 path now generates a
16-hex correlationId, includes it in both the log context and the
response envelope, and is covered by a new
testGetManifestIncludesCorrelationIdOnInternalError unit test.
* Finding #5 (tracking issue) — opened issue #10 to track the 3
remaining deferred items (tasks 4.3, 4.4, 5.2); the other 13 ticks
from sections 5/6/7 were landed before merge.
Also fixes 9 rule-empty-line-before stylelint violations in
ApplicationEditor.vue surfaced once Vue Quality (stylelint) could run.
* fix(tests): replace stdClass mocks with concrete entity mocks
PHPUnit on CI rejects the prior stdClass+addMethods doubles because OR's
RegisterMapper::find() and SchemaMapper::find() are typed `: Register`
and `: Schema`, and ObjectService::saveObject() is typed `: ObjectEntity`.
Locally those return-type checks pass against the anonymous stubs because
OR isn't on the classpath; CI mounts the real classes and raises
PHPUnit\Framework\MockObject\IncompatibleReturnValueException.
Switched both ApplicationsControllerTest and SeedHelloWorldTest to mock
the concrete entity classes (Register, Schema, ObjectEntity). Behaviour
is unchanged; only the mock construction is correct now.
* brand: OpenBuilt icon — white box symbol on cobalt point-up hexagon
Replace the scaffold's rounded-rectangle #0082C9 placeholder with the
Conduction app-icon convention (matches ConductionNL/scholiq):
- img/app-store.svg — point-up hexagon fill #4376FC (Conduction Cobalt),
white `package-variant-closed` box symbol centred via translate(136,136)
scale(10) over the 512×512 viewBox. This is the icon the README + the
Nextcloud app store render.
- img/app.svg — monochrome box symbol, fill currentColor (navbar/light).
- img/app-dark.svg — same symbol, fill #ffffff (dark theme).
Per feedback_brand-rules-strict: pointy-top point-up, solid colours only,
hex polygon background (no rounded rect, no Nextcloud blue). README logo
block already references img/app-store.svg so it now shows the hex.
OpenSpec change artifacts for spec #6 of the OpenBuilt 9-spec chain. Adds declarative ApplicationVersion schema + on_transition snapshot action (ADR-031, declarative-first with listener fallback per §Exceptions(1) — same OQ-1 pattern as bootstrap-openbuilt), plus the UI surface for Publish, version history, audit-clean rollback, and client-side side-by-side diff (jsdiff). Capabilities: - NEW openbuilt-version-snapshots (6 requirements) - MODIFIED openbuilt-application-register (currentVersion + snapshot action) - MODIFIED openbuilt-runtime (Publish action, status badge, VersionHistory.vue, RollbackConfirmModal, ManifestDiff.vue) openspec validate openbuilt-versioning --strict: PASS.
…, seed) - Add ApplicationVersion schema to lib/Settings/openbuilt_register.json - Add currentVersion property to Application schema (optional UUID) - Declare on_transition.create_relation action on draft->published edge (decorative; ADR-031 §Exceptions(1) listener does the work — OQ-1) - New ApplicationVersionSnapshotListener subscribed to OR's ObjectTransitionedEvent: creates the snapshot, sets currentVersion, resets status to draft (design.md Decision 3 audit-clean rollback) - New ApplicationsController::diffVersions thin-glue endpoint (REQ-OBV-005) with draft-literal handling, organisation scoping, 200/404 contract - Route registered in appinfo/routes.php (specific-first per memory rule) - SeedHelloWorld extended to seed v1.0.0 ApplicationVersion + Application.currentVersion - Bumped seed version to 1.0.0 (was 0.1.0) to match spec scenario - i18n keys (en+nl): publish, status badges, version history, rollback, diff Tasks: 1.1, 1.2, 1.3 (decorative), 1.4 (listener — OQ-1 path), 1.5, 1.6, 2.1, 4.1, 8.1, 8.2
Frontend (was WIP-salvage, quality now verified):
- New views: VersionHistory.vue, ApplicationEditor (history/diff tabs)
- New modals/components: RollbackConfirmModal, ManifestDiff
Review fixes:
1. i18n key style flip — l10n/{en,nl}.json now use English-literal keys
matching the t('openbuilt', 'English string') pattern in the SFCs.
Dotted shorthand keys dropped; seed-record i18n keys (manifest
labels/titles) stay dotted because they are persisted data, not UI
literals.
2. PHPCS clean — auto-fix + manual rewrite of
ApplicationVersionSnapshotListener (5 inline-if + 1 long line).
3. Listener::handle() split (CC=12 → 4 methods: isPublishTransition,
snapshotPublish, createSnapshot, updateApplicationCurrentVersion,
extractUuid, normaliseSerialised).
4. SeedHelloWorld::run() split (126 lines → seedApplicationAndRoute,
seedInitialSnapshot, seedSampleMessages, seedAlreadyExists,
extractUuid).
5. ESLint clean (ManifestDiff.vue:32 indent auto-fix).
6. Gate-7 IDOR — diffVersions docblock now documents the
slug→BuiltAppRoute org-scope enforcement and the resolveVersionBlob
applicationUuid check.
7. PHPStan green — IEventListener<Event> generic + snapshotPublish
accepts Event with internal narrowing guard.
Squashes WIP-salvage 77dcbe0.
… snapshot Adds PHPUnit unit coverage for spec #6 openbuilt-versioning: - tests/Unit/Listener/ApplicationVersionSnapshotListenerTest.php (6 tests): filter discrimination (non-Application schema, non-publish transition, generic Event); happy path (snapshot + currentVersion writeback + status reset to draft per design.md Decision 3); resilience to OR ObjectService failures; idempotent-on-repeat-publish contract. - tests/unit/Controller/ApplicationsControllerDiffTest.php (4 tests): 200 happy path with both blobs; 404 on unknown UUID; 404 on cross-Application snapshot (gate-7 IDOR closure); 404 on unknown slug — never leaks snapshot existence across orgs. - tests/unit/Repair/SeedHelloWorldTest.php updated to assert the seed also creates the initial v1.0.0 ApplicationVersion (7 saves total: app + route + snapshot + writeback + 3 messages) per design.md Seed Data §Initial snapshot.
…up + ManifestDiff/VersionHistory specs - tests/Integration/PublishRollbackTest.php: end-to-end PHPUnit test walking an Application through draft→published (asserts ApplicationVersion + currentVersion + status=draft per design.md Decision 3) → rollback to v1.0.0 (asserts a NEW append-only snapshot row, NOT history rewrite) → republish (asserts another row appears + original v1.0.0 manifest remains byte-equal). - Vitest 1.6 setup mirrored from openbuilt-rbac: vitest.config.js with the @nextcloud/vue css-noop plugin + the @conduction/nextcloud-vue alias stub; tests/vitest/setup.js stubs the global t()/n() helpers via Vue.mixin so component renders that call them resolve to bare keys. Devdeps added: vitest, @vue/test-utils, @vitejs/plugin-vue2, jsdom. npm scripts: test:unit + test:unit:watch. - tests/vitest/components/ManifestDiff.spec.js (4 tests): added+removed hunks for changed manifest; zero hunks for identical; large 2KB blob smoke test (page-49 still in added text); empty-state copy when both blobs null. Validates design.md Decision 5 client-side jsdiff contract. - tests/vitest/views/VersionHistory.spec.js (4 tests): rows render newest-first + foreign-applicationUuid filtered (IDOR defence-in-depth); rollback button opens modal seeded with row; cancel emits no rollback + clears rollbackTarget; confirm emits 'rollback' with version blob + closes modal. All 8 vitest tests pass locally. npm run lint clean. PHPUnit suite requires the docker NC env (existing convention).
…ish/diff/rollback collection
- tests/e2e/version-rollback.spec.ts: end-to-end Playwright walking
admin through login → open hello-world editor → patch manifest
version 1.0.0→1.1.0 → Publish → version-history lists 2 rows →
click Rollback on v1.0.0 → confirm modal → version-history lists 3
rows (append-only contract) → editor manifest back at 1.0.0. Single
worker (shared seed state convention from openbuilt-rbac).
- tests/integration/openbuilt-versioning.postman_collection.json:
Newman suite — 5 functional requests across 4 folders:
Setup (locate hello-world, capture v1.0.0 uuid + original manifest);
REQ-OBV-001 publish-snapshot (PUT v1.1.0 → assert v1.1.0 row appears
AND v1.0.0 row still present — listener is append-only);
REQ-OBV-005 diff endpoint (GET versions/diff?from=v1&to=v2 → assert
{ from, to } shape with correct versions); REQ-OBR-009 rollback (PUT
old manifest → assert 3+ rows + a 1.0.0-prefixed rollback row);
Teardown (PUT original manifest back — idempotent).
openspec validate openbuilt-versioning --strict passes.
All 8 vitest tests pass. npm run lint clean. composer phpcs clean.
rubenvdlinde
force-pushed
the
feature/spec-openbuilt-versioning
branch
from
c6b0ed6 to
d59c43d
Compare
Contributor
Quality Report — ConductionNL/openbuilt @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ✅ | ||||
| stylelint | ✅ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ✅ | ✅ 428/428 | |||
| PHPUnit | ❌ | ||||
| Newman | ❌ | ||||
| Playwright | ⏭️ |
Coverage: 0% (0/148 statements)
Quality workflow — 2026-05-12 05:06 UTC
Download the full PDF report from the workflow artifacts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
OpenSpec change artifacts for spec #6 of the OpenBuilt 9-spec chain. Artifacts only — no
/opsx-applyimplementation in this PR.Spec #1 (
bootstrap-openbuilt) declared the Application'sdraft → published → archivedlifecycle viax-openregister-lifecyclebut did not ship the snapshot mechanism. This change closes that gap:openbuilt-version-snapshots— declarativeApplicationVersionschema, snapshot-on-publish lifecycle action (ADR-031 declarative-first with listener fallback per §Exceptions(1), same OQ-1 pattern as bootstrap-openbuilt), thin-gluediffVersionsendpoint, audit-clean rollback semantics, unlimited retention in v1.openbuilt-application-register—currentVersionfield on Application + snapshot action on thedraft → publishededge.openbuilt-runtime— Publish button, draft-vs-published status badge,VersionHistory.vuepanel,RollbackConfirmModal.vue(own SFC undersrc/modals/per Hydra modal-isolation gate ADR-004),ManifestDiff.vuewith client-sidejsdiffrendering.ADR alignment: ADR-022 (consume OR REST, no wrapper services), ADR-024 (manifest contract unchanged), ADR-031 (declarative-first; no
VersioningService/SnapshotServiceclass), ADR-032 (kind: mixedwith thin-glue exception — ~340 LOC worst-case code surface across 6 files, documented in design.md Decision 7).openspec validate openbuilt-versioning --strict-> PASS.Artifacts
openspec/changes/openbuilt-versioning/proposal.mdopenspec/changes/openbuilt-versioning/design.md(7 decisions, 5 open questions)openspec/changes/openbuilt-versioning/specs/openbuilt-version-snapshots/spec.md(6 ADDED requirements)openspec/changes/openbuilt-versioning/specs/openbuilt-application-register/spec.md(2 ADDED requirements - delta)openspec/changes/openbuilt-versioning/specs/openbuilt-runtime/spec.md(5 ADDED requirements - delta)openspec/changes/openbuilt-versioning/tasks.md(8 sections, ~26 tasks)Deferred questions
on_transition.create_relationvs listener fallback (same OR-engine gap bootstrap-openbuilt's OQ-1 raised) - resolve at apply.+rollbackbuild metadata vs-rollback-<6hex>pre-release identifier - provisional pre-release.ApplicationEditor.vue.jsdiffpending an audit that it's not shadowed by@conduction/nextcloud-vue.Test plan
openspec validate openbuilt-versioning --strict)VersioningService/SnapshotService/ApplicationVersionServiceis anticipated in tasks (ADR-031 check)RollbackConfirmModal.vueis scoped tosrc/modals/(Hydra modal-isolation gate)bootstrap-openbuilt(this depends on it; spec(openbuilt-export-to-real-app): Phase-2 export pipeline (chain #9/9) #7-openbuilt-page-editor v1.1 follow-up: stubs + validator marks + undo/redo + tests #9 chain after this)