Compare commits

...
Author SHA1 Message Date
james.maesandCodex b199b24f01 ci: use the shared branch-aware CodeQL worker
Co-Authored-By: Codex <noreply@openai.com>
2026-10-21 10:09:27 -05:00
james.maesandCodex b5308a8bab ci: adopt central orb 0.7.12 and stable gates (#37)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 08:50:12 -05:00
james.maesandCodex 0caaa3717e ci: centralize rc release completion in qqq orb (#36)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 02:23:46 -05:00
james.maesandCodex 464db76bc3 ci: adopt shared orb 0.7.11 (#35)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 00:54:30 -05:00
james.maes 19a06166f5 Merge pull request #34 from QRun-IO/feature/central-ci
ci: adopt shared QQQ orb 0.7.4
2026-10-20 19:32:48 -05:00
james.maesandCodex 61060e2793 ci: adopt central QQQ orb 0.7.4
Co-Authored-By: Codex <noreply@openai.com>
2026-10-20 19:26:47 -05:00
james.maes 4e88ed8303 Merge pull request #31 from QRun-IO/ci/release-rc-secrets-inherit
ci(release-rc): pass secrets so the shared workflow can sign the RC tag
2026-10-16 08:03:57 -05:00
james.maesandClaude Opus 5.5 7a7b804106 ci(release-rc): pass secrets to the shared workflow so it can sign the RC tag
QRun-IO/.github#2 adds a tag-and-release job that signs vX with the
QRUN_TAG_SIGNING_KEY secret after Maven Central confirms the artifact.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 16:19:25 -05:00
james.maes 4c95151a86 Merge pull request #29 from QRun-IO/feature/ui-api-1.6
feat(ui-api): extension for QQQ UI API 1.6.0 (operationIds, BasicErrorResponseV1, QQQ 4.1.0-RC.15)
2026-10-15 16:12:53 -05:00
james.maesandClaude Opus 5.5 41bbf2c428 chore: target QQQ 4.1.0-RC.15 (UI API 1.6.0)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 12:27:04 -05:00
james.maesandClaude Opus 5.5 2f6be765f2 feat(ui-api): extension for QQQ UI API 1.6.0 (operationIds, BasicErrorResponseV1, QQQ 4.1.0-RC.14)
Regenerated against UI API 1.6.0: every operation has an operationId and
the standard error responses (BasicErrorResponseV1: error, code, message,
fieldErrors, traceId); the extension's own error schema is kept but
deprecated; hand-written error bodies go through QJavalinUtils so they carry
code/message/traceId. Extension MINOR bumped.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 11:43:37 -05:00
james.maes 92dd901409 Merge pull request #28 from QRun-IO/fix/producer-version-from-build
fix: qbit metadata version comes from the build
2026-10-15 01:42:56 -05:00
james.maesandClaude Opus 5.5 6a4ea584f5 fix: the qbit metadata version comes from the build, not a hardcoded constant
The producer read a literal version, so released artifacts reported a stale
or -SNAPSHOT version. qbit-collaboration.properties (version=${project.version}) is
Maven-filtered and the producer loads it; tests assert producer == bundle ==
artifact version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 01:27:45 -05:00
james.maes 03b3bbaca2 Merge pull request #27 from QRun-IO/fix/help-bundle-version-test
test(help): bundle version test compares with the artifact version
2026-10-14 23:18:42 -05:00
james.maesandClaude Opus 5.5 31ce528064 test(help): compare the help bundle version with the artifact version, not a hardcoded SNAPSHOT
The bundle version is now Maven-filtered, so a literal SNAPSHOT in the test
fails every release build. Surefire passes the artifact version in
qbit.artifactVersion.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 23:07:29 -05:00
james.maes 90b3956cf7 Merge pull request #26 from QRun-IO/fix/help-bundle-version
fix(help): help bundle version comes from the build, not a hardcoded SNAPSHOT
2026-10-14 22:37:20 -05:00
james.maesandClaude Opus 5.5 e4f92192c6 fix(help): the help bundle carries the artifact version (Maven-filtered) instead of a hardcoded SNAPSHOT
On release branches the bundle's version and the producer's differed, so the
bundle test that asserts they match failed, and released bundles recorded
SNAPSHOT as their provenance. help/*.yaml is now filtered:
version: ${project.version}.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 22:04:44 -05:00
james.maes 675d30568e Merge pull request #25 from QRun-IO/feature/help-bundle
feat(help): qbit-collaboration help bundle via QQQ help bundles, with coverage gate
2026-10-14 20:45:30 -05:00
james.maesandClaude Opus 5.5 3df535453e feat(help): ship the qbit-collaboration help bundle through QQQ help bundles, with coverage gate
Host-neutral help (deployment-specific facts removed), registered with
HelpBundles, gated by HelpBundleAssertions. QQQ 4.1.0-RC.7.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 20:27:03 -05:00
james.maes d302f1dc1f Merge pull request #24 from QRun-IO/feature/tables-populated-defaults
feat: Create rows from configuration, Setup card and table help
2026-10-14 17:44:57 -05:00
james.maesandClaude Opus 5.5 58c87b0378 fix: load feature settings in one transaction, correct scope wording, count only eligible tables
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 17:39:52 -05:00
james.maesandClaude Opus 5.5 e5647e6020 chore: well-formed STAND-IN marker for the help applier
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 17:30:31 -05:00
james.maesandClaude Opus 5.5 3d2a1ded72 feat: Create rows from configuration, Setup card and table help so Feature Settings is never a mystery
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 17:08:52 -05:00
james.maes 662a9f1a6d Merge pull request #23 from QRun-IO/feature/qqq-rc7
feat: QQQ RC.7 followers provider and secured-data label rules
2026-10-14 16:33:33 -05:00
james.maesandClaude Opus 5.5 e014c00428 feat: QQQ 4.1.0-RC.7: record followers provider and secured-data label rules
CollaborationFollowersProvider implements core RecordFollowersProviderInterface
over collaboration_follow (CHANGE/ALERT -> notifyOnChange, COMMENT ->
notifyOnComment, muted excluded), registered via RecordFeaturesMetaData, so
qbit-alerts can notify followers. Cached favorite/recent labels are stored
only when FieldAccessHelper.isRecordLabelFullAccess holds; notification
titles fall back to the table label and id for recipients without FULL
label access. Timeline masking (MASKED shows the mask, HIDDEN omitted,
canary never leaks) is covered by tests.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 16:29:09 -05:00
james.maes ea0b74f94c Merge pull request #22 from QRun-IO/fix/issues-20-21
fix: context-free attachment steps (#20) and no fixed home column widths (#21)
2026-10-14 14:59:18 -05:00
james.maesandClaude Opus 5.5 e051c74273 fix: context-free attachment action steps and no fixed home column widths
DeleteAttachmentsProcess Review/Delete create their AttachmentsService on
first use instead of in the constructor, so QQQ can build them during
context-free instance validation (fixes #20). Home table columns no
longer set widths, so narrow cards wrap instead of scrolling (fixes #21).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 14:56:09 -05:00
james.maes 680fd5fa02 Merge pull request #18 from QRun-IO/feature/orb-0.6.9
ci: qqq-orb 0.6.9 (refresh SNAPSHOT dependencies)
2026-10-14 10:56:55 -05:00
james.maes 1e0a5773bb Merge pull request #19 from QRun-IO/feature/email-api
refactor(email): use qbit-email's public api package; no G1 allow-list
2026-10-14 10:25:07 -05:00
james.maesandClaude Opus 5.5 83b253a94f ci: qqq-orb 0.6.9 (refresh SNAPSHOT dependencies)
Moves qqq-orb@0.6.8 to qqq-orb@0.6.9, which passes --update-snapshots so cached SNAPSHOT dependencies are re-checked on every build (QRun-IO/qqq-orb#22).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 10:06:36 -05:00
41 changed files with 4318 additions and 322 deletions

No files matched your search

+11 -57
View File
@@ -1,60 +1,14 @@
version: 2.1
setup: true
orbs:
qqq-orb: kingsrook/qqq-orb@0.6.8
commands:
configure-package-install:
steps:
- run:
name: Keep package installation unattended
command: |
# These build machines are discarded after the job.
sudo install -d /etc/needrestart/conf.d
printf '%s\n' '$nrconf{restart} = "l";' | sudo tee /etc/needrestart/conf.d/99-qqq-ci.conf >/dev/null
qqq-orb: kingsrook/qqq-orb@0.7.12
workflows:
test_only:
jobs:
- qqq-orb/mvn_test_only:
pre-steps:
- configure-package-install
context: [qqq-maven-registry-credentials]
filters:
branches:
ignore: /(develop|release\/.*)/
publish_snapshot:
jobs:
- qqq-orb/mvn_publish:
pre-steps:
- configure-package-install
context: [qqq-maven-registry-credentials]
branch_type: snapshot
filters:
branches:
only: [develop]
publish_release_candidate:
jobs:
- qqq-orb/mvn_publish:
pre-steps:
- configure-package-install
context: [qqq-maven-registry-credentials]
branch_type: release_candidate
filters:
branches:
only: [/release\/.*/]
publish_release:
jobs:
- qqq-orb/mvn_publish:
pre-steps:
- configure-package-install
context: [qqq-maven-registry-credentials]
branch_type: release
filters:
branches:
ignore: /.*/
tags:
only: [/^v\d+\.\d+\.\d+$/]
setup:
jobs:
- qqq-orb/generate_pipeline:
orb_version: 0.7.12
filters:
branches:
ignore: automation/qbit-rc-pending
tags:
only: /^v\d+\.\d+\.\d+$/
+23
View File
@@ -0,0 +1,23 @@
name: CodeQL
'on':
push:
branches:
- main
- develop
- release/**
- hotfix/**
pull_request: {}
schedule:
- cron: 41 16 * * 0
workflow_dispatch: {}
permissions:
contents: read
actions: read
security-events: write
packages: read
concurrency:
group: codeql-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
analyze:
uses: QRun-IO/qqq-orb/.github/workflows/qbit-codeql.yml@c288a8864fe9054f68410e1d78f5863aea4c4d22
+62 -13
View File
@@ -1,25 +1,74 @@
# Cut the next release candidate (QRun-IO/qqq docs/QRUN-QBIT-REPO-STANDARD.md, C6):
# run this workflow by hand, or merge a develop PR labelled `release:rc`. It merges develop into
# the release line and the release/* push runs CircleCI publish_release_candidate.
name: Release candidate
on:
'on':
workflow_dispatch:
inputs:
dry_run:
description: Print the plan without merging or creating branches
description: Plan a cut without changing release state
type: boolean
default: false
finalize:
description: Retry finalization of an existing cut; do not cut another RC
type: boolean
default: false
recover:
description: Recover the same published RC after a deployment timeout; never
reupload
type: boolean
default: false
circle_build:
description: Original Circle publisher build number (recovery only)
type: string
default: ''
merge_sha:
description: Existing cut merge_sha (finalize retry only)
type: string
default: ''
bump_sha:
description: Existing cut bump_sha (finalize retry only)
type: string
default: ''
branch:
description: Existing cut branch (finalize retry only)
type: string
default: ''
version:
description: Existing cut version (finalize retry only)
type: string
default: ''
pull_request:
types: [closed]
branches: [develop]
types:
- closed
branches:
- develop
repository_dispatch:
types:
- qbit-rc-published
permissions:
contents: write
actions: read
checks: read
jobs:
release-rc:
if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release:rc'))
uses: QRun-IO/.github/.github/workflows/qbit-release-rc.yml@main
if: github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch'
|| (github.event_name == 'pull_request' && github.event.pull_request.merged
== true && github.event.pull_request.base.ref == 'develop' && contains(github.event.pull_request.labels.*.name,
'release:rc'))
uses: QRun-IO/qqq-orb/.github/workflows/qbit-release-rc.yml@cc30f599e63c8e41629c99d23395bac1adb8bc44
with:
dry_run: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run }}
dry_run: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run || false
}}
finalize: ${{ github.event_name == 'repository_dispatch' || (github.event_name
== 'workflow_dispatch' && inputs.finalize) }}
recover: ${{ github.event_name == 'workflow_dispatch' && inputs.recover || false
}}
circle_build: ${{ github.event_name == 'workflow_dispatch' && inputs.circle_build
|| '' }}
merge_sha: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.merge_sha
|| inputs.merge_sha || '' }}
bump_sha: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.bump_sha
|| inputs.bump_sha || '' }}
branch: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.branch
|| inputs.branch || '' }}
version: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.version
|| inputs.version || '' }}
secrets: inherit
+16
View File
@@ -0,0 +1,16 @@
profile: qbit
orb_version: 0.7.12
default_branch: develop
java_version: '21'
browsers: true
api_checks: false
docs_only: false
release_on_main: false
release_tag_policy: stable
test_branch_policy: non-release
publish:
snapshot: true
release_candidate: true
release: true
asciidoc: false
release_completion: true
+17 -1
View File
@@ -4,14 +4,30 @@ All notable changes are documented here, following [Keep a Changelog](https://ke
## [Unreleased]
### Added
- Feature Settings table action **Create rows from configuration**: writes the code configuration out as editable `collaboration_feature_setting` rows (insert-only, only when the table is empty, no change in behavior).
- Setup card on the Collaboration home: each record feature, whether it is on, for which tables, and where that comes from.
- Host-neutral QBIT help bundle covering tables, fields, sections, built-in actions, the app, widgets and possible-value sources; core registration and `HelpBundleAssertions` coverage replace the temporary help loader.
- `CollaborationTablesGuardrailTest` and `FeatureSettingsDefaultsTest`.
### Changed
- UI API extension collaboration 1.1.0 (requires QQQ 4.1.0-RC.15, UI API 1.6.0): operationIds, standard error responses with BasicErrorResponseV1, extension tags and published presence request/snapshot/viewer schemas to resolve dangling references. Retain CollaborationErrorV1 as deprecated.
- Upgrade the default QQQ BOM to `4.1.0-RC.7` from Maven Central.
- Register the core followers provider for alerts and other qbits, with event preferences, future-mute exclusion, system reads scoped to one record, and caller-owned recipient access checks.
- Cache favorite/recent record labels only for FULL field access. Resolve comment/share notification labels per recipient with a table-label-and-id fallback. Use the typed core label-access API for email labels as well.
- Verify RC.7 timeline audit masking and HIDDEN-field omission through enforced viewer queries, including canaries in values and messages.
- Switch the optional qbit-email integration to 0.1.0-RC.2 and its published `com.kingsrook.qbits.email.api` package, preserving templates, categories, idempotency keys, linked records and enqueue-status handling. Narrow the email package allowance to the public API.
- Email through qbit-email 0.1.0-RC.1: new optional dependency and `EmailCollaborationNotifier` (templates `collaboration_mention`, `collaboration_share`, `collaboration_task_reminder`), the default notifier when qbit-email is produced in the instance and no `notifier` is configured; `NoOpNotifier` otherwise. One NOTIFICATION message per recipient, no comment bodies, record labels only when field access allows. New `recipientEmailResolver` config hook; `CollaborationNotification` gains optional `sourceId` and `actorUserId`.
### Fixed
- QBit metadata reports the Maven artifact version from a filtered resource, including release versions.
- Timeline audit summaries read "Edited by Alice Morgan: Title, Total" or "Created by Alice Morgan" instead of "Record was Edited"; detail rows are unchanged.
- The demo server chooses its user per browser session (`?user=bob`, remembered in a cookie) instead of once per JVM, and sends the person's name to the frontend so it no longer shows Anonymous.
- The share recipient search and mention candidates no longer offer the caller to themself.
@@ -38,7 +54,7 @@ All notable changes are documented here, following [Keep a Changelog](https://ke
- Adopt core feature overrides, record capabilities and implied WRITE locks, reference metadata, mirrored locks, after-commit cleanup and summaries. Core registers feature permissions in the policy editor.
- Replace `OtherUserAccess`/`UserSessionSupplier` with `CollaborationRecordAccessChecker` and core `UserSessionProviderInterface`; configure `withUserSessionProvider`.
- Remove `ParentTableRestriction` and `TagFilterTranslator`; runtime `collaborationTags` filtering/search uses core subqueries. Retain the unpinned visibility fallback still missing from core.
- Publish identifier-only realtime hints after commit. Selectable Tags output and the optional followers SPI await missing core hooks.
- Publish identifier-only realtime hints after commit. Selectable Tags output awaits a core hook; the followers SPI is adopted above.
- Build against locally installed QQQ `4.1.0-SNAPSHOT` until RC.6 is released; `qqq-middleware-javalin` is a compile dependency. Object storage remains pinned to `0.1.0-RC.2`.
+59 -14
View File
@@ -4,6 +4,23 @@ Record collaboration for QQQ: attachments, tags, custom fields, comments with me
Design: [QRun-IO/qqq PR #1136](https://github.com/QRun-IO/qqq/pull/1136), `docs/COLLABORATION.md`. See [the phase table](docs/DESIGN.md).
## In-app help
The qbit registers [help/qbit-collaboration.yaml](src/main/resources/help/qbit-collaboration.yaml)
with QQQ's help-bundle registry. Core startup sync applies it when the host has the
`helpContent` table; registration is safe without that table. Update the bundle's
literal version alongside the POM version when releasing.
To customize text, register a separate bundle with `layer: HOST` and the same entry
key and role using `HelpBundles.register(instance, "help/my-host.yaml")`. HOST text
takes precedence over QBIT text; startup sync preserves user edits. Hosts should
supply help for their configured table-specific follow, tag and assignment actions,
and for a renamed Collaboration app.
`CollaborationHelpBundleTest` runs `HelpBundleAssertions` against the produced
metadata and checks widget and possible-value-source coverage. The table guardrail
also checks that every table explains how its rows are created. Run `./mvnw -q verify`.
## Dependent fields
Comment parents list the selected thread's root and replies. Feature-setting scope names follow `scopeType` (apps, eligible tables, or `instance`). Comment field anchors follow `tableName` and offer non-hidden fields visible to the session. These use RC.5 filter variables and custom providers receiving `otherValues`; automatic dependency refresh awaits core `dependsOn`. See [dependent-field details](docs/CONTINGENT-POSSIBLE-VALUES.md).
@@ -11,16 +28,33 @@ Comment parents list the selected thread's root and replies. Feature-setting sco
## Requirements
- Java 21.
- QQQ `4.1.0-SNAPSHOT` installed from develop, including UI API extension point #1128. The build will move to `4.1.0-RC.6` once released; middleware Javalin is a compile dependency.
- QQQ `4.1.0-RC.7` from Maven Central; middleware Javalin is a compile dependency.
- A configured QQQ backend supporting query, get, insert, update, delete, count and aggregate actions. PostgreSQL 15+ is the intended persistent store (the generated personal-target indexes use `NULLS NOT DISTINCT`); tests use the memory backend.
- Attachments require `qbit-object-storage:0.1.0-RC.2` (a pinned dependency), installed with a PRIVATE bucket alias matching `attachmentsBucketName`. Configure its connection and credentials in the host; this qbit does not provision buckets.
- Core feature resolution, permissions, reference security, summaries, query expansion and realtime use QQQ `4.1.0-SNAPSHOT`, targeting RC.6.
- Core feature resolution, permissions, reference security, summaries, query expansion and realtime use QQQ `4.1.0-RC.7`.
## Followers and secured data
The instance registers a core `RecordFollowersProviderInterface` backed by
`collaboration_follow`, so alerts and other qbits can use `RecordFollowers.get`.
CHANGE and ALERT select `notifyOnChange`; COMMENT selects `notifyOnComment`.
Future mutes are excluded, and disabling FOLLOW returns no subscribers. The
provider reads only the requested table/record as the system. Consumers must
check each recipient's record access before sending data.
Favorites and recents cache a record label only when every label field is FULL
for the current session; otherwise the stored label is null. Lists continue to
re-read labels as the viewer. Comment and share notification titles resolve
labels in each recipient's session and fall back to the table label and id
(for example, `Order #1042`) when label access is restricted or unavailable.
Timeline audit reads use core's enforced query boundary: MASKED values are
masked, HIDDEN details are omitted, and restricted audit messages are cleared.
Comment bodies remain user content; realtime field-name filtering is handled by core.
## Demo server
`CollaborationDevServer` is a disposable, memory-backed Sales CRM for trying the
Next dashboard and taking screenshots. It needs Java 21 and the locally installed
QQQ `4.1.0-SNAPSHOT` from develop. No database, Docker or MinIO is needed. It binds
Next dashboard and taking screenshots. It needs Java 21 and QQQ `4.1.0-RC.7` from Maven Central. No database, Docker or MinIO is needed. It binds
to `127.0.0.1`; stopping the JVM discards edits and uploaded attachments.
Build the Next static export in `qqq-frontend-next`:
@@ -116,6 +150,15 @@ new CollaborationQBitProducer()
Omit `withParentAppName` for a top-level app. Run normal QQQ instance validation after all producers.
## Starter defaults and setup
Collaboration ships no SQL seed. The one configuration table, `collaboration_feature_setting`, depends on the host's configuration (`withDefaultFeatures`, `withTableFeatures`, the default tag mode, features declared on apps and tables), so its rows are computed at run time:
- Open Feature Settings and run the table action **Create rows from configuration** (collaboration administrators). It writes one Instance row per feature, plus an App or Table row wherever the code declares something at that scope. The rows say exactly what the code already says, so nothing changes; `FeatureSettingsDefaultsTest` proves every table resolves identically with and without them.
- It only creates rows when the table is empty, so it never touches an administrator's rows. Rows are applied after all code configuration. An Instance row overrides what code declares on any app or table that has no row of its own, so once rows exist, change features in the rows, not in code.
- The **Setup** card on the Collaboration home shows each feature, whether it is on, for which tables, and whether that comes from Feature Settings rows or the configuration.
- Every collaboration table has help (shown when it is empty) that says how its rows get created. The other tables hold user content or runtime data and start empty by design.
## Tables
| Table | Purpose |
@@ -367,13 +410,13 @@ The runtime provider adds this field and its search entry where TAGS is enabled.
## UI API
The producer registers extension `collaboration` version `1.0.0` at
The producer registers extension `collaboration` version `1.1.0` at
`/qqq/v1/qbit/collaboration`. It uses the signed-in user's session and existing
services. Disable registration with `new CollaborationQBitConfig().withUiApi(false)`.
Presence, shares, tasks, my-work, direct upload and thumbnail routes are not part
of this extension version.
Requires QQQ `4.1.0-RC.15` and UI API `1.6.0`. Operations carry stable operationIds,
the collaboration tag and standard error responses.
All successes return HTTP 200. All bodies have named `Collaboration*V1` schemas
All successes return HTTP 200. Success and request bodies have named `Collaboration*V1` schemas
in [the extension contract](src/main/resources/openapi/qqq-v1/collaboration.yaml).
The server publishes these alongside core at `/qqq/v1/openapi.yaml` and `.json`.
@@ -435,9 +478,11 @@ attachment filename; preview requests inline content. QQQ's current OpenAPI
`Response` model cannot declare the `Location` header, so this contract uses the
JSON URL alternative consistently.
A missing or invisible parent returns identical `404 {"error":"Not found"}`.
Missing write permissions return 403; invalid input returns 400 with an `error`
message through QQQ's exception mapper. Provider/backend failures remain server
A missing or invisible parent returns 404 with the same `Not found` error message.
Missing write permissions return 403; invalid input returns 400 through QQQ's
exception mapper. Errors use `BasicErrorResponseV1` with `error`, `code`, `message`,
`traceId` and optional `fieldErrors`. `CollaborationErrorV1` remains defined but is
deprecated since 1.1.0. Provider/backend failures remain server
errors. Services continue to own author, record-lock and permission checks.
Mention candidates expose `canRead` as the string enum `"true"`, `"false"`,
`"unknown"`; unknown does not imply the recipient can read the record.
@@ -563,7 +608,7 @@ host integrations as other collaboration tables.
## Core contracts and completed UI API
The qbit targets QQQ RC.6 using the locally installed `4.1.0-SNAPSHOT`. Defaults enable FAVORITES, RECENTS and TIMELINE for eligible host tables; all other features start off. Configure before producing metadata:
The qbit uses QQQ `4.1.0-RC.7` from Maven Central. Defaults enable FAVORITES, RECENTS and TIMELINE for eligible host tables; all other features start off. Configure before producing metadata:
```java
config.withDefaultFeatures(RecordFeature.FAVORITES, RecordFeature.RECENTS, RecordFeature.TIMELINE)
@@ -593,9 +638,9 @@ New routes, all under `/qqq/v1/qbit/collaboration`:
| PUT | `/records/{table}/{pk}/assignment` |
| GET | `/my-work` |
Typed `CollaborationWorkSchemas` describe requests and results. Task PATCH preserves omitted fields, accepts OPEN/DONE/CANCELLED transitions, and permits explicit null for optional fields; null `remindAt` selects the service's due-date default. Assignment PUT replaces owner and assignee; null clears. Invalid input is 400, denied visible-record operations are 403, and missing/invisible parents are 404. Access requests deliberately never inspect parent existence. The extension stays at unreleased **1.0.0**; contract tooling accepts these additions without a bump.
Typed `CollaborationWorkSchemas` describe requests and results. Task PATCH preserves omitted fields, accepts OPEN/DONE/CANCELLED transitions, and permits explicit null for optional fields; null `remindAt` selects the service's due-date default. Assignment PUT replaces owner and assignee; null clears. Invalid input is 400, denied visible-record operations are 403, and missing/invisible parents are 404. Access requests deliberately never inspect parent existence. The extension is now **1.1.0**, including the UI API 1.6.0 error contract and published presence schemas.
`CollaborationRealtime` publishes `comment.added/updated/deleted`, `attachment.changed`, `tags.changed` and `task.changed` on `record:{table}:{pk}` after commit. Successful notification delivery publishes `notification.created` on `user:{userId}`. Payloads contain identifiers only. The optional followers provider is skipped because `RecordFollowersProviderInterface` is absent from the installed jar. Selectable Tags values remain unavailable because the overlay has no output hook.
`CollaborationRealtime` publishes `comment.added/updated/deleted`, `attachment.changed`, `tags.changed` and `task.changed` on `record:{table}:{pk}` after commit. Successful notification delivery publishes `notification.created` on `user:{userId}`. Payloads contain identifiers only. `CollaborationFollowersProvider` supplies the core followers SPI for alerts and other consumers. Selectable Tags values remain unavailable because the overlay has no output hook.
## Custom fields (phase f)
+8
View File
@@ -0,0 +1,8 @@
# Upgrading
## Unreleased
No schema change and nothing required of hosts.
- New table action **Create rows from configuration** on Feature Settings. Run it once if you want the effective feature settings visible and editable as rows. It changes no behavior and does nothing once the table has any row. Note that after rows exist they win over later changes to `withDefaultFeatures` or `withTableFeatures` in code, so change those settings in the rows from then on.
- New **Setup** widget first on the Collaboration home, and table help text. Hosts that override help on a table keep their own.
+31 -2
View File
@@ -113,7 +113,36 @@
</dependencies>
<build>
<resources>
<!-- help bundles carry the artifact version (QQQ help bundle provenance) -->
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
<includes>
<include>help/*.yaml</include>
<include>qbit-collaboration.properties</include>
</includes>
</resource>
<resource>
<directory>src/main/resources</directory>
<filtering>false</filtering>
<excludes>
<exclude>help/*.yaml</exclude>
<exclude>qbit-collaboration.properties</exclude>
</excludes>
</resource>
</resources>
<plugins>
<!-- the artifact version, for the help bundle version test -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<systemPropertyVariables combine.children="append">
<qbit.artifactVersion>${project.version}</qbit.artifactVersion>
</systemPropertyVariables>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
@@ -196,14 +225,14 @@
<profiles>
<!-- Built against qqq 4.1 (QBitMetaDataProducer). Until qbit-build-parent -->
<!-- imports the released 4.1 BOM, this profile is active by default and -->
<!-- imports qqq-bom-pom 4.1.0-RC.6 ahead of the parent's 4.0.0 BOM. -->
<!-- imports qqq-bom-pom 4.1.0-RC.15 ahead of the parent's 4.0.0 BOM. -->
<profile>
<id>qqq-snapshot</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<qqq.snapshot.version>4.1.0-RC.6</qqq.snapshot.version>
<qqq.snapshot.version>4.1.0-RC.15</qqq.snapshot.version>
</properties>
<dependencyManagement>
<dependencies>
@@ -22,6 +22,9 @@
package com.kingsrook.qbits.collaboration;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import com.kingsrook.qbits.collaboration.app.CollaborationHome;
import com.kingsrook.qbits.collaboration.attachments.DeleteAttachmentsProcess;
import com.kingsrook.qbits.collaboration.model.CollaborationTables;
@@ -29,6 +32,7 @@ import com.kingsrook.qbits.collaboration.recents.TrimRecentsProcess;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerMultiOutput;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.help.bundles.HelpBundles;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSource;
import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaData;
@@ -43,13 +47,41 @@ public class CollaborationQBitProducer implements QBitMetaDataProducer<Collabora
{
public static final String GROUP_ID = "com.kingsrook.qbits";
public static final String ARTIFACT_ID = "qbit-collaboration";
public static final String VERSION = "0.1.0";
public static final String VERSION = loadVersion();
private CollaborationQBitConfig qBitConfig;
private String namespace;
/*******************************************************************************
** Read the artifact version from the Maven-filtered properties resource.
*******************************************************************************/
private static String loadVersion()
{
try(InputStream inputStream = CollaborationQBitProducer.class.getClassLoader().getResourceAsStream("qbit-collaboration.properties"))
{
if(inputStream == null)
{
throw new IllegalStateException("Missing qbit-collaboration.properties; build with Maven to generate the artifact version.");
}
Properties properties = new Properties();
properties.load(inputStream);
String version = properties.getProperty("version");
if(version == null || version.isBlank() || version.contains("${"))
{
throw new IllegalStateException("Missing or unfiltered version in qbit-collaboration.properties; build with Maven resource filtering.");
}
return (version);
}
catch(IOException e)
{
throw new IllegalStateException("Could not read the artifact version from qbit-collaboration.properties.", e);
}
}
/*******************************************************************************
** Configure the qbit.
*******************************************************************************/
@@ -151,6 +183,7 @@ public class CollaborationQBitProducer implements QBitMetaDataProducer<Collabora
com.kingsrook.qbits.collaboration.tags.TagProcesses.processesFor(table).forEach(output::add);
}
output.add(DeleteAttachmentsProcess.metadata());
output.add(FeatureSettingsDefaultsProcess.process());
for(QPossibleValueSource source : CollaborationTables.possibleValueSources())
{
output.add(source);
@@ -178,6 +211,8 @@ public class CollaborationQBitProducer implements QBitMetaDataProducer<Collabora
QAppMetaData parent = instance.getApp(qBitConfig.getParentAppName());
parent.withChild(instance.getApp(qBitConfig.getAppName()));
}
// Registration is metadata-only; core startup sync skips hosts without helpContent.
HelpBundles.register(instance, "help/qbit-collaboration.yaml");
return (new MetaDataProducerMultiOutput());
}
}
@@ -68,6 +68,7 @@ public final class CoreCollaboration
{
config.applyFeatures(instance);
var features = RecordFeaturesMetaData.ofOrWithNew(instance);
features.withFollowersProvider(new QCodeReference(com.kingsrook.qbits.collaboration.follow.CollaborationFollowersProvider.class));
features.withOverrideProvider(new QCodeReference(FeatureSettingsProvider.class));
features.getRuntimeProviders().add(new QCodeReference(com.kingsrook.qbits.collaboration.tags.TagsMetaDataProvider.class));
features.getRuntimeProviders().add(new QCodeReference(com.kingsrook.qbits.collaboration.customfields.CustomFieldsProvider.class));
@@ -0,0 +1,278 @@
/*
* 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.collaboration;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.kingsrook.qbits.collaboration.model.CollaborationTables;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
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.collaboration.FeaturePermissionMode;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordFeature;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordFeaturesMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
/*******************************************************************************
** The collaboration_feature_setting rows that say, in the database, exactly
** what the code configuration already says: one INSTANCE row per feature
** (enabled for the configured default features, disabled for the rest, with
** the default permission mode and the TAGS mode), plus an APP or TABLE row
** wherever the code declares something at that scope.
**
** Why rows computed at run time and not a SQL seed: the right rows depend on
** the host's configuration (withDefaultFeatures, withTableFeatures, the
** default tag mode, features declared on apps and tables), which SQL cannot
** see.
**
** Why every declaring scope gets its own row: runtime overrides are applied
** AFTER the code declarations, instance first, then app, then table. A bare
** INSTANCE row would therefore overwrite what a table declares in code.
** Restating each declaring scope in its own row keeps the resolved result of
** every table identical with and without the rows (FeatureSettingsDefaultsTest
** proves that for several configurations).
**
** Rows are only ever created when the table is empty, so they can never
** disagree with rows an administrator already wrote.
*******************************************************************************/
public final class FeatureSettingsDefaults
{
public static final String INSTANCE_SCOPE_NAME = "instance";
private static final ObjectMapper MAPPER = new ObjectMapper();
/*******************************************************************************
** Utility class.
*******************************************************************************/
private FeatureSettingsDefaults()
{
}
/*******************************************************************************
** The rows to create: the configured rows when the table is empty, none
** when an administrator already has rows.
*******************************************************************************/
public static List<QRecord> missingRows(QInstance instance, CollaborationQBitConfig config) throws QException
{
if(!CollaborationRecords.query(CollaborationTables.FEATURE_SETTING, new QQueryFilter().withLimit(1)).isEmpty())
{
return (List.of());
}
return (configuredRows(instance, config));
}
/*******************************************************************************
** Every row the configuration implies (whether or not it exists yet).
*******************************************************************************/
public static List<QRecord> configuredRows(QInstance instance, CollaborationQBitConfig config)
{
List<QRecord> rows = new ArrayList<>();
///////////////////////////////////////////////////////////
// instance: every feature, so each one has a visible row //
///////////////////////////////////////////////////////////
RecordFeaturesMetaData instanceLevel = RecordFeaturesMetaData.of(instance);
for(RecordFeature feature : RecordFeature.values())
{
Map<String, Serializable> settings = new LinkedHashMap<>(declaredSettings(instanceLevel, feature));
if(feature == RecordFeature.TAGS)
{
settings.putIfAbsent("mode", config.getDefaultTagMode());
}
FeaturePermissionMode mode = declaredMode(instanceLevel, feature);
rows.add(row("INSTANCE", INSTANCE_SCOPE_NAME, feature, enabledThrough(feature, instanceLevel), mode == null ? FeaturePermissionMode.EDIT_OR_GRANTED : mode, settings));
}
/////////////////////////////////////////////////////////////////////////////
// apps and tables: only where the code declares something for the feature //
/////////////////////////////////////////////////////////////////////////////
for(QAppMetaData app : CollectionUtils.nonNullMap(instance.getApps()).values())
{
RecordFeaturesMetaData level = RecordFeaturesMetaData.of(app);
for(RecordFeature feature : declared(level))
{
rows.add(row("APP", app.getName(), feature, enabledThrough(feature, instanceLevel, level), modeThrough(feature, instanceLevel, level), declaredSettings(level, feature)));
}
}
for(QTableMetaData table : CollectionUtils.nonNullMap(instance.getTables()).values())
{
if(table.getName().startsWith("collaboration_"))
{
continue;
}
RecordFeaturesMetaData level = RecordFeaturesMetaData.of(table);
List<RecordFeaturesMetaData> apps = new ArrayList<>();
for(QAppMetaData app : CollectionUtils.nonNullMap(instance.getApps()).values())
{
boolean contains = CollectionUtils.nonNullList(app.getSections()).stream().anyMatch(section -> CollectionUtils.nonNullList(section.getTables()).contains(table.getName()));
if(contains && RecordFeaturesMetaData.of(app) != null)
{
apps.add(RecordFeaturesMetaData.of(app));
}
}
///////////////////////////////////////////////////////////////////////////
// a table row restates the whole chain (instance, its apps, the table). //
// Needed where the table declares something itself, and where several //
// apps declare the same feature: one row per app cannot restate the //
// combination, but the last override, the table row, can. //
///////////////////////////////////////////////////////////////////////////
Set<RecordFeature> features = new TreeSet<>(declared(level));
if(apps.size() > 1)
{
apps.forEach(app -> features.addAll(declared(app)));
}
List<RecordFeaturesMetaData> chain = new ArrayList<>();
chain.add(instanceLevel);
chain.addAll(apps);
chain.add(level);
RecordFeaturesMetaData[] levels = chain.toArray(new RecordFeaturesMetaData[0]);
for(RecordFeature feature : features)
{
Map<String, Serializable> settings = new LinkedHashMap<>();
for(RecordFeaturesMetaData each : levels)
{
settings.putAll(declaredSettings(each, feature));
}
rows.add(row("TABLE", table.getName(), feature, enabledThrough(feature, levels), modeThrough(feature, levels), settings));
}
}
return (rows);
}
/*******************************************************************************
** The features a scope declares anything about (enabled, mode or settings).
*******************************************************************************/
private static Set<RecordFeature> declared(RecordFeaturesMetaData level)
{
if(level == null)
{
return (Set.of());
}
return (Stream.of(level.getEnabled().keySet(), level.getPermissionModes().keySet(), level.getSettings().keySet())
.flatMap(Set::stream).collect(Collectors.toCollection(TreeSet::new)));
}
/*******************************************************************************
** Enabled as the code resolves it through the given levels, in order, the
** same way core does (a later level that declares the feature wins).
*******************************************************************************/
private static boolean enabledThrough(RecordFeature feature, RecordFeaturesMetaData... levels)
{
boolean enabled = false;
for(RecordFeaturesMetaData level : levels)
{
if(level != null && level.getEnabled().containsKey(feature))
{
enabled = Boolean.TRUE.equals(level.getEnabled().get(feature));
}
}
return (enabled);
}
/*******************************************************************************
** The permission mode through the given levels (a later declaration wins),
** EDIT_OR_GRANTED when none declares one, as core resolves it.
*******************************************************************************/
private static FeaturePermissionMode modeThrough(RecordFeature feature, RecordFeaturesMetaData... levels)
{
FeaturePermissionMode mode = FeaturePermissionMode.EDIT_OR_GRANTED;
for(RecordFeaturesMetaData level : levels)
{
if(declaredMode(level, feature) != null)
{
mode = declaredMode(level, feature);
}
}
return (mode);
}
/*******************************************************************************
**
*******************************************************************************/
private static FeaturePermissionMode declaredMode(RecordFeaturesMetaData level, RecordFeature feature)
{
return (level == null ? null : level.getPermissionModes().get(feature));
}
/*******************************************************************************
**
*******************************************************************************/
private static Map<String, Serializable> declaredSettings(RecordFeaturesMetaData level, RecordFeature feature)
{
return (level == null || level.getSettings().get(feature) == null ? Map.of() : level.getSettings().get(feature));
}
/*******************************************************************************
** One feature_setting record; no settings means a null settings column.
*******************************************************************************/
private static QRecord row(String scopeType, String scopeName, RecordFeature feature, boolean enabled, FeaturePermissionMode mode, Map<String, Serializable> settings)
{
QRecord record = new QRecord().withValue("scopeType", scopeType).withValue("scopeName", scopeName).withValue("feature", feature.name())
.withValue("enabled", enabled).withValue("permissionMode", mode == null ? null : mode.name());
if(!settings.isEmpty())
{
try
{
record.withValue("settings", MAPPER.writeValueAsString(settings));
}
catch(JsonProcessingException e)
{
throw (new IllegalStateException("Feature settings are not serializable", e));
}
}
return (record);
}
}
@@ -0,0 +1,274 @@
/*
* 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.collaboration;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import com.kingsrook.qbits.collaboration.model.CollaborationTables;
import com.kingsrook.qbits.collaboration.permissions.CollaborationPermissions;
import com.kingsrook.qqq.backend.core.actions.QBackendTransaction;
import com.kingsrook.qqq.backend.core.actions.permissions.CustomPermissionChecker;
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
import com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput;
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.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QIcon;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.MetaDataWithPermissionRules;
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.QProcessMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractExtractStep;
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;
/*******************************************************************************
** "Create rows from configuration": a table action on Feature Settings that
** writes the code configuration out as editable rows (FeatureSettingsDefaults).
** It changes no behavior on its own, only makes the effective settings visible
** and editable. It does nothing once the table has any row. Standard streamed
** ETL: Review lists the rows that will be created, Result the rows created.
*******************************************************************************/
public final class FeatureSettingsDefaultsProcess
{
public static final String NAME = "collaborationCreateFeatureSettings";
/*******************************************************************************
** Utility class.
*******************************************************************************/
private FeatureSettingsDefaultsProcess()
{
}
/*******************************************************************************
** The process: a table-level action (no records need to be selected).
*******************************************************************************/
public static QProcessMetaData process()
{
Map<String, Serializable> values = new HashMap<>();
values.put(StreamedETLWithFrontendProcess.FIELD_SOURCE_TABLE, CollaborationTables.FEATURE_SETTING);
values.put(StreamedETLWithFrontendProcess.FIELD_DESTINATION_TABLE, CollaborationTables.FEATURE_SETTING);
values.put(StreamedETLWithFrontendProcess.FIELD_SUPPORTS_FULL_VALIDATION, false);
values.put(StreamedETLWithFrontendProcess.FIELD_PREVIEW_MESSAGE,
"These rows will be created from the current configuration. Nothing changes: the rows say what the configuration already says, and you can edit them afterwards.");
QProcessMetaData process = StreamedETLWithFrontendProcess.defineProcessMetaData(Extract.class, Transform.class, Load.class, values);
process.setName(NAME);
process.setLabel("Create rows from configuration");
process.setIcon(new QIcon("playlist_add"));
process.setTableName(CollaborationTables.FEATURE_SETTING);
process.setMinInputRecords(0);
process.setPermissionRules(new QPermissionRules().withLevel(PermissionLevel.HAS_ACCESS_PERMISSION).withPermissionBaseName("collaboration")
.withCustomPermissionChecker(new QCodeReference(AdminOnly.class)));
return (process);
}
/*******************************************************************************
** Collaboration administrators only (the table itself is admin-write).
*******************************************************************************/
public static class AdminOnly implements CustomPermissionChecker
{
/*******************************************************************************
**
*******************************************************************************/
@Override
public void checkPermissionsThrowing(AbstractActionInput input, MetaDataWithPermissionRules metadata) throws QPermissionDeniedException
{
QSession session = QContext.getQSession();
if(session == null || !session.hasPermission(CollaborationPermissions.ADMIN))
{
throw (new QPermissionDeniedException("This needs the " + CollaborationPermissions.ADMIN + " permission."));
}
}
}
/*******************************************************************************
** Extract: the configured rows (none when the table already has rows).
*******************************************************************************/
public static class Extract extends AbstractExtractStep
{
/*******************************************************************************
**
*******************************************************************************/
@Override
public Integer doCount(RunBackendStepInput input) throws QException
{
return (FeatureSettingsDefaults.missingRows(QContext.getQInstance(), CollaborationRecords.config()).size());
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void run(RunBackendStepInput input, RunBackendStepOutput output) throws QException
{
for(QRecord row : FeatureSettingsDefaults.missingRows(QContext.getQInstance(), CollaborationRecords.config()))
{
getRecordPipe().addRecord(row);
}
}
}
/*******************************************************************************
** Transform: counts by scope for the review screen.
*******************************************************************************/
public static class Transform extends AbstractTransformStep implements ProcessSummaryProviderInterface
{
private final Map<String, ProcessSummaryLine> byScope = new HashMap<>();
/*******************************************************************************
**
*******************************************************************************/
@Override
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
{
for(QRecord record : input.getRecords())
{
String scope = record.getValueString("scopeType");
byScope.computeIfAbsent(scope, s -> line(Status.OK, scope + " setting will be created", scope + " settings will be created",
scope + " setting was created", scope + " settings were created")).incrementCount();
output.getRecords().add(record);
}
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
{
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
byScope.values().forEach(line -> line.addSelfToListIfAnyCount(lines));
if(lines.isEmpty())
{
lines.add(new ProcessSummaryLine(Status.INFO, null, "Feature settings already has rows, so nothing was created. Edit the rows directly."));
}
return (lines);
}
}
/*******************************************************************************
** Load: insert through the standard action with the administrator's own session.
*******************************************************************************/
public static class Load extends AbstractLoadStep implements ProcessSummaryProviderInterface
{
private final ProcessSummaryLine created = line(Status.OK, "setting was created", "settings were created", "setting was created", "settings were created");
/*******************************************************************************
** One transaction for the whole load: the override refresh waits for the
** commit, so a failure on a later page can never leave some rows (for
** example Instance rows without the App and Table rows that restate the
** code) in effect.
*******************************************************************************/
@Override
public Optional<QBackendTransaction> openTransaction(RunBackendStepInput input) throws QException
{
return (Optional.of(QBackendTransaction.openFor(new InsertInput(CollaborationTables.FEATURE_SETTING))));
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
{
List<QRecord> inserted = new InsertAction().execute(new InsertInput(CollaborationTables.FEATURE_SETTING).withRecords(input.getRecords())
.withTransaction(getTransaction().orElse(null))).getRecords();
for(QRecord record : inserted)
{
if(record.getErrors() != null && !record.getErrors().isEmpty())
{
throw (new QException("Could not create feature settings: " + record.getErrors()));
}
created.incrementCount();
output.getRecords().add(record);
}
}
/*******************************************************************************
**
*******************************************************************************/
@Override
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
{
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
created.addSelfToListIfAnyCount(lines);
return (lines);
}
}
/*******************************************************************************
** A summary line with its four messages.
*******************************************************************************/
private static ProcessSummaryLine line(Status status, String singularFuture, String pluralFuture, String singularPast, String pluralPast)
{
ProcessSummaryLine line = new ProcessSummaryLine(status, 0, null);
line.setSingularFutureMessage(singularFuture);
line.setPluralFutureMessage(pluralFuture);
line.setSingularPastMessage(singularPast);
line.setPluralPastMessage(pluralPast);
return (line);
}
}
@@ -35,6 +35,7 @@ import com.kingsrook.qbits.collaboration.favorites.FavoriteEntry;
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.permissions.fieldaccess.FieldAccessHelper;
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;
@@ -55,7 +56,7 @@ import com.kingsrook.qqq.backend.core.utils.ValueUtils;
/*******************************************************************************
** Resolves targets only with released RC.5 APIs. Each list batches record label
** Resolves targets through core permission and field-access APIs. Each list batches record label
** refreshes by table, preserving table permissions and record security locks.
** Next accepts the flat /app/name/ routes, including dotted process names.
*******************************************************************************/
@@ -131,6 +132,17 @@ public final class TargetResolver
/*******************************************************************************
** Persist record labels only when all label fields are FULL for this session.
*******************************************************************************/
public static String cacheableLabel(FavoriteEntry target)
{
return ("RECORD".equals(target.targetType())
&& !FieldAccessHelper.isRecordLabelFullAccess(QContext.getQInstance().getTable(target.targetName())) ? null : target.label());
}
/*******************************************************************************
** One QueryAction per referenced record table; no cached labels escape.
*******************************************************************************/
@@ -52,7 +52,7 @@ public final class CollaborationApi
*******************************************************************************/
public static MiddlewareSpecExtension extension()
{
return (new MiddlewareSpecExtension().withName("collaboration").withSemanticVersion("1.0.0")
return (new MiddlewareSpecExtension().withName("collaboration").withSemanticVersion("1.1.0")
.withDescription("Record collaboration: favorites, recents, attachments, tags, conversations, following, timeline, people and presence")
.withSpec(PostPresenceSpec.class).withSpec(DeletePresenceSpec.class).withSpec(GetPresenceSpec.class)
.withSpec(ListFavoritesSpec.class)
@@ -46,6 +46,7 @@ import com.kingsrook.qqq.backend.core.exceptions.QBadRequestException;
import com.kingsrook.qqq.middleware.javalin.specs.BasicOperation;
import com.kingsrook.qqq.middleware.javalin.specs.BasicResponse;
import com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec;
import com.kingsrook.qqq.middleware.javalin.specs.v1.responses.BasicErrorResponseV1;
import com.kingsrook.qqq.openapi.model.HttpMethod;
import com.kingsrook.qqq.openapi.model.In;
import com.kingsrook.qqq.openapi.model.Parameter;
@@ -112,10 +113,10 @@ abstract class CollaborationJsonSpec extends AbstractJsonEndpointSpec
*******************************************************************************/
static List<BasicResponse> errors()
{
return (List.of(new BasicResponse(HttpStatus.BAD_REQUEST, "Invalid input", "CollaborationErrorV1"),
new BasicResponse(HttpStatus.UNAUTHORIZED, "Sign in required", "CollaborationErrorV1"),
new BasicResponse(HttpStatus.FORBIDDEN, "Permission denied", "CollaborationErrorV1"),
new BasicResponse(HttpStatus.NOT_FOUND, "Not found (including invisible parents)", "CollaborationErrorV1")));
return (List.of(new BasicResponse(HttpStatus.BAD_REQUEST, "Invalid input", BasicErrorResponseV1.class.getSimpleName()),
new BasicResponse(HttpStatus.UNAUTHORIZED, "Sign in required", BasicErrorResponseV1.class.getSimpleName()),
new BasicResponse(HttpStatus.FORBIDDEN, "Permission denied", BasicErrorResponseV1.class.getSimpleName()),
new BasicResponse(HttpStatus.NOT_FOUND, "Not found (including invisible parents)", BasicErrorResponseV1.class.getSimpleName())));
}
/*******************************************************************************
@@ -514,7 +514,7 @@ public final class CollaborationSchemas
@Override
public Schema toSchema()
{
return (new Schema().withType(Type.OBJECT).withDescription("Standard QQQ error response.").withProperties(new TreeMap<>(Map.ofEntries(
return (new Schema().withType(Type.OBJECT).withDescription("Deprecated since 1.1.0: errors use BasicErrorResponseV1.").withProperties(new TreeMap<>(Map.ofEntries(
Map.entry("error", new Schema().withType(Type.STRING).withDescription("Human-readable reason the operation failed.").withNullable(true))))));
}
}
@@ -714,6 +714,10 @@ public final class CollaborationSchemas
schemas.put("CollaborationCommentPostRequestV1", new CollaborationCommentPostRequestV1(null, null, null).toSchema());
schemas.put("CollaborationCommentEditRequestV1", new CollaborationCommentEditRequestV1(null).toSchema());
schemas.put("CollaborationFollowRequestV1", new CollaborationFollowRequestV1(null, null).toSchema());
schemas.put("CollaborationPresenceRequestV1", new CollaborationPresenceSchemas.CollaborationPresenceRequestV1(null, null, null, null, null).toSchema());
schemas.put("CollaborationPresenceLeaveV1", new CollaborationPresenceSchemas.CollaborationPresenceLeaveV1(null, null, null).toSchema());
schemas.put("CollaborationPresenceSnapshotV1", new CollaborationPresenceSchemas.CollaborationPresenceSnapshotV1(null, null, null).toSchema());
schemas.put("CollaborationPresenceViewerV1", new CollaborationPresenceSchemas.CollaborationPresenceViewerV1(null, null, null, null).toSchema());
schemas.putAll(CollaborationWorkSchemas.components());
return (schemas);
}
@@ -76,11 +76,12 @@ import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
*******************************************************************************/
public final class CollaborationHome
{
public static final String SETUP_WIDGET = "collaborationSetup";
public static final String KPI_WIDGET = "collaborationKpis";
public static final String TAGS_WIDGET = "collaborationTags";
public static final String FIELDS_WIDGET = "collaborationCustomFields";
public static final String PRESENCE_WIDGET = "collaborationWhosHere";
public static final List<String> HOME_WIDGETS = List.of(KPI_WIDGET, TAGS_WIDGET, FIELDS_WIDGET, PRESENCE_WIDGET);
public static final List<String> HOME_WIDGETS = List.of(SETUP_WIDGET, KPI_WIDGET, TAGS_WIDGET, FIELDS_WIDGET, PRESENCE_WIDGET);
public static final String NOBODY_HERE = "Nobody else is here right now.";
public static final String NO_TAGS = "No tags yet. Tags appear here once someone creates one on a record.";
@@ -120,6 +121,7 @@ public final class CollaborationHome
public static List<QWidgetMetaData> widgets()
{
return (List.of(
widget(SETUP_WIDGET, "Setup", WidgetType.TABLE, SetupRenderer.class),
widget(KPI_WIDGET, "Overview", WidgetType.MULTI_STATISTICS, KpiRenderer.class),
widget(TAGS_WIDGET, "Tags", WidgetType.TABLE, TagsRenderer.class),
widget(FIELDS_WIDGET, "Custom fields", WidgetType.TABLE, FieldsRenderer.class),
@@ -140,6 +142,30 @@ public final class CollaborationHome
/*******************************************************************************
** The Setup card: each record feature, whether it is on, for which tables,
** where that comes from, and the next step.
*******************************************************************************/
public static TableData setup() throws QException
{
CollaborationSecurity.ensureSessionKeys(QContext.getQInstance(), QContext.getQSession());
List<Map<String, Object>> rows = new ArrayList<>();
for(CollaborationSetupStatus.Item item : CollaborationSetupStatus.load(QContext.getQInstance()))
{
Map<String, Object> row = new LinkedHashMap<>();
row.put("feature", item.feature());
row.put("state", item.state());
row.put("where", item.where());
row.put("source", item.source());
row.put("next", item.nextStep() == null ? "" : item.nextStep());
rows.add(row);
}
return (table("Setup", "Nothing to set up.", rows, column("Feature", "feature", "left"), column("State", "state", "left"), column("Where", "where", "left"),
column("From", "source", "left"), column("Next step", "next", "left")));
}
/*******************************************************************************
** The KPI groups: conversations, work, files and custom fields.
*******************************************************************************/
@@ -200,7 +226,7 @@ public final class CollaborationHome
row.put("records", tag.getValueInteger("usageCount") == null ? 0 : tag.getValueInteger("usageCount"));
rows.add(row);
}
return (table("Tags", NO_TAGS, rows, column("Label", "label", "3fr", "left"), column("Table", "table", "2fr", "left"), column("Records", "records", "1fr", "right")));
return (table("Tags", NO_TAGS, rows, column("Label", "label", "left"), column("Table", "table", "left"), column("Records", "records", "right")));
}
@@ -224,8 +250,8 @@ public final class CollaborationHome
row.put("indexState", friendly(definition.getValueString("indexState")));
rows.add(row);
}
return (table("Custom fields", NO_FIELDS, rows, column("Name", "name", "3fr", "left"), column("Table", "table", "2fr", "left"),
column("Status", "status", "1fr", "left"), column("Index state", "indexState", "1fr", "left")));
return (table("Custom fields", NO_FIELDS, rows, column("Name", "name", "left"), column("Table", "table", "left"),
column("Status", "status", "left"), column("Index state", "indexState", "left")));
}
@@ -249,7 +275,7 @@ public final class CollaborationHome
rows.add(row);
});
}
return (table("Who's here", admin ? NOBODY_HERE : PRESENCE_ADMIN_ONLY, rows, column("Table", "table", "3fr", "left"), column("People", "viewers", "1fr", "right")));
return (table("Who's here", admin ? NOBODY_HERE : PRESENCE_ADMIN_ONLY, rows, column("Table", "table", "left"), column("People", "viewers", "right")));
}
@@ -267,9 +293,12 @@ public final class CollaborationHome
/*******************************************************************************
** A plain column; the frontend styles it.
*******************************************************************************/
private static TableData.Column column(String header, String accessor, String width, String align)
private static TableData.Column column(String header, String accessor, String align)
{
return (new TableData.Column("default", header, accessor, width, align));
//////////////////////////////////////////////////////////////////
// no width: frontends size the columns to fit narrow (390 px) cards //
//////////////////////////////////////////////////////////////////
return (new TableData.Column("default", header, accessor, null, align));
}
@@ -360,6 +389,23 @@ public final class CollaborationHome
/*******************************************************************************
** Setup renderer instantiated by QQQ.
*******************************************************************************/
public static class SetupRenderer extends AbstractWidgetRenderer
{
/*******************************************************************************
** Render using the current session.
*******************************************************************************/
@Override
public RenderWidgetOutput render(RenderWidgetInput input) throws QException
{
return (new RenderWidgetOutput(setup()));
}
}
/*******************************************************************************
** KPI renderer instantiated by QQQ.
*******************************************************************************/
@@ -0,0 +1,129 @@
/*
* 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.collaboration.app;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import com.kingsrook.qbits.collaboration.CollaborationRecords;
import com.kingsrook.qbits.collaboration.model.CollaborationTables;
import com.kingsrook.qqq.backend.core.actions.collaboration.RecordFeaturesResolver;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
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.collaboration.RecordFeature;
import com.kingsrook.qqq.backend.core.model.metadata.tables.Capability;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
/*******************************************************************************
** The Setup card on the Collaboration home: which record features are on, for
** which tables, and whether that comes from Feature Settings rows or from the
** code defaults. Uses the same resolution the runtime uses
** (RecordFeaturesResolver: code declarations, then the committed rows), so the
** card never reports something the runtime would not do.
*******************************************************************************/
public final class CollaborationSetupStatus
{
private static final int NAMED_TABLES = 5;
/*******************************************************************************
** One line of the card.
*******************************************************************************/
public record Item(String feature, String state, String where, String source, String nextStep)
{
}
/*******************************************************************************
** Utility class.
*******************************************************************************/
private CollaborationSetupStatus()
{
}
/*******************************************************************************
** One line for Feature Settings itself, then one per record feature.
*******************************************************************************/
public static List<Item> load(QInstance instance) throws QException
{
List<QRecord> rows = CollaborationRecords.query(CollaborationTables.FEATURE_SETTING, new QQueryFilter().withLimit(1000));
Set<String> featuresWithRows = new HashSet<>();
rows.forEach(row -> featuresWithRows.add(row.getValueString("feature")));
List<Item> items = new ArrayList<>();
items.add(rows.isEmpty()
? new Item("Feature settings", "Using code defaults", "-", "Configuration", "Run Create rows from configuration on Feature Settings to see and edit every setting.")
: new Item("Feature settings", "Set up", rows.size() + " row" + (rows.size() == 1 ? "" : "s"), "Feature Settings", null));
List<QTableMetaData> hostTables = CollectionUtils.nonNullMap(instance.getTables()).values().stream()
.filter(table -> !table.getName().startsWith("collaboration_") && !Boolean.TRUE.equals(table.getIsHidden()) && table.getPrimaryKeyField() != null
&& (table.isCapabilityEnabled(instance.getBackend(table.getBackendName()), Capability.TABLE_GET) || table.isCapabilityEnabled(instance.getBackend(table.getBackendName()), Capability.TABLE_QUERY)))
.sorted((a, b) -> a.getName().compareTo(b.getName())).toList();
for(RecordFeature feature : RecordFeature.values())
{
List<String> on = new ArrayList<>();
for(QTableMetaData table : hostTables)
{
if(RecordFeaturesResolver.resolve(instance, table).getFeatures().get(feature).getEnabled())
{
on.add(table.getLabel() == null ? table.getName() : table.getLabel());
}
}
String source = featuresWithRows.contains(feature.name()) ? "Feature Settings" : "Configuration";
String name = friendly(feature);
if(on.isEmpty())
{
items.add(new Item(name, "Off", "No table", source, "Add a Feature Settings row (scope INSTANCE, or TABLE for one table) and turn it on."));
}
else
{
boolean all = on.size() == hostTables.size();
String where = all ? "Every table" : String.join(", ", on.subList(0, Math.min(NAMED_TABLES, on.size()))) + (on.size() > NAMED_TABLES ? " and " + (on.size() - NAMED_TABLES) + " more" : "");
items.add(new Item(name, all ? "On" : "On for " + on.size() + " of " + hostTables.size() + " tables", where, source, null));
}
}
return (items);
}
/*******************************************************************************
** TAGS becomes Tags, CUSTOM_FIELDS becomes Custom fields.
*******************************************************************************/
static String friendly(RecordFeature feature)
{
String lower = feature.name().toLowerCase(Locale.ROOT).replace('_', ' ');
return (Character.toUpperCase(lower.charAt(0)) + lower.substring(1));
}
}
@@ -92,7 +92,7 @@ public final class DeleteAttachmentsProcess
*******************************************************************************/
public static class Review extends AbstractTransformStep implements ProcessSummaryProviderInterface
{
private final AttachmentsService service;
private AttachmentsService service;
private final ProcessSummaryLine selected = line(Status.OK, "will be deleted", "deleted");
private final ProcessSummaryLine skipped = line(Status.WARNING, "cannot be deleted (skipped)", "skipped");
@@ -101,7 +101,11 @@ public final class DeleteAttachmentsProcess
*******************************************************************************/
public Review()
{
this(new AttachmentsService());
//////////////////////////////////////////////////////////////////////////
// no QContext here: QQQ constructs steps during context-free instance //
// validation, so the service is created on first use (in a run) //
//////////////////////////////////////////////////////////////////////////
this(null);
}
/*******************************************************************************
@@ -112,6 +116,20 @@ public final class DeleteAttachmentsProcess
this.service = service;
}
/*******************************************************************************
** The attachments service, created on first use inside a run (QContext exists).
*******************************************************************************/
private AttachmentsService service()
{
if(service == null)
{
service = new AttachmentsService();
}
return (service);
}
/*******************************************************************************
** Dry run only; no object or row mutations.
*******************************************************************************/
@@ -122,7 +140,7 @@ public final class DeleteAttachmentsProcess
{
try
{
QRecord checked = service.requireMutable(row.getValue("id"));
QRecord checked = service().requireMutable(row.getValue("id"));
output.getRecords().add(checked);
selected.incrementCountAndAddPrimaryKey(checked.getValue("id"));
}
@@ -151,7 +169,7 @@ public final class DeleteAttachmentsProcess
*******************************************************************************/
public static class Delete extends AbstractLoadStep implements ProcessSummaryProviderInterface
{
private final AttachmentsService service;
private AttachmentsService service;
private final ProcessSummaryLine deleted = line(Status.OK, "will be deleted", "deleted");
private final ProcessSummaryLine failed = line(Status.ERROR, "could not be deleted", "could not be deleted (retry required)");
@@ -160,7 +178,11 @@ public final class DeleteAttachmentsProcess
*******************************************************************************/
public Delete()
{
this(new AttachmentsService());
//////////////////////////////////////////////////////////////////////////
// no QContext here: QQQ constructs steps during context-free instance //
// validation, so the service is created on first use (in a run) //
//////////////////////////////////////////////////////////////////////////
this(null);
}
/*******************************************************************************
@@ -171,6 +193,20 @@ public final class DeleteAttachmentsProcess
this.service = service;
}
/*******************************************************************************
** The attachments service, created on first use inside a run (QContext exists).
*******************************************************************************/
private AttachmentsService service()
{
if(service == null)
{
service = new AttachmentsService();
}
return (service);
}
/*******************************************************************************
** Count success only after both storage and row deletion succeed.
*******************************************************************************/
@@ -181,7 +217,7 @@ public final class DeleteAttachmentsProcess
{
try
{
service.delete(List.of(row.getValue("id")));
service().delete(List.of(row.getValue("id")));
deleted.incrementCountAndAddPrimaryKey(row.getValue("id"));
}
catch(QException | RuntimeException expected)
@@ -288,7 +288,7 @@ public class CommentsService
new FollowService().ensureFollower(user, table, id, "MENTIONED");
if(!user.equals(PersonalRecords.currentUserId()))
{
notify(row, user, CollaborationNotification.Category.MENTION, "You were mentioned in a comment", mention.getValueInteger("id"));
notify(row, user, CollaborationNotification.Category.MENTION, "You were mentioned in a comment on ", mention.getValueInteger("id"));
notified.add(user);
}
}
@@ -307,7 +307,7 @@ public class CommentsService
if(!author.equals(follower.userId()) && !mentioned.contains(follower.userId()) && Boolean.TRUE.equals(follower.notifyOnComment())
&& (follower.mutedUntil() == null || !follower.mutedUntil().isAfter(Instant.now())))
{
notify(row, follower.userId(), CollaborationNotification.Category.FOLLOW, "New comment on a followed record", null);
notify(row, follower.userId(), CollaborationNotification.Category.FOLLOW, "New comment on ", null);
}
}
}
@@ -317,7 +317,8 @@ public class CommentsService
*******************************************************************************/
private void notify(QRecord row, String user, CollaborationNotification.Category category, String title, Integer mentionId) throws QException
{
Notifications.send(new CollaborationNotification(user, title, row.getValueString("body"), category,
Notifications.send(new CollaborationNotification(user, title
+ new CollaborationRecordAccessChecker().notificationLabel(user, row.getValueString("tableName"), row.getValueString("recordId")), row.getValueString("body"), category,
row.getValueString("tableName"), row.getValueString("recordId"), Notifications.link(row.getValueString("tableName"), row.getValueString("recordId")))
.withEvent(mentionId == null ? row.getValue("id") : mentionId, PersonalRecords.currentUserId()),
mentionId == null ? null : () -> CollaborationRecords.update(CollaborationTables.MENTION,
@@ -70,7 +70,7 @@ public final class FavoritesService
.withOrderBy(new QFilterOrderBy("sortOrder", false)).withLimit(1));
Integer order = last.isEmpty() ? 0 : Math.addExact(last.getFirst().getValueInteger("sortOrder"), 1);
QRecord row = new QRecord().withValue("userId", userId).withValue("targetType", targetType).withValue("targetName", targetName)
.withValue("recordId", target.recordId()).withValue("label", target.label()).withValue("sortOrder", order);
.withValue("recordId", target.recordId()).withValue("label", TargetResolver.cacheableLabel(target)).withValue("sortOrder", order);
try
{
PersonalRecords.insert(CollaborationTables.FAVORITE, row);
@@ -0,0 +1,70 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.collaboration.follow;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qbits.collaboration.CollaborationRecords;
import com.kingsrook.qbits.collaboration.model.CollaborationTables;
import com.kingsrook.qqq.backend.core.actions.collaboration.RecordFollowersProviderInterface;
import com.kingsrook.qqq.backend.core.context.CapturedContext;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
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.collaboration.FollowEvent;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordFollower;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordReference;
import com.kingsrook.qqq.backend.core.model.session.QSystemUserSession;
/*******************************************************************************
** Core event subscribers; consumers must check each recipient's record access.
*******************************************************************************/
public class CollaborationFollowersProvider implements RecordFollowersProviderInterface
{
/*******************************************************************************
** Read only this parent's subscriptions as the system, independent of the caller.
*******************************************************************************/
@Override
public List<RecordFollower> getFollowers(QInstance instance, RecordReference reference, FollowEvent event) throws QException
{
List<RecordFollower> followers = new ArrayList<>();
QContext.withTemporaryContext(new CapturedContext(instance, new QSystemUserSession(instance)), () ->
{
Instant now = Instant.now();
String preference = event == FollowEvent.COMMENT ? "notifyOnComment" : "notifyOnChange";
for(QRecord row : CollaborationRecords.query(CollaborationTables.FOLLOW,
CollaborationRecords.parent(reference.tableName(), reference.primaryKey().toString())))
{
if(Boolean.TRUE.equals(row.getValueBoolean(preference))
&& (row.getValueInstant("mutedUntil") == null || !row.getValueInstant("mutedUntil").isAfter(now)))
{
followers.add(new RecordFollower().withUserId(row.getValueString("userId"))
.withNotifyOnChange(row.getValueBoolean("notifyOnChange")).withNotifyOnComment(row.getValueBoolean("notifyOnComment"))
.withReason(row.getValueString("reason")));
}
}
});
return (followers);
}
}
@@ -70,7 +70,7 @@ public final class RecentsService
if(existing.isEmpty())
{
QRecord row = new QRecord().withValue("userId", userId).withValue("targetType", targetType).withValue("targetName", targetName)
.withValue("recordId", target.recordId()).withValue("label", target.label()).withValue("lastViewedAt", now).withValue("viewCount", 1);
.withValue("recordId", target.recordId()).withValue("label", TargetResolver.cacheableLabel(target)).withValue("lastViewedAt", now).withValue("viewCount", 1);
try
{
PersonalRecords.insert(CollaborationTables.RECENT, row);
@@ -92,7 +92,7 @@ public final class RecentsService
return;
}
PersonalRecords.update(CollaborationTables.RECENT, List.of(new QRecord().withValue("id", row.getValue("id"))
.withValue("lastViewedAt", now).withValue("viewCount", Math.addExact(row.getValueInteger("viewCount"), 1)).withValue("label", target.label())));
.withValue("lastViewedAt", now).withValue("viewCount", Math.addExact(row.getValueInteger("viewCount"), 1)).withValue("label", TargetResolver.cacheableLabel(target))));
}
@@ -27,6 +27,7 @@ import java.util.concurrent.atomic.AtomicReference;
import com.kingsrook.qbits.collaboration.CollaborationQBitConfig;
import com.kingsrook.qbits.collaboration.CollaborationRecords;
import com.kingsrook.qqq.backend.core.actions.customizers.QCodeLoader;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessHelper;
import com.kingsrook.qqq.backend.core.actions.tables.GetAction;
import com.kingsrook.qqq.backend.core.context.CapturedContext;
import com.kingsrook.qqq.backend.core.context.QContext;
@@ -34,7 +35,6 @@ import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.exceptions.QNotFoundException;
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.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
/*******************************************************************************
@@ -90,8 +90,7 @@ public class CollaborationRecordAccessChecker implements com.kingsrook.qqq.backe
/*******************************************************************************
** The record label as the recipient may see it: empty unless a session for the
** recipient exists, the record is readable, and every label field is fully
** accessible (FieldAccessHelper.isRecordLabelFullAccess, absent in older QQQ
** versions, which means no label).
** accessible under the recipient session's field-access policy.
*******************************************************************************/
public Optional<String> recordLabel(String userId, String table, Serializable recordId) throws QException
{
@@ -111,7 +110,7 @@ public class CollaborationRecordAccessChecker implements com.kingsrook.qqq.backe
try
{
ParentRecordAccess.requireVisibleParent(table, recordId);
if(labelFullyAccessible(table))
if(FieldAccessHelper.isRecordLabelFullAccess(QContext.getQInstance().getTable(table)))
{
GetInput input = new GetInput(table).withPrimaryKey(recordId).withShouldGenerateDisplayValues(true);
QRecord record = new GetAction().executeForRecord(input);
@@ -127,18 +126,10 @@ public class CollaborationRecordAccessChecker implements com.kingsrook.qqq.backe
}
/*******************************************************************************
** Reflective guard: the helper only exists in QQQ versions with secured data.
** Notification titles fall back to public table metadata and the record id.
*******************************************************************************/
private static boolean labelFullyAccessible(String table)
public String notificationLabel(String userId, String table, Serializable recordId) throws QException
{
try
{
Class<?> helper = Class.forName("com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessHelper");
return (Boolean.TRUE.equals(helper.getMethod("isRecordLabelFullAccess", QTableMetaData.class).invoke(null, QContext.getQInstance().getTable(table))));
}
catch(ReflectiveOperationException | LinkageError e)
{
return (false);
}
return (recordLabel(userId, table, recordId).orElse(QContext.getQInstance().getTable(table).getLabel() + " #" + recordId));
}
}
@@ -97,7 +97,8 @@ public class SharingService
.withValue("recipientCouldRead", recipient.canRead()).withValue("sentAt", Instant.now()).withValue("parentDeleted", false));
if(Boolean.TRUE.equals(recipient.canRead()))
{
Notifications.send(new CollaborationNotification(recipient.userId(), name + " shared " + link.label() + " with you", message,
Notifications.send(new CollaborationNotification(recipient.userId(), name + " shared "
+ new CollaborationRecordAccessChecker().notificationLabel(recipient.userId(), table, id) + " with you", message,
CollaborationNotification.Category.SHARE, table, id, link.url()).withEvent(row.getValue("id"), from));
new FollowService().ensureFollower(recipient.userId(), table, id, "SHARED");
}
@@ -0,0 +1,748 @@
bundle: qbit-collaboration
version: ${project.version}
layer: QBIT
entries:
- key: widget:collaborationKpis;slot:label
summary: "See counts of collaboration activity and work you can access."
- key: widget:collaborationTags;slot:label
summary: "Browse tags and their usage from the Collaboration home."
- key: widget:collaborationCustomFields;slot:label
summary: "Review custom fields and their status from the Collaboration home."
- key: widget:collaborationWhosHere;slot:label
summary: "See who is currently present, when you have collaboration administrator access."
- key: widget:collaboration_field_definitionJoinCollaboration_field_value;slot:label
summary: "Review values associated with this custom field."
- key: widget:collaboration_tagJoinCollaboration_record_tag;slot:label
summary: "See records carrying this tag."
- key: widget:collaboration_commentJoinCollaboration_comment_revision;slot:label
summary: "Review earlier versions of this comment."
- key: widget:collaboration_commentJoinCollaboration_mention;slot:label
summary: "See people mentioned in this comment."
- key: widget:collaboration_commentJoinCollaboration_follow;slot:label
summary: "See followers of the record containing this comment."
- key: app:collaboration;slot:help
summary: "Work together through record comments, attachments, tags, tasks and sharing."
content: |
Use Collaboration to review discussions, files and work associated with records. Features are available where they have been enabled, and access still depends on the underlying record permissions. Open Feature Settings to review availability, People to find participants, or the content tables to review what has been created.
Use the Setup card to see which features are enabled and where their settings come from.
- key: table:collaboration_feature_setting;slot:help
summary: "Control which record features are available across the site, in an app or on a table."
content: |
**How rows get created**
Use Feature Settings to turn features such as Comments, Tags and Attachments on or off. Choose the Scope Type and Scope Name to identify where your setting applies, then select the Feature. Enabled controls availability, while Permission Mode controls who can use it. Settings holds additional options for that feature.
To start with your configured settings, run Create rows from configuration while this table is empty. Review the proposed rows before continuing. This action leaves existing rows untouched. You can then edit the rows to override the configuration.
- key: table:collaboration_feature_setting;field:scopeType
summary: "Choose whether the setting applies to the whole site, an app or a table."
- key: table:collaboration_feature_setting;field:scopeName
summary: "Choose the app or table the setting applies to."
- key: table:collaboration_feature_setting;field:feature
summary: "Choose the record feature you want to configure."
- key: table:collaboration_feature_setting;field:enabled
summary: "Whether this feature is available in the selected scope."
- key: table:collaboration_feature_setting;field:settings
summary: "Additional options for the selected feature, stored as JSON."
- key: table:collaboration_feature_setting;field:permissionMode
summary: "Choose whether editing permission or an explicit feature permission allows use."
content: |
Permission Mode controls which permission allows someone to use the selected feature. The edit-or-granted option accepts either table editing permission or the specific feature permission. The granted-only option requires the specific feature permission. You still need access to the record, and the feature must be enabled for its scope.
- key: table:collaboration_user;slot:help
summary: "Find the people used in mentions, sharing and assignments."
content: |
**How rows get created**
People is the directory used when you mention someone, share a record or assign work. Entries are maintained automatically as signed-in people use collaboration features. You can review their display names, contact details and activity here, but you cannot edit these directory records by hand.
- key: table:collaboration_user;field:userId
summary: "The person this entry belongs to."
- key: table:collaboration_user;field:displayName
summary: "The name you see when selecting or mentioning this person."
- key: table:collaboration_user;field:email
summary: "The email address recorded for this person."
- key: table:collaboration_user;field:avatarUrl
summary: "The address of the image used for this person."
- key: table:collaboration_user;field:lastSeenAt
summary: "When this person was last seen using collaboration features."
- key: table:collaboration_user;field:active
summary: "Whether this person is marked active in the directory."
- key: table:collaboration_favorite;slot:help
summary: "Keep track of the records, tables and apps you have starred."
content: |
**How rows get created**
Star a record, table or app to keep it among your Favorites. Each entry identifies the destination and stores your chosen label, folder and sort order. Favorites belong to individual people, so your list reflects your own choices. An empty list means you have not starred anything available here.
- key: table:collaboration_favorite;field:userId
summary: "The person this entry belongs to."
- key: table:collaboration_favorite;field:targetType
summary: "The kind of destination, such as a record, table or app."
- key: table:collaboration_favorite;field:targetName
summary: "The destination this entry opens."
- key: table:collaboration_favorite;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_favorite;field:label
summary: "The name shown to you for this entry."
- key: table:collaboration_favorite;field:sortOrder
summary: "The position used to order this entry."
- key: table:collaboration_favorite;field:folder
summary: "The folder used to group your favorites."
- key: table:collaboration_recent;slot:help
summary: "Find records you opened recently and see when you last viewed them."
content: |
**How rows get created**
Recently Viewed is filled automatically when you open records with Recents enabled. Each entry keeps the destination, your latest viewing time and the number of views. You do not need to create these entries yourself. Older entries are removed by Trim recents according to the configured retention limits.
- key: table:collaboration_recent;field:userId
summary: "The person this entry belongs to."
- key: table:collaboration_recent;field:targetType
summary: "The kind of destination, such as a record, table or app."
- key: table:collaboration_recent;field:targetName
summary: "The destination this entry opens."
- key: table:collaboration_recent;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_recent;field:label
summary: "The name shown to you for this entry."
- key: table:collaboration_recent;field:lastViewedAt
summary: "When you most recently opened this destination."
- key: table:collaboration_recent;field:viewCount
summary: "How many times you have opened this destination."
- key: table:collaboration_attachment;slot:help
summary: "Browse files attached to records, with their descriptions and storage details."
content: |
**How rows get created**
Upload a file through the Attachments panel on a record to create an attachment. You can review the file name, type, size and description here, together with its parent record. The file is stored separately from this entry. Attachments must be enabled for the parent table before you can add files.
- key: table:collaboration_attachment;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_attachment;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_attachment;field:fileName
summary: "The name of the attached file."
- key: table:collaboration_attachment;field:contentType
summary: "The file type reported for the attachment."
- key: table:collaboration_attachment;field:sizeBytes
summary: "The size of the attached file in bytes."
- key: table:collaboration_attachment;field:sha256
summary: "The file fingerprint used to identify its contents."
- key: table:collaboration_attachment;field:bucketName
summary: "The storage location holding the attached file."
- key: table:collaboration_attachment;field:storageKey
summary: "The location of the file within its storage bucket."
- key: table:collaboration_attachment;field:thumbnailKey
summary: "The location of the smaller preview image in storage."
- key: table:collaboration_attachment;field:description
summary: "A description that helps you understand this entry."
- key: table:collaboration_attachment;field:createdByUserId
summary: "The person who created this entry."
- key: table:collaboration_attachment;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_comment;slot:help
summary: "Read record discussions, including replies, authors and resolution details."
content: |
**How rows get created**
Write comments from the Comments panel on a record where Comments is enabled. A discussion can contain replies and can be resolved when it no longer needs attention. You can review the author, latest activity and resolution here. Earlier text from edited comments is retained in Comment History.
- key: table:collaboration_comment;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_comment;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_comment;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_comment;field:threadId
summary: "The opening comment of the discussion this reply belongs to."
- key: table:collaboration_comment;field:parentCommentId
summary: "The comment this reply answers."
- key: table:collaboration_comment;field:body
summary: "The text of the comment."
- key: table:collaboration_comment;field:fieldName
summary: "The record field this entry refers to."
- key: table:collaboration_comment;field:authorUserId
summary: "The person who wrote the comment."
- key: table:collaboration_comment;field:lastActivityAt
summary: "When the comment discussion was last active."
- key: table:collaboration_comment;field:editedAt
summary: "When the comment was edited."
- key: table:collaboration_comment;field:resolvedAt
summary: "When the discussion was marked resolved."
- key: table:collaboration_comment;field:resolvedByUserId
summary: "The person who resolved the discussion."
- key: table:collaboration_comment;field:deletedAt
summary: "When the comment was deleted."
- key: table:collaboration_comment;field:deletedByUserId
summary: "The person who deleted the comment."
- key: table:collaboration_comment_revision;slot:help
summary: "Review earlier text saved when comments were edited."
content: |
**How rows get created**
Comment History is filled automatically when someone edits a comment. Each entry identifies the comment, its earlier text, and who edited it and when. Use these records to understand how a discussion changed. An empty list means there are no recorded edits available for you to review.
- key: table:collaboration_comment_revision;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_comment_revision;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_comment_revision;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_comment_revision;field:commentId
summary: "The comment this entry refers to."
- key: table:collaboration_comment_revision;field:body
summary: "The earlier comment text retained for this edit."
- key: table:collaboration_comment_revision;field:editedAt
summary: "When the comment was edited."
- key: table:collaboration_comment_revision;field:editedByUserId
summary: "The person who edited the comment."
- key: table:collaboration_mention;slot:help
summary: "Track people mentioned in comments and whether their notices have been read."
content: |
**How rows get created**
Mention someone in a record comment to create a mention entry. You can review which comment named them, whether the mention is visible, and when they were notified or read it. These entries are maintained by the discussion features; you do not need to create them separately.
- key: table:collaboration_mention;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_mention;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_mention;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_mention;field:commentId
summary: "The comment this entry refers to."
- key: table:collaboration_mention;field:mentionedUserId
summary: "The person mentioned in the comment."
- key: table:collaboration_mention;field:visible
summary: "Whether the mention is visible to the mentioned person."
- key: table:collaboration_mention;field:readAt
summary: "When the mentioned person read the mention."
- key: table:collaboration_mention;field:notifiedAt
summary: "When a notification was sent for the mention."
- key: table:collaboration_follow;slot:help
summary: "See who follows a record and which changes they want to hear about."
content: |
**How rows get created**
Follow a record to receive updates about it where Follow is enabled. Your follower entry stores whether you want notices about changes and comments, along with any temporary mute. You can review why a person follows a record here. Following a record does not replace the permissions needed to read it.
- key: table:collaboration_follow;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_follow;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_follow;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_follow;field:userId
summary: "The person this entry belongs to."
- key: table:collaboration_follow;field:reason
summary: "Why this person follows the record."
- key: table:collaboration_follow;field:notifyOnChange
summary: "Whether the follower wants notifications about record changes."
- key: table:collaboration_follow;field:notifyOnComment
summary: "Whether the follower wants notifications about comments."
- key: table:collaboration_follow;field:mutedUntil
summary: "When the temporary pause in follower notifications ends."
- key: table:collaboration_activity;slot:help
summary: "Review the history of comments, files, tags, tasks and sharing on records."
content: |
**How rows get created**
Activity records what happens as you use collaboration features on a record. Each entry gives the time, the person involved, the kind of event and a short description. Turn on Timeline for the parent table to show this history on records. Activity entries are created automatically and cannot be edited here.
- key: table:collaboration_activity;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_activity;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_activity;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_activity;field:at
summary: "When the activity occurred."
- key: table:collaboration_activity;field:actorUserId
summary: "The person who performed the activity."
- key: table:collaboration_activity;field:type
summary: "The kind of activity recorded."
- key: table:collaboration_activity;field:summary
summary: "A short description of what happened."
- key: table:collaboration_activity;field:refTableName
summary: "The table holding the item referenced by this activity."
- key: table:collaboration_activity;field:refId
summary: "The identifier of the item referenced by this activity."
- key: table:collaboration_follow_digest;slot:help
summary: "Review grouped change notices waiting to be sent to followers."
content: |
**How rows get created**
As followed records change, entries are created automatically. You can review changes waiting to be sent together to someone following a record. Each entry identifies the recipient, the record and the time the notice is due. Send follow digests processes these pending notices. An empty list means no grouped changes are currently waiting here.
- key: table:collaboration_follow_digest;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_follow_digest;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_follow_digest;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_follow_digest;field:userId
summary: "The person this entry belongs to."
- key: table:collaboration_follow_digest;field:dueAt
summary: "When the grouped change notice is due to be sent."
- key: table:collaboration_follow_digest;field:changes
summary: "The changes collected for the next grouped notice."
- key: table:collaboration_tag;slot:help
summary: "Manage the labels people apply to records and their approval status."
content: |
**How rows get created**
Create or suggest a tag from a record to add it to the vocabulary. Use Tags to review the vocabulary available for labeling records. A tag can apply across tables or be limited to one table. Depending on Feature Settings, people can create tags freely or suggest tags for approval. Use Approve tags, Merge tags or Delete tags to manage the vocabulary.
- key: table:collaboration_tag;field:name
summary: "The stable name identifying the tag."
- key: table:collaboration_tag;field:label
summary: "The name shown to you for this entry."
- key: table:collaboration_tag;field:color
summary: "The color used to display the tag."
- key: table:collaboration_tag;field:tableName
summary: "The table this tag is limited to; blank means it is available across tables."
- key: table:collaboration_tag;field:approved
summary: "Whether the tag has been approved for use."
- key: table:collaboration_tag;field:description
summary: "A description that helps you understand this entry."
- key: table:collaboration_tag;field:createdByUserId
summary: "The person who created this entry."
- key: table:collaboration_tag;field:usageCount
summary: "How many records use the tag."
- key: table:collaboration_tag;field:mergedIntoTagId
summary: "The tag that replaced this one after a merge."
- key: table:collaboration_record_tag;slot:help
summary: "See which tags have been applied to each record."
content: |
**How rows get created**
Record Tags links a tag to a record and identifies who applied it. Entries are created when you tag a record or use Add tags on selected records. Tags must be enabled for the parent table. Use the record tagging controls to change these links rather than editing them directly.
- key: table:collaboration_record_tag;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_record_tag;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_record_tag;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_record_tag;field:tagId
summary: "The tag applied to this record."
- key: table:collaboration_record_tag;field:createdByUserId
summary: "The person who created this entry."
- key: table:collaboration_share;slot:help
summary: "Review records shared with people, including messages and opening times."
content: |
**How rows get created**
Share a record with someone from the record header to create a share entry. You can review the sender, recipient, message and the time the recipient opened it. Sharing must be enabled for that table. A share does not itself give the recipient permission to read the record.
- key: table:collaboration_share;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_share;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_share;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_share;field:fromUserId
summary: "The person who shared the record."
- key: table:collaboration_share;field:toUserId
summary: "The person the record was shared with."
- key: table:collaboration_share;field:message
summary: "The message accompanying the share or access request."
- key: table:collaboration_share;field:recipientCouldRead
summary: "Whether the recipient could read the record when it was shared."
- key: table:collaboration_share;field:sentAt
summary: "When the record was shared."
- key: table:collaboration_share;field:openedAt
summary: "When the recipient opened the share."
- key: table:collaboration_access_request;slot:help
summary: "Review requests to open records and record how those requests were handled."
content: |
**How rows get created**
When you cannot open a shared record, you can request access. Approvers review the request and record their decision with Mark granted or Decline. Grant the required permissions separately before marking a request granted; this action only records the outcome. The request keeps the handler, time and any response note.
- key: table:collaboration_access_request;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_access_request;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_access_request;field:requesterUserId
summary: "The person asking for access to the record."
- key: table:collaboration_access_request;field:shareId
summary: "The share associated with this access request."
- key: table:collaboration_access_request;field:message
summary: "The message accompanying the share or access request."
- key: table:collaboration_access_request;field:status
summary: "Whether the request is open, granted, declined or withdrawn."
- key: table:collaboration_access_request;field:handledByUserId
summary: "The person who answered the access request."
- key: table:collaboration_access_request;field:handledAt
summary: "When the access request was answered."
- key: table:collaboration_access_request;field:note
summary: "The response note recorded when the request was handled."
- key: table:collaboration_task;slot:help
summary: "Track record tasks, assignees, due dates, reminders and completion."
content: |
**How rows get created**
Add a task from the Tasks panel on a record where Tasks is enabled. Give it a title and assign it to someone, with a due date or reminder when needed. Use Mark done when the work is complete and Reopen if it needs more work. Reminder times and completion details are recorded here.
- key: table:collaboration_task;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_task;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_task;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_task;field:title
summary: "A short description of the work to do."
- key: table:collaboration_task;field:notes
summary: "Additional details about the task."
- key: table:collaboration_task;field:assigneeUserId
summary: "The person assigned to work on the record or task."
- key: table:collaboration_task;field:dueAt
summary: "When the task is due."
- key: table:collaboration_task;field:remindAt
summary: "When a task reminder should be sent."
- key: table:collaboration_task;field:remindedAt
summary: "When the task reminder was sent."
- key: table:collaboration_task;field:overdueNotifiedAt
summary: "When an overdue task notification was sent."
- key: table:collaboration_task;field:status
summary: "Whether the task is open, done or cancelled."
- key: table:collaboration_task;field:completedAt
summary: "When the task was marked done."
- key: table:collaboration_task;field:completedByUserId
summary: "The person who marked the task done."
- key: table:collaboration_task;field:createdByUserId
summary: "The person who created this entry."
- key: table:collaboration_record_assignment;slot:help
summary: "See who owns each record and who is assigned to work on it."
content: |
**How rows get created**
Record Owners keeps the owner and assignee associated with a record. You make these assignments through the record controls where Assignment is enabled. Ownership and assignment are separate roles, so you can review both here. The entry links back to the parent record and follows its access restrictions.
- key: table:collaboration_record_assignment;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_record_assignment;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_record_assignment;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_record_assignment;field:ownerUserId
summary: "The person responsible for the record."
- key: table:collaboration_record_assignment;field:assigneeUserId
summary: "The person assigned to work on the record or task."
- key: table:collaboration_field_definition;slot:help
summary: "Define additional fields for a table and manage their publication and validation."
content: |
**How rows get created**
Create a definition in Custom Fields to add information to a table without changing its built-in fields. Choose the table, name, label and type, then set any validation or display options. Use {{label:collaborationPublishField}} to activate a draft. Rebuild index and Archive field manage existing active fields. Custom Fields must be enabled on the table.
- key: table:collaboration_field_definition;field:tableName
summary: "The table you are adding the custom field to."
- key: table:collaboration_field_definition;field:name
summary: "The stable name identifying the custom field."
- key: table:collaboration_field_definition;field:label
summary: "The label you see beside the custom field."
- key: table:collaboration_field_definition;field:type
summary: "The kind of value the custom field accepts."
- key: table:collaboration_field_definition;field:options
summary: "The choices available for a selection field, stored as JSON."
- key: table:collaboration_field_definition;field:linkTableName
summary: "The table you can select records from for a record link."
- key: table:collaboration_field_definition;field:required
summary: "Whether you must supply a value for the custom field."
- key: table:collaboration_field_definition;field:defaultValue
summary: "The initial value offered for the custom field."
- key: table:collaboration_field_definition;field:minValue
summary: "The smallest allowed numeric value."
- key: table:collaboration_field_definition;field:maxValue
summary: "The largest allowed numeric value."
- key: table:collaboration_field_definition;field:maxLength
summary: "The maximum number of characters allowed."
- key: table:collaboration_field_definition;field:helpText
summary: "The guidance shown when you fill in the custom field."
- key: table:collaboration_field_definition;field:sectionName
summary: "The section where the custom field is displayed."
- key: table:collaboration_field_definition;field:sortOrder
summary: "The position used to order this entry."
- key: table:collaboration_field_definition;field:filterable
summary: "Whether the custom field is available for filtering."
- key: table:collaboration_field_definition;field:searchable
summary: "Whether the custom field is available for searching."
- key: table:collaboration_field_definition;field:classification
summary: "The sensitivity assigned to information stored in the custom field."
- key: table:collaboration_field_definition;field:status
summary: "Whether the custom field is a draft, active or archived."
content: |
New custom fields start as drafts. Review the definition and use Publish field to make a draft active. Use Archive field when an active definition should no longer be active. You change this status through those actions rather than editing it directly; each action checks the current state before applying the change.
- key: table:collaboration_field_definition;field:indexState
summary: "Whether preparation for filtering is absent, building, ready or failed."
- key: table:collaboration_field_definition;field:storage
summary: "The storage method used for this custom field."
- key: table:collaboration_field_definition;field:statusMessage
summary: "The latest explanation or warning about the custom field."
- key: table:collaboration_field_definition;field:indexDdl
summary: "The database instructions used to prepare the field for filtering."
- key: table:collaboration_field_definition;field:createdByUserId
summary: "The person who created this entry."
- key: table:collaboration_field_value;slot:help
summary: "Review values entered into custom fields on records."
content: |
**How rows get created**
Custom Field Values stores entries made through custom fields on records when separate value storage is used. Each entry identifies its parent record and field, with the value stored according to its type. You enter or change values on the parent record; these supporting records are read-only here.
- key: table:collaboration_field_value;field:tableName
summary: "The table containing the related record."
- key: table:collaboration_field_value;field:recordId
summary: "The identifier of the related record."
- key: table:collaboration_field_value;field:parentDeleted
summary: "Whether the related record has been deleted."
- key: table:collaboration_field_value;field:fieldName
summary: "The record field this entry refers to."
- key: table:collaboration_field_value;field:valueText
summary: "The text stored for the custom field."
- key: table:collaboration_field_value;field:valueNumber
summary: "The numeric value stored for the custom field."
- key: table:collaboration_field_value;field:valueDate
summary: "The date stored for the custom field."
- key: table:collaboration_field_value;field:valueDateTime
summary: "The date and time stored for the custom field."
- key: table:collaboration_field_value;field:valueBoolean
summary: "The yes or no value stored for the custom field."
- key: process:collaborationTrimRecents;slot:help
summary: "Remove older Recently Viewed entries according to the configured limits."
content: |
Trim recents maintains Recently Viewed by removing older entries according to the configured per-person count limit. It works on viewing history, so it does not delete the records you opened. Use Recently Viewed to review the retained history after cleanup has run. Automatic cleanup requires your host to configure a scheduler.
- key: process:collaborationBuildFieldIndexes;slot:help
summary: "Prepare active custom fields for filtering."
content: |
Build field indexes performs the background preparation needed for filtering custom fields. You can review Index State and Status Message in Custom Fields to see whether preparation is complete or needs attention. These supporting details help you distinguish a field definition from a field that is ready for filtering.
- key: process:collaborationPublishField;slot:help
summary: "Make selected draft custom fields active."
content: |
Select draft definitions in Custom Fields and use Publish field when their labels, types and validation are ready. Custom Fields must be enabled for the target table. Review the selected definitions before continuing, then read the results for each field; a failed field does not prevent the others from being processed.
- key: process:collaborationArchiveField;slot:help
summary: "Archive selected active custom fields."
content: |
Select active definitions in Custom Fields and use Archive field when they should no longer be active. Review the affected values before continuing. The action checks each selected definition and reports its outcome separately. Read the result for each field so you can distinguish archived definitions from those that could not be changed.
- key: process:collaborationRebuildField;slot:help
summary: "Rebuild filtering support for selected active custom fields."
content: |
Use Rebuild index on active custom fields when their filtering support needs to be prepared again. Review the selected definitions before continuing. After the action, check Index State and Status Message for progress or problems. The result reports each selected field separately, so review any failures before retrying.
- key: process:collaborationSendTaskReminders;slot:help
summary: "Send due task reminders and overdue notifications."
content: |
Send task reminders checks tasks for reminders that are due and work that has become overdue. You choose Due At and Remind At on the task; Reminded At and Overdue Notified At record notices already sent. Review those times when checking why a task has or has not produced a notification.
- key: process:collaborationGrant_collaboration_access_request;slot:help
summary: "Record that selected access requests have been granted."
content: |
Grant the person the required access in your permission system first, then use Mark granted to record the outcome of the request. You can add a Note for the requester. Review the selected requests before continuing. This action records the decision, handler and time; it does not change record permissions.
- key: process:collaborationDecline_collaboration_access_request;slot:help
summary: "Decline selected access requests and record your response."
content: |
Use Decline when an access request should not be approved. You can add a Note explaining the decision before reviewing the selected requests. Only requests you are permitted to handle can be processed. Read the results to confirm which decisions were recorded and which requests were skipped.
- key: process:collaborationDone_collaboration_task;slot:help
summary: "Mark selected tasks done and record their completion."
content: |
Use Mark done after the work described by a task is finished. Review the selected tasks before continuing, then check the results for any tasks you could not change. Completion records who finished the task and when. If more work is needed later, use Reopen on the task.
- key: process:collaborationReopen_collaboration_task;slot:help
summary: "Return selected tasks to open status."
content: |
Use Reopen when a completed task needs more work. Select the tasks and review them before continuing. The action checks whether you can manage each task and reports skipped records separately. Afterward, review the task status and its existing assignment and timing details before continuing the work.
- key: process:collaborationSendFollowDigests;slot:help
summary: "Send grouped change notices that are due for followers."
content: |
Send follow digests processes pending groups of record changes for followers. Each Follow Digests entry identifies the record, recipient and due time. Use that list to review notices waiting to be sent. An empty list means no grouped notices are waiting there; it does not mean the record has no followers.
- key: process:collaborationApproveTags;slot:help
summary: "Approve selected tags for use on records."
content: |
Use Approve tags to make suggested tags available in an approval-based vocabulary. Select the tags you want to approve and review the selection before continuing. You need permission to manage tags. Check the result for skipped or unchanged tags, then review Approved in the Tags list.
- key: process:collaborationMergeTags;slot:help
summary: "Combine selected tags into a chosen target tag."
content: |
Use Merge tags when several tags should be represented by one approved tag. Choose the Target tag and review the selected source tags before continuing. The action moves their record assignments to the target. Review the results and the remaining vocabulary before applying the target tag to more records.
- key: process:collaborationDeleteTags;slot:help
summary: "Delete selected tags and remove their record assignments."
content: |
Use Delete tags when tags should be removed from the vocabulary. Review the selected tags and the records that will lose tag assignments before continuing. You need permission to manage tags. This removes tag assignments from the affected records; it does not delete the records themselves.
- key: process:collaborationDeleteAttachments;slot:help
summary: "Delete selected attachments from their records."
content: |
Select the attachments you want to remove and use Delete attachments. Review the selection before continuing, especially the parent records and file names. The action checks whether you can remove each attachment. Read the results afterward to see which attachments were deleted and which could not be processed.
- key: table:collaboration_feature_setting;section:identity
summary: "The identifying details for this entry."
- key: table:collaboration_feature_setting;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_feature_setting;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_user;section:identity
summary: "The identifying details for this entry."
- key: table:collaboration_user;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_user;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_favorite;section:identity
summary: "The identifying details for this entry."
- key: table:collaboration_favorite;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_favorite;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_recent;section:identity
summary: "The identifying details for this entry."
- key: table:collaboration_recent;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_recent;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_attachment;section:file
summary: "The attached file and its description."
- key: table:collaboration_attachment;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_attachment;section:storage
summary: "The storage details and preparation status for this entry."
- key: table:collaboration_attachment;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_comment;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_comment;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_comment;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_comment_revision;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_comment_revision;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_comment_revision;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_mention;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_mention;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_mention;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_follow;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_follow;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_follow;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_activity;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_activity;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_activity;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_follow_digest;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_follow_digest;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_follow_digest;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_tag;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_tag;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_record_tag;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_record_tag;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_record_tag;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_share;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_share;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_share;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_access_request;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_access_request;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_task;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_task;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_task;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_record_assignment;section:details
summary: "The settings and details associated with this entry."
- key: table:collaboration_record_assignment;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_record_assignment;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_field_definition;section:definition
summary: "The custom field identity, type and publication status."
- key: table:collaboration_field_definition;section:settings
summary: "The custom field choices, validation and display settings."
- key: table:collaboration_field_definition;section:storage
summary: "The storage details and preparation status for this entry."
- key: table:collaboration_field_definition;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_field_value;section:value
summary: "The value entered for the custom field."
- key: table:collaboration_field_value;section:parent
summary: "The record this entry belongs to and whether that record was deleted."
- key: table:collaboration_field_value;section:dates
summary: "When this entry was created and last changed."
- key: table:collaboration_field_definition;section:values
summary: "Review stored values associated with this custom field."
- key: table:collaboration_tag;section:recordTags
summary: "See which records carry this tag."
- key: table:collaboration_comment;section:collaboration_comment_revision
summary: "Review earlier versions of this comment."
- key: table:collaboration_comment;section:collaboration_mention
summary: "See people mentioned in this comment."
- key: table:collaboration_comment;section:collaboration_follow
summary: "See who follows the record containing this comment."
- key: widget:collaborationSetup;slot:label
summary: "See which record features are enabled and where their settings come from."
- key: process:collaborationCreateFeatureSettings;slot:help
summary: "Create editable feature settings from your current configuration."
content: |
Run Create rows from configuration in {{label:collaboration_feature_setting}} when the table is empty. Review the proposed settings before continuing. You need collaboration administrator access.
The action creates the settings already declared by your configuration. It does not overwrite existing rows. After creating rows, edit them to change feature availability; saved settings override the code configuration.
- key: possibleValueSource:collaboration_feature_setting;slot:help
summary: "Control which record features are available across the site, in an app or on a table."
- key: possibleValueSource:collaboration_user;slot:help
summary: "Find the people used in mentions, sharing and assignments."
- key: possibleValueSource:collaboration_favorite;slot:help
summary: "Keep track of the records, tables and apps you have starred."
- key: possibleValueSource:collaboration_recent;slot:help
summary: "Find records you opened recently and see when you last viewed them."
- key: possibleValueSource:collaboration_attachment;slot:help
summary: "Browse files attached to records, with their descriptions and storage details."
- key: possibleValueSource:collaboration_comment;slot:help
summary: "Read record discussions, including replies, authors and resolution details."
- key: possibleValueSource:collaboration_comment_revision;slot:help
summary: "Review earlier text saved when comments were edited."
- key: possibleValueSource:collaboration_mention;slot:help
summary: "Track people mentioned in comments and whether their notices have been read."
- key: possibleValueSource:collaboration_follow;slot:help
summary: "See who follows a record and which changes they want to hear about."
- key: possibleValueSource:collaboration_activity;slot:help
summary: "Review the history of comments, files, tags, tasks and sharing on records."
- key: possibleValueSource:collaboration_follow_digest;slot:help
summary: "Review grouped change notices waiting to be sent to followers."
- key: possibleValueSource:collaboration_tag;slot:help
summary: "Manage the labels people apply to records and their approval status."
- key: possibleValueSource:collaboration_record_tag;slot:help
summary: "See which tags have been applied to each record."
- key: possibleValueSource:collaboration_share;slot:help
summary: "Review records shared with people, including messages and opening times."
- key: possibleValueSource:collaboration_access_request;slot:help
summary: "Review requests to open records and record how those requests were handled."
- key: possibleValueSource:collaboration_task;slot:help
summary: "Track record tasks, assignees, due dates, reminders and completion."
- key: possibleValueSource:collaboration_record_assignment;slot:help
summary: "See who owns each record and who is assigned to work on it."
- key: possibleValueSource:collaboration_field_definition;slot:help
summary: "Define additional fields for a table and manage their publication and validation."
- key: possibleValueSource:collaboration_field_value;slot:help
summary: "Review values entered into custom fields on records."
- key: possibleValueSource:collaboration_field_type;slot:help
summary: "Choose the kind of value your custom field accepts."
- key: possibleValueSource:collaboration_field_status;slot:help
summary: "Choose whether a custom field is a draft, active or archived."
- key: possibleValueSource:collaboration_field_index_state;slot:help
summary: "Review whether filtering support is absent, building, ready or failed."
- key: possibleValueSource:collaboration_field_classification;slot:help
summary: "Choose the sensitivity of information stored in the custom field."
- key: possibleValueSource:collaboration_custom_field_tables;slot:help
summary: "Choose a table configured to support custom fields."
- key: possibleValueSource:collaboration_scope_name;slot:help
summary: "Choose an app or table for the selected scope, or the whole instance."
- key: possibleValueSource:collaboration_record_field_name;slot:help
summary: "Choose a visible field from the selected table."
- key: possibleValueSource:collaboration_access_request_status;slot:help
summary: "Review whether an access request is open, granted, declined or withdrawn."
- key: possibleValueSource:collaboration_task_status;slot:help
summary: "Review whether a task is open, done or cancelled."
- key: possibleValueSource:collaboration_target_type;slot:help
summary: "Choose the kind of destination you want to save."
- key: possibleValueSource:collaboration_scope_type;slot:help
summary: "Choose whether a setting applies to the whole instance, an app or a table."
- key: possibleValueSource:collaboration_feature;slot:help
summary: "Choose the record feature you want to configure."
- key: possibleValueSource:collaboration_permission_mode;slot:help
summary: "Choose whether a feature accepts editing permission or requires an explicit feature permission."
File diff suppressed because it is too large. Load diff
@@ -0,0 +1 @@
version=${project.version}
@@ -29,6 +29,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule;
import com.kingsrook.qqq.middleware.javalin.specs.extensions.MiddlewareSpecExtensionsMetaData;
import com.kingsrook.qqq.middleware.javalin.specs.v1.MiddlewareVersionV1;
import com.kingsrook.qqq.middleware.javalin.specs.v1.responses.BasicErrorResponseV1;
import com.kingsrook.qqq.middleware.javalin.tools.UiApiContract;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
@@ -56,7 +57,7 @@ class CollaborationApiContractTest
assertThat(UiApiContract.check(generated, Files.readString(path), null, 1,
"mvnw.cmd -o -q -Dtest=CollaborationApiContractTest -Dcollaboration.openapi.update=true test")).isEmpty();
var model = version.generateExtensionOpenAPIModel("qqq", extension);
assertThat(model.getComponents().getSchemas().keySet()).allMatch(name -> name.startsWith("Collaboration"));
assertThat(model.getComponents().getSchemas().keySet()).allMatch(name -> name.startsWith("Collaboration") || name.equals(BasicErrorResponseV1.class.getSimpleName()));
assertThat(model.getPaths().keySet()).allMatch(pathName -> pathName.startsWith("/qqq/v1/qbit/collaboration/"));
assertThat(generated).contains("multipart/form-data", "format: \"binary\"", "clients follow url", "nextCursor");
assertThat(extension.getSpecs()).hasSize(45);
@@ -37,6 +37,7 @@ import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.kingsrook.qbits.collaboration.attachments.AttachmentStorage;
import com.kingsrook.qbits.objectstorage.api.PresignGet;
import com.kingsrook.qbits.objectstorage.api.PutRequest;
@@ -431,8 +432,16 @@ class CollaborationApiHttpTest extends PersonalServiceFixture
HttpResponse<String> hidden = request("GET", "/records/document/3/" + feature, null, "alice");
HttpResponse<String> absent = request("GET", "/records/document/999/" + feature, null, "alice");
assertThat(hidden.statusCode()).isEqualTo(404);
assertThat(hidden.body()).isEqualTo(absent.body());
assertThat(json(hidden, 404).get("error").asText()).isEqualTo("Not found");
ObjectNode hiddenError = (ObjectNode) json(hidden, 404);
ObjectNode absentError = (ObjectNode) json(absent, 404);
assertThat(hiddenError.path("traceId").asText()).isNotBlank();
assertThat(absentError.path("traceId").asText()).isNotBlank();
hiddenError.remove("traceId");
absentError.remove("traceId");
assertThat(hiddenError).isEqualTo(absentError);
assertThat(hiddenError.path("error").asText()).isEqualTo("Not found");
assertThat(hiddenError.path("code").asText()).isEqualTo("NOT_FOUND");
assertThat(hiddenError.path("message").asText()).isEqualTo("Not found");
}
assertError(404, "POST", "/records/document/3/comments", "not json", "alice");
assertError(404, "GET", "/mentions/candidates?table=document&pk=3", null, "alice");
@@ -500,15 +509,19 @@ class CollaborationApiHttpTest extends PersonalServiceFixture
JsonNode version = json(client.send(HttpRequest.newBuilder(URI.create(serverUrl + "/qqq/v1/version")).GET().build(),
HttpResponse.BodyHandlers.ofString()), 200);
assertThat(version.at("/extensions/0/name").asText()).isEqualTo("collaboration");
assertThat(version.at("/extensions/0/version").asText()).isEqualTo("1.0.0");
assertThat(version.at("/extensions/0/version").asText()).isEqualTo("1.1.0");
}
/*******************************************************************************
** Framework errors always contain a human-readable error property.
** Framework errors include the standard message, code and request trace.
*******************************************************************************/
private void assertError(int status, String method, String path, String body, String caller) throws Exception
{
assertThat(json(request(method, path, body, caller), status).get("error").asText()).isNotBlank();
var error = json(request(method, path, body, caller), status);
assertThat(error.path("error").asText()).isNotBlank();
assertThat(error.path("code").asText()).isNotBlank();
assertThat(error.path("message").asText()).isNotBlank();
assertThat(error.path("traceId").asText()).isNotBlank();
}
/*******************************************************************************
@@ -0,0 +1,62 @@
/*
* 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.collaboration;
import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.help.bundles.HelpBundles;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule;
import com.kingsrook.qqq.backend.core.testing.HelpBundleAssertions;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Coverage of metadata produced by this qbit, before core adds its own bulk actions.
*******************************************************************************/
class CollaborationHelpBundleTest
{
/*******************************************************************************
** Every owned object resolves and has help, without host-specific providers.
*******************************************************************************/
@Test
void bundleCoversProducedMetadata() throws Exception
{
QInstance instance = new QInstance();
instance.addBackend(new QBackendMetaData().withName("memory").withBackendType(MemoryBackendModule.class));
new CollaborationQBitProducer().withQBitConfig(new CollaborationQBitConfig().withBackendName("memory")).produce(instance);
HelpBundleAssertions.forInstance(instance)
.bundles("help/qbit-collaboration.yaml")
.owning(target -> target.name().startsWith("collaboration"))
.assertComplete();
var entries = HelpBundles.of(instance).getBundles().getFirst().getEntries();
assertThat(entries).extracting(entry -> entry.getKey()).doesNotHaveDuplicates();
// Core's gate requires tables, fields, apps and processes; also cover our widgets and selectors.
instance.getWidgets().keySet().forEach(name -> assertThat(entries)
.anyMatch(entry -> entry.getKey().equals("widget:" + name + ";slot:label")));
instance.getPossibleValueSources().keySet().stream().filter(name -> name.startsWith("collaboration")).forEach(name -> assertThat(entries)
.anyMatch(entry -> entry.getKey().equals("possibleValueSource:" + name + ";slot:help")));
}
}
@@ -0,0 +1,223 @@
/*
* 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.collaboration;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import com.kingsrook.qqq.backend.core.model.metadata.help.bundles.HelpBundleEntry;
import com.kingsrook.qqq.backend.core.model.metadata.help.bundles.HelpBundles;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Guardrail (owner requirement 2026-10-14: "all tables should be populated and
** the qbit should be fully using them"). For every collaboration_* table:
** - runtime code (not just its model, metadata or home screen) reads or writes
** it, so no table exists only on paper;
** - it is either seeded (feature settings: FeatureSettingsDefaults, from the
** configuration at run time) or listed here with why it starts empty;
** - it has bundle help that says what it is for and how its rows get created.
** A new table fails this test until it is wired, seeded or explained.
*******************************************************************************/
class CollaborationTablesGuardrailTest extends PersonalServiceFixture
{
private static final Path MAIN = Path.of("src", "main", "java", "com", "kingsrook", "qbits", "collaboration");
/*******************************************************************************
** Seeded from the code configuration by "Create rows from configuration".
*******************************************************************************/
static final List<String> SEEDED = List.of("collaboration_feature_setting");
/*******************************************************************************
** Tables that legitimately start empty, and where their rows come from.
*******************************************************************************/
static final Map<String, String> STARTS_EMPTY = Map.ofEntries(
Map.entry("collaboration_user", "runtime: filled as signed-in people use collaboration services"),
Map.entry("collaboration_favorite", "user content: a person stars something"),
Map.entry("collaboration_recent", "runtime: a person opens a record"),
Map.entry("collaboration_attachment", "user content: a person uploads a file"),
Map.entry("collaboration_comment", "user content: a person comments"),
Map.entry("collaboration_comment_revision", "runtime: a comment is edited"),
Map.entry("collaboration_mention", "runtime: a comment mentions someone"),
Map.entry("collaboration_follow", "user content: a person follows a record"),
Map.entry("collaboration_follow_digest", "runtime: a followed record changes"),
Map.entry("collaboration_activity", "runtime: collaboration features are used"),
Map.entry("collaboration_tag", "user content: a person or administrator adds a tag"),
Map.entry("collaboration_record_tag", "user content: a person tags a record"),
Map.entry("collaboration_field_definition", "administrator content: a field manager defines a custom field"),
Map.entry("collaboration_field_value", "user content: a person fills in a custom field"),
Map.entry("collaboration_share", "user content: a person shares a record"),
Map.entry("collaboration_access_request", "user content: a person asks for access"),
Map.entry("collaboration_task", "user content: a person adds a task"),
Map.entry("collaboration_record_assignment", "user content: a person assigns a record"));
/*******************************************************************************
** Every table is used by runtime code.
*******************************************************************************/
@Test
void everyTableIsUsedAtRuntime() throws Exception
{
Map<String, String> constantByTable = constantByTable();
List<String> runtimeSource;
try(Stream<Path> files = Files.walk(MAIN))
{
runtimeSource = files.filter(p -> p.toString().endsWith(".java"))
.filter(p -> !p.startsWith(MAIN.resolve("model")) && !p.startsWith(MAIN.resolve("metadata")) && !p.startsWith(MAIN.resolve("app"))
&& !p.getFileName().toString().equals("CoreCollaboration.java") && !p.getFileName().toString().equals("CollaborationSchema.java"))
.map(CollaborationTablesGuardrailTest::read).toList();
}
for(String table : collaborationTables())
{
String constant = constantByTable.get(table);
assertThat(constant).as("constant for " + table).isNotNull();
Pattern use = Pattern.compile("CollaborationTables\\." + constant + "\\b");
assertThat(runtimeSource.stream().anyMatch(source -> use.matcher(source).find()))
.as(table + " (" + constant + ") must be read or written by runtime code, not only declared").isTrue();
}
}
/*******************************************************************************
** Every table is seeded or explained.
*******************************************************************************/
@Test
void everyTableIsSeededOrExplained() throws Exception
{
for(String table : collaborationTables())
{
boolean seeded = SEEDED.contains(table);
assertThat(seeded || STARTS_EMPTY.containsKey(table)).as(table + " must be seeded or listed in STARTS_EMPTY").isTrue();
assertThat(seeded && STARTS_EMPTY.containsKey(table)).as(table + " cannot be both seeded and listed as starting empty").isFalse();
}
assertThat(STARTS_EMPTY.keySet()).allMatch(table -> instance.getTable(table) != null, "STARTS_EMPTY names only real tables");
///////////////////////////////////////////////////////////////////////////////////////
// the seeded table has a real action that writes its rows, and it is named in help //
///////////////////////////////////////////////////////////////////////////////////////
assertThat(instance.getProcess(FeatureSettingsDefaultsProcess.NAME).getTableName()).isEqualTo("collaboration_feature_setting");
assertThat(FeatureSettingsDefaults.configuredRows(instance, config)).isNotEmpty();
assertThat(help("collaboration_feature_setting").getContent()).contains(instance.getProcess(FeatureSettingsDefaultsProcess.NAME).getLabel());
}
/*******************************************************************************
** Every table and the app have bundle help that says how rows get created.
*******************************************************************************/
@Test
void everyTableHasEmptyStateHelp() throws Exception
{
for(String table : collaborationTables())
{
assertThat(help(table).getContent()).as(table + " help says how rows get created").contains("How rows get created");
}
assertThat(HelpBundles.of(instance).getBundles()).singleElement().satisfies(bundle ->
{
assertThat(bundle.getId()).isEqualTo("qbit-collaboration");
assertThat(bundle.getVersion()).as("the help bundle carries the artifact version").isEqualTo(System.getProperty("qbit.artifactVersion")).isEqualTo(CollaborationQBitProducer.VERSION);
assertThat(bundle.getEntries()).anyMatch(entry -> entry.getKey().equals("app:collaboration;slot:help"));
});
}
/*******************************************************************************
** Registration works without a help table; core owns the guarded startup sync.
*******************************************************************************/
@Test
void registrationWithoutHelpTable()
{
assertThat(instance.getTable("helpContent")).isNull();
HelpBundles.syncOnStartup(instance);
assertThat(HelpBundles.of(instance).getBundles()).hasSize(1);
}
/*******************************************************************************
**
*******************************************************************************/
private HelpBundleEntry help(String table)
{
return (HelpBundles.of(instance).getBundles().getFirst().getEntries().stream()
.filter(entry -> entry.getKey().equals("table:" + table + ";slot:help")).findFirst().orElseThrow());
}
/*******************************************************************************
**
*******************************************************************************/
private List<String> collaborationTables()
{
List<String> tables = instance.getTables().values().stream().map(QTableMetaData::getName).filter(n -> n.startsWith("collaboration_")).sorted().toList();
assertThat(tables).hasSize(19);
return (tables);
}
/*******************************************************************************
** CollaborationTables declares X = "collaboration_x".
*******************************************************************************/
private static Map<String, String> constantByTable() throws Exception
{
Map<String, String> rs = new HashMap<>();
Matcher m = Pattern.compile("String\\s+([A-Z_]+)\\s*=\\s*\"(collaboration_[a-z_]+)\"").matcher(read(MAIN.resolve("model").resolve("CollaborationTables.java")));
while(m.find())
{
rs.put(m.group(2), m.group(1));
}
return (rs);
}
/*******************************************************************************
**
*******************************************************************************/
private static String read(Path path)
{
try
{
return (Files.readString(path, StandardCharsets.UTF_8));
}
catch(Exception e)
{
throw (new IllegalStateException(e));
}
}
}
@@ -146,7 +146,7 @@ class CollaborationTest
assertThat(producer.isEnabled()).isTrue();
assertThat(producer.getQBitConfig()).isSameAs(config);
assertThat(producer.getNamespace()).isEqualTo("collaboration");
assertThat(producer.getQBitMetaData().getVersion()).isEqualTo("0.1.0");
assertThat(producer.getQBitMetaData().getVersion()).isEqualTo(System.getProperty("qbit.artifactVersion")).isEqualTo(CollaborationQBitProducer.VERSION);
assertThat(producer.getQBitMetaData().getArtifactId()).isEqualTo("qbit-collaboration");
assertThat(config.getDefaultBackendNameForTables()).isEqualTo("memory");
assertThat(config.getAdminApp()).isTrue();
@@ -228,6 +228,21 @@ class CollaborationTest
/*******************************************************************************
** Home tables leave column widths to the frontend, so narrow cards wrap
** instead of scrolling sideways (issue #21).
*******************************************************************************/
@Test
void homeTablesHaveNoFixedColumnWidths() throws Exception
{
for(TableData table : java.util.List.of(CollaborationHome.tags(), CollaborationHome.fields(), CollaborationHome.presence()))
{
assertThat(table.getColumns()).isNotEmpty().allSatisfy(column -> assertThat(column.getWidth()).isNull());
}
}
/*******************************************************************************
** Empty states explain what has not been populated.
*******************************************************************************/
@@ -179,8 +179,9 @@ public class CustomFieldsTest extends PersonalServiceFixture
assertThatThrownBy(() -> new DeleteAction().execute(new DeleteInput(CollaborationTables.FIELD_DEFINITION).withPrimaryKeys(List.of(row.getValue("id"))))).hasMessageContaining("archive");
assertThatThrownBy(() -> FieldDefinitions.validate(new QRecord(row).withValue("name", "renamed"), row)).hasMessageContaining("cannot change");
assertThatThrownBy(() -> FieldDefinitions.options(new QRecord().withValue("options", "{}"))).hasMessageContaining("options");
assertThatThrownBy(() -> FieldDefinitions.validate(new QRecord(row).withValue("classification", "BAD"), row)).hasMessageContaining("classification");
assertThatThrownBy(() -> FieldDefinitions.validate(new QRecord(row).withValue("minValue", 5).withValue("maxValue", 1), row)).hasMessageContaining("Minimum");
QRecord published = FieldDefinitions.get(row.getValue("id"));
assertThatThrownBy(() -> FieldDefinitions.validate(new QRecord(published).withValue("classification", "BAD"), published)).hasMessageContaining("classification");
assertThatThrownBy(() -> FieldDefinitions.validate(new QRecord(published).withValue("minValue", 5).withValue("maxValue", 1), published)).hasMessageContaining("Minimum");
}
/*******************************************************************************
@@ -0,0 +1,398 @@
/*
* 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.collaboration;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.function.Consumer;
import com.kingsrook.qbits.collaboration.app.CollaborationSetupStatus;
import com.kingsrook.qbits.collaboration.model.CollaborationTables;
import com.kingsrook.qbits.collaboration.permissions.CollaborationPermissions;
import com.kingsrook.qqq.backend.core.actions.collaboration.RecordFeaturesResolver;
import com.kingsrook.qqq.backend.core.actions.collaboration.RuntimeMetaDataOverlay;
import com.kingsrook.qqq.backend.core.actions.processes.RunProcessAction;
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
import com.kingsrook.qqq.backend.core.actions.tables.UpdateAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLine;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessInput;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessOutput;
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.actions.tables.update.UpdateInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.authentication.QAuthenticationMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.FeaturePermissionMode;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordFeature;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordFeaturesMetaData;
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.layout.QAppMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QAppSection;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QIcon;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.model.session.QUser;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryRecordStore;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** The "Create rows from configuration" defaults for collaboration_feature_setting.
** Main claim: writing the rows changes nothing. For several configurations
** (default, table features, app and table declarations, permission modes,
** settings, two apps containing one table), every table resolves to exactly the
** same enabled flag, permission mode and settings with and without the rows.
*******************************************************************************/
class FeatureSettingsDefaultsTest
{
private QInstance instance;
private CollaborationQBitConfig config;
/*******************************************************************************
** Fresh instance: a backend, three host tables, two apps, then the qbit.
** `code` runs after the qbit is produced and declares features on apps/tables.
*******************************************************************************/
private void build(Consumer<CollaborationQBitConfig> configure, Consumer<QInstance> code) throws Exception
{
MemoryRecordStore.getInstance().reset();
instance = new QInstance().withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("anonymous").withType(QAuthenticationType.FULLY_ANONYMOUS));
instance.addBackend(new QBackendMetaData().withName("memory").withBackendType(MemoryBackendModule.class));
instance.setEnforcePermissionsInCoreActions(true);
for(String name : List.of("document", "invoice", "receipt"))
{
instance.addTable(new QTableMetaData().withName(name).withLabel(name.substring(0, 1).toUpperCase() + name.substring(1) + "s").withBackendName("memory").withPrimaryKeyField("id")
.withField(new QFieldMetaData("id", QFieldType.INTEGER)).withField(new QFieldMetaData("title", QFieldType.STRING)).withRecordLabelFormatAndFields("%s", "title"));
}
instance.addApp(new QAppMetaData().withName("sales").withLabel("Sales").withIcon(new QIcon("sell")).withSection(new QAppSection().withName("s").withLabel("S").withTables(List.of("invoice", "receipt"))));
instance.addApp(new QAppMetaData().withName("ops").withLabel("Ops").withIcon(new QIcon("build")).withSection(new QAppSection().withName("o").withLabel("O").withTables(List.of("receipt", "document"))));
config = new CollaborationQBitConfig().withBackendName("memory");
configure.accept(config);
new CollaborationQBitProducer().withQBitConfig(config).produce(instance);
code.accept(instance);
new com.kingsrook.qqq.backend.core.instances.QInstanceEnricher(instance).enrich();
admin();
RuntimeMetaDataOverlay.refresh(instance);
}
/*******************************************************************************
**
*******************************************************************************/
private void admin()
{
QContext.init(instance, new QSession().withUser(new QUser().withIdReference("admin")).withPermissions(CollaborationPermissions.ADMIN));
}
/*******************************************************************************
**
*******************************************************************************/
@AfterEach
void tearDown()
{
com.kingsrook.qbits.collaboration.presence.PresenceRegistry.close(instance);
com.kingsrook.qqq.backend.core.realtime.RealtimeBus.close(instance);
QContext.clear();
MemoryRecordStore.getInstance().reset();
}
/*******************************************************************************
** What every host table resolves to for every feature: enabled, permission mode,
** settings (with the TAGS mode as TagsService reads it).
*******************************************************************************/
private Map<String, String> effective()
{
Map<String, String> rs = new TreeMap<>();
for(String table : List.of("document", "invoice", "receipt"))
{
var resolved = RecordFeaturesResolver.resolve(instance, instance.getTable(table));
for(RecordFeature feature : RecordFeature.values())
{
var one = resolved.getFeatures().get(feature);
Map<String, java.io.Serializable> settings = new TreeMap<>(one.getSettings());
if(feature == RecordFeature.TAGS)
{
///////////////////////////////////////////////////////////////////////////
// TagsService reads a missing mode as the configured default tag mode, //
// so a row that spells the default out is the same effective setting. //
///////////////////////////////////////////////////////////////////////////
settings.putIfAbsent("mode", config.getDefaultTagMode());
}
rs.put(table + "." + feature, one.getEnabled() + " " + one.getPermissionMode() + " " + settings);
}
}
return (rs);
}
/*******************************************************************************
** Run the real "Create rows from configuration" process end to end.
*******************************************************************************/
@SuppressWarnings("unchecked")
private List<ProcessSummaryLine> create() throws Exception
{
RunProcessInput input = new RunProcessInput();
input.setProcessName(FeatureSettingsDefaultsProcess.NAME);
input.setFrontendStepBehavior(RunProcessInput.FrontendStepBehavior.SKIP);
RunProcessOutput output = new RunProcessAction().execute(input);
return ((List<ProcessSummaryLine>) output.getValues().get(com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.StreamedETLWithFrontendProcess.FIELD_PROCESS_SUMMARY));
}
/*******************************************************************************
**
*******************************************************************************/
private List<QRecord> rows() throws Exception
{
return (new QueryAction().execute(new QueryInput(CollaborationTables.FEATURE_SETTING).withFilter(new QQueryFilter())).getRecords());
}
/*******************************************************************************
** The configurations: defaults; table features with GRANTED_ONLY and a table
** TAGS mode; an app that turns attachments on and sets the sharing approver;
** a different default tag mode and default features; two apps with one table.
*******************************************************************************/
private void scenario(int number) throws Exception
{
switch(number)
{
case 0 -> build(c -> { }, i -> { });
case 1 -> build(c -> c.withDefaultFeatures(RecordFeature.COMMENTS, RecordFeature.TAGS).withTableFeatures("document", RecordFeature.TAGS, RecordFeature.TASKS), i ->
{
RecordFeaturesMetaData.ofOrWithNew(i.getTable("invoice")).withPermissionMode(RecordFeature.SHARING, FeaturePermissionMode.GRANTED_ONLY)
.withSetting(RecordFeature.TAGS, "mode", "APPROVED_ONLY");
});
case 2 -> build(c -> c.withDefaultTagMode("APPROVED_ONLY"), i ->
{
RecordFeaturesMetaData.ofOrWithNew(i.getApp("sales")).withEnabled(RecordFeature.ATTACHMENTS, true).withSetting(RecordFeature.SHARING, "accessApproverPermission", "sales.admin");
RecordFeaturesMetaData.ofOrWithNew(i.getTable("receipt")).withEnabled(RecordFeature.COMMENTS, true).withEnabled(RecordFeature.FAVORITES, false);
});
case 3 -> build(c -> c.withDefaultFeatures(), i ->
{
RecordFeaturesMetaData.ofOrWithNew(i.getApp("sales")).withEnabled(RecordFeature.TASKS, true).withPermissionMode(RecordFeature.TASKS, FeaturePermissionMode.GRANTED_ONLY);
RecordFeaturesMetaData.ofOrWithNew(i.getApp("ops")).withEnabled(RecordFeature.TASKS, false);
RecordFeaturesMetaData.ofOrWithNew(i.getApp("ops")).withSetting(RecordFeature.TAGS, "mode", "APPROVED_ONLY");
});
default -> throw new IllegalArgumentException();
}
}
/*******************************************************************************
** The proof: for every scenario the effective feature set is identical with
** and without the seeded rows, and rows really were created.
*******************************************************************************/
@Test
void seededRowsChangeNothing() throws Exception
{
for(int number = 0; number <= 3; number++)
{
scenario(number);
Map<String, String> without = effective();
assertThat(rows()).as("scenario " + number + " starts empty").isEmpty();
List<ProcessSummaryLine> summary = create();
assertThat(summary).as("scenario " + number).isNotEmpty();
List<QRecord> rows = rows();
assertThat(rows).as("scenario " + number + " rows").hasSizeGreaterThanOrEqualTo(RecordFeature.values().length);
assertThat(rows.stream().filter(row -> "INSTANCE".equals(row.getValueString("scopeType")))).hasSize(RecordFeature.values().length);
assertThat(effective()).as("scenario " + number + ": effective settings with the seeded rows").containsExactlyInAnyOrderEntriesOf(without);
tearDown();
}
}
/*******************************************************************************
** The default scenario in plain terms: favorites, recents and timeline are
** the only features on, TAGS carries the mode, everything else is off.
*******************************************************************************/
@Test
void defaultRowsMirrorTheConfiguredDefaults() throws Exception
{
scenario(0);
create();
for(QRecord row : rows())
{
assertThat(row.getValueString("scopeType")).isEqualTo("INSTANCE");
assertThat(row.getValueString("scopeName")).isEqualTo("instance");
RecordFeature feature = RecordFeature.valueOf(row.getValueString("feature"));
boolean on = List.of(RecordFeature.FAVORITES, RecordFeature.RECENTS, RecordFeature.TIMELINE).contains(feature);
assertThat(row.getValueBoolean("enabled")).as(feature.name()).isEqualTo(on);
assertThat(row.getValueString("permissionMode")).isEqualTo("EDIT_OR_GRANTED");
assertThat(row.getValueString("settings")).isEqualTo(feature == RecordFeature.TAGS ? "{\"mode\":\"FREE\"}" : null);
}
}
/*******************************************************************************
** Running it again creates nothing; an edit survives; and the rows are live:
** turning COMMENTS on in its row turns comments on for every host table.
*******************************************************************************/
@Test
void insertOnlyAndTheRowsAreLive() throws Exception
{
scenario(0);
create();
int count = rows().size();
assertThat(RecordFeaturesResolver.resolve(instance, instance.getTable("document")).isEnabled(RecordFeature.COMMENTS)).isFalse();
QRecord comments = rows().stream().filter(row -> "COMMENTS".equals(row.getValueString("feature"))).findFirst().orElseThrow();
new UpdateAction().execute(new UpdateInput(CollaborationTables.FEATURE_SETTING).withRecords(List.of(new QRecord().withValue("id", comments.getValue("id")).withValue("enabled", true))));
assertThat(RecordFeaturesResolver.resolve(instance, instance.getTable("document")).isEnabled(RecordFeature.COMMENTS)).as("the edited row drives the runtime").isTrue();
assertThat(RecordFeaturesResolver.resolve(instance, instance.getTable("invoice")).isEnabled(RecordFeature.COMMENTS)).isTrue();
List<ProcessSummaryLine> second = create();
assertThat(second).singleElement().satisfies(line -> assertThat(line.getMessage()).contains("already has rows"));
assertThat(rows()).hasSize(count);
assertThat(rows().stream().filter(row -> "COMMENTS".equals(row.getValueString("feature"))).findFirst().orElseThrow().getValueBoolean("enabled")).isTrue();
}
/*******************************************************************************
** A table that already has an administrator's rows gets nothing added.
*******************************************************************************/
@Test
void neverAddsToExistingRows() throws Exception
{
scenario(1);
CollaborationRecords.insert(CollaborationTables.FEATURE_SETTING, new QRecord().withValue("scopeType", "INSTANCE").withValue("scopeName", "instance")
.withValue("feature", "TASKS").withValue("enabled", true));
assertThat(FeatureSettingsDefaults.missingRows(instance, config)).isEmpty();
create();
assertThat(rows()).hasSize(1);
}
/*******************************************************************************
** Only collaboration administrators may run it.
*******************************************************************************/
@Test
void adminOnly() throws Exception
{
scenario(0);
QContext.init(instance, new QSession().withUser(new QUser().withIdReference("viewer")).withPermissions(CollaborationPermissions.VIEW));
assertThatThrownBy(() -> new FeatureSettingsDefaultsProcess.AdminOnly().checkPermissionsThrowing(null, null)).isInstanceOf(QPermissionDeniedException.class);
assertThat(instance.getProcess(FeatureSettingsDefaultsProcess.NAME).getMinInputRecords()).isEqualTo(0);
assertThat(instance.getProcess(FeatureSettingsDefaultsProcess.NAME).getTableName()).isEqualTo(CollaborationTables.FEATURE_SETTING);
}
/*******************************************************************************
** The Setup card reports the configuration, then the rows, and what is on where.
*******************************************************************************/
@Test
void setupCardUsesTheRuntimeResolution() throws Exception
{
scenario(1);
List<CollaborationSetupStatus.Item> before = CollaborationSetupStatus.load(instance);
assertThat(before).hasSize(RecordFeature.values().length + 1);
assertThat(before.getFirst().state()).isEqualTo("Using code defaults");
assertThat(before.getFirst().nextStep()).contains("Create rows from configuration");
assertThat(item(before, "Comments").state()).isEqualTo("On for 2 of 3 tables");
assertThat(item(before, "Comments").where()).isEqualTo("Invoices, Receipts");
assertThat(item(before, "Favorites").state()).isEqualTo("Off");
assertThat(item(before, "Tasks").state()).isEqualTo("On for 1 of 3 tables");
assertThat(item(before, "Tasks").where()).isEqualTo("Documents");
assertThat(item(before, "Presence").state()).isEqualTo("Off");
assertThat(item(before, "Presence").nextStep()).contains("Feature Settings");
assertThat(item(before, "Tasks").source()).isEqualTo("Configuration");
create();
List<CollaborationSetupStatus.Item> after = CollaborationSetupStatus.load(instance);
assertThat(after.getFirst().state()).isEqualTo("Set up");
assertThat(item(after, "Tasks").source()).isEqualTo("Feature Settings");
List<String> beforeStates = new ArrayList<>(before.stream().skip(1).map(CollaborationSetupStatus.Item::state).toList());
assertThat(after.stream().skip(1).map(CollaborationSetupStatus.Item::state).toList()).as("the card reports the same thing before and after").isEqualTo(beforeStates);
}
/*******************************************************************************
** The load is one transaction: while it is open (and after it fails and is
** rolled back) the override overlay never sees any of its rows, so a failure
** on a later page cannot leave Instance rows without the rows that restate
** the code.
*******************************************************************************/
@Test
void laterPageFailureNeverReachesTheOverlay() throws Exception
{
scenario(1);
long generation = RuntimeMetaDataOverlay.getGeneration(instance);
FeatureSettingsDefaultsProcess.Load load = new FeatureSettingsDefaultsProcess.Load();
assertThat(load.openTransaction(new com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput())).isPresent();
com.kingsrook.qqq.backend.core.actions.QBackendTransaction tx = new com.kingsrook.qqq.backend.core.actions.QBackendTransaction();
load.setTransaction(java.util.Optional.of(tx));
List<QRecord> all = FeatureSettingsDefaults.missingRows(instance, config);
var page1 = new com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput();
page1.setRecords(new ArrayList<>(all.subList(0, 3)));
load.runOnePage(page1, new com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput());
assertThat(RuntimeMetaDataOverlay.getGeneration(instance)).as("no refresh before commit").isEqualTo(generation);
var page2 = new com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput();
page2.setRecords(new ArrayList<>(List.of(new QRecord().withValue("scopeType", "INSTANCE"))));
assertThatThrownBy(() -> load.runOnePage(page2, new com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput()))
.isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QException.class);
tx.rollback();
assertThat(RuntimeMetaDataOverlay.getGeneration(instance)).as("rolled back: the overlay never changed").isEqualTo(generation);
}
/*******************************************************************************
**
*******************************************************************************/
private static CollaborationSetupStatus.Item item(List<CollaborationSetupStatus.Item> items, String feature)
{
return (items.stream().filter(item -> feature.equals(item.feature())).findFirst().orElseThrow());
}
}
@@ -0,0 +1,109 @@
/*
* 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.collaboration;
import java.time.Instant;
import java.util.List;
import com.kingsrook.qbits.collaboration.model.CollaborationTables;
import com.kingsrook.qqq.backend.core.actions.collaboration.RecordFollowers;
import com.kingsrook.qqq.backend.core.actions.collaboration.RuntimeMetaDataOverlay;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.FollowEvent;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordFeature;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordFeaturesMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordFollower;
import com.kingsrook.qqq.backend.core.model.metadata.collaboration.RecordReference;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.model.session.QSystemUserSession;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryRecordStore;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Exercise the installed provider through core's public event-subscriber facade.
*******************************************************************************/
class FollowersProviderTest extends PersonalServiceFixture
{
/*******************************************************************************
** Preferences, mutes and parent scope apply even for callers without access.
*******************************************************************************/
@Test
void resolvesEventSubscribersAsSystemWithoutFilteringRecipientAccess() throws Exception
{
seed("change", "document", "1", true, false, null, false);
seed("comment", "document", "1", false, true, null, false);
seed("both", "document", "1", true, true, Instant.now().minusSeconds(60), false);
seed("muted", "document", "1", true, true, Instant.now().plusSeconds(3600), false);
seed("neither", "document", "1", false, false, null, false);
seed("other-record", "document", "2", true, true, null, false);
seed("other-table", "other", "1", true, true, null, false);
seed("deleted", "document", "1", true, true, null, true);
RecordReference reference = new RecordReference("document", 1);
for(QSession session : List.of(new QSession(), new QSystemUserSession(instance)))
{
QContext.init(instance, session);
for(FollowEvent event : List.of(FollowEvent.ALERT, FollowEvent.CHANGE))
{
assertThat(RecordFollowers.get(instance, reference, event)).extracting(RecordFollower::getUserId)
.containsExactlyInAnyOrder("change", "both");
}
assertThat(RecordFollowers.get(instance, reference, FollowEvent.COMMENT)).extracting(RecordFollower::getUserId)
.containsExactlyInAnyOrder("comment", "both");
assertThat(RecordFollowers.get(instance, reference, FollowEvent.CHANGE)).filteredOn(f -> f.getUserId().equals("change"))
.singleElement().satisfies(f ->
{
assertThat(f.getNotifyOnChange()).isTrue();
assertThat(f.getNotifyOnComment()).isFalse();
assertThat(f.getReason()).isEqualTo("MANUAL");
});
assertThat(QContext.getQSession()).isSameAs(session);
}
}
/*******************************************************************************
** Existing subscriptions do not override the host's FOLLOW feature switch.
*******************************************************************************/
@Test
void disabledFollowReturnsEmpty() throws Exception
{
seed("follower", "document", "1", true, true, null, false);
RecordFeaturesMetaData.ofOrWithNew(instance.getTable("document")).withEnabled(RecordFeature.FOLLOW, false);
RuntimeMetaDataOverlay.refresh(instance);
for(FollowEvent event : FollowEvent.values())
{
assertThat(RecordFollowers.get(instance, new RecordReference("document", 1), event)).isEmpty();
}
}
/*******************************************************************************
** Seed persisted preferences directly, including subscriptions lacking access.
*******************************************************************************/
private void seed(String user, String table, String id, Boolean change, Boolean comment, Instant muted, Boolean deleted) throws Exception
{
MemoryRecordStore.getInstance().insert(new InsertInput(CollaborationTables.FOLLOW).withRecords(List.of(new QRecord()
.withValue("userId", user).withValue("tableName", table).withValue("recordId", id).withValue("reason", "MANUAL")
.withValue("notifyOnChange", change).withValue("notifyOnComment", comment).withValue("mutedUntil", muted)
.withValue("parentDeleted", deleted))), true);
}
}
@@ -0,0 +1,159 @@
/*
* 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.collaboration;
import java.util.List;
import java.util.Optional;
import com.kingsrook.qbits.collaboration.comments.CommentsService;
import com.kingsrook.qbits.collaboration.favorites.FavoritesService;
import com.kingsrook.qbits.collaboration.model.CollaborationTables;
import com.kingsrook.qbits.collaboration.notify.CollaborationNotification;
import com.kingsrook.qbits.collaboration.notify.CollaborationNotifier;
import com.kingsrook.qbits.collaboration.notify.RecordingNotifier;
import com.kingsrook.qbits.collaboration.recents.RecentsService;
import com.kingsrook.qbits.collaboration.sharing.SharingService;
import com.kingsrook.qqq.backend.core.actions.collaboration.UserSessionProviderInterface;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.security.FieldSecurityLock;
import com.kingsrook.qqq.backend.core.model.metadata.security.QSecurityKeyType;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.model.session.QUser;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Cached and delivered labels respect the session that will receive the data.
*******************************************************************************/
class SecuredLabelsTest extends PersonalServiceFixture
{
private static RecordingNotifier recorder;
/*******************************************************************************
** Non-FULL labels are never cached; lists always re-read as the current viewer.
*******************************************************************************/
@Test
void cachesOnlyFullAccessLabelsAndRefreshesForViewer() throws Exception
{
for(FieldSecurityLock.Behavior behavior : List.of(FieldSecurityLock.Behavior.MASK, FieldSecurityLock.Behavior.DENY, FieldSecurityLock.Behavior.REVEAL))
{
restrictLabel(behavior);
FavoritesService.star("RECORD", "document", 1);
RecentsService.recordView("RECORD", "document", 1);
for(String table : List.of(CollaborationTables.FAVORITE, CollaborationTables.RECENT))
{
assertThat(PersonalRecords.query(table, PersonalRecords.ownFilter())).singleElement()
.satisfies(row -> assertThat(row.getValueString("label")).isNull());
}
assertThat(FavoritesService.list()).singleElement().satisfies(entry -> assertThat(entry.label()).doesNotContain("First document"));
assertThat(RecentsService.list(50)).singleElement().satisfies(entry -> assertThat(entry.label()).doesNotContain("First document"));
FavoritesService.unstar("RECORD", "document", 1);
PersonalRecords.delete(CollaborationTables.RECENT, PersonalRecords.query(CollaborationTables.RECENT, PersonalRecords.ownFilter()).stream().map(row -> row.getValue("id")).toList());
}
QContext.getQSession().withSecurityKeyValue("sensitive", "full");
FavoritesService.star("RECORD", "document", 1);
RecentsService.recordView("RECORD", "document", 1);
for(String table : List.of(CollaborationTables.FAVORITE, CollaborationTables.RECENT))
{
assertThat(PersonalRecords.query(table, PersonalRecords.ownFilter())).singleElement()
.satisfies(row -> assertThat(row.getValueString("label")).isEqualTo("First document"));
}
login("alice");
assertThat(FavoritesService.list()).singleElement().satisfies(entry -> assertThat(entry.label()).doesNotContain("First document"));
assertThat(RecentsService.list(50)).singleElement().satisfies(entry -> assertThat(entry.label()).doesNotContain("First document"));
FavoritesService.star("TABLE", "document", null);
assertThat(PersonalRecords.query(CollaborationTables.FAVORITE, PersonalRecords.targetFilter("TABLE", "document", null)))
.singleElement().satisfies(row -> assertThat(row.getValueString("label")).isEqualTo("Documents"));
}
/*******************************************************************************
** The sender's FULL label cannot leak to recipients with MASKED or HIDDEN access.
*******************************************************************************/
@Test
void notificationTitlesResolveLabelsPerRecipient() throws Exception
{
for(FieldSecurityLock.Behavior behavior : List.of(FieldSecurityLock.Behavior.MASK, FieldSecurityLock.Behavior.DENY))
{
restrictLabel(behavior);
QContext.getQSession().withSecurityKeyValue("sensitive", "full");
recorder = new RecordingNotifier();
config.withNotifier(new QCodeReference(TestNotifier.class)).withUserSessionProvider(new QCodeReference(TestSessions.class));
new SharingService().share("document", 1, List.of("restricted", "full"), "Shared user content");
new CommentsService().post("document", 1, "@[Restricted](user:restricted) @[Full](user:full)", null, null);
assertThat(recorder.notifications()).hasSize(4);
assertThat(recorder.notifications()).filteredOn(n -> n.recipientUserId().equals("restricted")).hasSize(2)
.allSatisfy(n -> assertThat(n.title()).contains("Documents #1").doesNotContain("First document"));
assertThat(recorder.notifications()).filteredOn(n -> n.recipientUserId().equals("full")).hasSize(2)
.allSatisfy(n -> assertThat(n.title()).contains("First document"));
assertThat(QContext.getQSession().getUser().getIdReference()).isEqualTo("alice");
}
}
/*******************************************************************************
** Field-lock override grants FULL to selected sessions only.
*******************************************************************************/
private void restrictLabel(FieldSecurityLock.Behavior behavior)
{
if(!instance.getSecurityKeyTypes().containsKey("sensitive"))
{
instance.addSecurityKeyType(new QSecurityKeyType().withName("sensitive"));
}
instance.getTable("document").getField("title").withFieldSecurityLock(new FieldSecurityLock()
.withSecurityKeyType("sensitive").withDefaultBehavior(behavior).withOverrideValues(List.of("full")));
}
/*******************************************************************************
** Recipients share record access but have different label access.
*******************************************************************************/
public static class TestSessions implements UserSessionProviderInterface
{
/*******************************************************************************
** Build independent recipient sessions for real core field checks.
*******************************************************************************/
@Override
public Optional<QSession> sessionForUser(String userId)
{
QSession session = new QSession().withUser(new QUser().withIdReference(userId)).withPermissions("document.read")
.withSecurityKeyValue("tenant", "a");
if(userId.equals("full"))
{
session.withSecurityKeyValue("sensitive", "full");
}
return (Optional.of(session));
}
}
/*******************************************************************************
** Capture notifications before any external transport.
*******************************************************************************/
public static class TestNotifier implements CollaborationNotifier
{
/*******************************************************************************
** Preserve the payload for assertions.
*******************************************************************************/
@Override
public void notify(CollaborationNotification notification)
{
recorder.notify(notification);
}
}
}
@@ -32,6 +32,10 @@ import com.kingsrook.qbits.collaboration.timeline.TimelinePage;
import com.kingsrook.qbits.collaboration.timeline.TimelineService;
import com.kingsrook.qqq.backend.core.actions.metadata.personalization.TableMetaDataPersonalizerInterface;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldMaskStyle;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldValueMasker;
import com.kingsrook.qqq.backend.core.model.metadata.security.FieldSecurityLock;
import com.kingsrook.qqq.backend.core.model.metadata.security.QSecurityKeyType;
import com.kingsrook.qqq.backend.core.instances.QInstanceValidator;
import com.kingsrook.qqq.backend.core.model.actions.metadata.personalization.TableMetaDataPersonalizerInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
@@ -182,6 +186,40 @@ public class TimelineServiceTest extends PersonalServiceFixture
assertThat(timeline.timeline("document", 1, null, 50, Set.of("AUDIT")).items()).isEmpty();
}
/*******************************************************************************
** RC.7 QueryAction masks audit values and removes HIDDEN detail rows as the viewer.
*******************************************************************************/
@Test
void fieldTiersProtectTimelineValuesAndMessages() throws Exception
{
String canary = "TIMELINE-SECRET-CANARY";
instance.addSecurityKeyType(new QSecurityKeyType().withName("sensitive"));
instance.getTable("document").getField("title").withFieldSecurityLock(new FieldSecurityLock()
.withSecurityKeyType("sensitive").withDefaultBehavior(FieldSecurityLock.Behavior.MASK).withMaskStyle(FieldMaskStyle.FULL));
instance.getTable("document").getField("tenant").withFieldSecurityLock(new FieldSecurityLock()
.withSecurityKeyType("sensitive").withDefaultBehavior(FieldSecurityLock.Behavior.DENY));
seedAudit(4, canary, 100);
for(String field : List.of("title", "tenant"))
{
seed("auditDetail", new QRecord().withValue("id", field.equals("title") ? 10L : 11L).withValue("auditId", 4L)
.withValue("fieldName", field).withValue("oldValue", canary).withValue("newValue", canary).withValue("message", canary));
}
TimelinePage page = timeline.timeline("document", 1, null, 50, Set.of("AUDIT"));
assertThat(page.items()).filteredOn(item -> item.id().equals(4L)).singleElement().satisfies(item ->
{
assertThat(item.summary()).isNull();
assertThat(item.details()).singleElement().satisfies(detail ->
{
assertThat(detail.fieldName()).isEqualTo("title");
assertThat(detail.oldValue()).isEqualTo(FieldValueMasker.MASK);
assertThat(detail.newValue()).isEqualTo(FieldValueMasker.MASK);
assertThat(detail.message()).isNull();
});
});
assertThat(page.items().stream().flatMap(item -> item.details().stream())).noneMatch(detail -> "tenant".equals(detail.fieldName()));
assertThat(page.toString()).doesNotContain(canary, "Old", "New", "sensitive old", "sensitive new");
}
/*******************************************************************************
** Real personalizer boundary, like core's audit screen.
*******************************************************************************/
@@ -102,6 +102,20 @@ public class AttachmentsServiceTest extends PersonalServiceFixture
/*******************************************************************************
** Upload, metadata, newest-first list, signed download and deletion round trip.
*******************************************************************************/
/*******************************************************************************
** The action steps can be constructed without a QContext, as QQQ does during
** instance validation (issue #20); the service is created on first use.
*******************************************************************************/
@Test
void stepsConstructWithoutContext()
{
QContext.clear();
assertThat(new DeleteAttachmentsProcess.Review()).isNotNull();
assertThat(new DeleteAttachmentsProcess.Delete()).isNotNull();
}
@Test
void roundTrip() throws Exception
{
@@ -43,6 +43,8 @@ import com.kingsrook.qqq.backend.core.actions.collaboration.UserSessionProviderI
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.metadata.security.FieldSecurityLock;
import com.kingsrook.qqq.backend.core.model.metadata.security.QSecurityKeyType;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
@@ -159,7 +161,7 @@ class EmailCollaborationNotifierTest extends PersonalServiceFixture
assertThat(message.getValueString("linkedTableName")).isEqualTo("document");
assertThat(message.getValueString("linkedRecordId")).isEqualTo("1");
assertThat(message.getValueString("senderQbit")).isEqualTo("qbit-collaboration");
assertThat(message.getValueString("subject")).contains("alice mentioned you on a record in Documents");
assertThat(message.getValueString("subject")).contains("alice mentioned you on First document");
assertThat(message.getValueString("subject") + message.getValueString("textBody") + message.getValueString("htmlBody")).doesNotContain("secret comment body");
assertThat(message.getValueString("htmlBody")).contains("https://app.example.org/app/document/1");
});
@@ -175,6 +177,27 @@ class EmailCollaborationNotifierTest extends PersonalServiceFixture
/*******************************************************************************
** Restricted record labels never enter email subjects or rendered bodies.
*******************************************************************************/
@Test
void maskedLabelUsesGenericEmailText() throws Exception
{
withEmail();
instance.addSecurityKeyType(new QSecurityKeyType().withName("sensitive"));
instance.getTable("document").getField("title").withFieldSecurityLock(new FieldSecurityLock()
.withSecurityKeyType("sensitive").withDefaultBehavior(FieldSecurityLock.Behavior.MASK));
Notifications.send(notification("bob", CollaborationNotification.Category.MENTION, "7"));
assertThat(messages()).singleElement().satisfies(message ->
{
assertThat(message.getValueString("subject")).contains("alice mentioned you on a record in Documents");
assertThat(message.getValueString("subject") + message.getValueString("textBody") + message.getValueString("htmlBody"))
.doesNotContain("First document", "secret comment body");
});
}
/*******************************************************************************
** Each recipient gets their own message; the share and task kinds use their
** own templates and key kinds; follow digests send no email.
@@ -52,6 +52,8 @@ import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.audits.AuditLevel;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.PermissionLevel;
import com.kingsrook.qqq.backend.core.model.metadata.security.FieldSecurityLock;
import com.kingsrook.qqq.backend.core.model.metadata.security.QSecurityKeyType;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.scheduleing.simple.SimpleSchedulerMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
@@ -114,6 +116,26 @@ class RecentsServiceTest extends PersonalServiceFixture
/*******************************************************************************
** A refreshed recent discards its old cached label after access is restricted.
*******************************************************************************/
@Test
void refreshClearsLabelWhenFieldAccessIsRestricted() throws Exception
{
at(START);
RecentsService.recordView("RECORD", "document", 1);
assertThat(rows().getFirst().getValueString("label")).isEqualTo("First document");
instance.addSecurityKeyType(new QSecurityKeyType().withName("sensitive"));
instance.getTable("document").getField("title").withFieldSecurityLock(new FieldSecurityLock()
.withSecurityKeyType("sensitive").withDefaultBehavior(FieldSecurityLock.Behavior.MASK));
at(START.plusSeconds(60));
RecentsService.recordView("RECORD", "document", 1);
assertThat(rows().getFirst().getValueString("label")).isNull();
assertThat(rows().getFirst().getValueInteger("viewCount")).isEqualTo(2);
}
/*******************************************************************************
** Null ids also upsert; visibility is checked even inside the throttle window.
*******************************************************************************/