Compare commits

...
Author SHA1 Message Date
james.maes 3683375dbf ci: pin settings-safe QQQ orb 0.6.8
Use reviewed release tooling for QRun-IO/qqq-all#10; keep release versions unchanged.
2026-09-30 10:51:05 -05:00
james.maes 92a1425c34 build: re-pin to qbit-build-parent 2.0.0 (#7)
Closes QRun-IO/qqq#768. Part of QRun-IO/qqq-all#1.
2026-09-26 01:09:15 -05:00
james.maes 7ac729eff8 docs: note qqq 4.0 baseline in README and CLAUDE.md
The README prerequisite and the CLAUDE.md build facts now match the 2.0.0 parent.

Part of QRun-IO/qqq-all#1
2026-09-25 20:50:39 -05:00
james.maes d1a8515c44 ci: keep package installs unattended on machine executors
Adds qbit-quick-search's configure-package-install pre-step so needrestart cannot hang install_java (QRun-IO/qqq-orb#11).

Part of QRun-IO/qqq-all#1
2026-09-25 20:50:24 -05:00
james.maes 341827916c build: add opt-in qqq-snapshot profile
-Pqqq-snapshot imports qqq-bom-pom 4.1.0-SNAPSHOT (override with -Dqqq.snapshot.version) and adds the Central snapshots repository.

Part of QRun-IO/qqq-all#1
2026-09-25 20:49:24 -05:00
james.maes ca909fdb53 test: cover api field names in filters and extract associations
Guards the qqq 4.0 migrations: filter validation and execution resolve fields per api version, and the extract step still fetches associations.

Part of QRun-IO/qqq-all#1
2026-09-25 20:47:45 -05:00
james.maes dd7c7f4fda build: re-pin to qbit-build-parent 2.0.0 (qqq 4.0.0)
The parent's qqq BOM now sets the qqq module versions; material dashboard moves to 0.41.0 (built for qqq 4.0) and code uses the qqq 4.0 replacements for removed APIs.

Part of QRun-IO/qqq-all#1
2026-09-25 20:47:27 -05:00
james.maes 34f620ea43 chore: merge main into develop
Brings main's LICENSE, NOTICE, CODEOWNERS, CLAUDE.md, release config and README; keeps develop's orb 0.6 and revision 0.114.0-SNAPSHOT.

Part of QRun-IO/qqq-all#1
2026-09-25 20:41:44 -05:00
James MaesandClaude Opus 4.8 23ade22276 docs: add CLAUDE.md pointer to QQQ knowledge-base dossier + hub
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-12 05:31:32 -05:00
james.maesandClaude Opus 4.7 4f3c7719f9 chore: add CODEOWNERS pointing to sole maintainer
Architecture audit pass 2026-05-21. Minimal CODEOWNERS file
making the implicit ownership explicit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-21 17:14:27 -05:00
Darin Kelkhoff 80a632634a Merge pull request #6 from QRun-IO/feature/follow-all-exposed-joins-in-input-record-filter-step
Feature/follow all exposed joins in input record filter step
2026-03-24 16:37:14 -05:00
Darin Kelkhoff 349882379c chore: cleanup from code review 2026-02-16 16:38:54 -06:00
Darin Kelkhoff 3b8f659b69 chore: update other qqq deps to pinned branch version 2026-02-16 16:30:00 -06:00
Darin Kelkhoff 8770f6331d chore: update to kingsrook/qqq-orb@0.6 2026-02-16 16:23:46 -06:00
Darin Kelkhoff a1fa73bf45 chore: update qbit-build-parent to 1.5.1 (java 21) 2026-02-16 16:21:01 -06:00
Darin Kelkhoff 2149b265ad chore: update qqq version to tagged branch build (fix for validation w/ flipped joins) 2026-02-16 16:17:07 -06:00
Darin Kelkhoff 6d0ad8b033 feat(recordWorkflowsFilterJoins): Improve support for filtering by an exposed join on a table, including relationships including 'many's.
Also expose a class, RecordWorkflowContextJoinedRecordHelper, that application-defined workflow types can use to make their filter steps work the same way.

Add large test on InputRecordFilterStep - that tries to do as many versions of 1-n, n-1, n-1-n, 1-n-1, etc, that my friend claude and i could come up with - along with a CompanyHierarchyTablesAndJoinsMetaDataProducer that defines a nice complex set of tables & joins.
2026-02-16 16:04:40 -06:00
Darin Kelkhoff 95f4ae1fa5 fix(containers): fix case where a container that ends with a conditional, with an empty path - when that's executed, the null to-step-no coming out of that step was ending the workflow too early.
instead of, break the loop at that point, and pop the container if in a container.

add a test for this - and - refactor the test class to avoid nested blocks, letting each test-case be its own method
2026-01-26 15:24:00 -06:00
Darin Kelkhoff 84e1ef8dd8 fix: correct the names of these widgets 2026-01-26 14:07:32 -06:00
james.maes 292750756c chore: migrate license from AGPL-3.0 to Apache-2.0 2026-01-05 10:14:27 -06:00
james.maes 2ee383ed4c docs: update README with correct group ID and version 2025-12-28 16:43:56 -06:00
CircleCI a16f419346 Bump version to 0.4.0 [skip ci] 2025-12-28 22:38:22 +00:00
james.maes 0e2fc89a33 feat: Java 21 LTS migration with qbit-build-parent 1.5.0 (#4)
* feat: migrate to Java 21 with qbit-build-parent 1.5.0

* fix: update qbit-build-parent to 1.5.1 for JUnit 6 compatibility

* chore: retrigger CI after Maven Central sync
2025-12-28 16:35:58 -06:00
james.maes 1304b7254d chore(license): add AGPL-3.0 license with QRun-IO copyright 2025-12-25 19:32:46 -06:00
james.maes 54c3289084 docs: Standardize README 2025-12-24 14:18:55 -06:00
james.maes b7c4aabf0e ci: Add GitHub release configuration 2025-12-24 12:44:00 -06:00
Darin Kelkhoff 4a13f52556 fix(recordWorkflows): filter workflowId field by workflowTypeName when adding it to tableTriggers 2025-12-15 11:24:46 -06:00
Darin Kelkhoff 4965ba611a Merge pull request #3 from QRun-IO/feature/multi-forking-steps
Feature/multi forking steps
2025-12-01 10:32:49 -06:00
CircleCI 56f75dd7a7 Bump version to 0.3.0 [skip ci] 2025-09-18 19:47:47 +00:00
james.maes 13c8ed9a2f Merge for release 0.3.0 2025-09-18 14:46:14 -05:00
CircleCI 01cb9384b2 Bump version to 0.2.0 [skip ci] 2025-09-18 15:07:06 +00:00
23 changed files with 2127 additions and 361 deletions

No files matched your search

+23 -1
View File
@@ -1,12 +1,24 @@
version: 2.1
orbs:
qqq-orb: kingsrook/qqq-orb@0.3.12
qqq-orb: kingsrook/qqq-orb@0.6.8
commands:
configure-package-install:
steps:
- run:
name: Keep package installation unattended
command: |
# These build machines are discarded after the job.
sudo install -d /etc/needrestart/conf.d
printf '%s\n' '$nrconf{restart} = "l";' | sudo tee /etc/needrestart/conf.d/99-qqq-ci.conf >/dev/null
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:
+1
View File
@@ -0,0 +1 @@
* @KofTwentyTwo
+31
View File
@@ -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:
- "*"
+24
View File
@@ -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.
+202
View File
@@ -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.
+15
View File
@@ -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.
================================================================================
+109 -68
View File
@@ -1,109 +1,150 @@
# QBit: Workflows
# qbit-workflows
[![Version](https://img.shields.io/badge/version-TODO-blue.svg)](https://github.com/Kingsrook/qbit-workflows)
[![License](https://img.shields.io/badge/license-GNU%20Affero%20GPL%20v3-green.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)
[![Java](https://img.shields.io/badge/java-17+-blue.svg)](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
+37 -2
View File
@@ -29,7 +29,7 @@
<parent>
<groupId>com.kingsrook</groupId>
<artifactId>qbit-build-parent</artifactId>
<version>1.4.0</version>
<version>2.0.0</version>
</parent>
<groupId>com.kingsrook.qbits</groupId>
@@ -87,7 +87,7 @@
<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>
@@ -103,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>
@@ -173,8 +173,9 @@ public class WorkflowsQBitProducer implements QBitMetaDataProducer<WorkflowsQBit
tableTriggerTable.withField(new QFieldMetaData("workflowId", QFieldType.INTEGER)
.withBackendName("workflow_id")
.withPossibleValueSourceName(Workflow.TABLE_NAME)
.withPossibleValueSourceFilter(new QQueryFilter(
new QFilterCriteria("tableName", QCriteriaOperator.EQUALS, "${input.tableName}"))));
.withPossibleValueSourceFilter(new QQueryFilter()
.withCriteria(new QFilterCriteria("workflowTypeName", QCriteriaOperator.EQUALS, RecordWorkflowsDefinition.WORKFLOW_TYPE))
.withCriteria(new QFilterCriteria("tableName", QCriteriaOperator.EQUALS, "${input.tableName}"))));
//////////////////////////////////////////////////////////////////////////////
// place workflowId field after scriptId in whatever section scriptId is in //
@@ -393,7 +393,22 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
Serializable valueAsType = stepOutputClass == null ? link.getConditionValue() : ValueUtils.getValueAsType(stepOutputClass, link.getConditionValue());
if(Objects.equals(valueAsType, stepOutput))
{
return link.getToStepNo();
////////////////////////////////////////////////////////////////////////////////
// a null link to-step no here may (always?) mean that a branch is empty. //
// but, rather than just returning null, we'll instead break this loop, so we //
// can be sure to hit the check for being inside a container before the end //
// of this method (which, if we're not in a container, will return null). //
// see testContainerEndingWithConditionalWithOneEmptySide //
////////////////////////////////////////////////////////////////////////////////
if(link.getToStepNo() != null)
{
return link.getToStepNo();
}
else
{
LOG.debug("Found link with condition value matching stepOutput, but no toStepNo - this may be expected for an empty branch within a container?", logPair("fromStepNo", link.getFromStepNo()), logPair("condition", link.getConditionValue()));
break;
}
}
}
catch(Exception e)
@@ -25,8 +25,10 @@ package com.kingsrook.qbits.workflows.implementations.recordworkflows;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.kingsrook.qbits.workflows.definition.OutboundLinkMode;
import com.kingsrook.qbits.workflows.definition.OutboundLinkOption;
import com.kingsrook.qbits.workflows.definition.WorkflowStepType;
@@ -39,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;
@@ -54,6 +57,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.utils.BackendQueryFilterUtils;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
import com.kingsrook.qqq.backend.core.utils.StringUtils;
/*******************************************************************************
@@ -106,8 +110,10 @@ public class InputRecordFilterStep extends WorkflowStepType implements WorkflowS
**
***************************************************************************/
@Override
public WorkflowStepOutput execute(WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext context) throws QException
public WorkflowStepOutput execute(WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext workflowExecutionContext) throws QException
{
RecordWorkflowContext context = (RecordWorkflowContext) workflowExecutionContext;
QRecord record = (QRecord) context.getValues().get("record");
if(record == null)
{
@@ -130,26 +136,38 @@ public class InputRecordFilterStep extends WorkflowStepType implements WorkflowS
///////////////////////////////////////////////////////////////////////////////
filter.applyCriteriaOptionToAllCriteria(CriteriaOption.CASE_INSENSITIVE);
List<QRecordWithJoinedRecords> recordWithJoins = buildCrossProduct(record, filter, context);
List<QRecordWithJoinedRecords> recordWithJoins = buildCrossProduct(record, filter, context.recordWorkflowContextJoinedRecordHelper.get());
return evaluateCrossProduct(recordWithJoins, filter);
}
/***************************************************************************
* For a given record, and a filter, and a {@link RecordWorkflowContextJoinedRecordHelper}
* object from a live workflow context, build a List of {@link QRecordWithJoinedRecords}
* that can be used to evaluate if a record (with joins) matches a filter.
*
* <p>Note that this method is public, and called by application-defined workflows.
* In other words, this method is part of our published API in here!</p>
*
* @param record the main record in the workflow
* @param filter the filter which may have joins (thus the need for a cross-product)
* @param joinedRecordHelper object from context of the workflow that knows
* about cached join records and records being inserted
* and/or deleted.
* @return {@code List<QRecordWithJoinedRecords>} the cross product that the
* filter should be evaluated against.
***************************************************************************/
public List<QRecordWithJoinedRecords> buildCrossProduct(QRecord record, QQueryFilter filter, WorkflowExecutionContext workflowExecutionContext) throws QException
public static List<QRecordWithJoinedRecords> buildCrossProduct(QRecord record, QQueryFilter filter, RecordWorkflowContextJoinedRecordHelper joinedRecordHelper) throws QException
{
RecordWorkflowContext context = (RecordWorkflowContext) workflowExecutionContext;
List<QRecordWithJoinedRecords> crossProduct = new ArrayList<>();
crossProduct.add(new QRecordWithJoinedRecords(record));
List<QueryJoin> joinsInFilter = BackendQueryFilterUtils.identifyJoinsInFilter(context.getWorkflow().getTableName(), filter);
List<QueryJoin> joinsInFilter = BackendQueryFilterUtils.identifyJoinsInFilter(joinedRecordHelper.getTableName(), filter);
joinsInFilter = sortQueryJoinsFromMainTableOutward(joinedRecordHelper.getTableName(), joinsInFilter);
for(QueryJoin join : joinsInFilter)
{
crossProduct = expandCrossProductViaJoin(crossProduct, join, context);
crossProduct = expandCrossProductViaJoin(crossProduct, join, joinedRecordHelper);
}
return crossProduct;
@@ -157,16 +175,96 @@ public class InputRecordFilterStep extends WorkflowStepType implements WorkflowS
/*******************************************************************************
* Sort the query joins so that they fan outward from the main table to ones
* farther away.
*
* <p>This is so, if we've got a -> b -> c -- we'll process 'b' before 'c',
* as we need the records in 'b' to find the records in 'c'.</p>
*
* <p><i>Note that this method was copied from {@code AbstractRDBMSAction}</i></p>
*******************************************************************************/
private static List<QueryJoin> sortQueryJoinsFromMainTableOutward(String mainTableName, List<QueryJoin> queryJoins)
{
List<QueryJoin> rs = new ArrayList<>();
////////////////////////////////////////////////////////////////////////////////
// make a copy of the input list that we can feel safe removing elements from //
////////////////////////////////////////////////////////////////////////////////
List<QueryJoin> inputListCopy = new ArrayList<>(queryJoins);
///////////////////////////////////////////////////////////////////////////////////////////////////
// keep track of the tables (or aliases) that we've seen - that's what we'll "grow" outward from //
///////////////////////////////////////////////////////////////////////////////////////////////////
Set<String> seenTablesOrAliases = new HashSet<>();
seenTablesOrAliases.add(mainTableName);
////////////////////////////////////////////////////////////////////////////////////
// loop as long as there are more tables in the inputList, and the keepGoing flag //
// is set (e.g., indicating that we added something in the last iteration) //
////////////////////////////////////////////////////////////////////////////////////
boolean keepGoing = true;
while(!inputListCopy.isEmpty() && keepGoing)
{
keepGoing = false;
Iterator<QueryJoin> iterator = inputListCopy.iterator();
while(iterator.hasNext())
{
QueryJoin nextQueryJoin = iterator.next();
//////////////////////////////////////////////////////////////////////////
// get the baseTableOrAlias from this join - and if it isn't set in the //
// QueryJoin, then get it from the left-side of the join's metaData //
//////////////////////////////////////////////////////////////////////////
String baseTableOrAlias = nextQueryJoin.getBaseTableOrAlias();
if(baseTableOrAlias == null && nextQueryJoin.getJoinMetaData() != null)
{
baseTableOrAlias = nextQueryJoin.getJoinMetaData().getLeftTable();
}
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// if we have a baseTableOrAlias (would we ever not?), and we've seen it before - OR - we've seen this query join's joinTableOrAlias, //
// then we can add this pair of namesOrAliases to our seen-set, remove this queryJoin from the inputListCopy (iterator), and keep going //
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if((StringUtils.hasContent(baseTableOrAlias) && seenTablesOrAliases.contains(baseTableOrAlias)) || seenTablesOrAliases.contains(nextQueryJoin.getJoinTableOrItsAlias()))
{
rs.add(nextQueryJoin);
if(StringUtils.hasContent(baseTableOrAlias))
{
seenTablesOrAliases.add(baseTableOrAlias);
}
seenTablesOrAliases.add(nextQueryJoin.getJoinTableOrItsAlias());
iterator.remove();
keepGoing = true;
}
}
}
///////////////////////////////////////////////////////////////////////////////////////////////////////////////
// in case any are left, add them all here - does this ever happen? //
// the only time a conditional breakpoint here fires in the RDBMS test suite, is in query designed to throw. //
///////////////////////////////////////////////////////////////////////////////////////////////////////////////
rs.addAll(inputListCopy);
return (rs);
}
/***************************************************************************
*
***************************************************************************/
private static List<QRecordWithJoinedRecords> expandCrossProductViaJoin(List<QRecordWithJoinedRecords> orderWithJoinedRecords, QueryJoin queryJoin, RecordWorkflowContext context) throws QException
private static List<QRecordWithJoinedRecords> expandCrossProductViaJoin(List<QRecordWithJoinedRecords> recordWithJoinedRecords, QueryJoin queryJoin, RecordWorkflowContextJoinedRecordHelper joinedRecordHelper) throws QException
{
String joinTableName = queryJoin.getJoinTable();
ArrayList<QRecord> recordsToBeInserted = context.recordsToInsert.get().computeIfAbsent(joinTableName, k -> new ArrayList<>());
List<QRecord> recordsAlreadyInBackend = context.getJoinRecords(queryJoin);
HashSet<Serializable> idsToDelete = context.primaryKeysToDelete.get().computeIfAbsent(joinTableName, k -> new HashSet<>());
String primaryKeyField = QContext.getQInstance().getTable(joinTableName).getPrimaryKeyField();
String joinTableName = queryJoin.getJoinTable();
List<QRecord> recordsToBeInserted = joinedRecordHelper.getRecordsToInsert(joinTableName);
List<QRecord> recordsAlreadyInBackend = joinedRecordHelper.getJoinRecords(queryJoin);
Set<Serializable> idsToDelete = joinedRecordHelper.getPrimaryKeysToDelete(joinTableName);
String primaryKeyField = QContext.getQInstance().getTable(joinTableName).getPrimaryKeyField();
//////////////////////////////////////////////////////////////////////////////////////////////////////
// add records that already existed to the cross product, filtering out ones that are to be deleted //
@@ -185,8 +283,8 @@ public class InputRecordFilterStep extends WorkflowStepType implements WorkflowS
////////////////////////////////////
CollectionUtils.addAllIfNotNull(recordsToCross, recordsToBeInserted);
orderWithJoinedRecords = makeCrossProduct(orderWithJoinedRecords, joinTableName, recordsToCross);
return orderWithJoinedRecords;
recordWithJoinedRecords = makeCrossProduct(recordWithJoinedRecords, joinTableName, recordsToCross);
return recordWithJoinedRecords;
}
@@ -194,18 +292,21 @@ public class InputRecordFilterStep extends WorkflowStepType implements WorkflowS
/***************************************************************************
*
***************************************************************************/
private static List<QRecordWithJoinedRecords> makeCrossProduct(List<QRecordWithJoinedRecords> orderWithJoinedRecords, String joinTableName, List<QRecord> joinRecodsToCross)
private static List<QRecordWithJoinedRecords> makeCrossProduct(List<QRecordWithJoinedRecords> recordsWithJoinedRecords, String joinTableName, List<QRecord> joinRecordsToCross)
{
if(!joinRecodsToCross.isEmpty())
if(recordsWithJoinedRecords.isEmpty() || joinRecordsToCross.isEmpty())
{
List<QRecordWithJoinedRecords> newCrossProduct = new ArrayList<>();
for(QRecordWithJoinedRecords orderWithJoinedRecord : orderWithJoinedRecords)
{
newCrossProduct.addAll(orderWithJoinedRecord.buildCrossProduct(joinTableName, joinRecodsToCross));
}
orderWithJoinedRecords = newCrossProduct;
return new ArrayList<>();
}
return orderWithJoinedRecords;
List<QRecordWithJoinedRecords> newCrossProduct = new ArrayList<>();
for(QRecordWithJoinedRecords recordWithJoinedRecord : recordsWithJoinedRecords)
{
newCrossProduct.addAll(recordWithJoinedRecord.buildCrossProduct(joinTableName, joinRecordsToCross));
}
recordsWithJoinedRecords = newCrossProduct;
return recordsWithJoinedRecords;
}
@@ -254,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);
@@ -25,24 +25,16 @@ package com.kingsrook.qbits.workflows.implementations.recordworkflows;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import com.google.gson.reflect.TypeToken;
import com.kingsrook.qbits.workflows.execution.LazyInitObjectInWorkflowContext;
import com.kingsrook.qbits.workflows.execution.ObjectInWorkflowContext;
import com.kingsrook.qbits.workflows.execution.WorkflowExecutionContext;
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.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.actions.tables.query.QueryJoin;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.data.QRecordEntity;
import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
/*******************************************************************************
@@ -57,17 +49,43 @@ public class RecordWorkflowContext extends WorkflowExecutionContext
public final ObjectInWorkflowContext<HashMap<String, ArrayList<QRecord>>> recordsToInsert = new ObjectInWorkflowContext<>(this, "recordsToInsert", new HashMap<>());
public final ObjectInWorkflowContext<HashMap<String, HashSet<Serializable>>> primaryKeysToDelete = new ObjectInWorkflowContext<>(this, "primaryKeysToDelete", new HashMap<>());
///////////////////////////////////////////////////////////////////////////////////////////
// records already stored in the backend that are joined with the main record. //
// should only be accessed via the getRelatedRecords method, which lazy inits (by query) //
///////////////////////////////////////////////////////////////////////////////////////////
private final ObjectInWorkflowContext<HashMap<JoinKey, ArrayList<QRecord>>> joinRecords = new ObjectInWorkflowContext<>(this, "joinRecords", new HashMap<>());
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// records already stored in the backend that are joined with the main record - they used to be stored in a map kept //
// right here, but they've migrated into the RecordWorkflowContextJoinedRecordHelper. //
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
public final ObjectInWorkflowContext<RecordWorkflowContextJoinedRecordHelper> recordWorkflowContextJoinedRecordHelper = new LazyInitObjectInWorkflowContext<>(this, "recordWorkflowContextJoinedRecordHelper", () -> newRecordWorkflowContextJoinedRecordHelper(this));
private record JoinKey(String joinName, ArrayList<Serializable> joinValues)
/***************************************************************************
* Construct a new RecordWorkflowContextJoinedRecordHelper, which uses this
* context class's members to get the list of records to insert and the
* set of ids to delete
***************************************************************************/
private RecordWorkflowContextJoinedRecordHelper newRecordWorkflowContextJoinedRecordHelper(RecordWorkflowContext recordWorkflowContext)
{
return new RecordWorkflowContextJoinedRecordHelper(getWorkflow().getTableName(), record.get())
{
/***************************************************************************
*
***************************************************************************/
@Override
public List<QRecord> getRecordsToInsert(String tableName)
{
return recordWorkflowContext.recordsToInsert.get().computeIfAbsent(tableName, (k) -> new ArrayList<>());
}
/***************************************************************************
*
***************************************************************************/
@Override
public Set<Serializable> getPrimaryKeysToDelete(String tableName)
{
return recordWorkflowContext.primaryKeysToDelete.get().computeIfAbsent(tableName, (k) -> new HashSet<>());
}
};
}
@@ -147,81 +165,11 @@ public class RecordWorkflowContext extends WorkflowExecutionContext
/***************************************************************************
*
* allow join-records, which are normally managed by the recordWorkflowContextJoinedRecordHelper
* to be explicitly set in that object. Useful for test scenarios, maybe more.
***************************************************************************/
public List<QRecord> getJoinRecords(QueryJoin queryJoin) throws QException
public void setJoinRecords(QueryJoin queryJoin, List<QRecord> associatedRecords)
{
JoinRecordsKeyConstruction result = getJoinRecordsKeyConstruction(queryJoin, record.get());
if(joinRecords.get().get(result.key()) == null)
{
ArrayList<QRecord> records = CollectionUtils.useOrWrap(result.makeEmpty() ? Collections.emptyList() : QueryAction.execute(queryJoin.getJoinTable(), result.filter()), new TypeToken<>() {});
joinRecords.get().put(result.key(), records);
}
return joinRecords.get().get(result.key());
}
/***************************************************************************
*
***************************************************************************/
private JoinRecordsKeyConstruction getJoinRecordsKeyConstruction(QueryJoin queryJoin, QRecord mainRecord)
{
ArrayList<Serializable> joinValues = new ArrayList<>();
JoinKey key = new JoinKey(queryJoin.getJoinMetaData().getName(), joinValues);
String baseTableName = getWorkflow().getTableName();
QQueryFilter filter = new QQueryFilter();
boolean makeEmpty = false;
for(JoinOn joinOn : queryJoin.getJoinMetaData().getJoinOns())
{
Serializable mainTableValue;
String joinTableField;
if(queryJoin.getJoinMetaData().getLeftTable().equals(baseTableName))
{
mainTableValue = mainRecord.getValue(joinOn.getLeftField());
joinTableField = joinOn.getRightField();
}
else
{
mainTableValue = mainRecord.getValue(joinOn.getRightField());
joinTableField = joinOn.getLeftField();
}
key.joinValues.add(mainTableValue);
if(mainTableValue == null)
{
// throw (new QException("Missing join value in " + baseTableName + " getting related " + tableName + " records"));
makeEmpty = true;
}
filter.addCriteria(new QFilterCriteria(joinTableField, QCriteriaOperator.EQUALS, mainTableValue));
}
JoinRecordsKeyConstruction result = new JoinRecordsKeyConstruction(key, filter, makeEmpty);
return result;
}
/***************************************************************************
*
***************************************************************************/
private record JoinRecordsKeyConstruction(JoinKey key, QQueryFilter filter, boolean makeEmpty)
{
}
/***************************************************************************
*
***************************************************************************/
public void setJoinRecords(QueryJoin queryJoin, QRecord mainRecord, List<QRecord> records)
{
ArrayList<QRecord> recordArrayList = CollectionUtils.useOrWrap(records, new TypeToken<>() {});
JoinRecordsKeyConstruction result = getJoinRecordsKeyConstruction(queryJoin, mainRecord);
joinRecords.get().put(result.key(), recordArrayList);
recordWorkflowContextJoinedRecordHelper.get().setJoinRecords(queryJoin, associatedRecords);
}
}
@@ -0,0 +1,238 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import com.google.gson.reflect.TypeToken;
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.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.actions.tables.query.QueryJoin;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
import com.kingsrook.qqq.backend.core.utils.StringUtils;
/*******************************************************************************
* For workflows that are centered around a single record and may work with
* records joined to that record, an instance of this class can be put into
* the workflow's context. It can then be used, specifically, by the
* {@link InputRecordFilterStep} to build up a cross-product used to do in-
* memory filter operation.
*******************************************************************************/
public class RecordWorkflowContextJoinedRecordHelper implements Serializable
{
private final String tableName;
private final QRecord record;
private Map<String, List<QRecord>> joinRecords = new HashMap<>();
/*******************************************************************************
** Constructor
**
*******************************************************************************/
public RecordWorkflowContextJoinedRecordHelper(String tableName, QRecord record)
{
this.tableName = tableName;
this.record = record;
}
/***************************************************************************
* if the context is collecting records that will be inserted when the
* workflow is done, and those need to be included, e.g., for in-memory
* filters - then override this method (e.g., via an anonymous inner class
* in the specific workflow context class in question), and return appropriate
* pending-insertion records here.
***************************************************************************/
public List<QRecord> getRecordsToInsert(String tableName)
{
return Collections.emptyList();
}
/***************************************************************************
* if the context is collecting primary keys that will be deleted when the
* workflow is done, and those records need to be excluded, e.g., for in-memory
* filters - then override this method (e.g., via an anonymous inner class
* in the specific workflow context class in question), and return appropriate
* pending-deletion keys here.
***************************************************************************/
public Set<Serializable> getPrimaryKeysToDelete(String tableName)
{
return Collections.emptySet();
}
/***************************************************************************
* Clear the join records map. Specifically useful if the context is being
* used both during and after workflow execution (e.g. before and after
* records have been stored).
***************************************************************************/
public void reset()
{
joinRecords.clear();
}
/***************************************************************************
* get the join records for a specific query join against the main record
* of the workflow.
*
* <p>internally this method does cache those lookups - see {@code reset()}
* to clear that cache.</p>
***************************************************************************/
public List<QRecord> getJoinRecords(QueryJoin queryJoin) throws QException
{
String joinTableOrAlias = queryJoin.getJoinTableOrItsAlias();
if(!StringUtils.hasContent(joinTableOrAlias))
{
throw (new QException("Missing joinTableOrAlias in queryJoin: " + queryJoin));
}
List<QRecord> baseRecords;
if(queryJoin.getBaseTableOrAlias().equals(tableName))
{
baseRecords = List.of(record);
}
else
{
baseRecords = Objects.requireNonNullElseGet(joinRecords.get(queryJoin.getBaseTableOrAlias()), ArrayList::new);
}
QQueryFilter joinRecordsFilter = getJoinRecordsFilter(queryJoin, baseRecords);
if(joinRecords.get(joinTableOrAlias) == null)
{
List<QRecord> records = joinRecordsFilter == null ? Collections.emptyList() : QueryAction.execute(queryJoin.getJoinTable(), joinRecordsFilter);
joinRecords.put(joinTableOrAlias, records);
}
return joinRecords.get(joinTableOrAlias);
}
/***************************************************************************
* For a given queryJoin and a list of 'base records', build a filter that
* can find join records.
*
* <p>Note that this will potentially be a (a=? AND b=?) OR (a=? AND b=?)
* style query... </p>
*
* @return filter to find join records - or - null if there should be no
* join records returned (e.g., empty base record list).
***************************************************************************/
protected QQueryFilter getJoinRecordsFilter(QueryJoin queryJoin, List<QRecord> baseRecords)
{
String baseTableName = queryJoin.getBaseTableOrAlias();
if(CollectionUtils.nullSafeIsEmpty(baseRecords))
{
return (null);
}
QQueryFilter filter = new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR);
for(QRecord baseRecord : baseRecords)
{
QQueryFilter subFilter = new QQueryFilter();
filter.addSubFilter(subFilter);
for(JoinOn joinOn : queryJoin.getJoinMetaData().getJoinOns())
{
Serializable mainTableValue;
String joinTableField;
if(queryJoin.getJoinMetaData().getLeftTable().equals(baseTableName))
{
mainTableValue = baseRecord.getValue(joinOn.getLeftField());
joinTableField = joinOn.getRightField();
}
else
{
mainTableValue = baseRecord.getValue(joinOn.getRightField());
joinTableField = joinOn.getLeftField();
}
if(mainTableValue == null)
{
subFilter.addCriteria(new QFilterCriteria(joinTableField, QCriteriaOperator.FALSE));
}
else
{
subFilter.addCriteria(new QFilterCriteria(joinTableField, QCriteriaOperator.EQUALS, mainTableValue));
}
}
}
return (filter);
}
/***************************************************************************
*
***************************************************************************/
public void setJoinRecords(QueryJoin queryJoin, List<QRecord> joinRecords)
{
ArrayList<QRecord> recordArrayList = CollectionUtils.useOrWrap(joinRecords, new TypeToken<>() {});
this.joinRecords.put(queryJoin.getJoinTableOrItsAlias(), recordArrayList);
}
/*******************************************************************************
** Getter for tableName
**
*******************************************************************************/
public String getTableName()
{
return tableName;
}
/*******************************************************************************
** Getter for record
**
*******************************************************************************/
public QRecord getRecord()
{
return record;
}
}
@@ -116,9 +116,10 @@ public class RecordWorkflowTypeTester implements WorkflowTypeTesterInterface
QueryJoin queryJoin = new QueryJoin()
.withJoinTable(associatedTableName)
.withBaseTableOrAlias(tableName)
.withJoinMetaData(QContext.getQInstance().getJoin(association.get().getJoinName()));
recordWorkflowContext.setJoinRecords(queryJoin, inputRecord, associatedRecords);
recordWorkflowContext.setJoinRecords(queryJoin, associatedRecords);
}
}
}
@@ -198,6 +199,12 @@ public class RecordWorkflowTypeTester implements WorkflowTypeTesterInterface
{
RecordWorkflowContext context = (RecordWorkflowContext) workflowOutput.getContext();
/////////////////////////////////////////////////////////////////////////////////////////////////
// reset the pre-looked up joins in this object (since after the workflow is complete, records //
// will be stored, which wouldn't have been before, so it might have cached old record lists.) //
/////////////////////////////////////////////////////////////////////////////////////////////////
context.recordWorkflowContextJoinedRecordHelper.get().reset();
QRecord record = getRecordForTestAssertionFilter(workflowOutput, assertion);
if(record == null)
{
@@ -210,7 +217,7 @@ public class RecordWorkflowTypeTester implements WorkflowTypeTesterInterface
// re-use the order filtering logic of InputRecordFilterStep (e.g., building joins) //
//////////////////////////////////////////////////////////////////////////////////////
InputRecordFilterStep inputRecordFilterStep = new InputRecordFilterStep();
List<QRecordWithJoinedRecords> orderWithJoinedRecords = inputRecordFilterStep.buildCrossProduct(record, filter, context);
List<QRecordWithJoinedRecords> orderWithJoinedRecords = InputRecordFilterStep.buildCrossProduct(record, filter, context.recordWorkflowContextJoinedRecordHelper.get());
WorkflowStepOutput workflowStepOutput = inputRecordFilterStep.evaluateCrossProduct(orderWithJoinedRecords, filter);
return (Objects.equals(workflowStepOutput.outputData(), true));
@@ -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())
@@ -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);
}
}
@@ -32,7 +32,7 @@ import com.kingsrook.qqq.backend.core.utils.ValueUtils;
*******************************************************************************/
public class WorkflowRevisionViewerWidget extends BaseQSequentialWorkflowWidgetRenderer
{
public static final String NAME = "WorkflowRunLogViewer";
public static final String NAME = "WorkflowRevisionViewerWidget";
@@ -43,7 +43,7 @@ import com.kingsrook.qqq.backend.core.utils.ValueUtils;
*******************************************************************************/
public class WorkflowRunLogViewerWidget extends BaseQSequentialWorkflowWidgetRenderer
{
public static final String NAME = "WorkflowRevisionViewer";
public static final String NAME = "WorkflowRunLogViewerWidget";
@@ -136,13 +136,13 @@ public class BaseTest
/***************************************************************************
**
***************************************************************************/
private QInstance defineQInstance() throws QException
protected QInstance defineQInstance() throws QException
{
/////////////////////////////////////
// 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")
@@ -0,0 +1,324 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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;
import java.util.List;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterOrderBy;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerInterface;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerMultiOutput;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn;
import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinType;
import com.kingsrook.qqq.backend.core.model.metadata.joins.QJoinMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.tables.ExposedJoin;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
* MetaData Producer that builds several tables and joins, for a mock HR database.
*
* <p>ER Diagram (joins only):</p>
*
* <pre>
* +-------------+
* | company |
* +-------------+
* | ↓ 1:N
* |
* N:1 ↑ |
* +-------------+ → M:1 (manager)
* | department |-------------------+
* +-------------+ |
* | ↓ 1:N |
* | |
* N:1 ↑ | 1:M ↑ v
* +-------------+ 1:1 +----------------+
* | employee |---------->| employeeDetail |
* +-------------+ +----------------+
* ↓ 1:N | ^ \
* | | \ M:1 (mentor, self-join)
* | +----+
* N:1 ↑ |
* +-------------+ → M:1 +----------+
* | jobHistory |---------->| jobTitle |
* +-------------+ 1:M ← +----------+
* </pre>
*******************************************************************************/
public class CompanyHierarchyTablesAndJoinsMetaDataProducer implements MetaDataProducerInterface<MetaDataProducerMultiOutput>
{
public static final String COMPANY_TABLE = "company";
public static final String DEPARTMENT_TABLE = "department";
public static final String EMPLOYEE_TABLE = "employee";
public static final String EMPLOYEE_DETAIL_TABLE = "employeeDetail";
public static final String JOB_TITLE_TABLE = "jobTitle";
public static final String JOB_HISTORY_TABLE = "jobHistory";
public static final String COMPANY_JOIN_DEPARTMENT = "companyDepartments";
public static final String DEPARTMENT_JOIN_COMPANY = "departmentCompany";
public static final String DEPARTMENT_JOIN_EMPLOYEE = "departmentEmployees";
public static final String EMPLOYEE_JOIN_DEPARTMENT = "employeeDepartment";
public static final String EMPLOYEE_JOIN_EMPLOYEE_AS_MENTOR = "employeeMentor";
public static final String EMPLOYEE_JOIN_EMPLOYEE_DETAIL = "employeeEmployeeDetail";
public static final String EMPLOYEE_DETAIL_JOIN_EMPLOYEE = "employeeDetailEmployee";
public static final String EMPLOYEE_JOIN_JOB_HISTORY = "employeeJobHistories";
public static final String JOB_HISTORY_JOIN_EMPLOYEE = "jobHistoryEmployee";
public static final String JOB_HISTORY_JOIN_JOB_TITLE = "jobHistoryJobTitle";
public static final String JOB_TITLE_JOIN_JOB_HISTORY = "jobTitleJobHistories";
public static final String DEPARTMENT_JOIN_MANAGER = "departmentManager";
/***************************************************************************
*
***************************************************************************/
@Override
public MetaDataProducerMultiOutput produce(QInstance qInstance) throws QException
{
MetaDataProducerMultiOutput rs = new MetaDataProducerMultiOutput();
////////////
// Tables //
////////////
/////////////////////////////////////
// Company (root of the hierarchy) //
/////////////////////////////////////
rs.add(new QTableMetaData()
.withName(COMPANY_TABLE)
.withField(new QFieldMetaData("id", QFieldType.INTEGER).withIsEditable(false))
.withField(new QFieldMetaData("name", QFieldType.STRING))
.withField(new QFieldMetaData("industry", QFieldType.STRING))
.withField(new QFieldMetaData("foundedDate", QFieldType.DATE))
.withExposedJoin(new ExposedJoin().withJoinTable(EMPLOYEE_TABLE).withJoinPath(List.of(DEPARTMENT_JOIN_COMPANY, DEPARTMENT_JOIN_EMPLOYEE)))
.withExposedJoin(new ExposedJoin().withJoinTable(EMPLOYEE_DETAIL_TABLE).withJoinPath(List.of(COMPANY_JOIN_DEPARTMENT, DEPARTMENT_JOIN_MANAGER, EMPLOYEE_JOIN_EMPLOYEE_DETAIL))));
//////////////////////////////////////////////////////////////////////////////////
// Department (many departments per company; has a manager FK back to employee) //
//////////////////////////////////////////////////////////////////////////////////
rs.add(new QTableMetaData()
.withName(DEPARTMENT_TABLE)
.withField(new QFieldMetaData("id", QFieldType.INTEGER).withIsEditable(false))
.withField(new QFieldMetaData("companyId", QFieldType.INTEGER)) // FK -> company
.withField(new QFieldMetaData("managerId", QFieldType.INTEGER)) // FK -> employee (self-ref via join)
.withField(new QFieldMetaData("name", QFieldType.STRING))
.withField(new QFieldMetaData("budget", QFieldType.DECIMAL))
.withExposedJoin(new ExposedJoin().withJoinTable(EMPLOYEE_DETAIL_TABLE).withJoinPath(List.of(DEPARTMENT_JOIN_EMPLOYEE, EMPLOYEE_JOIN_EMPLOYEE_DETAIL)))
.withExposedJoin(new ExposedJoin().withJoinTable(JOB_HISTORY_TABLE).withJoinPath(List.of(DEPARTMENT_JOIN_MANAGER, EMPLOYEE_JOIN_JOB_HISTORY)))
);
/////////////////////////////////////////////////////////////////////
// Employee (many employees per department; 1:1 to EmployeeDetail) //
/////////////////////////////////////////////////////////////////////
rs.add(new QTableMetaData()
.withName(EMPLOYEE_TABLE)
.withField(new QFieldMetaData("id", QFieldType.INTEGER).withIsEditable(false))
.withField(new QFieldMetaData("departmentId", QFieldType.INTEGER)) // FK -> department
.withField(new QFieldMetaData("mentorEmployeeId", QFieldType.INTEGER)) // FK -> employee (self-join)
.withField(new QFieldMetaData("firstName", QFieldType.STRING))
.withField(new QFieldMetaData("lastName", QFieldType.STRING))
.withField(new QFieldMetaData("email", QFieldType.STRING))
.withField(new QFieldMetaData("hireDate", QFieldType.DATE))
.withField(new QFieldMetaData("isActive", QFieldType.BOOLEAN))
.withExposedJoin(new ExposedJoin().withJoinTable(COMPANY_TABLE).withJoinPath(List.of(EMPLOYEE_JOIN_DEPARTMENT, DEPARTMENT_JOIN_COMPANY)))
.withExposedJoin(new ExposedJoin().withJoinTable(JOB_TITLE_TABLE).withJoinPath(List.of(EMPLOYEE_JOIN_JOB_HISTORY, JOB_HISTORY_JOIN_JOB_TITLE)))
);
//////////////////////////////////////////////////////////////////
// EmployeeDetail (1:1 with employee - extended/sensitive info) //
//////////////////////////////////////////////////////////////////
rs.add(new QTableMetaData()
.withName(EMPLOYEE_DETAIL_TABLE)
.withField(new QFieldMetaData("id", QFieldType.INTEGER).withIsEditable(false))
.withField(new QFieldMetaData("employeeId", QFieldType.INTEGER)) // FK -> employee (1:1)
.withField(new QFieldMetaData("phone", QFieldType.STRING))
.withField(new QFieldMetaData("emergencyContact", QFieldType.STRING))
.withField(new QFieldMetaData("salary", QFieldType.DECIMAL))
.withField(new QFieldMetaData("benefitsTier", QFieldType.STRING)));
////////////////////////////////////////////////////////////////////
// JobTitle (lookup table - many employees can share a job title) //
////////////////////////////////////////////////////////////////////
rs.add(new QTableMetaData()
.withName(JOB_TITLE_TABLE)
.withField(new QFieldMetaData("id", QFieldType.INTEGER).withIsEditable(false))
.withField(new QFieldMetaData("name", QFieldType.STRING))
.withField(new QFieldMetaData("grade", QFieldType.STRING))
.withField(new QFieldMetaData("isExempt", QFieldType.BOOLEAN)));
///////////////////////////////////////////////////////////////////////////////
// JobHistory (many job history rows per employee; each row n:1 to jobTitle) //
///////////////////////////////////////////////////////////////////////////////
rs.add(new QTableMetaData()
.withName(JOB_HISTORY_TABLE)
.withField(new QFieldMetaData("id", QFieldType.INTEGER).withIsEditable(false))
.withField(new QFieldMetaData("employeeId", QFieldType.INTEGER)) // FK -> employee
.withField(new QFieldMetaData("jobTitleId", QFieldType.INTEGER)) // FK -> jobTitle
.withField(new QFieldMetaData("startDate", QFieldType.DATE))
.withField(new QFieldMetaData("endDate", QFieldType.DATE))
.withField(new QFieldMetaData("salaryAtTime", QFieldType.DECIMAL)));
/////////////////////////////////////////
// set common attributes on all tables //
/////////////////////////////////////////
rs.getEach(QTableMetaData.class).forEach(t ->
{
t.setPrimaryKeyField("id");
t.setBackendName(BaseTest.MEMORY_BACKEND_NAME);
});
///////////
// Joins //
///////////
/////////////////////////////////////////////////////////////////
// company 1:n department (company.id = department.companyId) //
/////////////////////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(COMPANY_JOIN_DEPARTMENT)
.withLeftTable(COMPANY_TABLE)
.withRightTable(DEPARTMENT_TABLE)
.withType(JoinType.ONE_TO_MANY)
.withJoinOn(new JoinOn("id", "companyId"))
.withOrderBy(new QFilterOrderBy("name")));
///////////////////////////////////////////////////////////////////////////////////////////
// department n:1 company (flip of above - useful when traversing from department side) //
///////////////////////////////////////////////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(DEPARTMENT_JOIN_COMPANY)
.withLeftTable(DEPARTMENT_TABLE)
.withRightTable(COMPANY_TABLE)
.withType(JoinType.MANY_TO_ONE)
.withJoinOn(new JoinOn("companyId", "id")));
//////////////////////////////////////////////////////////////////////
// department 1:n employee (department.id = employee.departmentId) //
//////////////////////////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(DEPARTMENT_JOIN_EMPLOYEE)
.withLeftTable(DEPARTMENT_TABLE)
.withRightTable(EMPLOYEE_TABLE)
.withType(JoinType.ONE_TO_MANY)
.withJoinOn(new JoinOn("id", "departmentId"))
.withOrderBy(new QFilterOrderBy("lastName"))
.withOrderBy(new QFilterOrderBy("firstName")));
//////////////////////////////////////////////
// employee n:1 department (flip of above) //
//////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(EMPLOYEE_JOIN_DEPARTMENT)
.withLeftTable(EMPLOYEE_TABLE)
.withRightTable(DEPARTMENT_TABLE)
.withType(JoinType.MANY_TO_ONE)
.withJoinOn(new JoinOn("departmentId", "id")));
/////////////////////////////////////////////////
// employee n:1 employee (mentor relationship) //
/////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(EMPLOYEE_JOIN_EMPLOYEE_AS_MENTOR)
.withLeftTable(EMPLOYEE_TABLE) // the mentee
.withRightTable(EMPLOYEE_TABLE) // the mentor
.withType(JoinType.MANY_TO_ONE)
.withJoinOn(new JoinOn("mentorEmployeeId", "id")));
////////////////////////////////////////////////////////////////////////////
// employee 1:1 employeeDetail (employee.id = employeeDetail.employeeId) //
////////////////////////////////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(EMPLOYEE_JOIN_EMPLOYEE_DETAIL)
.withLeftTable(EMPLOYEE_TABLE)
.withRightTable(EMPLOYEE_DETAIL_TABLE)
.withType(JoinType.ONE_TO_ONE)
.withJoinOn(new JoinOn("id", "employeeId")));
//////////////////////////////////////////////////
// employeeDetail 1:1 employee (flip of above) //
//////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(EMPLOYEE_DETAIL_JOIN_EMPLOYEE)
.withLeftTable(EMPLOYEE_DETAIL_TABLE)
.withRightTable(EMPLOYEE_TABLE)
.withType(JoinType.ONE_TO_ONE)
.withJoinOn(new JoinOn("employeeId", "id")));
////////////////////////////////////////////////////////////////////
// employee 1:n jobHistory (employee.id = jobHistory.employeeId) //
////////////////////////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(EMPLOYEE_JOIN_JOB_HISTORY)
.withLeftTable(EMPLOYEE_TABLE)
.withRightTable(JOB_HISTORY_TABLE)
.withType(JoinType.ONE_TO_MANY)
.withJoinOn(new JoinOn("id", "employeeId"))
.withOrderBy(new QFilterOrderBy("startDate", false))); // most recent first
//////////////////////////////////////////////
// jobHistory n:1 employee (flip of above) //
//////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(JOB_HISTORY_JOIN_EMPLOYEE)
.withLeftTable(JOB_HISTORY_TABLE)
.withRightTable(EMPLOYEE_TABLE)
.withType(JoinType.MANY_TO_ONE)
.withJoinOn(new JoinOn("employeeId", "id")));
////////////////////////////////////////////////////////////////////
// jobHistory n:1 jobTitle (jobHistory.jobTitleId = jobTitle.id) //
////////////////////////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(JOB_HISTORY_JOIN_JOB_TITLE)
.withLeftTable(JOB_HISTORY_TABLE)
.withRightTable(JOB_TITLE_TABLE)
.withType(JoinType.MANY_TO_ONE)
.withJoinOn(new JoinOn("jobTitleId", "id")));
//////////////////////////////////////////////
// jobTitle 1:n jobHistory (flip of above) //
//////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(JOB_TITLE_JOIN_JOB_HISTORY)
.withLeftTable(JOB_TITLE_TABLE)
.withRightTable(JOB_HISTORY_TABLE)
.withType(JoinType.ONE_TO_MANY)
.withJoinOn(new JoinOn("id", "jobTitleId"))
.withOrderBy(new QFilterOrderBy("startDate", false)));
/////////////////////////////////////////////////////////////////////////////
// department n:1 employee (manager) (department.managerId = employee.id) //
/////////////////////////////////////////////////////////////////////////////
rs.add(new QJoinMetaData()
.withName(DEPARTMENT_JOIN_MANAGER)
.withLeftTable(DEPARTMENT_TABLE)
.withRightTable(EMPLOYEE_TABLE)
.withType(JoinType.MANY_TO_ONE)
.withJoinOn(new JoinOn("managerId", "id")));
return (rs);
}
}
@@ -111,183 +111,312 @@ class WorkflowExecutorTest extends BaseTest
**
*******************************************************************************/
@Test
void testContainers() throws QException
void testSimpleContainer() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
{
/////////////////////////////////////
// . 1 //
// . | //
// /-2-\ opens container2 (push) //
// | | | //
// | 3 | //
// | | | //
// \-4-/ last in container2 (pop) //
// . | //
// . 5 //
/////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2)),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 3)),
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2),
WorkflowsTestDataSource.newLink(2, 3, "push"),
WorkflowsTestDataSource.newLink(3, 4),
WorkflowsTestDataSource.newLink(2, 5, "pop")
));
/////////////////////////////////////
// . 1 //
// . | //
// /-2-\ opens container2 (push) //
// | | | //
// | 3 | //
// | | | //
// \-4-/ last in container2 (pop) //
// . | //
// . 5 //
/////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2)),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 3)),
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2),
WorkflowsTestDataSource.newLink(2, 3, "push"),
WorkflowsTestDataSource.newLink(3, 4),
WorkflowsTestDataSource.newLink(2, 5, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(10, output.getContext().getValues().get("sum"));
}
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(10, output.getContext().getValues().get("sum"));
}
{
///////////////////////////////////////////////
// . 1 //
// . | //
// /---2---\ opens outer container2 (push) //
// | | | //
// | 3 | //
// | | | //
// | /-4-\ | opens nested container4 (push) //
// | | | | | //
// | | 5 | | //
// | | | | | //
// | \-6-/ | last in nested container (pop) //
// | | | //
// \---7---/ last in outer container (pop) //
// . | //
// . 8 //
///////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2)),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 3)),
WorkflowsTestDataSource.newStep(6, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4)),
WorkflowsTestDataSource.newStep(7, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 5)),
WorkflowsTestDataSource.newStep(8, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 6))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2),
WorkflowsTestDataSource.newLink(2, 3, "push"),
WorkflowsTestDataSource.newLink(3, 4),
WorkflowsTestDataSource.newLink(4, 5, "push"),
WorkflowsTestDataSource.newLink(5, 6),
WorkflowsTestDataSource.newLink(4, 7, "pop"),
WorkflowsTestDataSource.newLink(2, 8, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(21, output.getContext().getValues().get("sum"));
}
{
////////////////////////////////////////////////////////////////////////////////////////////////
// /---1---\ opens outer container1 (push) //
// | | | //
// | /-2-\ | opens nested container2 (push) //
// | | | | | //
// .\\-3-// last in nested container2 and outer container1 (but since no next step, no pops) //
////////////////////////////////////////////////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "push"),
WorkflowsTestDataSource.newLink(2, 3, "push")
));
/*******************************************************************************
**
*******************************************************************************/
@Test
void testNestedContainers() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(1, output.getContext().getValues().get("sum"));
}
///////////////////////////////////////////////
// . 1 //
// . | //
// /---2---\ opens outer container2 (push) //
// | | | //
// | 3 | //
// | | | //
// | /-4-\ | opens nested container4 (push) //
// | | | | | //
// | | 5 | | //
// | | | | | //
// | \-6-/ | last in nested container (pop) //
// | | | //
// \---7---/ last in outer container (pop) //
// . | //
// . 8 //
///////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2)),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 3)),
WorkflowsTestDataSource.newStep(6, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4)),
WorkflowsTestDataSource.newStep(7, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 5)),
WorkflowsTestDataSource.newStep(8, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 6))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2),
WorkflowsTestDataSource.newLink(2, 3, "push"),
WorkflowsTestDataSource.newLink(3, 4),
WorkflowsTestDataSource.newLink(4, 5, "push"),
WorkflowsTestDataSource.newLink(5, 6),
WorkflowsTestDataSource.newLink(4, 7, "pop"),
WorkflowsTestDataSource.newLink(2, 8, "pop")
));
{
////////////////////////////////////////////////////////////////////////////////
// /---1---\ opens outer container1 (push) //
// | | | //
// | /-2-\ | opens nested container2 (push) //
// | | | | | //
// .\\-3-// last in nested container2 outer container1 (pop (the outermost)) //
// . | //
// . 4 //
////////////////////////////////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "push"),
WorkflowsTestDataSource.newLink(2, 3, "push"),
WorkflowsTestDataSource.newLink(1, 4, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(21, output.getContext().getValues().get("sum"));
}
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(3, output.getContext().getValues().get("sum"));
}
{
/////////////////////////////////////////////////////////////////
// /---1---\ opens outer container1 //
// | | | //
// | <-2-> | opens empty container2 and immediately closes it //
// | | | //
// \---3---/ last in outer container1 //
/////////////////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "push"),
WorkflowsTestDataSource.newLink(2, 3, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(1, output.getContext().getValues().get("sum"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testNestedContainersWithNoNextStep() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
{
/////////////////////////////////////////////////////
// . <-1-> opens empty container1 and closes it //
// . | //
// . <-2-> opens empty container2 and closes it //
// . | //
// . <-3-> opens empty container3 and closes it //
// . | //
// . 4 //
/////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "pop"),
WorkflowsTestDataSource.newLink(2, 3, "pop"),
WorkflowsTestDataSource.newLink(3, 4, "pop")
));
////////////////////////////////////////////////////////////////////////////////////////////////
// /---1---\ opens outer container1 (push) //
// | | | //
// | /-2-\ | opens nested container2 (push) //
// | | | | | //
// .\\-3-// last in nested container2 and outer container1 (but since no next step, no pops) //
////////////////////////////////////////////////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "push"),
WorkflowsTestDataSource.newLink(2, 3, "push")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(1, output.getContext().getValues().get("sum"));
}
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(1, output.getContext().getValues().get("sum"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testNestedContainersWithPopToOutermost() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
////////////////////////////////////////////////////////////////////////////////
// /---1---\ opens outer container1 (push) //
// | | | //
// | /-2-\ | opens nested container2 (push) //
// | | | | | //
// .\\-3-// last in nested container2 outer container1 (pop (the outermost)) //
// . | //
// . 4 //
////////////////////////////////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "push"),
WorkflowsTestDataSource.newLink(2, 3, "push"),
WorkflowsTestDataSource.newLink(1, 4, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(3, output.getContext().getValues().get("sum"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testEmptyNestedContainer() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
/////////////////////////////////////////////////////////////////
// /---1---\ opens outer container1 //
// | | | //
// | <-2-> | opens empty container2 and immediately closes it //
// | | | //
// \---3---/ last in outer container1 //
/////////////////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "push"),
WorkflowsTestDataSource.newLink(2, 3, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(1, output.getContext().getValues().get("sum"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testMultipleSequentialEmptyContainers() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
/////////////////////////////////////////////////////
// . <-1-> opens empty container1 and closes it //
// . | //
// . <-2-> opens empty container2 and closes it //
// . | //
// . <-3-> opens empty container3 and closes it //
// . | //
// . 4 //
/////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "pop"),
WorkflowsTestDataSource.newLink(2, 3, "pop"),
WorkflowsTestDataSource.newLink(3, 4, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0));
assertEquals(1, output.getContext().getValues().get("sum"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testContainerEndingWithConditionalWithOneEmptySide_trueCondition() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
////////////////////////////////////////////////////
// . 1 //
// . | //
// /---2---\ opens outer container2 (push) //
// | | | //
// | 3 | if/else style step //
// | / \ | //
// | 4 | | one step in the true, none in false //
// | | | | //
// \--\-/--/ last in outer container (pop) //
// . | //
// . 5 //
////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.BOOLEAN_CONDITIONAL, Map.of()),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2)),
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2),
WorkflowsTestDataSource.newLink(2, 3, "push"),
WorkflowsTestDataSource.newLink(3, 4, true),
WorkflowsTestDataSource.newLink(3, null, false),
WorkflowsTestDataSource.newLink(2, 5, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0, "condition", true));
assertEquals(7, output.getContext().getValues().get("sum"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testContainerEndingWithConditionalWithOneEmptySide_falseCondition() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
////////////////////////////////////////////////////
// . 1 //
// . | //
// /---2---\ opens outer container2 (push) //
// | | | //
// | 3 | if/else style step //
// | / \ | //
// | 4 | | one step in the true, none in false //
// | | | | //
// \--\-/--/ last in outer container (pop) //
// . | //
// . 5 //
////////////////////////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.CONTAINER, Map.of()),
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.BOOLEAN_CONDITIONAL, Map.of()),
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2)),
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2),
WorkflowsTestDataSource.newLink(2, 3, "push"),
WorkflowsTestDataSource.newLink(3, 4, true),
WorkflowsTestDataSource.newLink(3, null, false),
WorkflowsTestDataSource.newLink(2, 5, "pop")
));
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0, "condition", false));
assertEquals(5, output.getContext().getValues().get("sum"));
}
@@ -313,7 +442,7 @@ class WorkflowExecutorTest extends BaseTest
**
*******************************************************************************/
@Test
void testMultiForkingStep() throws Exception
void testMultiForkingStep_individualForks() throws Exception
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
@@ -350,6 +479,39 @@ class WorkflowExecutorTest extends BaseTest
assertEquals(5, run.apply("carl"));
assertEquals(7, run.apply("braces"));
assertEquals(0, run.apply("lou"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testMultiForkingStep_forksConverging() throws Exception
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
///////////////////////////////////
// build a workflow with 3 forks //
// . 1 //
// ./ | \ //
// 2 3 4 //
///////////////////////////////////
Workflow workflow = WorkflowsTestDataSource.insertWorkflowAndInitialRevision(TestWorkflowDefinitions.TEST_WORKFLOW_TYPE, null);
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.SPLIT_BY_LETTERS_IN_NAME, Map.of()),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 1)), // "a"
WorkflowsTestDataSource.newStep(3, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 2)), // "b"
WorkflowsTestDataSource.newStep(4, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4)) // "c"
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "a"), // += 1
WorkflowsTestDataSource.newLink(1, 3, "b"), // += 2
WorkflowsTestDataSource.newLink(1, 4, "c"), // += 3
WorkflowsTestDataSource.newLink(2, null),
WorkflowsTestDataSource.newLink(3, null),
WorkflowsTestDataSource.newLink(4, null)
));
//////////////////////////////////////
// add a step (5) after the 3 forks //
@@ -368,6 +530,12 @@ class WorkflowExecutorTest extends BaseTest
//////////////////////////////////
new DeleteAction().execute(new DeleteInput(WorkflowLink.TABLE_NAME).withQueryFilter(new QQueryFilter(new QFilterCriteria("toStepNo", QCriteriaOperator.IS_BLANK))));
UnsafeFunction<String, Integer, ?> run = (String name) ->
{
WorkflowOutput output = executeWorkflow(workflow.getId(), Map.of("seedValue", 0, "name", name));
return ValueUtils.getValueAsInteger(output.getContext().getValues().get("sum"));
};
assertEquals(10, run.apply("bobby"));
assertEquals(15, run.apply("braces"));
assertEquals(8, run.apply("lou"));
@@ -0,0 +1,578 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.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;
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.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
import com.kingsrook.qqq.backend.core.utils.collections.MapBuilder;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.workflows.CompanyHierarchyTablesAndJoinsMetaDataProducer.COMPANY_TABLE;
import static com.kingsrook.qbits.workflows.CompanyHierarchyTablesAndJoinsMetaDataProducer.DEPARTMENT_TABLE;
import static com.kingsrook.qbits.workflows.CompanyHierarchyTablesAndJoinsMetaDataProducer.EMPLOYEE_DETAIL_TABLE;
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;
/*******************************************************************************
** Unit test for InputRecordFilterStep
*******************************************************************************/
class InputRecordFilterStepTest extends BaseTest
{
/*******************************************************************************
**
*******************************************************************************/
@Test
void testWithoutJoins() throws QException
{
//////////////////////////////////////////////////
// empty filter matches any record (even empty) //
//////////////////////////////////////////////////
QQueryFilter emptyFilter = new QQueryFilter();
assertOutput(true, EMPLOYEE_TABLE, emptyFilter, new QRecord());
assertOutput(true, EMPLOYEE_TABLE, new QQueryFilter(), new QRecord().withValue("id", 1));
/////////////////////////////////////////////////
// simple single criteria - matches or doesn't //
/////////////////////////////////////////////////
QQueryFilter idEquals1 = new QQueryFilter().withCriteria("id", QCriteriaOperator.EQUALS, 1);
assertOutput(false, EMPLOYEE_TABLE, idEquals1, new QRecord());
assertOutput(false, EMPLOYEE_TABLE, idEquals1, Map.of("id", 2));
assertOutput(true, EMPLOYEE_TABLE, idEquals1, Map.of("id", 1));
}
/*******************************************************************************
** 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.");
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testOneToOneJoin() throws Exception
{
new InsertAction().execute(new InsertInput(EMPLOYEE_DETAIL_TABLE).withRecord(new QRecord().withValue("employeeId", 1).withValue("phone", "555-1234")));
QQueryFilter phoneContains555 = new QQueryFilter().withCriteria(EMPLOYEE_DETAIL_TABLE + ".phone", QCriteriaOperator.CONTAINS, "555");
QQueryFilter phoneContains911 = new QQueryFilter().withCriteria(EMPLOYEE_DETAIL_TABLE + ".phone", QCriteriaOperator.CONTAINS, "911");
///////////////////////////////////////////////////////////////////////
// employee with detail record with matching phone number is a match //
///////////////////////////////////////////////////////////////////////
assertOutput(true, EMPLOYEE_TABLE, phoneContains555, Map.of("id", 1));
///////////////////////////////////////////////////////////////////////////////
// employee with detail record with non-matching phone number is NOT a match //
///////////////////////////////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, phoneContains911, Map.of("id", 1));
///////////////////////////////////////////////////
// employee without detail record is NOT a match //
///////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, phoneContains555, Map.of("id", 2));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testManyToOneJoin() throws Exception
{
new InsertAction().execute(new InsertInput(DEPARTMENT_TABLE).withRecords(List.of(
new QRecord().withValue("id", 1).withValue("name", "Engineering"),
new QRecord().withValue("id", 2).withValue("name", "Sales"))));
QQueryFilter departmentIsEngineering = new QQueryFilter().withCriteria(DEPARTMENT_TABLE + ".name", QCriteriaOperator.EQUALS, "Engineering");
//////////////////////////////////////////////////
// employee with matching department is a match //
//////////////////////////////////////////////////
assertOutput(true, EMPLOYEE_TABLE, departmentIsEngineering, Map.of("departmentId", 1));
//////////////////////////////////////////////////////////
// employee with non-matching department is NOT a match //
//////////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, departmentIsEngineering, Map.of("departmentId", 2));
//////////////////////////////////////////////////
// employee without a department is not a match //
//////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, departmentIsEngineering, Map.of());
assertOutput(false, EMPLOYEE_TABLE, departmentIsEngineering, MapBuilder.of("departmentId", null));
assertOutput(false, EMPLOYEE_TABLE, departmentIsEngineering, Map.of("departmentId", 3));
}
/*******************************************************************************
* employee N:1 department N:1 company
*******************************************************************************/
@Test
void testManyToOneThenManyToOneJoin() throws Exception
{
new InsertAction().execute(new InsertInput(COMPANY_TABLE).withRecords(List.of(
new QRecord().withValue("id", 1).withValue("name", "ACME"),
new QRecord().withValue("id", 2).withValue("name", "EvilCorp"))));
new InsertAction().execute(new InsertInput(DEPARTMENT_TABLE).withRecords(List.of(
new QRecord().withValue("id", 11).withValue("companyId", 1).withValue("name", "Engineering"),
new QRecord().withValue("id", 12).withValue("companyId", 1).withValue("name", "Sales"),
new QRecord().withValue("id", 21).withValue("companyId", 2).withValue("name", "Evil"),
new QRecord().withValue("id", 31).withValue("companyId", null).withValue("name", "Company-less"))));
QQueryFilter companyIsACME = new QQueryFilter().withCriteria(COMPANY_TABLE + ".name", QCriteriaOperator.EQUALS, "ACME");
///////////////////////////////////////////////
// employee with matching company is a match //
///////////////////////////////////////////////
assertOutput(true, EMPLOYEE_TABLE, companyIsACME, Map.of("departmentId", 11));
//////////////////////////////////////////////////////////
// employee with non-matching department is NOT a match //
//////////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, companyIsACME, Map.of("departmentId", 21));
////////////////////////////////////////////////////////////////////
// employee without a department (thus no company) is not a match //
////////////////////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, companyIsACME, Map.of());
assertOutput(false, EMPLOYEE_TABLE, companyIsACME, MapBuilder.of("departmentId", null));
assertOutput(false, EMPLOYEE_TABLE, companyIsACME, Map.of("departmentId", 3));
//////////////////////////////////////////////////////////////////////
// employee without a department that has no company is not a match //
//////////////////////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, companyIsACME, Map.of("departmentId", 31));
}
/*******************************************************************************
** department 1:N employee 1:1 employeeDetail
*******************************************************************************/
@Test
void testOneToManyThenOneToOneJoin() throws Exception
{
//////////////////////////////////////////////////////////////////////////////////////
// this test queries for Departments, but on fields from EmployeeDetail //
// The relationship is Department, one-to-many Employee, one-to-one EmployeeDetail. //
//////////////////////////////////////////////////////////////////////////////////////
new InsertAction().execute(new InsertInput(EMPLOYEE_TABLE).withRecords(List.of(
new QRecord().withValue("id", 1).withValue("departmentId", 11),
new QRecord().withValue("id", 2).withValue("departmentId", 21),
new QRecord().withValue("id", 3).withValue("departmentId", 31))));
new InsertAction().execute(new InsertInput(EMPLOYEE_DETAIL_TABLE).withRecords(List.of(
new QRecord().withValue("id", 101).withValue("employeeId", 1).withValue("salary", new BigDecimal("105000")),
new QRecord().withValue("id", 102).withValue("employeeId", 2).withValue("salary", new BigDecimal("95000")))));
QQueryFilter hasEmployeeOver100K = new QQueryFilter().withCriteria(EMPLOYEE_DETAIL_TABLE + ".salary", QCriteriaOperator.GREATER_THAN, new BigDecimal("100000"));
///////////////////////////////////////////////////////////
// department with a matching employee detail is a match //
///////////////////////////////////////////////////////////
assertOutput(true, DEPARTMENT_TABLE, hasEmployeeOver100K, Map.of("id", 11));
/////////////////////////////////////////////////////////////////////////////////////
// department with an employee, who has a detail, but doesn't match is NOT a match //
/////////////////////////////////////////////////////////////////////////////////////
assertOutput(false, DEPARTMENT_TABLE, hasEmployeeOver100K, Map.of("id", 21));
/////////////////////////////////////////////////////////////////////
// department with no employee, but no employee detail is no match //
/////////////////////////////////////////////////////////////////////
assertOutput(false, DEPARTMENT_TABLE, hasEmployeeOver100K, Map.of("id", 31));
/////////////////////////////////////////////
// department with no employee is no match //
/////////////////////////////////////////////
assertOutput(false, DEPARTMENT_TABLE, hasEmployeeOver100K, Map.of("id", 41));
}
/*******************************************************************************
** employee 1:N jobHistory
*******************************************************************************/
@Test
void testOneToManyJoin() throws Exception
{
new InsertAction().execute(new InsertInput(JOB_HISTORY_TABLE).withRecords(List.of(
new QRecord().withValue("id", 101).withValue("employeeId", 1).withValue("salaryAtTime", new BigDecimal("120000")),
new QRecord().withValue("id", 102).withValue("employeeId", 2).withValue("salaryAtTime", new BigDecimal("90000")))));
QQueryFilter hasJobHistoryOver100K = new QQueryFilter().withCriteria(JOB_HISTORY_TABLE + ".salaryAtTime", QCriteriaOperator.GREATER_THAN, new BigDecimal("100000"));
//////////////////////////////////////////////////
// employee with a matching job history matches //
//////////////////////////////////////////////////
assertOutput(true, EMPLOYEE_TABLE, hasJobHistoryOver100K, Map.of("id", 1));
///////////////////////////////////////////////////
// employee with only non-matching rows does not //
///////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, hasJobHistoryOver100K, Map.of("id", 2));
////////////////////////////////////
// employee with no rows does not //
////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, hasJobHistoryOver100K, Map.of("id", 3));
}
/*******************************************************************************
** employee 1:N jobHistory N:1 jobTitle
*******************************************************************************/
@Test
void testOneToManyThenManyToOneJoin() throws Exception
{
new InsertAction().execute(new InsertInput(JOB_TITLE_TABLE).withRecords(List.of(
new QRecord().withValue("id", 11).withValue("name", "Engineer"),
new QRecord().withValue("id", 12).withValue("name", "Intern"))));
new InsertAction().execute(new InsertInput(JOB_HISTORY_TABLE).withRecords(List.of(
new QRecord().withValue("id", 101).withValue("employeeId", 1).withValue("jobTitleId", 11),
new QRecord().withValue("id", 102).withValue("employeeId", 1).withValue("jobTitleId", 12),
new QRecord().withValue("id", 201).withValue("employeeId", 2).withValue("jobTitleId", 12),
new QRecord().withValue("id", 301).withValue("employeeId", 3).withValue("jobTitleId", null))));
QQueryFilter hasHadEngineerTitle = new QQueryFilter().withCriteria(JOB_TITLE_TABLE + ".name", QCriteriaOperator.EQUALS, "Engineer");
QQueryFilter hasHadInternTitle = new QQueryFilter().withCriteria(JOB_TITLE_TABLE + ".name", QCriteriaOperator.EQUALS, "Intern");
////////////////////////////////////////////////////////////
// employee with multiple matching titles through history //
////////////////////////////////////////////////////////////
assertOutput(true, EMPLOYEE_TABLE, hasHadEngineerTitle, Map.of("id", 1));
assertOutput(true, EMPLOYEE_TABLE, hasHadInternTitle, Map.of("id", 1));
/////////////////////////////////////////////////////////
// employee with single matching title through history //
/////////////////////////////////////////////////////////
assertOutput(true, EMPLOYEE_TABLE, hasHadInternTitle, Map.of("id", 1));
//////////////////////////////////////////////////////
// employee with non-matching title through history //
//////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, hasHadEngineerTitle, Map.of("id", 2));
////////////////////////////////////////////////////////
// employee with job history but missing title target //
////////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, hasHadEngineerTitle, Map.of("id", 3));
//////////////////////////////////
// employee with no job history //
//////////////////////////////////
assertOutput(false, EMPLOYEE_TABLE, hasHadEngineerTitle, Map.of("id", 4));
}
/*******************************************************************************
** company 1:N department 1:N employee
*******************************************************************************/
@Test
void testOneToManyThenOneToManyJoin() throws Exception
{
new InsertAction().execute(new InsertInput(DEPARTMENT_TABLE).withRecords(List.of(
new QRecord().withValue("id", 11).withValue("companyId", 1).withValue("name", "Engineering"),
new QRecord().withValue("id", 12).withValue("companyId", 1).withValue("name", "Support"),
new QRecord().withValue("id", 21).withValue("companyId", 2).withValue("name", "Support"),
new QRecord().withValue("id", 31).withValue("companyId", 3).withValue("name", "Safety"),
new QRecord().withValue("id", 41).withValue("companyId", 4).withValue("name", "Empty Department"))));
new InsertAction().execute(new InsertInput(EMPLOYEE_TABLE).withRecords(List.of(
new QRecord().withValue("departmentId", 11).withValue("lastName", "Smith").withValue("firstName", "Ozzie"),
new QRecord().withValue("departmentId", 12).withValue("lastName", "Smith").withValue("firstName", "Will"),
new QRecord().withValue("departmentId", 11).withValue("lastName", "Jones"),
new QRecord().withValue("departmentId", 21).withValue("lastName", "Jones"),
new QRecord().withValue("departmentId", 31).withValue("lastName", "Simpson"),
new QRecord().withValue("departmentId", 21).withValue("lastName", "Taylor"))));
QQueryFilter hasEmployeeNamedSmith = new QQueryFilter().withCriteria(EMPLOYEE_TABLE + ".lastName", QCriteriaOperator.EQUALS, "Smith");
QQueryFilter hasEmployeeNamedSimpson = new QQueryFilter().withCriteria(EMPLOYEE_TABLE + ".lastName", QCriteriaOperator.EQUALS, "Simpson");
/////////////////////////////////////////////////
// company with at least one matching employee //
/////////////////////////////////////////////////
assertOutput(true, COMPANY_TABLE, hasEmployeeNamedSmith, Map.of("id", 1));
assertOutput(true, COMPANY_TABLE, hasEmployeeNamedSimpson, Map.of("id", 3));
//////////////////////////////////////////////
// company with employees but none matching //
//////////////////////////////////////////////
assertOutput(false, COMPANY_TABLE, hasEmployeeNamedSmith, Map.of("id", 2));
///////////////////////////////////////////////
// company with departments but no employees //
///////////////////////////////////////////////
assertOutput(false, COMPANY_TABLE, hasEmployeeNamedSmith, Map.of("id", 4));
}
/*******************************************************************************
** department N:1 manager(employee) 1:N jobHistory
*******************************************************************************/
@Test
void testManyToOneThenOneToManyJoin() throws Exception
{
new InsertAction().execute(new InsertInput(EMPLOYEE_TABLE).withRecords(List.of(
new QRecord().withValue("id", 1).withValue("lastName", "Smith"),
new QRecord().withValue("id", 2).withValue("lastName", "Jones"),
new QRecord().withValue("id", 3).withValue("lastName", "Milton")
)));
new InsertAction().execute(new InsertInput(JOB_HISTORY_TABLE).withRecords(List.of(
new QRecord().withValue("id", 301).withValue("employeeId", 1).withValue("salaryAtTime", new BigDecimal("130000")),
new QRecord().withValue("id", 302).withValue("employeeId", 1).withValue("salaryAtTime", new BigDecimal("120000")),
new QRecord().withValue("id", 303).withValue("employeeId", 2).withValue("salaryAtTime", new BigDecimal("80000")))));
QQueryFilter managerHasHistoryOver100K = new QQueryFilter().withCriteria(JOB_HISTORY_TABLE + ".salaryAtTime", QCriteriaOperator.GREATER_THAN, new BigDecimal("100000"));
//////////////////////////////////////////////////////////
// department whose manager has matching history row(s) //
//////////////////////////////////////////////////////////
assertOutput(true, DEPARTMENT_TABLE, managerHasHistoryOver100K, Map.of("managerId", 1));
/////////////////////////////////////////////////////////
// department whose manager has only non-matching rows //
/////////////////////////////////////////////////////////
assertOutput(false, DEPARTMENT_TABLE, managerHasHistoryOver100K, Map.of("managerId", 2));
////////////////////////////////////////////////////////////
// department with null or unknown manager does not match //
////////////////////////////////////////////////////////////
assertOutput(false, DEPARTMENT_TABLE, managerHasHistoryOver100K, Map.of());
assertOutput(false, DEPARTMENT_TABLE, managerHasHistoryOver100K, Map.of("managerId", 99));
//////////////////////////////////////////////////
// manager who has no job history doesn't match //
//////////////////////////////////////////////////
assertOutput(false, DEPARTMENT_TABLE, managerHasHistoryOver100K, Map.of("managerId", 3));
}
/*******************************************************************************
** employeeDetail 1:1 employee (reverse direction of employee->employeeDetail)
*******************************************************************************/
@Test
void testOneToOneReverseJoin() throws Exception
{
new InsertAction().execute(new InsertInput(EMPLOYEE_TABLE).withRecords(List.of(
new QRecord().withValue("id", 100).withValue("lastName", "Smith"),
new QRecord().withValue("id", 101).withValue("lastName", "Jones"))));
QQueryFilter employeeLastNameIsSmith = new QQueryFilter().withCriteria(EMPLOYEE_TABLE + ".lastName", QCriteriaOperator.EQUALS, "Smith");
/////////////////////////////////////////////////////
// detail row linked to matching employee is match //
/////////////////////////////////////////////////////
assertOutput(true, EMPLOYEE_DETAIL_TABLE, employeeLastNameIsSmith, Map.of("employeeId", 100));
/////////////////////////////////////////////////////////
// detail row linked to non-matching employee no match //
/////////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_DETAIL_TABLE, employeeLastNameIsSmith, Map.of("employeeId", 101));
////////////////////////////////////////////////////
// detail row with null/unknown employee no match //
////////////////////////////////////////////////////
assertOutput(false, EMPLOYEE_DETAIL_TABLE, employeeLastNameIsSmith, MapBuilder.of("employeeId", null));
assertOutput(false, EMPLOYEE_DETAIL_TABLE, employeeLastNameIsSmith, Map.of("employeeId", 999));
}
/*******************************************************************************
** company 1:N department N:1 manager(employee) 1:1 employeeDetail
*******************************************************************************/
@Test
void testOneToManyThenManyToOneThenOneToOneJoin() throws Exception
{
new InsertAction().execute(new InsertInput(EMPLOYEE_TABLE).withRecords(List.of(
new QRecord().withValue("id", 11).withValue("lastName", "Smith"),
new QRecord().withValue("id", 21).withValue("lastName", "Jones"),
new QRecord().withValue("id", 31).withValue("lastName", "Milton")
)));
new InsertAction().execute(new InsertInput(DEPARTMENT_TABLE).withRecords(List.of(
new QRecord().withValue("id", 401).withValue("companyId", 1).withValue("managerId", 11).withValue("name", "Engineering"),
new QRecord().withValue("id", 402).withValue("companyId", 2).withValue("managerId", 21).withValue("name", "Support"),
new QRecord().withValue("id", 403).withValue("companyId", 3).withValue("managerId", 31).withValue("name", "Office Space"),
new QRecord().withValue("id", 404).withValue("companyId", 4).withValue("managerId", null).withValue("name", "No Manager"))));
new InsertAction().execute(new InsertInput(EMPLOYEE_DETAIL_TABLE).withRecords(List.of(
new QRecord().withValue("id", 501).withValue("employeeId", 11).withValue("benefitsTier", "PLATINUM"),
new QRecord().withValue("id", 502).withValue("employeeId", 21).withValue("benefitsTier", "BASIC"))));
QQueryFilter hasManagerWithPlatinumTier = new QQueryFilter().withCriteria(EMPLOYEE_DETAIL_TABLE + ".benefitsTier", QCriteriaOperator.EQUALS, "PLATINUM");
///////////////////////////////////////////////////////////////
// company with department whose manager has matching detail //
///////////////////////////////////////////////////////////////
assertOutput(true, COMPANY_TABLE, hasManagerWithPlatinumTier, Map.of("id", 1));
///////////////////////////////////////////////////////////////
// company with department whose manager detail is non-match //
///////////////////////////////////////////////////////////////
assertOutput(false, COMPANY_TABLE, hasManagerWithPlatinumTier, Map.of("id", 2));
///////////////////////////////////////////////////
// company with department whose manager is null //
///////////////////////////////////////////////////
assertOutput(false, COMPANY_TABLE, hasManagerWithPlatinumTier, Map.of("id", 4));
//////////////////////////////////////////////////////////
// company with department whose manager has no history //
//////////////////////////////////////////////////////////
assertOutput(false, COMPANY_TABLE, hasManagerWithPlatinumTier, Map.of("id", 3));
/////////////////////////////////////////////
// company with no departments is no match //
/////////////////////////////////////////////
assertOutput(false, COMPANY_TABLE, hasManagerWithPlatinumTier, Map.of("id", 5));
}
/***************************************************************************
*
***************************************************************************/
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, workflowRevision, record);
}
/***************************************************************************
*
***************************************************************************/
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);
}
}
@@ -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());
}
/***************************************************************************
**
***************************************************************************/