build: re-pin to qbit-build-parent 2.0.0 and back-merge main (QRun-IO/qqq#768) #7
No files matched your search
@@ -3,10 +3,22 @@ version: 2.1
|
||||
orbs:
|
||||
qqq-orb: kingsrook/qqq-orb@0.6
|
||||
|
||||
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
|
||||
|
||||
workflows:
|
||||
test_only:
|
||||
jobs:
|
||||
- qqq-orb/mvn_test_only:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
filters:
|
||||
branches:
|
||||
@@ -17,6 +29,8 @@ workflows:
|
||||
publish_snapshot:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: snapshot
|
||||
filters:
|
||||
@@ -27,6 +41,8 @@ workflows:
|
||||
publish_feature:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: feature
|
||||
filters:
|
||||
@@ -39,6 +55,8 @@ workflows:
|
||||
publish_release_candidate:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: release_candidate
|
||||
filters:
|
||||
@@ -49,6 +67,8 @@ workflows:
|
||||
publish_release:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: release
|
||||
filters:
|
||||
@@ -60,6 +80,8 @@ workflows:
|
||||
publish_hotfix_release:
|
||||
jobs:
|
||||
- qqq-orb/mvn_publish:
|
||||
pre-steps:
|
||||
- configure-package-install
|
||||
context: [qqq-maven-registry-credentials]
|
||||
branch_type: hotfix
|
||||
filters:
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
* @KofTwentyTwo
|
||||
@@ -0,0 +1,31 @@
|
||||
# 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:
|
||||
- "*"
|
||||
@@ -0,0 +1,24 @@
|
||||
# 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):
|
||||
|
||||
- develop carries unreleased 2026 feature work plus everything on main, and builds on
|
||||
qqq 4.0.0 via parent `com.kingsrook:qbit-build-parent:2.0.0` (`-Pqqq-snapshot`
|
||||
checks qqq 4.1.0-SNAPSHOT); main is the released line (0.4.0) on qqq 0.35.0 via
|
||||
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.
|
||||
@@ -0,0 +1,202 @@
|
||||
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.
|
||||
@@ -0,0 +1,15 @@
|
||||
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,109 +1,150 @@
|
||||
# QBit: Workflows
|
||||
# qbit-workflows
|
||||
|
||||
[](https://github.com/Kingsrook/qbit-workflows)
|
||||
[](https://www.gnu.org/licenses/agpl-3.0.en.html)
|
||||
[](https://adoptium.net/)
|
||||
State machine workflows for QQQ applications.
|
||||
|
||||
### 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!*
|
||||
**For:** QQQ developers building approval flows, order pipelines, or any multi-step business processes
|
||||
**Status:** Stable
|
||||
|
||||
This QBit provides TODO
|
||||
## Why This Exists
|
||||
|
||||
## 🏗️ Architecture
|
||||
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.
|
||||
|
||||
### Technology Stack
|
||||
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.
|
||||
|
||||
- **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
|
||||
## Features
|
||||
|
||||
### Core Capabilities
|
||||
- **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
|
||||
|
||||
- **Workflow Management**: TODO - Define workflow capabilities
|
||||
- **Process Automation**: TODO - Define automation features
|
||||
- **Integration**: TODO - Define integration capabilities
|
||||
|
||||
## 🚀 Quick Start
|
||||
## Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Java 17+** (required for QQQ features)
|
||||
- **Maven 3.8+** (for build system)
|
||||
- QQQ application (v4.0.0+)
|
||||
- Database backend configured
|
||||
|
||||
### Usage
|
||||
### Installation
|
||||
|
||||
Add to your `pom.xml`:
|
||||
|
||||
#### Pom dependency
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qbits</groupId>
|
||||
<artifactId>qbit-workflows</artifactId>
|
||||
<version>${TODO}</version>
|
||||
<version>0.4.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
#### Setup
|
||||
TODO
|
||||
### Register the QBit
|
||||
|
||||
### Provides
|
||||
#### Tables
|
||||
TODO
|
||||
```java
|
||||
public class AppMetaProvider extends QMetaProvider {
|
||||
@Override
|
||||
public void configure(QInstance qInstance) {
|
||||
new WorkflowsQBit().configure(qInstance);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Classes
|
||||
TODO
|
||||
### Define a Workflow
|
||||
|
||||
### Dependencies
|
||||
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")
|
||||
);
|
||||
```
|
||||
|
||||
## 📚 Documentation
|
||||
## Usage
|
||||
|
||||
**📖 [Complete Documentation Wiki](https://github.com/Kingsrook/qqq/wiki)** - Start here for comprehensive guides
|
||||
### Transition Actions
|
||||
|
||||
- **[🏠 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
|
||||
```java
|
||||
new QWorkflowTransition("approved", "shipped")
|
||||
.withAction(new ShipOrderAction());
|
||||
|
||||
## 🤝 Contributing
|
||||
public class ShipOrderAction implements WorkflowTransitionAction {
|
||||
@Override
|
||||
public void execute(WorkflowTransitionContext context) {
|
||||
// Send shipping notification
|
||||
// Update inventory
|
||||
// Generate tracking number
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Important**: This repository is a component of the QQQ framework. All contributions, issues, and discussions should go through the main QQQ repository.
|
||||
### Role-Based Transitions
|
||||
|
||||
### Development Workflow
|
||||
```java
|
||||
// Only managers can approve
|
||||
new QWorkflowTransition("pending", "approved")
|
||||
.withAllowedRoles("manager", "admin");
|
||||
```
|
||||
|
||||
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
|
||||
### Transition Validation
|
||||
|
||||
### Code Standards
|
||||
```java
|
||||
new QWorkflowTransition("approved", "shipped")
|
||||
.withValidator((context) -> {
|
||||
if (context.getRecord().getValue("shippingAddress") == null) {
|
||||
throw new WorkflowException("Shipping address required");
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
- **Maven**: Follow Maven best practices
|
||||
- **Documentation**: Update relevant documentation
|
||||
- **Versioning**: Follow semantic versioning
|
||||
- **QBit Pattern**: Follow QBit component architecture
|
||||
### Querying by State
|
||||
|
||||
**First time contributing?** Start with our [Developer Onboarding Guide](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding) to get your environment set up.
|
||||
```java
|
||||
// Find all pending orders
|
||||
QueryInput query = new QueryInput()
|
||||
.withTableName("order")
|
||||
.withFilter(new QQueryFilter()
|
||||
.withCriteria("status", Operator.EQUALS, "pending"));
|
||||
```
|
||||
|
||||
## 🏢 About Kingsrook
|
||||
## Configuration
|
||||
|
||||
QBit Workflows is built by **[Kingsrook](https://qrun.io)** - making engineers more productive through intelligent automation and developer tools.
|
||||
The QBit creates a transition history table automatically:
|
||||
|
||||
- **Website**: [https://qrun.io](https://qrun.io)
|
||||
- **Contact**: [contact@kingsrook.com](mailto:contact@kingsrook.com)
|
||||
- **GitHub**: [https://github.com/Kingsrook](https://github.com/Kingsrook)
|
||||
| Table | Purpose |
|
||||
|-------|---------|
|
||||
| `workflow_transition_log` | Audit trail of all state changes |
|
||||
|
||||
## 📄 License
|
||||
Each log entry records: record ID, from state, to state, user, timestamp, and optional comments.
|
||||
|
||||
This project is licensed under the **GNU Affero General Public License v3.0** - see the [LICENSE.txt](LICENSE.txt) file for details.
|
||||
## Project Status
|
||||
|
||||
---
|
||||
Stable and production-ready.
|
||||
|
||||
**Ready to build workflows with full control?** [Get started with QQQ today!](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)
|
||||
### Roadmap
|
||||
|
||||
- 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
|
||||
@@ -29,7 +29,7 @@
|
||||
<parent>
|
||||
<groupId>com.kingsrook</groupId>
|
||||
<artifactId>qbit-build-parent</artifactId>
|
||||
<version>1.5.1</version>
|
||||
<version>2.0.0</version>
|
||||
</parent>
|
||||
|
||||
<groupId>com.kingsrook.qbits</groupId>
|
||||
@@ -73,24 +73,21 @@
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qqq</groupId>
|
||||
<artifactId>qqq-backend-core</artifactId>
|
||||
<version>0.40.0-join-enhancements-24cb9791-20260216.220349-1</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qqq</groupId>
|
||||
<artifactId>qqq-middleware-api</artifactId>
|
||||
<version>0.40.0-join-enhancements-24cb9791-20260216.220349-1</version>
|
||||
<optional>true</optional>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qqq</groupId>
|
||||
<artifactId>qqq-backend-module-rdbms</artifactId>
|
||||
<version>0.40.0-join-enhancements-24cb9791-20260216.220349-1</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qqq</groupId>
|
||||
<artifactId>qqq-frontend-material-dashboard</artifactId>
|
||||
<version>0.27.0-RC.1</version>
|
||||
<version>0.41.0</version>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
@@ -106,4 +103,39 @@
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<profiles>
|
||||
<!-- Opt-in check against the next qqq line: mvn -B verify -Pqqq-snapshot -->
|
||||
<!-- (override the version with -Dqqq.snapshot.version=...). Default builds -->
|
||||
<!-- take the qqq version only from qbit-build-parent (ADR-0007). -->
|
||||
<profile>
|
||||
<id>qqq-snapshot</id>
|
||||
<properties>
|
||||
<qqq.snapshot.version>4.1.0-SNAPSHOT</qqq.snapshot.version>
|
||||
</properties>
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.kingsrook.qqq</groupId>
|
||||
<artifactId>qqq-bom-pom</artifactId>
|
||||
<version>${qqq.snapshot.version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</dependencyManagement>
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>sonatype-snapshots</id>
|
||||
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
|
||||
<releases>
|
||||
<enabled>false</enabled>
|
||||
</releases>
|
||||
<snapshots>
|
||||
<enabled>true</enabled>
|
||||
</snapshots>
|
||||
</repository>
|
||||
</repositories>
|
||||
</profile>
|
||||
</profiles>
|
||||
|
||||
</project>
|
||||
+2
-1
@@ -41,6 +41,7 @@ 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;
|
||||
@@ -354,7 +355,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 GetTableApiFieldsAction.ApiNameVersionAndTableName(apiName, apiVersion, tableName));
|
||||
Map<String, QFieldMetaData> tableApiFields = GetTableApiFieldsAction.getTableApiFieldMap(new GetTableApiFieldsInput().withApiName(apiName).withVersion(apiVersion).withTableName(tableName));
|
||||
ArrayList<String> badRequestMessages = new ArrayList<>();
|
||||
ApiQueryFilterUtils.manageCriteriaFields(filter, tableApiFields, badRequestMessages, apiName, apiVersion, new QueryInput(tableName).withFilter(filter));
|
||||
errors.addAll(badRequestMessages);
|
||||
|
||||
+2
-1
@@ -31,6 +31,7 @@ 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;
|
||||
@@ -189,7 +190,7 @@ public class RecordWorkflowUtils
|
||||
{
|
||||
WorkflowRevision workflowRevision = context.getWorkflowRevision();
|
||||
Workflow workflow = context.getWorkflow();
|
||||
Map<String, QFieldMetaData> tableApiFields = GetTableApiFieldsAction.getTableApiFieldMap(new GetTableApiFieldsAction.ApiNameVersionAndTableName(workflowRevision.getApiName(), workflowRevision.getApiVersion(), workflow.getTableName()));
|
||||
Map<String, QFieldMetaData> tableApiFields = GetTableApiFieldsAction.getTableApiFieldMap(new GetTableApiFieldsInput().withApiName(workflowRevision.getApiName()).withVersion(workflowRevision.getApiVersion()).withTableName(workflow.getTableName()));
|
||||
List<String> badRequestMessages = new ArrayList<>();
|
||||
|
||||
CountInput countInput = new CountInput(context.getWorkflow().getTableName())
|
||||
|
||||
+2
-2
@@ -78,10 +78,10 @@ public class RunRecordWorkflowExtractStep extends ExtractViaQueryStep
|
||||
** Make sure associations are fetched (so api records have children!)
|
||||
*******************************************************************************/
|
||||
@Override
|
||||
protected void customizeInputPreQuery(QueryInput queryInput)
|
||||
protected void customizeInputPreQuery(RunBackendStepInput runBackendStepInput, QueryInput queryInput)
|
||||
{
|
||||
super.customizeInputPreQuery(queryInput);
|
||||
queryInput.setIncludeAssociations(true);
|
||||
super.customizeInputPreQuery(runBackendStepInput, queryInput);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -142,7 +142,7 @@ public class BaseTest
|
||||
// basic definition of an instance //
|
||||
/////////////////////////////////////
|
||||
QInstance qInstance = new QInstance();
|
||||
qInstance.setAuthentication(new QAuthenticationMetaData().withType(QAuthenticationType.FULLY_ANONYMOUS));
|
||||
qInstance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withType(QAuthenticationType.FULLY_ANONYMOUS));
|
||||
qInstance.addBackend(new RDBMSBackendMetaData()
|
||||
.withName(RDBMS_BACKEND_NAME)
|
||||
.withVendor("h2")
|
||||
|
||||
+75
-1
@@ -24,11 +24,13 @@ package com.kingsrook.qbits.workflows.implementations.recordworkflows;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.math.BigDecimal;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import com.kingsrook.qbits.workflows.BaseTest;
|
||||
import com.kingsrook.qbits.workflows.execution.WorkflowStepOutput;
|
||||
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.backend.core.actions.tables.InsertAction;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
@@ -45,6 +47,7 @@ import static com.kingsrook.qbits.workflows.CompanyHierarchyTablesAndJoinsMetaDa
|
||||
import static com.kingsrook.qbits.workflows.CompanyHierarchyTablesAndJoinsMetaDataProducer.EMPLOYEE_TABLE;
|
||||
import static com.kingsrook.qbits.workflows.CompanyHierarchyTablesAndJoinsMetaDataProducer.JOB_HISTORY_TABLE;
|
||||
import static com.kingsrook.qbits.workflows.CompanyHierarchyTablesAndJoinsMetaDataProducer.JOB_TITLE_TABLE;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
|
||||
|
||||
@@ -78,6 +81,43 @@ class InputRecordFilterStepTest extends BaseTest
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** with an api version on the revision, filter fields are api field names -
|
||||
** v1's shoeCount was replaced by the backend's noOfShoes.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testFilterUsingApiFieldNames() throws QException
|
||||
{
|
||||
WorkflowRevision workflowRevisionV1 = new WorkflowRevision().withApiName(API_NAME).withApiVersion(V1);
|
||||
QQueryFilter shoeCountIs47 = new QQueryFilter().withCriteria("shoeCount", QCriteriaOperator.EQUALS, 47);
|
||||
|
||||
assertOutput(true, TABLE_NAME_PERSON, shoeCountIs47, workflowRevisionV1, Map.of("id", 1, "noOfShoes", 47));
|
||||
assertOutput(false, TABLE_NAME_PERSON, shoeCountIs47, workflowRevisionV1, Map.of("id", 1, "noOfShoes", 3));
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** validation checks filter fields against the api version's fields.
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testValidateUsingApiFieldNames() throws QException
|
||||
{
|
||||
QRecord workflowRevisionV1 = new WorkflowRevision().withApiName(API_NAME).withApiVersion(V1).toQRecord();
|
||||
QRecord workflow = new Workflow().withTableName(TABLE_NAME_PERSON).toQRecord();
|
||||
|
||||
assertThat(runValidate(new QQueryFilter().withCriteria("shoeCount", QCriteriaOperator.EQUALS, 47), workflowRevisionV1, workflow))
|
||||
.isEmpty();
|
||||
|
||||
/////////////////////////////////////////
|
||||
// noOfShoes only joined the api in v2 //
|
||||
/////////////////////////////////////////
|
||||
assertThat(runValidate(new QQueryFilter().withCriteria("noOfShoes", QCriteriaOperator.EQUALS, 47), workflowRevisionV1, workflow))
|
||||
.containsExactly("Unrecognized criteria field name: noOfShoes.");
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
**
|
||||
*******************************************************************************/
|
||||
@@ -477,10 +517,20 @@ class InputRecordFilterStepTest extends BaseTest
|
||||
*
|
||||
***************************************************************************/
|
||||
void assertOutput(boolean expectedOutput, String tableName, QQueryFilter filter, Map<String, Serializable> recordValues) throws QException
|
||||
{
|
||||
assertOutput(expectedOutput, tableName, filter, null, recordValues);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
void assertOutput(boolean expectedOutput, String tableName, QQueryFilter filter, WorkflowRevision workflowRevision, Map<String, Serializable> recordValues) throws QException
|
||||
{
|
||||
QRecord record = new QRecord();
|
||||
record.setValues(recordValues);
|
||||
assertOutput(expectedOutput, tableName, filter, record);
|
||||
assertOutput(expectedOutput, tableName, filter, workflowRevision, record);
|
||||
}
|
||||
|
||||
|
||||
@@ -489,16 +539,40 @@ class InputRecordFilterStepTest extends BaseTest
|
||||
*
|
||||
***************************************************************************/
|
||||
void assertOutput(boolean expectedOutput, String tableName, QQueryFilter filter, QRecord record) throws QException
|
||||
{
|
||||
assertOutput(expectedOutput, tableName, filter, null, record);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
void assertOutput(boolean expectedOutput, String tableName, QQueryFilter filter, WorkflowRevision workflowRevision, QRecord record) throws QException
|
||||
{
|
||||
WorkflowStep step = new WorkflowStep();
|
||||
Map<String, Serializable> inputValues = Map.of("queryFilterJson", JsonUtils.toJson(filter));
|
||||
|
||||
RecordWorkflowContext context = new RecordWorkflowContext();
|
||||
context.setWorkflow(new Workflow().withTableName(tableName));
|
||||
context.setWorkflowRevision(workflowRevision);
|
||||
context.record.set(record);
|
||||
record.setTableName(tableName);
|
||||
|
||||
WorkflowStepOutput stepOutput = new InputRecordFilterStep().execute(step, inputValues, context);
|
||||
assertEquals(expectedOutput, stepOutput.outputData());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
*
|
||||
***************************************************************************/
|
||||
private List<String> runValidate(QQueryFilter filter, QRecord workflowRevision, QRecord workflow) throws QException
|
||||
{
|
||||
List<String> errors = new ArrayList<>();
|
||||
Map<String, Serializable> inputValues = Map.of("queryFilterJson", JsonUtils.toJson(filter));
|
||||
new InputRecordFilterStep().validate(new WorkflowStep(), inputValues, workflowRevision, workflow, errors);
|
||||
return (errors);
|
||||
}
|
||||
}
|
||||
+14
@@ -42,6 +42,7 @@ import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
|
||||
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
|
||||
import com.kingsrook.qqq.backend.core.exceptions.QException;
|
||||
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.RunProcessInput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessOutput;
|
||||
import com.kingsrook.qqq.backend.core.model.actions.processes.Status;
|
||||
@@ -209,6 +210,19 @@ class RunRecordWorkflowProcessTest extends BaseTest
|
||||
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
** the extract step must fetch associations (so api records have children).
|
||||
*******************************************************************************/
|
||||
@Test
|
||||
void testExtractStepIncludesAssociations()
|
||||
{
|
||||
QueryInput queryInput = new QueryInput(Workflow.TABLE_NAME);
|
||||
new RunRecordWorkflowExtractStep().customizeInputPreQuery(new RunBackendStepInput(), queryInput);
|
||||
assertTrue(queryInput.getIncludeAssociations());
|
||||
}
|
||||
|
||||
|
||||
|
||||
/***************************************************************************
|
||||
**
|
||||
***************************************************************************/
|
||||
|
||||
Reference in new issue
Block a user