Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Darin Kelkhoff
|
910d5c9858 | ||
|
Darin Kelkhoff
|
6ef1727eb8 | ||
|
Darin Kelkhoff
|
fce13986b4 | ||
 james.maes
|
c8f3bb4312 |
No files matched your search
+53
-10
@@ -1,14 +1,57 @@
|
||||
version: 2.1
|
||||
setup: true
|
||||
|
||||
orbs:
|
||||
qqq-orb: kingsrook/qqq-orb@0.8
|
||||
qqq-orb: kingsrook/qqq-orb@0.3.7
|
||||
|
||||
workflows:
|
||||
setup:
|
||||
|
||||
test_only:
|
||||
jobs:
|
||||
- qqq-orb/generate_pipeline:
|
||||
orb_version: '0.8'
|
||||
filters:
|
||||
branches:
|
||||
ignore: automation/qbit-rc-pending
|
||||
tags:
|
||||
only: /v.*/
|
||||
- qqq-orb/mvn_test_only:
|
||||
context: [ qqq-maven-registry-credentials ]
|
||||
filters:
|
||||
branches:
|
||||
ignore: /(develop|main|release/.*|hotfix/.*|integration.*)/
|
||||
tags:
|
||||
only: []
|
||||
|
||||
publish_snapshot:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
context: [ qqq-maven-registry-credentials ]
|
||||
branch_type: snapshot
|
||||
filters:
|
||||
branches:
|
||||
only:
|
||||
- develop
|
||||
|
||||
publish_release_candidate:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
context: [ qqq-maven-registry-credentials ]
|
||||
branch_type: release_candidate
|
||||
filters:
|
||||
branches:
|
||||
only:
|
||||
- /release\/.*/
|
||||
|
||||
publish_release:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
context: [ qqq-maven-registry-credentials ]
|
||||
branch_type: release
|
||||
filters:
|
||||
branches:
|
||||
ignore: /.*/
|
||||
tags:
|
||||
only: [ /v.*/ ]
|
||||
|
||||
publish_hotfix_release:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
context: [ qqq-maven-registry-credentials ]
|
||||
branch_type: hotfix
|
||||
filters:
|
||||
branches:
|
||||
only:
|
||||
- /hotfix\/.*/
|
||||
@@ -1,7 +0,0 @@
|
||||
name: build
|
||||
on:
|
||||
push:
|
||||
jobs:
|
||||
maven:
|
||||
uses: self:KofTwentyTwo/ci-workflows/.gitea/workflows/maven.yaml@v1
|
||||
secrets: inherit
|
||||
@@ -1 +0,0 @@
|
||||
* @KofTwentyTwo
|
||||
@@ -1,31 +0,0 @@
|
||||
# GitHub Release Configuration
|
||||
# Auto-generates release notes from PR labels
|
||||
|
||||
changelog:
|
||||
exclude:
|
||||
labels:
|
||||
- ignore-for-release
|
||||
- duplicate
|
||||
- invalid
|
||||
authors:
|
||||
- dependabot
|
||||
- dependabot[bot]
|
||||
categories:
|
||||
- title: Breaking Changes
|
||||
labels:
|
||||
- breaking-change
|
||||
- breaking
|
||||
- title: New Features
|
||||
labels:
|
||||
- enhancement
|
||||
- feature
|
||||
- title: Bug Fixes
|
||||
labels:
|
||||
- bug
|
||||
- fix
|
||||
- title: Dependencies
|
||||
labels:
|
||||
- dependencies
|
||||
- title: Other Changes
|
||||
labels:
|
||||
- "*"
|
||||
@@ -1,23 +0,0 @@
|
||||
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
|
||||
@@ -1,74 +0,0 @@
|
||||
name: Release candidate
|
||||
'on':
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
dry_run:
|
||||
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
|
||||
repository_dispatch:
|
||||
types:
|
||||
- qbit-rc-published
|
||||
permissions:
|
||||
contents: write
|
||||
actions: read
|
||||
checks: read
|
||||
jobs:
|
||||
release-rc:
|
||||
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 || 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
@@ -1,16 +0,0 @@
|
||||
profile: qbit
|
||||
orb_version: '0.8'
|
||||
default_branch: main
|
||||
java_version: '21'
|
||||
browsers: true
|
||||
api_checks: false
|
||||
docs_only: false
|
||||
release_on_main: false
|
||||
release_tag_policy: v-prefix
|
||||
test_branch_policy: all
|
||||
publish:
|
||||
snapshot: true
|
||||
release_candidate: true
|
||||
release: true
|
||||
asciidoc: false
|
||||
release_completion: false
|
||||
@@ -1,23 +0,0 @@
|
||||
# qbit-workflows
|
||||
|
||||
## Knowledge base
|
||||
|
||||
Reviewed dossiers for this repo and the wider QQQ platform live in the second-brain
|
||||
vault:
|
||||
|
||||
- Hub / start here: `R:/Git.Local/KofTwentyTwo/second-brain/knowledge/qqq/qqq-hub.md`
|
||||
- This repo's dossier:
|
||||
`R:/Git.Local/KofTwentyTwo/second-brain/knowledge/qqq/repos/qbit-workflows.md`
|
||||
(reviewed at main `4f3c7719f9f9`, pom 0.4.0, 2026-07-04)
|
||||
- QBit mechanics refresher:
|
||||
`R:/Git.Local/KofTwentyTwo/second-brain/knowledge/qqq/architecture/metadata-model.md`
|
||||
|
||||
Key facts from the review (see dossier for detail):
|
||||
|
||||
- origin/develop is 32 commits ahead of main (unreleased 2026 feature work, pinned to
|
||||
a throwaway `0.40.0-join-enhancements-*` qqq build); main is the released line on
|
||||
qqq 0.35.0 via parent `com.kingsrook:qbit-build-parent:1.5.1`.
|
||||
- README and CHANGELOG.md do not describe this codebase (template rot) — trust the
|
||||
source and the dossier instead.
|
||||
- Licensing is inconsistent (LICENSE/NOTICE Apache-2.0 vs pom + file headers AGPL-3.0
|
||||
vs README "Proprietary") — pending reconciliation.
|
||||
@@ -1,202 +0,0 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to the Licensor for inclusion in the Work by the copyright
|
||||
owner or by an individual or Legal Entity authorized to submit on
|
||||
behalf of the copyright owner. For the purposes of this definition,
|
||||
"submitted" means any form of electronic, verbal, or written
|
||||
communication sent to the Licensor or its representatives, including
|
||||
but not limited to communication on electronic mailing lists, source
|
||||
code control systems, and issue tracking systems that are managed by,
|
||||
or on behalf of, the Licensor for the purpose of discussing and
|
||||
improving the Work, but excluding communication that is conspicuously
|
||||
marked or otherwise designated in writing by the copyright owner as
|
||||
"Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2022-2025 QRunIO, LLC
|
||||
|
||||
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
|
||||
|
||||
http://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.
|
||||
@@ -1,15 +0,0 @@
|
||||
qBit: Workflows
|
||||
Copyright 2022-2025 QRunIO, LLC
|
||||
|
||||
This product includes software developed at QRunIO, LLC (https://qrun.io/).
|
||||
|
||||
Licensed under the Apache License, Version 2.0.
|
||||
|
||||
================================================================================
|
||||
|
||||
Trademarks:
|
||||
|
||||
QQQ, qBits, qRun, qStudio, and the QRunIO logo are trademarks of QRunIO, LLC.
|
||||
Use of these trademarks must comply with QRunIO's Trademark Guidelines.
|
||||
|
||||
================================================================================
|
||||
@@ -1,150 +1,109 @@
|
||||
# qbit-workflows
|
||||
# QBit: Workflows
|
||||
|
||||
State machine workflows for QQQ applications.
|
||||
[](https://github.com/Kingsrook/qbit-workflows)
|
||||
[](https://www.gnu.org/licenses/agpl-3.0.en.html)
|
||||
[](https://adoptium.net/)
|
||||
|
||||
**For:** QQQ developers building approval flows, order pipelines, or any multi-step business processes
|
||||
**Status:** Stable
|
||||
### Overview
|
||||
*Note: This is one of the original QBit implementations - so, some of the mechanics of how
|
||||
it is loaded and used by an application are not exactly fully defined at the time of its
|
||||
creation... Please excuse any dust or not-quite-round wheels you find here!*
|
||||
|
||||
## Why This Exists
|
||||
This QBit provides TODO
|
||||
|
||||
Business processes have states. Orders go from pending to approved to shipped. Support tickets move through triage, investigation, and resolution. Building these flows means tracking state, validating transitions, and triggering actions at each step.
|
||||
## 🏗️ Architecture
|
||||
|
||||
This QBit provides a declarative workflow engine. Define states and transitions, and the system enforces valid paths, runs actions on transitions, and tracks history automatically.
|
||||
### Technology Stack
|
||||
|
||||
## Features
|
||||
- **Java**: Java 17+ with UTF-8 encoding
|
||||
- **Maven**: Build system with plugin management
|
||||
- **QQQ Framework**: Built on the QQQ low-code platform
|
||||
- **QBit Pattern**: Follows QBit component architecture
|
||||
|
||||
- **State Definitions** - Define allowed states for any entity
|
||||
- **Transition Rules** - Control which states can move to which other states
|
||||
- **Transition Actions** - Execute code when moving between states
|
||||
- **Role-Based Transitions** - Restrict who can trigger which transitions
|
||||
- **Transition History** - Automatic audit log of all state changes
|
||||
- **Dashboard Integration** - Status badges and transition buttons in the UI
|
||||
### Core Capabilities
|
||||
|
||||
## Quick Start
|
||||
- **Workflow Management**: TODO - Define workflow capabilities
|
||||
- **Process Automation**: TODO - Define automation features
|
||||
- **Integration**: TODO - Define integration capabilities
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- QQQ application (v4.1.0+)
|
||||
- Database backend configured
|
||||
- **Java 17+** (required for QQQ features)
|
||||
- **Maven 3.8+** (for build system)
|
||||
|
||||
### Installation
|
||||
|
||||
Add to your `pom.xml`:
|
||||
### Usage
|
||||
|
||||
#### Pom dependency
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qbits</groupId>
|
||||
<artifactId>qbit-workflows</artifactId>
|
||||
<version>0.4.0</version>
|
||||
<version>${TODO}</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
### Register the QBit
|
||||
#### Setup
|
||||
TODO
|
||||
|
||||
```java
|
||||
public class AppMetaProvider extends QMetaProvider {
|
||||
@Override
|
||||
public void configure(QInstance qInstance) {
|
||||
new WorkflowsQBit().configure(qInstance);
|
||||
}
|
||||
}
|
||||
```
|
||||
### Provides
|
||||
#### Tables
|
||||
TODO
|
||||
|
||||
### Define a Workflow
|
||||
#### Classes
|
||||
TODO
|
||||
|
||||
```java
|
||||
new QWorkflowMetaData()
|
||||
.withName("orderWorkflow")
|
||||
.withTable("order")
|
||||
.withStatusField("status")
|
||||
.withStates(
|
||||
new QWorkflowState("pending", "Pending"),
|
||||
new QWorkflowState("approved", "Approved"),
|
||||
new QWorkflowState("shipped", "Shipped"),
|
||||
new QWorkflowState("cancelled", "Cancelled")
|
||||
)
|
||||
.withTransitions(
|
||||
new QWorkflowTransition("pending", "approved"),
|
||||
new QWorkflowTransition("pending", "cancelled"),
|
||||
new QWorkflowTransition("approved", "shipped"),
|
||||
new QWorkflowTransition("approved", "cancelled")
|
||||
);
|
||||
```
|
||||
### Dependencies
|
||||
TODO
|
||||
|
||||
## Usage
|
||||
## 📚 Documentation
|
||||
|
||||
### Transition Actions
|
||||
**📖 [Complete Documentation Wiki](https://github.com/Kingsrook/qqq/wiki)** - Start here for comprehensive guides
|
||||
|
||||
```java
|
||||
new QWorkflowTransition("approved", "shipped")
|
||||
.withAction(new ShipOrderAction());
|
||||
- **[🏠 Home](https://github.com/Kingsrook/qqq/wiki/Home)** - Project overview and quick start
|
||||
- **[🏗️ Architecture](https://github.com/Kingsrook/qqq/wiki/High-Level-Architecture)** - System design and principles
|
||||
- **[🔧 Development](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)** - Setup and contribution guide
|
||||
- **[📦 Modules](https://github.com/Kingsrook/qqq/wiki/Core-Modules)** - Available components and usage
|
||||
- **[🚀 Building](https://github.com/Kingsrook/qqq/wiki/Building-Locally)** - Local development workflow
|
||||
- **[🔧 QBit Development](https://github.com/Kingsrook/qqq/wiki/QBit-Development)** - QBit development guide
|
||||
|
||||
public class ShipOrderAction implements WorkflowTransitionAction {
|
||||
@Override
|
||||
public void execute(WorkflowTransitionContext context) {
|
||||
// Send shipping notification
|
||||
// Update inventory
|
||||
// Generate tracking number
|
||||
}
|
||||
}
|
||||
```
|
||||
## 🤝 Contributing
|
||||
|
||||
### Role-Based Transitions
|
||||
**Important**: This repository is a component of the QQQ framework. All contributions, issues, and discussions should go through the main QQQ repository.
|
||||
|
||||
```java
|
||||
// Only managers can approve
|
||||
new QWorkflowTransition("pending", "approved")
|
||||
.withAllowedRoles("manager", "admin");
|
||||
```
|
||||
### Development Workflow
|
||||
|
||||
### Transition Validation
|
||||
1. **Fork the main QQQ repository**: https://github.com/Kingsrook/qqq
|
||||
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
|
||||
3. **Make your changes** (including QBit changes if applicable)
|
||||
4. **Run tests**: `mvn test`
|
||||
5. **Commit your changes**: `git commit -m 'Add amazing feature'`
|
||||
6. **Push to the branch**: `git push origin feature/amazing-feature`
|
||||
7. **Open a Pull Request** to the main QQQ repository
|
||||
|
||||
```java
|
||||
new QWorkflowTransition("approved", "shipped")
|
||||
.withValidator((context) -> {
|
||||
if (context.getRecord().getValue("shippingAddress") == null) {
|
||||
throw new WorkflowException("Shipping address required");
|
||||
}
|
||||
});
|
||||
```
|
||||
### Code Standards
|
||||
|
||||
### Querying by State
|
||||
- **Maven**: Follow Maven best practices
|
||||
- **Documentation**: Update relevant documentation
|
||||
- **Versioning**: Follow semantic versioning
|
||||
- **QBit Pattern**: Follow QBit component architecture
|
||||
|
||||
```java
|
||||
// Find all pending orders
|
||||
QueryInput query = new QueryInput()
|
||||
.withTableName("order")
|
||||
.withFilter(new QQueryFilter()
|
||||
.withCriteria("status", Operator.EQUALS, "pending"));
|
||||
```
|
||||
**First time contributing?** Start with our [Developer Onboarding Guide](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding) to get your environment set up.
|
||||
|
||||
## Configuration
|
||||
## 🏢 About Kingsrook
|
||||
|
||||
The QBit creates a transition history table automatically:
|
||||
QBit Workflows is built by **[Kingsrook](https://qrun.io)** - making engineers more productive through intelligent automation and developer tools.
|
||||
|
||||
| Table | Purpose |
|
||||
|-------|---------|
|
||||
| `workflow_transition_log` | Audit trail of all state changes |
|
||||
- **Website**: [https://qrun.io](https://qrun.io)
|
||||
- **Contact**: [contact@kingsrook.com](mailto:contact@kingsrook.com)
|
||||
- **GitHub**: [https://github.com/Kingsrook](https://github.com/Kingsrook)
|
||||
|
||||
Each log entry records: record ID, from state, to state, user, timestamp, and optional comments.
|
||||
## 📄 License
|
||||
|
||||
## Project Status
|
||||
This project is licensed under the **GNU Affero General Public License v3.0** - see the [LICENSE.txt](LICENSE.txt) file for details.
|
||||
|
||||
Stable and production-ready.
|
||||
---
|
||||
|
||||
### Roadmap
|
||||
**Ready to build workflows with full control?** [Get started with QQQ today!](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)
|
||||
|
||||
- Parallel state support (multiple active states)
|
||||
- Scheduled transitions (auto-expire after N days)
|
||||
- Workflow visualization in dashboard
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
3. Run tests: `mvn clean verify`
|
||||
4. Submit a pull request
|
||||
|
||||
## License
|
||||
|
||||
Proprietary - QRun.IO
|
||||
@@ -23,14 +23,13 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
|
||||
<properties>
|
||||
<revision>0.5.0-SNAPSHOT</revision>
|
||||
<qqq.version>4.1.0-RC.21</qqq.version>
|
||||
<revision>0.4.0-SNAPSHOT</revision>
|
||||
</properties>
|
||||
|
||||
<parent>
|
||||
<groupId>com.kingsrook</groupId>
|
||||
<artifactId>qbit-build-parent</artifactId>
|
||||
<version>1.5.1</version>
|
||||
<version>1.4.0</version>
|
||||
</parent>
|
||||
|
||||
<groupId>com.kingsrook.qbits</groupId>
|
||||
@@ -70,19 +69,6 @@
|
||||
</scm>
|
||||
|
||||
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<!-- Published QQQ 4.1 core (minimum QQQ 4.1), imported ahead of the parent's BOM. -->
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qqq</groupId>
|
||||
<artifactId>qqq-bom-pom</artifactId>
|
||||
<version>${qqq.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qqq</groupId>
|
||||
@@ -100,10 +86,8 @@
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qqq</groupId>
|
||||
<!-- 0.27.0-RC.1 references com.kingsrook.qqq.backend.javalin.QJavalinMetaData, which QQQ 4.x moved to com.kingsrook.qqq.middleware.javalin
|
||||
(NoClassDefFoundError when the form adjusters register). 0.42.0-RC.2 is the published line for 4.x; its public API is a superset. -->
|
||||
<artifactId>qqq-frontend-material-dashboard</artifactId>
|
||||
<version>0.42.0-RC.2</version>
|
||||
<version>0.27.0-RC.1</version>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
@@ -114,7 +98,7 @@
|
||||
<dependency>
|
||||
<groupId>org.assertj</groupId>
|
||||
<artifactId>assertj-core</artifactId>
|
||||
<version>3.27.7</version>
|
||||
<version>3.27.3</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
+1
-2
@@ -39,7 +39,6 @@ import com.kingsrook.qbits.workflows.model.Workflow;
|
||||
import com.kingsrook.qbits.workflows.model.WorkflowRevision;
|
||||
import com.kingsrook.qbits.workflows.model.WorkflowStep;
|
||||
import com.kingsrook.qqq.api.actions.GetTableApiFieldsAction;
|
||||
import com.kingsrook.qqq.api.model.actions.GetTableApiFieldsInput;
|
||||
import com.kingsrook.qqq.api.utils.ApiQueryFilterUtils;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.GetAction;
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
@@ -255,7 +254,7 @@ public class InputRecordFilterStep extends WorkflowStepType implements WorkflowS
|
||||
String apiName = workflowRevision.getValueString("apiName");
|
||||
String apiVersion = workflowRevision.getValueString("apiVersion");
|
||||
String tableName = workflow.getValueString("tableName");
|
||||
Map<String, QFieldMetaData> tableApiFields = GetTableApiFieldsAction.getTableApiFieldMap(new GetTableApiFieldsInput().withApiName(apiName).withVersion(apiVersion).withTableName(tableName));
|
||||
Map<String, QFieldMetaData> tableApiFields = GetTableApiFieldsAction.getTableApiFieldMap(new GetTableApiFieldsAction.ApiNameVersionAndTableName(apiName, apiVersion, tableName));
|
||||
ArrayList<String> badRequestMessages = new ArrayList<>();
|
||||
ApiQueryFilterUtils.manageCriteriaFields(filter, tableApiFields, badRequestMessages, apiName, apiVersion, new QueryInput(tableName).withFilter(filter));
|
||||
errors.addAll(badRequestMessages);
|
||||
|
||||
+1
-2
@@ -31,7 +31,6 @@ import com.kingsrook.qbits.workflows.execution.WorkflowExecutionContext;
|
||||
import com.kingsrook.qbits.workflows.model.Workflow;
|
||||
import com.kingsrook.qbits.workflows.model.WorkflowRevision;
|
||||
import com.kingsrook.qqq.api.actions.GetTableApiFieldsAction;
|
||||
import com.kingsrook.qqq.api.model.actions.GetTableApiFieldsInput;
|
||||
import com.kingsrook.qqq.api.utils.ApiQueryFilterUtils;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.CountAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.DeleteAction;
|
||||
@@ -180,7 +179,7 @@ public class RecordWorkflowUtils
|
||||
{
|
||||
WorkflowRevision workflowRevision = context.getWorkflowRevision();
|
||||
Workflow workflow = context.getWorkflow();
|
||||
Map<String, QFieldMetaData> tableApiFields = GetTableApiFieldsAction.getTableApiFieldMap(new GetTableApiFieldsInput().withApiName(workflowRevision.getApiName()).withVersion(workflowRevision.getApiVersion()).withTableName(workflow.getTableName()));
|
||||
Map<String, QFieldMetaData> tableApiFields = GetTableApiFieldsAction.getTableApiFieldMap(new GetTableApiFieldsAction.ApiNameVersionAndTableName(workflowRevision.getApiName(), workflowRevision.getApiVersion(), workflow.getTableName()));
|
||||
List<String> badRequestMessages = new ArrayList<>();
|
||||
|
||||
CountInput countInput = new CountInput(context.getWorkflow().getTableName())
|
||||
|
||||
+2
-2
@@ -78,9 +78,9 @@ public class RunRecordWorkflowExtractStep extends ExtractViaQueryStep
|
||||
** Make sure associations are fetched (so api records have children!)
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
protected void customizeInputPreQuery(RunBackendStepInput runBackendStepInput, QueryInput queryInput)
|
||||
protected void customizeInputPreQuery(QueryInput queryInput)
|
||||
{
|
||||
super.customizeInputPreQuery(runBackendStepInput, queryInput);
|
||||
super.customizeInputPreQuery(queryInput);
|
||||
queryInput.setIncludeAssociations(true);
|
||||
}
|
||||
|
||||
|
||||
+42
@@ -25,6 +25,7 @@ package com.kingsrook.qbits.workflows.implementations.recordworkflows;
|
||||
import java.io.Serializable;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.ListIterator;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
import java.util.Optional;
|
||||
@@ -35,6 +36,8 @@ import com.kingsrook.qqq.backend.core.actions.values.SearchPossibleValueSourceAc
|
||||
import com.kingsrook.qqq.backend.core.context.QContext;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.logging.QLogger;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceOutput;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.code.InitializableViaCodeReference;
|
||||
@@ -143,6 +146,8 @@ public class UpdateInputRecordFieldMetaDataAdjuster implements FormAdjusterInter
|
||||
}
|
||||
}
|
||||
|
||||
adjustPossibleValueSourceFilterCriteriaInputs(updatedField.getPossibleValueSourceFilter());
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////////
|
||||
// build the output object, starting with the new meta-data of the 'value' field //
|
||||
///////////////////////////////////////////////////////////////////////////////////
|
||||
@@ -186,6 +191,43 @@ public class UpdateInputRecordFieldMetaDataAdjuster implements FormAdjusterInter
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
* if the field has a possible-value-source filter on it, and that filter
|
||||
* uses an input field e.g., ${input.someField} - consider that this value
|
||||
* *might* be an attribute on the workflow so add an optional
|
||||
* ??${input.workflow.someField} after it.
|
||||
***************************************************************************/
|
||||
static void adjustPossibleValueSourceFilterCriteriaInputs(QQueryFilter filter)
|
||||
{
|
||||
if(filter == null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
for(QFilterCriteria criteria : CollectionUtils.nonNullList(filter.getCriteria()))
|
||||
{
|
||||
List<Serializable> values = CollectionUtils.nonNullList(criteria.getValues());
|
||||
ListIterator<Serializable> valueIterator = values.listIterator();
|
||||
while(valueIterator.hasNext())
|
||||
{
|
||||
Serializable value = valueIterator.next();
|
||||
if(value instanceof String stringValue && stringValue.startsWith("${input."))
|
||||
{
|
||||
String inputFieldName = stringValue.replace("${input.", "").replace("}", "");
|
||||
String updatedValue = stringValue + "??${input.workflow." + inputFieldName + "}";
|
||||
valueIterator.set(updatedValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for(QQueryFilter subFilter : CollectionUtils.nonNullList(filter.getSubFilters()))
|
||||
{
|
||||
adjustPossibleValueSourceFilterCriteriaInputs(subFilter);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
**
|
||||
***************************************************************************/
|
||||
|
||||
+88
-29
@@ -60,7 +60,10 @@ import org.json.JSONObject;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** workflow step that updates a record with one value in one field
|
||||
* Workflow step that updates a record with one value in one field
|
||||
*
|
||||
* This class includes some public static methods that can be useful for other
|
||||
* workflow step implementations that have similar functionality.
|
||||
*******************************************************************************/
|
||||
public class UpdateInputRecordFieldStep extends WorkflowStepType implements WorkflowStepExecutorInterface, WorkflowStepValidatorInterface
|
||||
{
|
||||
@@ -101,7 +104,15 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
**
|
||||
* For a given fieldName, tableName, and api and version (which come from a
|
||||
* workflowRevision), get QFieldMetaData for that field (if it's in that
|
||||
* API Version).
|
||||
*
|
||||
* @param fieldNameMaybeWithTableNamePrefix - field name - which can be
|
||||
* prefixed by tableName + "."
|
||||
* @param tableName table name
|
||||
* @param workflowRevision from which api name and version will come
|
||||
* @return optional containing QFieldMetaData if found, or empty if not.
|
||||
***************************************************************************/
|
||||
public static Optional<QFieldMetaData> getApiField(String fieldNameMaybeWithTableNamePrefix, String tableName, WorkflowRevision workflowRevision) throws QException
|
||||
{
|
||||
@@ -121,6 +132,31 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
|
||||
***************************************************************************/
|
||||
@Override
|
||||
public String getDynamicStepSummary(Integer workflowId, Map<String, Serializable> inputValues) throws QException
|
||||
{
|
||||
QRecord workflowRecord = GetAction.execute(Workflow.TABLE_NAME, workflowId);
|
||||
String tableName = workflowRecord.getValueString("tableName");
|
||||
return getStepSummary(inputValues, tableName, false);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
* Helper for {@link #getDynamicStepSummary(Integer, Map)} or
|
||||
* {@link #execute(WorkflowStep, Map, WorkflowExecutionContext)} to generate
|
||||
* a string like "${fieldLabel} will be / was set to ${value}" or "... cleared out"
|
||||
* where the value will be a translated possible value if applicable.
|
||||
*
|
||||
* @param inputValues map of values user assigned to the step. expected to
|
||||
* include String fieldName and String value.
|
||||
* @param tableName table that the field should come from. Many times this
|
||||
* may be the tableName on the workflow - but it could be
|
||||
* a hard-coded tableName in other implementations of this
|
||||
* step type.
|
||||
* @param isPastTense to format the message as "will be" or "was". e.g.,
|
||||
* for getDynamicStepSummary would be false ("will be")
|
||||
* and for execute would be true ("was").
|
||||
***************************************************************************/
|
||||
public static String getStepSummary(Map<String, Serializable> inputValues, String tableName, boolean isPastTense)
|
||||
{
|
||||
String fieldName = ValueUtils.getValueAsString(inputValues.get("fieldName"));
|
||||
String value = ValueUtils.getValueAsString(inputValues.get("value"));
|
||||
@@ -137,45 +173,38 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
|
||||
}
|
||||
}
|
||||
|
||||
return getStepSummary(workflowId, fieldName, apiName, apiVersion, value, false);
|
||||
return getStepSummary(fieldName, tableName, apiName, apiVersion, value, isPastTense);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
**
|
||||
*
|
||||
***************************************************************************/
|
||||
private String getStepSummary(Integer workflowId, String fieldName, String apiName, String apiVersion, String value, boolean isPastTense)
|
||||
private static String getStepSummary(String fieldName, String tableName, String apiName, String apiVersion, String value, boolean isPastTense)
|
||||
{
|
||||
String fieldLabel = null;
|
||||
QTableMetaData table = null;
|
||||
QTableMetaData table = QContext.getQInstance().getTable(tableName);
|
||||
|
||||
if(StringUtils.hasContent(fieldName))
|
||||
{
|
||||
try
|
||||
{
|
||||
if(workflowId != null)
|
||||
WorkflowRevision workflowRevision = new WorkflowRevision().withApiName(apiName).withApiVersion(apiVersion);
|
||||
if(WorkflowStepUtils.useApi(workflowRevision))
|
||||
{
|
||||
QRecord workflowRecord = GetAction.execute(Workflow.TABLE_NAME, workflowId);
|
||||
table = QContext.getQInstance().getTable(workflowRecord.getValueString("tableName"));
|
||||
|
||||
WorkflowRevision workflowRevision = new WorkflowRevision().withApiName(apiName).withApiVersion(apiVersion);
|
||||
if(WorkflowStepUtils.useApi(workflowRevision))
|
||||
Optional<QFieldMetaData> optionalApiField = getApiField(fieldName, tableName, workflowRevision);
|
||||
if(optionalApiField.isPresent())
|
||||
{
|
||||
Optional<QFieldMetaData> optionalApiField = getApiField(fieldName, table.getName(), workflowRevision);
|
||||
if(optionalApiField.isPresent())
|
||||
{
|
||||
// fieldName = optionalApiField.field().getName(); // hmm?
|
||||
fieldLabel = optionalApiField.get().getLabel();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
FieldAndJoinTable fieldAndJoinTable = FieldAndJoinTable.get(table, fieldName);
|
||||
fieldName = fieldAndJoinTable.field().getName();
|
||||
fieldLabel = fieldAndJoinTable.field().getLabel();
|
||||
fieldLabel = optionalApiField.get().getLabel();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
FieldAndJoinTable fieldAndJoinTable = FieldAndJoinTable.get(table, fieldName);
|
||||
fieldName = fieldAndJoinTable.field().getName();
|
||||
fieldLabel = fieldAndJoinTable.field().getLabel();
|
||||
}
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
@@ -183,15 +212,22 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
|
||||
}
|
||||
}
|
||||
|
||||
String verb = isPastTense ? "was" : "will be";
|
||||
|
||||
if(StringUtils.hasContent(fieldLabel))
|
||||
{
|
||||
String verb = isPastTense ? "was" : "will be";
|
||||
if(StringUtils.hasContent(value))
|
||||
{
|
||||
String displayValue = value;
|
||||
try
|
||||
{
|
||||
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// field names from this PVS are always table.field - but QValueFormatter doesn't expect that - so strip away table. //
|
||||
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
if(fieldName != null && fieldName.startsWith(tableName + "."))
|
||||
{
|
||||
fieldName = fieldName.replace(tableName + ".", "");
|
||||
}
|
||||
|
||||
QRecord record = new QRecord().withValue(fieldName, value);
|
||||
QValueFormatter.setDisplayValuesInRecordsIncludingPossibleValueTranslations(table, List.of(record));
|
||||
displayValue = record.getDisplayValue(fieldName);
|
||||
@@ -241,7 +277,8 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
|
||||
|
||||
context.doesRecordNeedUpdated.set(true);
|
||||
|
||||
String stepSummary = getStepSummary(context.getWorkflow().getId(), fieldName, context.getWorkflowRevision().getApiName(), context.getWorkflowRevision().getApiVersion(), value, true);
|
||||
String tableName = context.getWorkflow().getTableName();
|
||||
String stepSummary = getStepSummary(fieldName, tableName, context.getWorkflowRevision().getApiName(), context.getWorkflowRevision().getApiVersion(), value, true);
|
||||
return new WorkflowStepOutput(value, stepSummary);
|
||||
}
|
||||
|
||||
@@ -284,12 +321,34 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
|
||||
@Override
|
||||
public void validate(WorkflowStep step, Map<String, Serializable> inputValues, QRecord workflowRevision, QRecord workflow, List<String> errors) throws QException
|
||||
{
|
||||
if(WorkflowStepUtils.useApi(new WorkflowRevision(workflowRevision)))
|
||||
validate(workflow.getValueString("tableName"), inputValues, workflowRevision, errors);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
* implementation logic for {@link #validate(WorkflowStep, Map, QRecord, QRecord, List)}.
|
||||
* makes sure that, if the workflow uses API, that the field is a valid field
|
||||
* for the api version being used in the workflow revision.
|
||||
*
|
||||
* @param tableName table that the field should come from. Many times this
|
||||
* may be the tableName on the workflow - but it could be
|
||||
* a hard-coded tableName in other implementations of this
|
||||
* step type.
|
||||
* @param inputValues map of values user assigned to the step. expected to
|
||||
* include String fieldName.
|
||||
* @param workflowRevision from which api name and version will come
|
||||
* @param errors Out param - list of error message strings, which will be
|
||||
* added to if the input fieldName isn't in the table for the
|
||||
* api version on the workflowRevision
|
||||
***************************************************************************/
|
||||
public static void validate(String tableName, Map<String, Serializable> inputValues, QRecord workflowRevision, List<String> errors) throws QException
|
||||
{
|
||||
if(workflowRevision != null && WorkflowStepUtils.useApi(new WorkflowRevision(workflowRevision)))
|
||||
{
|
||||
String fieldName = ValueUtils.getValueAsString(inputValues.get("fieldName"));
|
||||
String apiName = ValueUtils.getValueAsString(workflowRevision.getValueString("apiName"));
|
||||
String apiVersion = ValueUtils.getValueAsString(workflowRevision.getValueString("apiVersion"));
|
||||
String tableName = ValueUtils.getValueAsString(workflow.getValueString("tableName"));
|
||||
|
||||
Optional<QFieldMetaData> optionalApiField = getApiField(fieldName, tableName, new WorkflowRevision(workflowRevision));
|
||||
if(optionalApiField.isEmpty())
|
||||
|
||||
+55
-10
@@ -140,6 +140,38 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
|
||||
throw (new QUserFacingException("Workflow not found by id: " + workflowId));
|
||||
}
|
||||
|
||||
String stepsJSON = runBackendStepInput.getValueString("steps");
|
||||
if(!StringUtils.hasContent(stepsJSON))
|
||||
{
|
||||
throw (new QUserFacingException("Workflow steps input was not provided."));
|
||||
}
|
||||
|
||||
List<WorkflowStep> workflowSteps;
|
||||
try
|
||||
{
|
||||
workflowSteps = JsonUtils.toObject(stepsJSON, new TypeReference<>() {});
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
throw (new QUserFacingException("Error parsing workflow steps json: " + e.getMessage(), e));
|
||||
}
|
||||
|
||||
String linksJSON = runBackendStepInput.getValueString("links");
|
||||
if(!StringUtils.hasContent(linksJSON))
|
||||
{
|
||||
throw (new QUserFacingException("Workflow links input was not provided."));
|
||||
}
|
||||
|
||||
List<WorkflowLink> workflowLinks;
|
||||
try
|
||||
{
|
||||
workflowLinks = JsonUtils.toObject(linksJSON, new TypeReference<>() {});
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
throw (new QUserFacingException("Error parsing workflow links json: " + e.getMessage(), e));
|
||||
}
|
||||
|
||||
////////////////////////////
|
||||
// look up next versionNo //
|
||||
////////////////////////////
|
||||
@@ -166,15 +198,15 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
|
||||
// insert the workflow revision //
|
||||
//////////////////////////////////
|
||||
String commitMessage = runBackendStepInput.getValueString("commitMessage");
|
||||
String userName = ObjectUtils.tryElse(() -> QContext.getQSession().getUser().getFullName(), "Unknown");
|
||||
WorkflowRevision workflowRevision = new WorkflowRevision();
|
||||
workflowRevision.setWorkflowId(workflowId);
|
||||
workflowRevision.setVersionNo(versionNo);
|
||||
workflowRevision.setCommitMessage(StringUtils.hasContent(commitMessage) ? commitMessage : "New workflow revision created by " + QContext.getQSession().getUser().getFullName());
|
||||
workflowRevision.setCommitMessage(StringUtils.hasContent(commitMessage) ? commitMessage : "New workflow revision created by " + userName);
|
||||
workflowRevision.setApiName(runBackendStepInput.getValueString("apiName"));
|
||||
workflowRevision.setApiVersion(runBackendStepInput.getValueString("apiVersion"));
|
||||
workflowRevision.setAuthor(ObjectUtils.tryElse(() -> QContext.getQSession().getUser().getFullName(), "Unknown"));
|
||||
workflowRevision.setAuthor(userName);
|
||||
|
||||
List<WorkflowStep> workflowSteps = JsonUtils.toObject(runBackendStepInput.getValueString("steps"), new TypeReference<>() {});
|
||||
if(!workflowSteps.isEmpty())
|
||||
{
|
||||
workflowRevision.setStartStepNo(workflowSteps.get(0).getStepNo());
|
||||
@@ -208,19 +240,24 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
|
||||
//////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// store steps (first setting revision id, validating, and putting a fresh summary on each) //
|
||||
//////////////////////////////////////////////////////////////////////////////////////////////
|
||||
List<String> errors = new ArrayList<>();
|
||||
List<String> errors = new ArrayList<>();
|
||||
List<String> errorsForThisStep = new ArrayList<>();
|
||||
workflowSteps.forEach(step ->
|
||||
{
|
||||
try
|
||||
{
|
||||
step.setWorkflowRevisionId(insertedRevisionId);
|
||||
|
||||
WorkflowStepType workflowStepType = WorkflowsRegistry.of(QContext.getQInstance()).getWorkflowStepType(step.getWorkflowStepTypeName());
|
||||
Map<String, Serializable> inputValues = ValueUtils.getValueAsMap(step.getInputValuesJson());
|
||||
WorkflowStepType workflowStepType = WorkflowsRegistry.of(QContext.getQInstance()).getWorkflowStepType(step.getWorkflowStepTypeName());
|
||||
if(workflowStepType == null)
|
||||
{
|
||||
throw (new QUserFacingException("Unknown workflow step type " + step.getWorkflowStepTypeName()));
|
||||
}
|
||||
|
||||
////////////////////////////////////
|
||||
// summary - if it fails, :shrug: //
|
||||
////////////////////////////////////
|
||||
Map<String, Serializable> inputValues = ValueUtils.getValueAsMap(step.getInputValuesJson());
|
||||
try
|
||||
{
|
||||
step.setSummary(workflowStepType.getDynamicStepSummary(workflowId, inputValues));
|
||||
@@ -237,18 +274,27 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
|
||||
if(validatorCodeReference != null)
|
||||
{
|
||||
WorkflowStepValidatorInterface validator = QCodeLoader.getAdHoc(WorkflowStepValidatorInterface.class, validatorCodeReference);
|
||||
validator.validate(step, inputValues, workflowRevisionRecord, workflowRecord, errors);
|
||||
validator.validate(step, inputValues, workflowRevisionRecord, workflowRecord, errorsForThisStep);
|
||||
if(!errorsForThisStep.isEmpty())
|
||||
{
|
||||
///////////////////////////////////////
|
||||
// put Step # in front of all errors //
|
||||
///////////////////////////////////////
|
||||
errors.addAll(errorsForThisStep.stream().map(e -> "Step " + step.getStepNo() + ": " + e).toList());
|
||||
errorsForThisStep.clear();
|
||||
}
|
||||
}
|
||||
}
|
||||
catch(Exception e)
|
||||
{
|
||||
errors.add("Error processing step [" + step.getSummary() + "]: " + e.getMessage());
|
||||
errors.add("Error processing Step " + step.getStepNo() + ": " + e.getMessage());
|
||||
}
|
||||
});
|
||||
|
||||
if(!errors.isEmpty())
|
||||
{
|
||||
throw (new QUserFacingException("Validation errors in steps: " + StringUtils.joinWithCommasAndAnd(errors)));
|
||||
String message = errors.size() + " validation error" + StringUtils.plural(errors) + " occurred within the workflow's steps:\n" + StringUtils.join("\n", errors);
|
||||
throw (new QUserFacingException(message));
|
||||
}
|
||||
|
||||
new InsertAction().execute(new InsertInput(WorkflowStep.TABLE_NAME).withRecordEntities(workflowSteps).withTransaction(transaction));
|
||||
@@ -256,7 +302,6 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
|
||||
/////////////////
|
||||
// store links //
|
||||
/////////////////
|
||||
List<WorkflowLink> workflowLinks = JsonUtils.toObject(runBackendStepInput.getValueString("links"), new TypeReference<>() {});
|
||||
workflowLinks.forEach(link -> link.setWorkflowRevisionId(insertedRevisionId));
|
||||
new InsertAction().execute(new InsertInput(WorkflowLink.TABLE_NAME).withRecordEntities(workflowLinks).withTransaction(transaction));
|
||||
|
||||
|
||||
@@ -142,7 +142,7 @@ public class BaseTest
|
||||
// basic definition of an instance //
|
||||
/////////////////////////////////////
|
||||
QInstance qInstance = new QInstance();
|
||||
qInstance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withType(QAuthenticationType.FULLY_ANONYMOUS));
|
||||
qInstance.setAuthentication(new QAuthenticationMetaData().withType(QAuthenticationType.FULLY_ANONYMOUS));
|
||||
qInstance.addBackend(new RDBMSBackendMetaData()
|
||||
.withName(RDBMS_BACKEND_NAME)
|
||||
.withVendor("h2")
|
||||
|
||||
+124
@@ -0,0 +1,124 @@
|
||||
/*
|
||||
* 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/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package com.kingsrook.qbits.workflows.implementations.recordworkflows;
|
||||
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import com.kingsrook.qbits.workflows.BaseTest;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.model.metadata.frontend.QFrontendFieldMetaData;
|
||||
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
|
||||
import com.kingsrook.qqq.frontend.materialdashboard.actions.formadjuster.FormAdjusterInput;
|
||||
import com.kingsrook.qqq.frontend.materialdashboard.actions.formadjuster.FormAdjusterOutput;
|
||||
import com.kingsrook.qqq.frontend.materialdashboard.actions.formadjuster.RunFormAdjusterProcess;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Unit test for UpdateInputRecordFieldMetaDataAdjuster
|
||||
*******************************************************************************/
|
||||
class UpdateInputRecordFieldMetaDataAdjusterTest extends BaseTest
|
||||
{
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testExecute() throws QException
|
||||
{
|
||||
Map<String, Serializable> allValues = Map.of(
|
||||
"workflowValuesJSON", JsonUtils.toJson(Map.of("tableName", TABLE_NAME_PERSON)),
|
||||
"workflowRevisionValuesJSON", JsonUtils.toJson(Map.of()),
|
||||
"value", 1
|
||||
);
|
||||
|
||||
///////////////////////
|
||||
// run for on-change //
|
||||
///////////////////////
|
||||
FormAdjusterOutput onChangeOutput = new UpdateInputRecordFieldMetaDataAdjuster().execute(new FormAdjusterInput()
|
||||
.withFieldName("fieldName")
|
||||
.withNewValue(TABLE_NAME_PERSON + ".firstName")
|
||||
.withAllValues(allValues)
|
||||
.withEvent(RunFormAdjusterProcess.EVENT_ON_CHANGE));
|
||||
assertEquals(Set.of("value"), onChangeOutput.getFieldsToClear());
|
||||
|
||||
assertEquals(1, onChangeOutput.getUpdatedFieldMetaData().size());
|
||||
assertThat(onChangeOutput.getUpdatedFieldDisplayValues()).isNullOrEmpty();
|
||||
QFrontendFieldMetaData updatedValueField = onChangeOutput.getUpdatedFieldMetaData().get("value");
|
||||
assertEquals("Value (First Name)", updatedValueField.getLabel());
|
||||
|
||||
/////////////////////
|
||||
// run for on-load //
|
||||
/////////////////////
|
||||
new InsertAction().execute(new InsertInput(TABLE_NAME_SHAPE).withRecord(new QRecord().withValue("id", 1).withValue("name", "Square")));
|
||||
|
||||
FormAdjusterOutput onLoadOutput = new UpdateInputRecordFieldMetaDataAdjuster().execute(new FormAdjusterInput()
|
||||
.withFieldName("fieldName")
|
||||
.withNewValue(TABLE_NAME_PERSON + ".favoriteShapeId")
|
||||
.withAllValues(allValues)
|
||||
.withEvent(RunFormAdjusterProcess.EVENT_ON_LOAD));
|
||||
assertThat(onLoadOutput.getFieldsToClear()).isNullOrEmpty();
|
||||
assertEquals(Map.of("value", "Square"), onLoadOutput.getUpdatedFieldDisplayValues());
|
||||
updatedValueField = onLoadOutput.getUpdatedFieldMetaData().get("value");
|
||||
assertEquals("Value (Favorite Shape)", updatedValueField.getLabel());
|
||||
assertEquals(TABLE_NAME_SHAPE, updatedValueField.getPossibleValueSourceName());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testAdjustPossibleValueSourceFilterCriteriaInputs()
|
||||
{
|
||||
QFieldMetaData field = new QFieldMetaData();
|
||||
UpdateInputRecordFieldMetaDataAdjuster.adjustPossibleValueSourceFilterCriteriaInputs(field.getPossibleValueSourceFilter());
|
||||
assertNull(field.getPossibleValueSourceFilter());
|
||||
|
||||
field.setPossibleValueSourceFilter(new QQueryFilter(new QFilterCriteria("id", QCriteriaOperator.EQUALS, 1)));
|
||||
UpdateInputRecordFieldMetaDataAdjuster.adjustPossibleValueSourceFilterCriteriaInputs(field.getPossibleValueSourceFilter());
|
||||
assertEquals(1, field.getPossibleValueSourceFilter().getCriteria().get(0).getValues().get(0));
|
||||
|
||||
field.setPossibleValueSourceFilter(new QQueryFilter(new QFilterCriteria("someId", QCriteriaOperator.EQUALS, "${input.someId}")));
|
||||
UpdateInputRecordFieldMetaDataAdjuster.adjustPossibleValueSourceFilterCriteriaInputs(field.getPossibleValueSourceFilter());
|
||||
assertEquals("${input.someId}??${input.workflow.someId}", field.getPossibleValueSourceFilter().getCriteria().get(0).getValues().get(0));
|
||||
|
||||
field.setPossibleValueSourceFilter(new QQueryFilter().withSubFilter(new QQueryFilter(new QFilterCriteria("someId", QCriteriaOperator.EQUALS, "${input.someId}"))));
|
||||
UpdateInputRecordFieldMetaDataAdjuster.adjustPossibleValueSourceFilterCriteriaInputs(field.getPossibleValueSourceFilter());
|
||||
assertEquals("${input.someId}??${input.workflow.someId}", field.getPossibleValueSourceFilter().getSubFilters().get(0).getCriteria().get(0).getValues().get(0));
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
+161
@@ -0,0 +1,161 @@
|
||||
/*
|
||||
* 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/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package com.kingsrook.qbits.workflows.implementations.recordworkflows;
|
||||
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qbits.workflows.BaseTest;
|
||||
import com.kingsrook.qbits.workflows.model.WorkflowRevision;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
|
||||
import com.kingsrook.qqq.backend.core.model.data.QRecord;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Unit test for UpdateInputRecordFieldStep
|
||||
*******************************************************************************/
|
||||
class UpdateInputRecordFieldStepTest extends BaseTest
|
||||
{
|
||||
private static WorkflowRevision workflowRevisionV1 = new WorkflowRevision().withApiName(API_NAME).withApiVersion(V1);
|
||||
private static WorkflowRevision workflowRevisionV2 = new WorkflowRevision().withApiName(API_NAME).withApiVersion(V2);
|
||||
private static WorkflowRevision workflowRevisionV3 = new WorkflowRevision().withApiName(API_NAME).withApiVersion(V3);
|
||||
private static WorkflowRevision workflowRevisionWithoutApi = new WorkflowRevision();
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testGetApiField() throws QException
|
||||
{
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".firstName", TABLE_NAME_PERSON, workflowRevisionV1))
|
||||
.isPresent().get().hasFieldOrPropertyWithValue("name", "firstName");
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField("firstName", TABLE_NAME_PERSON, workflowRevisionV1))
|
||||
.isPresent().get().hasFieldOrPropertyWithValue("name", "firstName");
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField("noSuchField", TABLE_NAME_PERSON, workflowRevisionV1))
|
||||
.isEmpty();
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".noSuchField", TABLE_NAME_PERSON, workflowRevisionV1))
|
||||
.isEmpty();
|
||||
|
||||
/////////////////////////////////////
|
||||
// this field is excluded from api //
|
||||
/////////////////////////////////////
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".debt", TABLE_NAME_PERSON, workflowRevisionV1))
|
||||
.isEmpty();
|
||||
|
||||
///////////////////////////////
|
||||
// this field is added in V3 //
|
||||
///////////////////////////////
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".salary", TABLE_NAME_PERSON, workflowRevisionV1))
|
||||
.isEmpty();
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".salary", TABLE_NAME_PERSON, workflowRevisionV3))
|
||||
.isPresent().get().hasFieldOrPropertyWithValue("name", "salary");
|
||||
|
||||
//////////////////////////////////////////
|
||||
// confirm shoeCount/noOfShoes renaming //
|
||||
//////////////////////////////////////////
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".shoeCount", TABLE_NAME_PERSON, workflowRevisionV1))
|
||||
.isPresent().get().hasFieldOrPropertyWithValue("name", "shoeCount");
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".shoeCount", TABLE_NAME_PERSON, workflowRevisionV2))
|
||||
.isEmpty();
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".noOfShoes", TABLE_NAME_PERSON, workflowRevisionV1))
|
||||
.isEmpty();
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".noOfShoes", TABLE_NAME_PERSON, workflowRevisionV2))
|
||||
.isPresent().get().hasFieldOrPropertyWithValue("name", "noOfShoes");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testGetStepSummary() throws QException
|
||||
{
|
||||
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName", "value", "John"), TABLE_NAME_PERSON, false))
|
||||
.isEqualTo("First Name will be set to 'John'");
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName", "value", "John"), TABLE_NAME_PERSON, true))
|
||||
.isEqualTo("First Name was set to 'John'");
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName", "value", ""), TABLE_NAME_PERSON, false))
|
||||
.isEqualTo("First Name will be cleared out");
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName"), TABLE_NAME_PERSON, true))
|
||||
.isEqualTo("First Name was cleared out");
|
||||
|
||||
new InsertAction().execute(new InsertInput(TABLE_NAME_SHAPE).withRecord(new QRecord().withValue("id", 1).withValue("name", "Square")));
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".favoriteShapeId", "value", "1"), TABLE_NAME_PERSON, false))
|
||||
.isEqualTo("Favorite Shape will be set to 'Square'");
|
||||
|
||||
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".favoriteShapeId", "value", "1"), TABLE_NAME_PERSON, true))
|
||||
.isEqualTo("Favorite Shape was set to 'Square'");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testValidate() throws QException
|
||||
{
|
||||
assertThat(runValidate(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName"), workflowRevisionV1)).isEmpty();
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////////
|
||||
// debt field - found if not using api, else not found as it is excluded from api //
|
||||
////////////////////////////////////////////////////////////////////////////////////
|
||||
assertThat(runValidate(Map.of("fieldName", TABLE_NAME_PERSON + ".debt"), workflowRevisionWithoutApi)).isEmpty();
|
||||
assertThat(runValidate(Map.of("fieldName", TABLE_NAME_PERSON + ".debt"), workflowRevisionV1)).hasSize(1)
|
||||
.element(0).asString()
|
||||
.contains("Could not find field 'person.debt' in table '" + TABLE_NAME_PERSON + "' for API '" + API_NAME + "' version 'v1'");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
private List<String> runValidate(Map<String, Serializable> inputValues, WorkflowRevision workflowRevision) throws QException
|
||||
{
|
||||
List<String> errors = new ArrayList<>();
|
||||
UpdateInputRecordFieldStep.validate(TABLE_NAME_PERSON, inputValues, workflowRevision == null ? null : workflowRevision.toQRecord(), errors);
|
||||
return (errors);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
-106
@@ -1,106 +0,0 @@
|
||||
/*
|
||||
* QQQ - Low-code Application Framework for Engineers.
|
||||
* Copyright (C) 2021-2025. Kingsrook, LLC
|
||||
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
|
||||
* contact@kingsrook.com
|
||||
* https://github.com/Kingsrook/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package com.kingsrook.qbits.workflows.metadata;
|
||||
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qbits.workflows.BaseTest;
|
||||
import com.kingsrook.qbits.workflows.WorkflowsTestDataSource;
|
||||
import com.kingsrook.qbits.workflows.implementations.recordworkflows.RecordWorkflowsDefinition;
|
||||
import com.kingsrook.qbits.workflows.model.Workflow;
|
||||
import com.kingsrook.qbits.workflows.model.WorkflowTestScenario;
|
||||
import com.kingsrook.qqq.backend.core.actions.processes.RunProcessAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
|
||||
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.insert.InsertInput;
|
||||
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
|
||||
import com.kingsrook.qqq.frontend.materialdashboard.actions.formadjuster.RunFormAdjusterProcess;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Runs the workflows form adjusters through the current Material Dashboard
|
||||
** form-adjuster process, the same way the UI API's table form-adjuster route
|
||||
** does (path params + multipart-style form params) - not by calling them directly.
|
||||
*******************************************************************************/
|
||||
class WorkflowTestAssertionFormAdjusterTest extends BaseTest
|
||||
{
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testVariableNameAdjusterThroughMaterialDashboardProcess() throws Exception
|
||||
{
|
||||
|
||||
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(RecordWorkflowsDefinition.WORKFLOW_TYPE, TABLE_NAME_PERSON);
|
||||
Integer scenarioId = new InsertAction().execute(new InsertInput(WorkflowTestScenario.TABLE_NAME).withRecordEntity(
|
||||
new WorkflowTestScenario().withWorkflowId(workflow.getId()).withName("s").withApiName(API_NAME).withApiVersion(V3).withApiJson("{}"))).getRecords().get(0).getValueInteger("id");
|
||||
|
||||
Map<String, Object> output = runAdjuster("WorkflowTestAssertion.variableName", RunFormAdjusterProcess.EVENT_ON_CHANGE,
|
||||
TABLE_NAME_PERSON + ".firstName", Map.of("workflowTestScenarioId", scenarioId));
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
Map<String, Object> expectedValueField = (Map<String, Object>) ((Map<String, Object>) output.get("updatedFieldMetaData")).get("expectedValue");
|
||||
assertNotNull(expectedValueField);
|
||||
assertTrue(String.valueOf(expectedValueField.get("label")).startsWith("Expected Value ("), "label: " + expectedValueField.get("label"));
|
||||
assertEquals(List.of("expectedValue"), output.get("fieldsToClear"));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
**
|
||||
***************************************************************************/
|
||||
private Map<String, Object> runAdjuster(String identifier, String event, String newValue, Map<String, Object> allValues) throws Exception
|
||||
{
|
||||
Map<String, List<String>> formParams = new HashMap<>();
|
||||
formParams.put("event", List.of(event));
|
||||
formParams.put("fieldName", List.of("variableName"));
|
||||
formParams.put("newValue", List.of(newValue));
|
||||
formParams.put("allValues", List.of(JsonUtils.toJson(allValues)));
|
||||
|
||||
RunProcessInput input = new RunProcessInput();
|
||||
input.setProcessName(RunFormAdjusterProcess.NAME);
|
||||
input.setFrontendStepBehavior(RunProcessInput.FrontendStepBehavior.SKIP);
|
||||
input.addValue("pathParams", new HashMap<>(Map.of("identifier", identifier, "event", event)));
|
||||
input.addValue("formParams", (Serializable) formParams);
|
||||
|
||||
RunProcessOutput processOutput = new RunProcessAction().execute(input);
|
||||
if(processOutput.getException().isPresent())
|
||||
{
|
||||
throw (processOutput.getException().get());
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
Map<String, Object> result = JsonUtils.toObject(processOutput.getValueString("responseString"), Map.class);
|
||||
return (result);
|
||||
}
|
||||
|
||||
}
|
||||
+102
@@ -0,0 +1,102 @@
|
||||
/*
|
||||
* 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/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package com.kingsrook.qbits.workflows.processes;
|
||||
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qbits.workflows.BaseTest;
|
||||
import com.kingsrook.qbits.workflows.TestWorkflowDefinitions;
|
||||
import com.kingsrook.qbits.workflows.WorkflowsTestDataSource;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
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.utils.JsonUtils;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.assertj.core.api.Assertions.assertThatThrownBy;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** Unit test for StoreNewWorkflowRevisionProcess
|
||||
*******************************************************************************/
|
||||
class StoreNewWorkflowRevisionProcessTest extends BaseTest
|
||||
{
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void test() throws QException
|
||||
{
|
||||
TestWorkflowDefinitions.registerTestWorkflowTypes();
|
||||
Integer workflowId = WorkflowsTestDataSource.insertTestWorkflow();
|
||||
|
||||
RunBackendStepInput input = new RunBackendStepInput();
|
||||
|
||||
RunBackendStepOutput output = new RunBackendStepOutput();
|
||||
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
|
||||
.hasMessageContaining("Workflow id is required");
|
||||
|
||||
input.addValue("workflowId", -999);
|
||||
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
|
||||
.hasMessageContaining("Workflow not found by id: -999");
|
||||
|
||||
input.addValue("workflowId", workflowId);
|
||||
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
|
||||
.hasMessageContaining("steps input was not provided");
|
||||
|
||||
input.addValue("steps", "1, 2, 3");
|
||||
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
|
||||
.hasMessageContaining("Error parsing workflow steps");
|
||||
|
||||
input.addValue("steps", JsonUtils.toJson(List.of(
|
||||
WorkflowsTestDataSource.newStep(1, "myStepType", Map.of("foo", 1)),
|
||||
WorkflowsTestDataSource.newStep(2, "yourStepType", Map.of("bar", true, "baz", false))
|
||||
)));
|
||||
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
|
||||
.hasMessageContaining("links input was not provided");
|
||||
|
||||
input.addValue("links", "not json");
|
||||
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
|
||||
.hasMessageContaining("Error parsing workflow links");
|
||||
|
||||
input.addValue("links", JsonUtils.toJson(List.of(WorkflowsTestDataSource.newLink(1, 2))));
|
||||
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
|
||||
.hasMessageContaining("2 validation errors occurred within the workflow's steps:")
|
||||
.hasMessageContaining("Error processing Step 1: Unknown workflow step type myStepType")
|
||||
.hasMessageContaining("Error processing Step 2: Unknown workflow step type yourStepType");
|
||||
|
||||
input.addValue("steps", JsonUtils.toJson(List.of(
|
||||
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("foo", 1)),
|
||||
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.BOOLEAN_CONDITIONAL, Map.of("bar", true, "baz", false))
|
||||
)));
|
||||
new StoreNewWorkflowRevisionProcess().run(input, output);
|
||||
assertNotNull(output.getValue("workflowRevisionId"));
|
||||
assertEquals(2, output.getValue("versionNo"));
|
||||
|
||||
new StoreNewWorkflowRevisionProcess().run(input, output);
|
||||
assertEquals(3, output.getValue("versionNo"));
|
||||
}
|
||||
|
||||
}
|
||||
Reference in new issue
Block a user