Compare commits

..
Author SHA1 Message Date
Darin Kelkhoff 93581b13a1 fix: not frontend publish, guy 2025-11-26 16:31:05 -06:00
Darin Kelkhoff 0c1a7c24e6 chore: add publish_feature 2025-11-26 16:24:27 -06:00
Darin Kelkhoff 1fc7091657 feat(apiVersions): Look for apiName and apiVersion params as top-level params (in addition to under "workflowRevision." prefix) 2025-11-24 16:33:23 -06:00
Darin Kelkhoff 566793ff00 feat(filterInputs): Refactor getFilterFromInput, extracting getFilterFromJsonOrObject from it 2025-11-24 16:32:49 -06:00
Darin Kelkhoff d119fd8a90 feat(multiForkingSteps): Add support for multi-forking / variable-output steps
including:
- allowedDescendantStepTypes property on workflowStepType
- add workflow-level validator
- new field in WorkflowStepOutput to indicate that a step within a multi-forking execution should terminate the entire workflow.
- allow null toStep to be stored in a link, to help track flow out of variable steps at end-of-graph
- replace GetWorkflowStepSummaryProcess with GetWorkflowStepDynamicValuesProcess, which also includes outboundLinkOptions for VARIABLE mode steps
2025-11-24 16:32:00 -06:00
Tim Chamberlain 6db3d2aa0f initialized input data on workflow step type 2025-10-30 09:58:30 -05:00
CircleCI 6846aff6dc Bump version to 0.114.0-SNAPSHOT [skip ci] 2025-10-29 17:40:03 +00:00
Tim Chamberlain 4f115e53c6 updates from code review feedback 2025-10-29 12:37:53 -05:00
Tim Chamberlain 20f0d38dd1 updated help help on dynamic value field 2025-10-28 15:49:29 -05:00
Tim Chamberlain 09eca84ecb updated to handle workflow type help help 2025-10-28 14:46:28 -05:00
CircleCI 0950a439e4 Bump version to 0.3.0-SNAPSHOT [skip ci] 2025-10-22 13:42:26 +00:00
james.maes 7e67a581e0 build(circleci): updated to 0.3.12 - fixed develop branch detection 2025-10-22 08:40:32 -05:00
james.maes 6c3de53631 Empty commit and push - testing circleci qqq-orb 2025-10-22 08:32:17 -05:00
Darin Kelkhoff 41c6cba913 fix(helpContent): handle null helpContent object as signal to remove content - not to null pointer or build list with null member 2025-10-20 16:04:53 -05:00
CircleCI 51e4a14778 Bump version to 0.2.0 [skip ci] 2025-09-29 20:35:34 +00:00
james.maes aa804e2fc5 ci(circleci): updated to latest production qqq orb - 0.3.8 2025-09-29 15:34:30 -05:00
Darin Kelkhoff 07f72dae49 Merge pull request #2 from Kingsrook/feature/ui-fixes-2025-09
Feature/UI fixes 2025 09
2025-09-23 15:34:25 -05:00
Darin Kelkhoff 910d5c9858 fix(updateRecordFieldStep): Fix cases where possible values weren't being translated in step summary/log (when "tableName." prefix was present).
Also factor some static util method out, for use in application-defined steps of a similar nature.
2025-09-23 11:13:18 -05:00
Darin Kelkhoff 6ef1727eb8 feat(updateRecordFieldStep): Adjust possible value filters that use "${input.myFieldName}" to consider getting that value (via coalescing) from "??${input.workflow.myFieldName}"
Add initial tests on this class
2025-09-23 11:11:53 -05:00
Darin Kelkhoff fce13986b4 feat(storeRevision): more error checking and update format of exception message if there are errors
- put newlines between sub-errors (UI will display as multiple lines)
- put Step # in front of all per-step error messages
- Check for null workflow step type specifically
- Check for missing or invalid JSON for steps and links
- avoid NPE if null user in session
- initial test on this process (at least its validation logic)
2025-09-23 10:52:05 -05:00
james.maes c8f3bb4312 chore: bump snapshot version after release 2025-09-18 14:47:43 -05:00
37 changed files with 2555 additions and 933 deletions

No files matched your search

+21 -10
View File
@@ -1,34 +1,45 @@
version: 2.1
orbs:
qqq-orb: kingsrook/qqq-orb@0.5.0
qqq-orb: kingsrook/qqq-orb@0.3.12
workflows:
test_only:
jobs:
- qqq-orb/mvn_test_only:
context: [ qqq-maven-registry-credentials ]
context: [qqq-maven-registry-credentials]
filters:
branches:
ignore: /(develop|main|release/.*|hotfix/.*|integration.*)/
tags:
only: []
only: []
publish_snapshot:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
context: [qqq-maven-registry-credentials]
branch_type: snapshot
filters:
branches:
only:
- develop
publish_feature:
jobs:
- qqq-orb/mvn_publish:
context: [qqq-maven-registry-credentials]
branch_type: feature
filters:
branches:
only:
- feature/.*
tags:
only: [/publish.*/]
publish_release_candidate:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
context: [qqq-maven-registry-credentials]
branch_type: release_candidate
filters:
branches:
@@ -38,18 +49,18 @@ workflows:
publish_release:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
context: [qqq-maven-registry-credentials]
branch_type: release
filters:
branches:
ignore: /.*/
ignore: /.*/
tags:
only: [ /v.*/ ]
only: [/v.*/]
publish_hotfix_release:
jobs:
- qqq-orb/mvn_publish:
context: [ qqq-maven-registry-credentials ]
context: [qqq-maven-registry-credentials]
branch_type: hotfix
filters:
branches:
-31
View File
@@ -1,31 +0,0 @@
# GitHub Release Configuration
# Auto-generates release notes from PR labels
changelog:
exclude:
labels:
- ignore-for-release
- duplicate
- invalid
authors:
- dependabot
- dependabot[bot]
categories:
- title: Breaking Changes
labels:
- breaking-change
- breaking
- title: New Features
labels:
- enhancement
- feature
- title: Bug Fixes
labels:
- bug
- fix
- title: Dependencies
labels:
- dependencies
- title: Other Changes
labels:
- "*"
-680
View File
@@ -1,680 +0,0 @@
QQQ - Low-code Application Framework for Engineers
Copyright (C) 2021-2025 QRun-IO, LLC
https://www.qrun.io | https://github.com/QRun-IO
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/>.
--------------------------------------------------------------------------------
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
+69 -110
View File
@@ -1,150 +1,109 @@
# qbit-workflows
# QBit: Workflows
State machine workflows for QQQ applications.
[![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/)
**For:** QQQ developers building approval flows, order pipelines, or any multi-step business processes
**Status:** Stable
### Overview
*Note: This is one of the original QBit implementations - so, some of the mechanics of how
it is loaded and used by an application are not exactly fully defined at the time of its
creation... Please excuse any dust or not-quite-round wheels you find here!*
## Why This Exists
This QBit provides TODO
Business processes have states. Orders go from pending to approved to shipped. Support tickets move through triage, investigation, and resolution. Building these flows means tracking state, validating transitions, and triggering actions at each step.
## 🏗️ Architecture
This QBit provides a declarative workflow engine. Define states and transitions, and the system enforces valid paths, runs actions on transitions, and tracks history automatically.
### Technology Stack
## Features
- **Java**: Java 17+ with UTF-8 encoding
- **Maven**: Build system with plugin management
- **QQQ Framework**: Built on the QQQ low-code platform
- **QBit Pattern**: Follows QBit component architecture
- **State Definitions** - Define allowed states for any entity
- **Transition Rules** - Control which states can move to which other states
- **Transition Actions** - Execute code when moving between states
- **Role-Based Transitions** - Restrict who can trigger which transitions
- **Transition History** - Automatic audit log of all state changes
- **Dashboard Integration** - Status badges and transition buttons in the UI
### Core Capabilities
## Quick Start
- **Workflow Management**: TODO - Define workflow capabilities
- **Process Automation**: TODO - Define automation features
- **Integration**: TODO - Define integration capabilities
## 🚀 Quick Start
### Prerequisites
- QQQ application (v0.20+)
- Database backend configured
- **Java 17+** (required for QQQ features)
- **Maven 3.8+** (for build system)
### Installation
Add to your `pom.xml`:
### Usage
#### Pom dependency
```xml
<dependency>
<groupId>io.qrun</groupId>
<groupId>com.kingsrook.qbits</groupId>
<artifactId>qbit-workflows</artifactId>
<version>0.2.0</version>
<version>${TODO}</version>
</dependency>
```
### Register the QBit
#### Setup
TODO
```java
public class AppMetaProvider extends QMetaProvider {
@Override
public void configure(QInstance qInstance) {
new WorkflowsQBit().configure(qInstance);
}
}
```
### Provides
#### Tables
TODO
### Define a Workflow
#### Classes
TODO
```java
new QWorkflowMetaData()
.withName("orderWorkflow")
.withTable("order")
.withStatusField("status")
.withStates(
new QWorkflowState("pending", "Pending"),
new QWorkflowState("approved", "Approved"),
new QWorkflowState("shipped", "Shipped"),
new QWorkflowState("cancelled", "Cancelled")
)
.withTransitions(
new QWorkflowTransition("pending", "approved"),
new QWorkflowTransition("pending", "cancelled"),
new QWorkflowTransition("approved", "shipped"),
new QWorkflowTransition("approved", "cancelled")
);
```
### Dependencies
TODO
## Usage
## 📚 Documentation
### Transition Actions
**📖 [Complete Documentation Wiki](https://github.com/Kingsrook/qqq/wiki)** - Start here for comprehensive guides
```java
new QWorkflowTransition("approved", "shipped")
.withAction(new ShipOrderAction());
- **[🏠 Home](https://github.com/Kingsrook/qqq/wiki/Home)** - Project overview and quick start
- **[🏗️ Architecture](https://github.com/Kingsrook/qqq/wiki/High-Level-Architecture)** - System design and principles
- **[🔧 Development](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)** - Setup and contribution guide
- **[📦 Modules](https://github.com/Kingsrook/qqq/wiki/Core-Modules)** - Available components and usage
- **[🚀 Building](https://github.com/Kingsrook/qqq/wiki/Building-Locally)** - Local development workflow
- **[🔧 QBit Development](https://github.com/Kingsrook/qqq/wiki/QBit-Development)** - QBit development guide
public class ShipOrderAction implements WorkflowTransitionAction {
@Override
public void execute(WorkflowTransitionContext context) {
// Send shipping notification
// Update inventory
// Generate tracking number
}
}
```
## 🤝 Contributing
### Role-Based Transitions
**Important**: This repository is a component of the QQQ framework. All contributions, issues, and discussions should go through the main QQQ repository.
```java
// Only managers can approve
new QWorkflowTransition("pending", "approved")
.withAllowedRoles("manager", "admin");
```
### Development Workflow
### Transition Validation
1. **Fork the main QQQ repository**: https://github.com/Kingsrook/qqq
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
3. **Make your changes** (including QBit changes if applicable)
4. **Run tests**: `mvn test`
5. **Commit your changes**: `git commit -m 'Add amazing feature'`
6. **Push to the branch**: `git push origin feature/amazing-feature`
7. **Open a Pull Request** to the main QQQ repository
```java
new QWorkflowTransition("approved", "shipped")
.withValidator((context) -> {
if (context.getRecord().getValue("shippingAddress") == null) {
throw new WorkflowException("Shipping address required");
}
});
```
### Code Standards
### Querying by State
- **Maven**: Follow Maven best practices
- **Documentation**: Update relevant documentation
- **Versioning**: Follow semantic versioning
- **QBit Pattern**: Follow QBit component architecture
```java
// Find all pending orders
QueryInput query = new QueryInput()
.withTableName("order")
.withFilter(new QQueryFilter()
.withCriteria("status", Operator.EQUALS, "pending"));
```
**First time contributing?** Start with our [Developer Onboarding Guide](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding) to get your environment set up.
## Configuration
## 🏢 About Kingsrook
The QBit creates a transition history table automatically:
QBit Workflows is built by **[Kingsrook](https://qrun.io)** - making engineers more productive through intelligent automation and developer tools.
| Table | Purpose |
|-------|---------|
| `workflow_transition_log` | Audit trail of all state changes |
- **Website**: [https://qrun.io](https://qrun.io)
- **Contact**: [contact@kingsrook.com](mailto:contact@kingsrook.com)
- **GitHub**: [https://github.com/Kingsrook](https://github.com/Kingsrook)
Each log entry records: record ID, from state, to state, user, timestamp, and optional comments.
## 📄 License
## Project Status
This project is licensed under the **GNU Affero General Public License v3.0** - see the [LICENSE.txt](LICENSE.txt) file for details.
Stable and production-ready.
---
### Roadmap
**Ready to build workflows with full control?** [Get started with QQQ today!](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)
- Parallel state support (multiple active states)
- Scheduled transitions (auto-expire after N days)
- Workflow visualization in dashboard
## Contributing
1. Fork the repository
2. Create a feature branch
3. Run tests: `mvn clean verify`
4. Submit a pull request
## License
Proprietary - QRun.IO
+3 -3
View File
@@ -21,15 +21,15 @@
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<properties>
<revision>0.4.0-SNAPSHOT</revision>
<revision>0.114.0-SNAPSHOT</revision>
</properties>
<parent>
<groupId>com.kingsrook</groupId>
<artifactId>qbit-build-parent</artifactId>
<version>1.5.1</version>
<version>1.4.0</version>
</parent>
<groupId>com.kingsrook.qbits</groupId>
@@ -28,7 +28,7 @@ package com.kingsrook.qbits.workflows.definition;
** ONE is a regular statement, that just flows to its next.
** CONTAINER is itself a no-op, but it wraps (for UI reasons) a sequence
** TWO is for an if/else
** Unclear exactly how we'd do variable number of outbounds (e.g., a switch)
** VARIABLE is for a variable number - 1 or more
***************************************************************************/
public enum OutboundLinkMode
{
@@ -36,4 +36,5 @@ public enum OutboundLinkMode
ONE,
CONTAINER,
TWO,
VARIABLE
}
@@ -26,6 +26,7 @@ import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.google.gson.reflect.TypeToken;
import com.kingsrook.qbits.workflows.execution.WorkflowStepExecutorInterface;
import com.kingsrook.qqq.backend.core.actions.customizers.QCodeLoader;
@@ -56,8 +57,10 @@ public class WorkflowStepType implements Serializable
private OutboundLinkMode outboundLinkMode;
private List<OutboundLinkOption> outboundLinkOptions;
private ArrayList<QFieldMetaData> inputFields;
private ArrayList<String> inputWidgetNames;
private Set<String> allowedDescendantStepTypes;
private ArrayList<QFieldMetaData> inputFields = new ArrayList<>();
private ArrayList<String> inputWidgetNames = new ArrayList<>();
@@ -83,6 +86,17 @@ public class WorkflowStepType implements Serializable
/***************************************************************************
* for a variable-output type step, it must dynamically define its outbound
* links
***************************************************************************/
public List<OutboundLinkOption> getDynamicOutboundLinkOptions(Integer workflowId, Map<String, Serializable> inputValues) throws QException
{
return (null);
}
/***************************************************************************
**
***************************************************************************/
@@ -409,6 +423,7 @@ public class WorkflowStepType implements Serializable
}
/*******************************************************************************
* Getter for validator
* @see #withValidator(QCodeReference)
@@ -445,4 +460,42 @@ public class WorkflowStepType implements Serializable
}
/*******************************************************************************
* Getter for allowedDescendantStepTypes
* @see #withAllowedDescendantStepTypes(Set)
*******************************************************************************/
public Set<String> getAllowedDescendantStepTypes()
{
return (this.allowedDescendantStepTypes);
}
/*******************************************************************************
* Setter for allowedDescendantStepTypes
* @see #withAllowedDescendantStepTypes(Set)
*******************************************************************************/
public void setAllowedDescendantStepTypes(Set<String> allowedDescendantStepTypes)
{
this.allowedDescendantStepTypes = allowedDescendantStepTypes;
}
/*******************************************************************************
* Fluent setter for allowedDescendantStepTypes
*
* @param allowedDescendantStepTypes
* to limit what step types can be placed inside this step type within a graph.
* for example,
* @return this
*******************************************************************************/
public WorkflowStepType withAllowedDescendantStepTypes(Set<String> allowedDescendantStepTypes)
{
this.allowedDescendantStepTypes = allowedDescendantStepTypes;
return (this);
}
}
@@ -25,16 +25,19 @@ package com.kingsrook.qbits.workflows.definition;
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 com.google.gson.reflect.TypeToken;
import com.kingsrook.qbits.workflows.execution.WorkflowTypeExecutorInterface;
import com.kingsrook.qbits.workflows.execution.WorkflowTypeTesterInterface;
import com.kingsrook.qbits.workflows.execution.WorkflowTypeValidatorInterface;
import com.kingsrook.qqq.backend.core.instances.QInstanceEnricher;
import com.kingsrook.qqq.backend.core.instances.QInstanceValidator;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.help.QHelpContent;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
import com.kingsrook.qqq.backend.core.utils.StringUtils;
@@ -50,9 +53,11 @@ public class WorkflowType implements Serializable
private String label;
private String description;
private QCodeReference executor;
private QCodeReference validator;
private QCodeReference tester;
private ArrayList<WorkflowStepTypeCategory> stepTypeCategories;
protected Map<String, List<QHelpContent>> helpContent;
private ArrayList<WorkflowStepTypeCategory> stepTypeCategories;
@@ -81,6 +86,11 @@ public class WorkflowType implements Serializable
qInstanceValidator.validateSimpleCodeReference("WorkflowType [" + name + "]: executor ", executor, WorkflowTypeExecutorInterface.class);
}
if(validator != null)
{
qInstanceValidator.validateSimpleCodeReference("WorkflowType [" + name + "]: validator ", validator, WorkflowTypeValidatorInterface.class);
}
if(tester != null)
{
qInstanceValidator.validateSimpleCodeReference("WorkflowType [" + name + "]: tester ", tester, WorkflowTypeTesterInterface.class);
@@ -266,6 +276,8 @@ public class WorkflowType implements Serializable
return Collections.emptyMap();
}
/*******************************************************************************
* Getter for tester
* @see #withTester(QCodeReference)
@@ -303,4 +315,92 @@ public class WorkflowType implements Serializable
}
/*******************************************************************************
** Getter for helpContent
*******************************************************************************/
public Map<String, List<QHelpContent>> getHelpContent()
{
return (this.helpContent);
}
/*******************************************************************************
** Setter for helpContent
*******************************************************************************/
public void setHelpContent(Map<String, List<QHelpContent>> helpContent)
{
this.helpContent = helpContent;
}
/*******************************************************************************
** Fluent setter for helpContent
*******************************************************************************/
public WorkflowType withHelpContent(Map<String, List<QHelpContent>> helpContent)
{
this.helpContent = helpContent;
return (this);
}
/*******************************************************************************
** Fluent setter for helpContent
*******************************************************************************/
public WorkflowType withHelpContent(String key, QHelpContent helpContent)
{
if(this.helpContent == null)
{
this.helpContent = new HashMap<>();
}
if(!this.helpContent.containsKey(key))
{
this.helpContent.put(key, new ArrayList<>());
}
this.helpContent.get(key).add(helpContent);
return (this);
}
/*******************************************************************************
* Getter for validator
* @see #withValidator(QCodeReference)
*******************************************************************************/
public QCodeReference getValidator()
{
return (this.validator);
}
/*******************************************************************************
* Setter for validator
* @see #withValidator(QCodeReference)
*******************************************************************************/
public void setValidator(QCodeReference validator)
{
this.validator = validator;
}
/*******************************************************************************
* Fluent setter for validator
*
* @param validator reference to implementation of
* {@link com.kingsrook.qbits.workflows.execution.WorkflowTypeValidatorInterface}
*
* @return this
*******************************************************************************/
public WorkflowType withValidator(QCodeReference validator)
{
this.validator = validator;
return (this);
}
}
@@ -203,6 +203,8 @@ public class WorkflowsRegistry implements QSupplementalInstanceMetaData, QHelpCo
/***************************************************************************
* plug in to the QQQ Help Content system, to allow help content to set
* descriptions and labels for workflow steps.
*
* Note: helpContent can come in here as null, if it has been, e.g., deleted!
***************************************************************************/
@Override
public void acceptHelpContent(QInstance qInstance, QHelpContent helpContent, Map<String, String> nameValuePairs)
@@ -215,11 +217,18 @@ public class WorkflowsRegistry implements QSupplementalInstanceMetaData, QHelpCo
{
if("description".equals(nameValuePairs.get("slot")))
{
workflowStepType.setDescription(helpContent.getContentAsHtml());
workflowStepType.setDescription(helpContent == null ? null : helpContent.getContentAsHtml());
}
else if("label".equals(nameValuePairs.get("slot")))
{
workflowStepType.setLabel(helpContent.getContent());
if(helpContent != null)
{
workflowStepType.setLabel(helpContent.getContent());
}
else
{
LOG.info("Not removing workflow step type label after deleted help content (original label is not known...", logPair("name", workflowStepTypeName));
}
}
else if(nameValuePairs.containsKey("field"))
{
@@ -229,9 +238,10 @@ public class WorkflowsRegistry implements QSupplementalInstanceMetaData, QHelpCo
.withType(QFieldType.STRING)
.withLabel("Step Description")
.withName("qswdDescription")
.withHelpContent(helpContent)
.withGridColumns(12);
newField.setHelpContents(helpContent == null ? null : ListBuilder.of(helpContent));
List<QFieldMetaData> existingFields = workflowStepType.getInputFields();
existingFields.add(newField);
workflowStepType.setInputFields(existingFields);
@@ -242,13 +252,24 @@ public class WorkflowsRegistry implements QSupplementalInstanceMetaData, QHelpCo
{
if(nameValuePairs.get("field").equals(fieldMetaData.getName()))
{
fieldMetaData.setHelpContents(ListBuilder.of(helpContent));
fieldMetaData.setHelpContents(helpContent == null ? null : ListBuilder.of(helpContent));
}
}
}
}
}
}
else if(nameValuePairs.containsKey("workflow") && nameValuePairs.containsKey("field"))
{
if(workflowTypes != null)
{
for(String workflowTypeName : workflowTypes.keySet())
{
String key = "workflow:" + nameValuePairs.get("workflow") + ";field:" + nameValuePairs.get("field");
workflowTypes.get(workflowTypeName).withHelpContent(key, helpContent);
}
}
}
}
}
@@ -0,0 +1,41 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowRunLogStep;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
import com.kingsrook.qqq.backend.core.utils.ListingHash;
/***************************************************************************
* state data carried throughout the {@link WorkflowExecutor} - which is
* useful to "leak out" in a managed way, e.g., for step types that do their
* own more sophisticated kind of execution, e.g., {@link WorkflowMultiForkingStepExecutorInterface}
***************************************************************************/
record ExecutionPayload(Map<Integer, WorkflowStep> stepMap, ListingHash<Integer, WorkflowLink> linkMap, WorkflowTypeExecutorInterface workflowTypeExecutor, AtomicInteger seqNo, List<WorkflowRunLogStep> logStepList)
{
}
@@ -0,0 +1,167 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Deque;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
import com.kingsrook.qqq.backend.core.utils.ListingHash;
/*******************************************************************************
* given a graph, find the first "join point" where multiple forks come together.
* Credit: https://chatgpt.com/share/68000e8f-879c-8011-bb33-0564eb77a1f2
*******************************************************************************/
public class FindFirstJoinPoint
{
/***************************************************************************
**
***************************************************************************/
public static Integer executeForFromStepNo(Integer fromStepNo, Map<Integer, WorkflowStep> stepMap, ListingHash<Integer, WorkflowLink> linksMapByFromStepNo)
{
List<Integer> startLinks = CollectionUtils.nonNullList(linksMapByFromStepNo.get(fromStepNo)).stream().map(ws -> ws.getToStepNo()).toList();
return execute(startLinks, stepMap, linksMapByFromStepNo);
}
/***************************************************************************
**
***************************************************************************/
public static Integer executeForLinks(Collection<WorkflowLink> startLinks, Map<Integer, WorkflowStep> stepMap, ListingHash<Integer, WorkflowLink> linksMapByFromStepNo)
{
return execute(startLinks.stream().map(ws -> ws.getToStepNo()).toList(), stepMap, linksMapByFromStepNo);
}
/***************************************************************************
**
***************************************************************************/
@SuppressWarnings("Java8MapApi")
public static Integer execute(Collection<Integer> startStepNos, Map<Integer, WorkflowStep> stepMap, ListingHash<Integer, WorkflowLink> linksMapByFromStepNo)
{
//////////////////////////////////////////////////////////////////////////////////
// visited: map each node to a set of source step numbers that have reached it. //
//////////////////////////////////////////////////////////////////////////////////
ListingHash<Integer, Integer> visited = new ListingHash<>();
///////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Initialize the multi-source BFS queue. Each entry carries the current node id and its originating source. //
///////////////////////////////////////////////////////////////////////////////////////////////////////////////
Deque<BFSQueueNode> queue = new ArrayDeque<>();
////////////////////////////////////////////////////////////////////////////////
// Seed the queue with each starting node, marking each as visited by itself. //
////////////////////////////////////////////////////////////////////////////////
for(Integer node : startStepNos)
{
visited.add(node, node);
queue.add(new BFSQueueNode(node, node));
}
///////////////////////////////////
// Perform the multi-source BFS. //
///////////////////////////////////
while(!queue.isEmpty())
{
BFSQueueNode firstNode = queue.removeFirst();
Integer current = firstNode.current;
Integer source = firstNode.source;
////////////////////////////////////////////////////////////////////
// Get the list of outgoing links/neighbors for the current node. //
////////////////////////////////////////////////////////////////////
List<WorkflowLink> neighbors = Objects.requireNonNullElse(linksMapByFromStepNo.get(current), Collections.emptyList());
for(WorkflowLink neighbor : neighbors)
{
Integer neighborId = neighbor.getToStepNo();
if(neighborId == null)
{
continue;
}
///////////////////////////////////////////////////////////////////////////
// Retrieve or initialize the set of sources that visited this neighbor. //
///////////////////////////////////////////////////////////////////////////
List<Integer> sourcesSet = visited.get(neighborId);
if(sourcesSet == null)
{
sourcesSet = new ArrayList<>();
visited.put(neighborId, sourcesSet);
}
/////////////////////////////////////////////////////////////////////
// If the current source has not visited the neighbor yet, add it. //
/////////////////////////////////////////////////////////////////////
if(!sourcesSet.contains(source))
{
sourcesSet.add(source);
//////////////////////////////////////////////////////////////
// Check if the neighbor was reached from multiple sources. //
// todo: should this be it has to equal all of them? //
// if(sourcesSet.size() == startStepNos.size()) //
//////////////////////////////////////////////////////////////
if(sourcesSet.size() > 1)
{
///////////////////////////////////////////////////////////////////////////////////////
// This is the first join point encountered – return the corresponding WorkflowStep. //
///////////////////////////////////////////////////////////////////////////////////////
return (stepMap.get(neighborId).getStepNo());
}
/////////////////////////////////////////////////////////////////
// Continue the BFS from this neighbor for the current source. //
/////////////////////////////////////////////////////////////////
queue.push(new BFSQueueNode(neighborId, source));
}
}
}
///////////////////////////////////////////////////////////////
// If no join point was found across all paths, return null. //
///////////////////////////////////////////////////////////////
return null;
}
/***************************************************************************
*
***************************************************************************/
private record BFSQueueNode(Integer current, Integer source)
{
}
}
@@ -42,6 +42,8 @@ public class WorkflowExecutionContext
private QBackendTransaction transaction;
private WorkflowRunLog workflowRunLog;
private WorkflowExecutor executor;
private boolean isTestRun = false;
@@ -235,4 +237,26 @@ public class WorkflowExecutionContext
return (this);
}
/*******************************************************************************
* Getter for executor
* @see #setExecutor(WorkflowExecutor)
*******************************************************************************/
WorkflowExecutor getExecutor()
{
return (this.executor);
}
/*******************************************************************************
* Setter for executor
* @param executor the object executing the workflow.
*******************************************************************************/
void setExecutor(WorkflowExecutor executor)
{
this.executor = executor;
}
}
@@ -31,6 +31,7 @@ import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Stack;
import java.util.concurrent.atomic.AtomicInteger;
import com.google.gson.reflect.TypeToken;
import com.kingsrook.qbits.workflows.definition.OutboundLinkMode;
import com.kingsrook.qbits.workflows.definition.WorkflowStepType;
@@ -71,6 +72,7 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
private WorkflowRunLog inputWorkflowRunLog;
private Stack<Integer> containerStack = new Stack<>();
private ExecutionPayload payload;
@@ -167,31 +169,10 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
///////////////
// step loop //
///////////////
Integer stepNo = workflowRevision.getStartStepNo();
int seqNo = 1;
while(stepNo != null)
{
WorkflowStep step = stepMap.get(stepNo);
if(step == null)
{
throw new QException("Step not found by stepNo: " + stepNo);
}
WorkflowRunLogStep workflowRunLogStep = new WorkflowRunLogStep();
workflowRunLogStep.setWorkflowStepId(step.getId());
workflowRunLogStep.setSeqNo(seqNo);
workflowRunLogStep.setStartTimestamp(Instant.now());
logStepList.add(workflowRunLogStep);
WorkflowStepOutput workflowStepOutput = executeStep(step, workflowTypeExecutor, context);
workflowRunLogStep.setOutputData(ValueUtils.getValueAsString(workflowStepOutput.outputData()));
workflowRunLogStep.setMessage(workflowStepOutput.message());
stepNo = getNextStepNo(workflowStepOutput.outputData(), step, linkMap, stepMap, false);
workflowRunLogStep.setEndTimestamp(Instant.now());
seqNo++;
}
ExecutionPayload payload = new ExecutionPayload(stepMap, linkMap, workflowTypeExecutor, new AtomicInteger(1), logStepList);
this.payload = payload;
context.setExecutor(this);
runStepLoop(workflowRevision.getStartStepNo(), context, null);
workflowTypeExecutor.postRun(context);
@@ -239,6 +220,51 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
/***************************************************************************
* @return true if the workflow should immediately stop
***************************************************************************/
boolean runStepLoop(Integer stepNo, WorkflowExecutionContext context, Integer stopStepNo) throws QException
{
while(stepNo != null)
{
WorkflowStep step = payload.stepMap().get(stepNo);
if(step == null)
{
throw new QException("Step not found by stepNo: " + stepNo);
}
WorkflowRunLogStep workflowRunLogStep = new WorkflowRunLogStep();
workflowRunLogStep.setWorkflowStepId(step.getId());
workflowRunLogStep.setStartTimestamp(Instant.now());
WorkflowStepOutput workflowStepOutput = executeStep(step, payload, context);
stepNo = getNextStepNo(workflowStepOutput.outputData(), step, payload.linkMap(), payload.stepMap(), false);
workflowRunLogStep.setEndTimestamp(Instant.now());
workflowRunLogStep.setOutputData(ValueUtils.getValueAsString(workflowStepOutput.outputData()));
workflowRunLogStep.setMessage(workflowStepOutput.message());
workflowRunLogStep.setSeqNo(payload.seqNo().getAndIncrement());
payload.logStepList().add(workflowRunLogStep);
if(stopStepNo != null && Objects.equals(stepNo, stopStepNo))
{
LOG.debug("Stopping at requested step", logPair("stopStepNo", stepNo));
return (false);
}
if(workflowStepOutput.shouldWorkflowImmediatelyStop())
{
LOG.info("Stopping step loop due to step output indicating workflow should immediately stop", logPair("stepNo", stepNo));
return (true);
}
}
return (false);
}
/***************************************************************************
**
***************************************************************************/
@@ -332,13 +358,23 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
}
}
Integer fromStepNo = fromStep.getStepNo();
List<WorkflowLink> links = linkMap.get(fromStepNo);
Class<? extends Serializable> stepOutputClass = stepOutput == null ? null : stepOutput.getClass();
Integer fromStepNo = fromStep.getStepNo();
List<WorkflowLink> links = linkMap.get(fromStepNo);
if(OutboundLinkMode.VARIABLE.equals(fromWorkflowStepType.getOutboundLinkMode()))
{
/////////////////////////////////////////////////////////////////////////////
// after a VARIABLE step (where its branches were all executed in //
// processMultiForkingStep), find the first join point, and step to there. //
/////////////////////////////////////////////////////////////////////////////
Integer joinStepNo = FindFirstJoinPoint.execute(links.stream().map(wl -> wl.getToStepNo()).toList(), stepMap, linkMap);
return (joinStepNo);
}
//////////////////////////////////////////////////////////////////////////////////////
// look for a link between the fromStepNo matching the stepOutput / condition value //
//////////////////////////////////////////////////////////////////////////////////////
List<String> evaluatedConditionValues = new ArrayList<>();
for(WorkflowLink link : CollectionUtils.nonNullList(links))
{
if(link.getConditionValue() == null)
@@ -350,8 +386,10 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
}
else
{
evaluatedConditionValues.add(link.getConditionValue());
try
{
Class<? extends Serializable> stepOutputClass = stepOutput == null ? null : stepOutput.getClass();
Serializable valueAsType = stepOutputClass == null ? link.getConditionValue() : ValueUtils.getValueAsType(stepOutputClass, link.getConditionValue());
if(Objects.equals(valueAsType, stepOutput))
{
@@ -365,6 +403,11 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
}
}
if(CollectionUtils.nullSafeHasContents(evaluatedConditionValues))
{
LOG.info("Evaluated at least 1 link condition value, but found no matches", logPair("evaluatedConditionValues", evaluatedConditionValues));
}
/////////////////////////////////////////////////////////////////////////
// if we didn't find a next-step, but there is something on the stack, //
// then look for a pop out of that frame //
@@ -385,7 +428,7 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
/***************************************************************************
**
***************************************************************************/
private WorkflowStepOutput executeStep(WorkflowStep step, WorkflowTypeExecutorInterface workflowTypeExecutor, WorkflowExecutionContext context) throws QException
private WorkflowStepOutput executeStep(WorkflowStep step, ExecutionPayload payload, WorkflowExecutionContext context) throws QException
{
WorkflowStepType workflowStepType = WorkflowsRegistry.of(QContext.getQInstance()).getWorkflowStepType(step.getWorkflowStepTypeName());
if(workflowStepType == null)
@@ -399,8 +442,7 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
}
WorkflowStepExecutorInterface workflowStepExecutor = QCodeLoader.getAdHoc(WorkflowStepExecutorInterface.class, workflowStepType.getExecutor());
workflowTypeExecutor.preStep(step, context);
payload.workflowTypeExecutor().preStep(step, context);
JSONObject jsonObject = JsonUtils.toJSONObject(step.getInputValuesJson());
Map<String, Object> mapValues = jsonObject.toMap();
@@ -415,13 +457,23 @@ public class WorkflowExecutor extends AbstractQActionBiConsumer<WorkflowInput, W
}
WorkflowStepOutput workflowStepOutput = workflowStepExecutor.execute(step, inputValues, context);
workflowStepOutput = workflowTypeExecutor.postStep(step, context, workflowStepOutput);
workflowStepOutput = payload.workflowTypeExecutor().postStep(step, context, workflowStepOutput);
return workflowStepOutput;
}
/***************************************************************************
*
***************************************************************************/
ExecutionPayload getPayload()
{
return (this.payload);
}
/***************************************************************************
**
***************************************************************************/
@@ -0,0 +1,134 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution;
import java.io.Serializable;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowRunLogStep;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.logging.QLogger;
import com.kingsrook.qqq.backend.core.utils.ValueUtils;
import static com.kingsrook.qqq.backend.core.logging.LogUtils.logPair;
/***************************************************************************
* interface for workflow step executors that are of a variable output type,
* and which can execute 0 or more of their outbound links.
***************************************************************************/
public interface WorkflowMultiForkingStepExecutorInterface extends WorkflowStepExecutorInterface
{
QLogger LOG = QLogger.getLogger(WorkflowMultiForkingStepExecutorInterface.class);
/***************************************************************************
* the Execute method for such steps should perform an executor.runStepLoop
* for each of the outbound links of the step (assuming they are supposed
* allowed to run).
***************************************************************************/
@Override
default WorkflowStepOutput execute(WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext context) throws QException
{
///////////////////////////////////////////////////////////////////////
// get the various sub-workflows ("fork links") to run from the step //
///////////////////////////////////////////////////////////////////////
WorkflowExecutor executor = context.getExecutor();
ExecutionPayload payload = executor.getPayload();
List<WorkflowLink> forkLinks = payload.linkMap().get(step.getStepNo());
preRun(step, inputValues, context);
sortForks(forkLinks, step, inputValues, context);
Integer stopStepNo = FindFirstJoinPoint.execute(forkLinks.stream().map(wl -> wl.getToStepNo()).toList(), payload.stepMap(), payload.linkMap());
boolean shouldWorkflowImmediatelyStop = false;
for(WorkflowLink link : forkLinks)
{
WorkflowRunLogStep workflowRunLogStep = new WorkflowRunLogStep();
workflowRunLogStep.setWorkflowStepId(step.getId());
workflowRunLogStep.setSeqNo(payload.seqNo().getAndIncrement());
workflowRunLogStep.setStartTimestamp(Instant.now());
WorkflowStepOutput workflowStepOutput = conditionallyExecuteFork(step, link, inputValues, context);
if(Objects.equals(workflowStepOutput.outputData(), true))
{
shouldWorkflowImmediatelyStop = executor.runStepLoop(link.getToStepNo(), context, stopStepNo);
}
workflowRunLogStep.setOutputData(ValueUtils.getValueAsString(workflowStepOutput.outputData()));
workflowRunLogStep.setMessage(workflowStepOutput.message());
workflowRunLogStep.setEndTimestamp(Instant.now());
payload.logStepList().add(workflowRunLogStep);
if(shouldWorkflowImmediatelyStop)
{
LOG.info("Stopping fork-link loop, due to step output indicating workflow should immediately stop", logPair("linkStartStepNo", link.getToStepNo()));
break;
}
}
WorkflowStepOutput workflowStepOutput = makeWorkflowStepOutput(step, inputValues, context);
postRun(step, inputValues, context);
if(shouldWorkflowImmediatelyStop)
{
workflowStepOutput = new WorkflowStepOutput(workflowStepOutput.outputData(), workflowStepOutput.message(), true);
}
return workflowStepOutput;
}
/***************************************************************************
* make sure the forks are executed in the order that the step expects.
***************************************************************************/
void sortForks(List<WorkflowLink> forkLinks, WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext context);
/***************************************************************************
* decide if a particular fork should be executed - and if so, then do so.
***************************************************************************/
WorkflowStepOutput conditionallyExecuteFork(WorkflowStep step, WorkflowLink fork, Map<String, Serializable> inputValues, WorkflowExecutionContext context) throws QException;
/***************************************************************************
* make output for the entire step, e.g., taking into account all of its
* forks.
***************************************************************************/
WorkflowStepOutput makeWorkflowStepOutput(WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext context) throws QException;
/***************************************************************************
* optional code to run before anything else in this interface
***************************************************************************/
default void preRun(WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext context) throws QException
{
}
/***************************************************************************
* optional code to run after anything else in this interface
***************************************************************************/
default void postRun(WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext context) throws QException
{
}
}
@@ -28,16 +28,26 @@ import java.io.Serializable;
/***************************************************************************
**
***************************************************************************/
public record WorkflowStepOutput(Serializable outputData, String message)
public record WorkflowStepOutput(Serializable outputData, String message, boolean shouldWorkflowImmediatelyStop)
{
/*******************************************************************************
** Constructor
**
*******************************************************************************/
public WorkflowStepOutput(Serializable outputData, String message)
{
this(outputData, message, false);
}
/*******************************************************************************
** Constructor
**
*******************************************************************************/
public WorkflowStepOutput(Serializable outputData)
{
this(outputData, null);
this(outputData, null, false);
}
@@ -48,7 +58,7 @@ public record WorkflowStepOutput(Serializable outputData, String message)
*******************************************************************************/
public WorkflowStepOutput()
{
this(null, null);
this(null, null, false);
}
}
@@ -0,0 +1,51 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution;
import java.util.List;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
/*******************************************************************************
* interface for the code that validates the overall structure of a workflow,
* e.g., when it's being saved. This would be where you'd validate relationships
* between steps (e.g., this step must have some other step within it)
*******************************************************************************/
public interface WorkflowTypeValidatorInterface
{
/***************************************************************************
* validate that a workflow can be saved.
*
* @param workflow the workflow record under which a new revision is being saved
* @param workflowRevision the new revision record that's been built
* @param workflowSteps list of workflow steps being saved
* @param workflowLinks list of workflow links being saved
* @param errors out param - any validation errors should be added to this list.
***************************************************************************/
void validate(QRecord workflow, QRecord workflowRevision, List<WorkflowStep> workflowSteps, List<WorkflowLink> workflowLinks, List<String> errors) throws QException;
}
@@ -0,0 +1,72 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution.nodes;
import java.util.ArrayList;
import java.util.List;
/***************************************************************************
* list of nodes in a graph representation of a workflow
***************************************************************************/
public record NodeSequence(List<StepNode> nodes)
{
/*******************************************************************************
** Constructor
**
*******************************************************************************/
public NodeSequence()
{
this(new ArrayList<>());
}
/***************************************************************************
*
***************************************************************************/
public void add(StepNode node)
{
nodes.add(node);
}
/***************************************************************************
*
***************************************************************************/
public StepNode get(int i)
{
return nodes.get(i);
}
/***************************************************************************
*
***************************************************************************/
public int size()
{
return (nodes.size());
}
}
@@ -0,0 +1,47 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution.nodes;
import java.util.HashMap;
import java.util.Map;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
/***************************************************************************
* Single step, plus, if it opens a nested scope (e.g., branches, or a container)
* then those subSequences, along with their conditionalValues (guards/labels)
* as map keys
***************************************************************************/
public record StepNode(WorkflowStep step, Map<String, NodeSequence> subSequences)
{
/*******************************************************************************
** Constructor for step w/o subSequences
**
*******************************************************************************/
public StepNode(WorkflowStep step)
{
this(step, new HashMap<>());
}
}
@@ -0,0 +1,224 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution.nodes;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import com.kingsrook.qbits.workflows.definition.OutboundLinkMode;
import com.kingsrook.qbits.workflows.definition.WorkflowStepType;
import com.kingsrook.qbits.workflows.definition.WorkflowsRegistry;
import com.kingsrook.qbits.workflows.execution.FindFirstJoinPoint;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.logging.QLogger;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
import com.kingsrook.qqq.backend.core.utils.ListingHash;
import com.kingsrook.qqq.backend.core.utils.StringUtils;
/*******************************************************************************
* Class that can convert a list of steps & links (as a workflow revision is
* stored in a database) to a hierarchical graph data structure - a list of nodes,
* each of which is a step, and optionally a map of lists of sub-branches
* (which can be more useful for various kinds of processing).
*******************************************************************************/
public class StepNodeGraphBuilder
{
private static final QLogger LOG = QLogger.getLogger(StepNodeGraphBuilder.class);
/***************************************************************************
*
***************************************************************************/
public static NodeSequence buildNodeSequence(Integer startStepNo, List<WorkflowStep> workflowSteps, List<WorkflowLink> workflowLinks)
{
Map<Integer, WorkflowStep> stepMap = CollectionUtils.listToMap(workflowSteps, ws -> ws.getStepNo());
ListingHash<Integer, WorkflowLink> linksFromMap = new ListingHash<>();
Map<Integer, Set<Integer>> linksToMap = new HashMap<>();
for(WorkflowLink workflowLink : workflowLinks)
{
linksFromMap.add(workflowLink.getFromStepNo(), workflowLink);
if(workflowLink.getToStepNo() != null)
{
Set<Integer> subToSet = linksToMap.computeIfAbsent(workflowLink.getToStepNo(), k -> new HashSet<>());
subToSet.add(workflowLink.getFromStepNo());
}
}
NodeSequence nodeSequence = new NodeSequence();
buildNodeSequence(nodeSequence, stepMap.get(startStepNo), stepMap, linksFromMap, null, 0);
return (nodeSequence);
}
/***************************************************************************
*
***************************************************************************/
private static void buildNodeSequence(NodeSequence nodeSequence, WorkflowStep startStep, Map<Integer, WorkflowStep> stepMap, ListingHash<Integer, WorkflowLink> linksFromMap, Integer joinStepNo, Integer depth)
{
WorkflowsRegistry workflowsRegistry = WorkflowsRegistry.of(QContext.getQInstance());
WorkflowStep currentWorkflowStep = startStep;
while(currentWorkflowStep != null)
{
WorkflowStepType workflowStepType = workflowsRegistry.getWorkflowStepType(currentWorkflowStep.getWorkflowStepTypeName());
if(workflowStepType == null)
{
LOG.warn("Unrecognized workflow step type: " + currentWorkflowStep.getWorkflowStepTypeName());
return;
}
if(Objects.equals(currentWorkflowStep.getStepNo(), joinStepNo))
{
//////////////////////////////////////////////////////////////////////////////
// if we've reached the join step, it's the end of this sequence, so return //
//////////////////////////////////////////////////////////////////////////////
return;
}
StepNode stepNode = new StepNode(currentWorkflowStep);
nodeSequence.add(stepNode);
List<WorkflowLink> outboundLinks = linksFromMap.get(currentWorkflowStep.getStepNo());
if(CollectionUtils.nullSafeIsEmpty(outboundLinks))
{
/////////////////////////////////////////////////////////////////////////////
// if no outbound links, then we're at the end of this sequence, so return //
/////////////////////////////////////////////////////////////////////////////
return;
}
else if(outboundLinks.size() == 1 && !StringUtils.hasContent(outboundLinks.get(0).getConditionValue())) // ?? avoid being tripped by a branch w/ only 1 side populated at the end of the graph
{
///////////////////////////////////////////////////////////////////
// 1 outbound link here means we're not in a switch/if-else/fork //
///////////////////////////////////////////////////////////////////
WorkflowLink outboundLink = outboundLinks.get(0);
currentWorkflowStep = outboundLink.getToStepNo() == null ? null : stepMap.get(outboundLink.getToStepNo());
////////////////////////////////
// todo is this == null okay? //
////////////////////////////////
if(currentWorkflowStep == null || currentWorkflowStep.getStepNo().equals(joinStepNo))
{
///////////////////////////////////////////////////////
// this means we're ending a nested (recursive) call //
///////////////////////////////////////////////////////
return;
}
}
else
{
if(workflowStepType.getOutboundLinkMode().equals(OutboundLinkMode.TWO) || workflowStepType.getOutboundLinkMode().equals(OutboundLinkMode.VARIABLE))
{
///////////////////////////////////////////////////////////////////////////////////////////////////
// this means we are starting a fork. find where it ends - where the branches first re-converge //
///////////////////////////////////////////////////////////////////////////////////////////////////
Integer branchJoin = FindFirstJoinPoint.executeForLinks(outboundLinks, stepMap, linksFromMap);
////////////////////////////////////////////
// for each branch, make a recursive call //
////////////////////////////////////////////
for(WorkflowLink outboundLink : outboundLinks)
{
String conditionValue = outboundLink.getConditionValue();
NodeSequence branchSequence = new NodeSequence();
stepNode.subSequences().put(conditionValue, branchSequence);
if(branchJoin != null && Objects.equals(branchJoin, outboundLink.getToStepNo()))
{
////////////////////////////////////////////////////////////////////////
// this indicates an empty branch - so continue to next outbound link //
////////////////////////////////////////////////////////////////////////
continue;
}
///////////////////////////////////////////////////////////////////////////////////////////
// if this is a step out of the branch (e.g., to a join), then don't process it in here. //
// also though, this line doesn't actually get hit, so... //
///////////////////////////////////////////////////////////////////////////////////////////
if(Objects.equals(outboundLink.getToStepNo(), joinStepNo))
{
continue;
}
else
{
if(outboundLink.getToStepNo() != null)
{
buildNodeSequence(branchSequence, stepMap.get(outboundLink.getToStepNo()), stepMap, linksFromMap, branchJoin, depth + 1);
}
}
}
////////////////////////////////////////////////////////////////////////////////
// after handling all the branches, then continue the loop with the join step //
////////////////////////////////////////////////////////////////////////////////
currentWorkflowStep = branchJoin == null ? null : stepMap.get(branchJoin);
}
else if(workflowStepType.getOutboundLinkMode().equals(OutboundLinkMode.CONTAINER))
{
///////////////////////////////////////////////////////////////////////
// if the container is non-empty, there should be a push link for it //
///////////////////////////////////////////////////////////////////////
Optional<WorkflowLink> pushLink = outboundLinks.stream().filter(ol -> "push".equals(ol.getConditionValue())).findFirst();
if(pushLink.isPresent())
{
if(pushLink.get().getToStepNo() != null)
{
NodeSequence containerSequence = new NodeSequence();
stepNode.subSequences().put("push", containerSequence);
buildNodeSequence(containerSequence, stepMap.get(pushLink.get().getToStepNo()), stepMap, linksFromMap, null, depth + 1);
}
}
Optional<WorkflowLink> popLink = outboundLinks.stream().filter(ol -> "pop".equals(ol.getConditionValue())).findFirst();
if(popLink.isPresent())
{
if(popLink.get().getToStepNo() != null)
{
currentWorkflowStep = stepMap.get(popLink.get().getToStepNo());
}
}
else
{
return;
}
}
else
{
LOG.warn("expected to have multiple outbound links for a step of type: " + currentWorkflowStep.getWorkflowStepTypeName());
}
}
}
}
}
@@ -98,6 +98,11 @@ public class RecordWorkflowInputRecordFilterWidget extends AbstractWidgetRendere
public static void applyApiNameAndVersionFromInputToWidgetData(RenderWidgetInput input, FilterAndColumnsSetupData widgetData)
{
String apiName = input.getQueryParams().get("workflowRevision.apiName");
if(!StringUtils.hasContent(apiName))
{
apiName = input.getQueryParams().get("apiName");
}
if(StringUtils.hasContent(apiName))
{
widgetData.setApiName(apiName);
@@ -113,6 +118,11 @@ public class RecordWorkflowInputRecordFilterWidget extends AbstractWidgetRendere
}
String apiVersion = input.getQueryParams().get("workflowRevision.apiVersion");
if(!StringUtils.hasContent(apiVersion))
{
apiVersion = input.getQueryParams().get("apiVersion");
}
if(StringUtils.hasContent(apiVersion))
{
widgetData.setApiVersion(apiVersion);
@@ -83,18 +83,28 @@ public class RecordWorkflowUtils
/***************************************************************************
**
* expects name in inputValues to be "queryFilterJson"
***************************************************************************/
public static QQueryFilter getFilterFromInput(Map<String, ?> inputValues) throws QException
{
Object object = inputValues.get("queryFilterJson");
if(object == null)
{
throw (new QException("Could not find filter in input values"));
}
return getFilterFromJsonOrObject(object);
}
/***************************************************************************
* supported input types are: QQueryFilter, String (json), Map.
***************************************************************************/
public static QQueryFilter getFilterFromJsonOrObject(Object object) throws QException
{
try
{
Object object = inputValues.get("queryFilterJson");
if(object == null)
{
throw (new QException("Could not find filter in input values"));
}
if(object instanceof QQueryFilter qQueryFilter)
{
return (qQueryFilter);
@@ -114,7 +124,7 @@ public class RecordWorkflowUtils
}
catch(IOException e)
{
throw new QException("Error getting filter from input values", e);
throw new QException("Error getting filter from Object", e);
}
}
@@ -25,16 +25,21 @@ package com.kingsrook.qbits.workflows.implementations.recordworkflows;
import java.io.Serializable;
import java.util.Collections;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import com.kingsrook.qbits.workflows.definition.WorkflowStepType;
import com.kingsrook.qbits.workflows.definition.WorkflowsRegistry;
import com.kingsrook.qbits.workflows.implementations.WorkflowStepUtils;
import com.kingsrook.qbits.workflows.model.WorkflowRevision;
import com.kingsrook.qqq.backend.core.actions.values.SearchPossibleValueSourceAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.logging.QLogger;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceInput;
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceOutput;
import com.kingsrook.qqq.backend.core.model.metadata.code.InitializableViaCodeReference;
@@ -128,12 +133,24 @@ public class UpdateInputRecordFieldMetaDataAdjuster implements FormAdjusterInter
{
QTableMetaData table = QContext.getQInstance().getTable(tableName);
FieldAndJoinTable fieldAndJoinTable = FieldAndJoinTable.get(table, newValue);
updatedField = fieldAndJoinTable.field().clone();
updatedField.setName("value");
updatedField.setLabel("Value (" + fieldAndJoinTable.field().getLabel() + ")");
}
if(fieldAndJoinTable != null)
////////////////////////////////////////////////////////////////////////////////
// check the workflow registry to see if there is help content for this field //
////////////////////////////////////////////////////////////////////////////////
WorkflowsRegistry workflowsRegistry = WorkflowsRegistry.of(QContext.getQInstance());
WorkflowStepType workflowStepType = workflowsRegistry.getWorkflowStepType(UpdateInputRecordFieldStep.NAME);
if(workflowStepType != null)
{
for(QFieldMetaData fieldMetaData : CollectionUtils.nonNullList(workflowStepType.getInputFields()))
{
updatedField = fieldAndJoinTable.field().clone();
updatedField.setName("value");
updatedField.setLabel("Value (" + fieldAndJoinTable.field().getLabel() + ")");
if(fieldMetaData.getName().equals("value"))
{
updatedField.setHelpContents(fieldMetaData.getHelpContents());
}
}
}
}
@@ -143,6 +160,8 @@ public class UpdateInputRecordFieldMetaDataAdjuster implements FormAdjusterInter
}
}
adjustPossibleValueSourceFilterCriteriaInputs(updatedField.getPossibleValueSourceFilter());
///////////////////////////////////////////////////////////////////////////////////
// build the output object, starting with the new meta-data of the 'value' field //
///////////////////////////////////////////////////////////////////////////////////
@@ -186,6 +205,43 @@ public class UpdateInputRecordFieldMetaDataAdjuster implements FormAdjusterInter
/***************************************************************************
* if the field has a possible-value-source filter on it, and that filter
* uses an input field e.g., ${input.someField} - consider that this value
* *might* be an attribute on the workflow so add an optional
* ??${input.workflow.someField} after it.
***************************************************************************/
static void adjustPossibleValueSourceFilterCriteriaInputs(QQueryFilter filter)
{
if(filter == null)
{
return;
}
for(QFilterCriteria criteria : CollectionUtils.nonNullList(filter.getCriteria()))
{
List<Serializable> values = CollectionUtils.nonNullList(criteria.getValues());
ListIterator<Serializable> valueIterator = values.listIterator();
while(valueIterator.hasNext())
{
Serializable value = valueIterator.next();
if(value instanceof String stringValue && stringValue.startsWith("${input."))
{
String inputFieldName = stringValue.replace("${input.", "").replace("}", "");
String updatedValue = stringValue + "??${input.workflow." + inputFieldName + "}";
valueIterator.set(updatedValue);
}
}
}
for(QQueryFilter subFilter : CollectionUtils.nonNullList(filter.getSubFilters()))
{
adjustPossibleValueSourceFilterCriteriaInputs(subFilter);
}
}
/***************************************************************************
**
***************************************************************************/
@@ -60,7 +60,10 @@ import org.json.JSONObject;
/*******************************************************************************
** workflow step that updates a record with one value in one field
* Workflow step that updates a record with one value in one field
*
* This class includes some public static methods that can be useful for other
* workflow step implementations that have similar functionality.
*******************************************************************************/
public class UpdateInputRecordFieldStep extends WorkflowStepType implements WorkflowStepExecutorInterface, WorkflowStepValidatorInterface
{
@@ -101,7 +104,15 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
/***************************************************************************
**
* For a given fieldName, tableName, and api and version (which come from a
* workflowRevision), get QFieldMetaData for that field (if it's in that
* API Version).
*
* @param fieldNameMaybeWithTableNamePrefix - field name - which can be
* prefixed by tableName + "."
* @param tableName table name
* @param workflowRevision from which api name and version will come
* @return optional containing QFieldMetaData if found, or empty if not.
***************************************************************************/
public static Optional<QFieldMetaData> getApiField(String fieldNameMaybeWithTableNamePrefix, String tableName, WorkflowRevision workflowRevision) throws QException
{
@@ -121,6 +132,31 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
***************************************************************************/
@Override
public String getDynamicStepSummary(Integer workflowId, Map<String, Serializable> inputValues) throws QException
{
QRecord workflowRecord = GetAction.execute(Workflow.TABLE_NAME, workflowId);
String tableName = workflowRecord.getValueString("tableName");
return getStepSummary(inputValues, tableName, false);
}
/***************************************************************************
* Helper for {@link #getDynamicStepSummary(Integer, Map)} or
* {@link #execute(WorkflowStep, Map, WorkflowExecutionContext)} to generate
* a string like "${fieldLabel} will be / was set to ${value}" or "... cleared out"
* where the value will be a translated possible value if applicable.
*
* @param inputValues map of values user assigned to the step. expected to
* include String fieldName and String value.
* @param tableName table that the field should come from. Many times this
* may be the tableName on the workflow - but it could be
* a hard-coded tableName in other implementations of this
* step type.
* @param isPastTense to format the message as "will be" or "was". e.g.,
* for getDynamicStepSummary would be false ("will be")
* and for execute would be true ("was").
***************************************************************************/
public static String getStepSummary(Map<String, Serializable> inputValues, String tableName, boolean isPastTense)
{
String fieldName = ValueUtils.getValueAsString(inputValues.get("fieldName"));
String value = ValueUtils.getValueAsString(inputValues.get("value"));
@@ -137,45 +173,38 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
}
}
return getStepSummary(workflowId, fieldName, apiName, apiVersion, value, false);
return getStepSummary(fieldName, tableName, apiName, apiVersion, value, isPastTense);
}
/***************************************************************************
**
*
***************************************************************************/
private String getStepSummary(Integer workflowId, String fieldName, String apiName, String apiVersion, String value, boolean isPastTense)
private static String getStepSummary(String fieldName, String tableName, String apiName, String apiVersion, String value, boolean isPastTense)
{
String fieldLabel = null;
QTableMetaData table = null;
QTableMetaData table = QContext.getQInstance().getTable(tableName);
if(StringUtils.hasContent(fieldName))
{
try
{
if(workflowId != null)
WorkflowRevision workflowRevision = new WorkflowRevision().withApiName(apiName).withApiVersion(apiVersion);
if(WorkflowStepUtils.useApi(workflowRevision))
{
QRecord workflowRecord = GetAction.execute(Workflow.TABLE_NAME, workflowId);
table = QContext.getQInstance().getTable(workflowRecord.getValueString("tableName"));
WorkflowRevision workflowRevision = new WorkflowRevision().withApiName(apiName).withApiVersion(apiVersion);
if(WorkflowStepUtils.useApi(workflowRevision))
Optional<QFieldMetaData> optionalApiField = getApiField(fieldName, tableName, workflowRevision);
if(optionalApiField.isPresent())
{
Optional<QFieldMetaData> optionalApiField = getApiField(fieldName, table.getName(), workflowRevision);
if(optionalApiField.isPresent())
{
// fieldName = optionalApiField.field().getName(); // hmm?
fieldLabel = optionalApiField.get().getLabel();
}
}
else
{
FieldAndJoinTable fieldAndJoinTable = FieldAndJoinTable.get(table, fieldName);
fieldName = fieldAndJoinTable.field().getName();
fieldLabel = fieldAndJoinTable.field().getLabel();
fieldLabel = optionalApiField.get().getLabel();
}
}
else
{
FieldAndJoinTable fieldAndJoinTable = FieldAndJoinTable.get(table, fieldName);
fieldName = fieldAndJoinTable.field().getName();
fieldLabel = fieldAndJoinTable.field().getLabel();
}
}
catch(Exception e)
{
@@ -183,15 +212,22 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
}
}
String verb = isPastTense ? "was" : "will be";
if(StringUtils.hasContent(fieldLabel))
{
String verb = isPastTense ? "was" : "will be";
if(StringUtils.hasContent(value))
{
String displayValue = value;
try
{
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// field names from this PVS are always table.field - but QValueFormatter doesn't expect that - so strip away table. //
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if(fieldName != null && fieldName.startsWith(tableName + "."))
{
fieldName = fieldName.replace(tableName + ".", "");
}
QRecord record = new QRecord().withValue(fieldName, value);
QValueFormatter.setDisplayValuesInRecordsIncludingPossibleValueTranslations(table, List.of(record));
displayValue = record.getDisplayValue(fieldName);
@@ -241,7 +277,8 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
context.doesRecordNeedUpdated.set(true);
String stepSummary = getStepSummary(context.getWorkflow().getId(), fieldName, context.getWorkflowRevision().getApiName(), context.getWorkflowRevision().getApiVersion(), value, true);
String tableName = context.getWorkflow().getTableName();
String stepSummary = getStepSummary(fieldName, tableName, context.getWorkflowRevision().getApiName(), context.getWorkflowRevision().getApiVersion(), value, true);
return new WorkflowStepOutput(value, stepSummary);
}
@@ -284,12 +321,34 @@ public class UpdateInputRecordFieldStep extends WorkflowStepType implements Work
@Override
public void validate(WorkflowStep step, Map<String, Serializable> inputValues, QRecord workflowRevision, QRecord workflow, List<String> errors) throws QException
{
if(WorkflowStepUtils.useApi(new WorkflowRevision(workflowRevision)))
validate(workflow.getValueString("tableName"), inputValues, workflowRevision, errors);
}
/***************************************************************************
* implementation logic for {@link #validate(WorkflowStep, Map, QRecord, QRecord, List)}.
* makes sure that, if the workflow uses API, that the field is a valid field
* for the api version being used in the workflow revision.
*
* @param tableName table that the field should come from. Many times this
* may be the tableName on the workflow - but it could be
* a hard-coded tableName in other implementations of this
* step type.
* @param inputValues map of values user assigned to the step. expected to
* include String fieldName.
* @param workflowRevision from which api name and version will come
* @param errors Out param - list of error message strings, which will be
* added to if the input fieldName isn't in the table for the
* api version on the workflowRevision
***************************************************************************/
public static void validate(String tableName, Map<String, Serializable> inputValues, QRecord workflowRevision, List<String> errors) throws QException
{
if(workflowRevision != null && WorkflowStepUtils.useApi(new WorkflowRevision(workflowRevision)))
{
String fieldName = ValueUtils.getValueAsString(inputValues.get("fieldName"));
String apiName = ValueUtils.getValueAsString(workflowRevision.getValueString("apiName"));
String apiVersion = ValueUtils.getValueAsString(workflowRevision.getValueString("apiVersion"));
String tableName = ValueUtils.getValueAsString(workflow.getValueString("tableName"));
Optional<QFieldMetaData> optionalApiField = getApiField(fieldName, tableName, new WorkflowRevision(workflowRevision));
if(optionalApiField.isEmpty())
@@ -84,7 +84,7 @@ public class WorkflowLink extends QRecordEntity
@QField(isRequired = true)
private Integer fromStepNo;
@QField(isRequired = true)
@QField()
private Integer toStepNo;
@QField(maxLength = 20, valueTooLongBehavior = ValueTooLongBehavior.ERROR)
@@ -0,0 +1,116 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.processes;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.google.gson.reflect.TypeToken;
import com.kingsrook.qbits.workflows.definition.OutboundLinkMode;
import com.kingsrook.qbits.workflows.definition.OutboundLinkOption;
import com.kingsrook.qbits.workflows.definition.WorkflowStepType;
import com.kingsrook.qbits.workflows.definition.WorkflowsRegistry;
import com.kingsrook.qqq.backend.core.actions.processes.BackendStep;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerInterface;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
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.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.PermissionLevel;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QBackendStepMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFunctionInputMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
import com.kingsrook.qqq.backend.core.utils.ValueUtils;
/*******************************************************************************
* process to get values that the backend must compute about a workflow step,
* based on input values, e.g., as a user is editing the step in a UI.
*
* Originally this was just the step summary (e.g., workflowStepType.getDynamicStepSummary)
*
* Then, when variable outboundLinkModes were added, also responsible for returning
* the link options to use for a step, based on its input values.
*
*******************************************************************************/
public class GetWorkflowStepDynamicValuesProcess implements BackendStep, MetaDataProducerInterface<QProcessMetaData>
{
public static final String NAME = "getWorkflowStepDynamicValues";
/***************************************************************************
**
***************************************************************************/
@Override
public QProcessMetaData produce(QInstance qInstance) throws QException
{
return new QProcessMetaData()
.withName(NAME)
.withPermissionRules(new QPermissionRules().withLevel(PermissionLevel.NOT_PROTECTED))
.withStep(new QBackendStepMetaData()
.withName("execute")
.withCode(new QCodeReference(getClass()))
.withInputData(new QFunctionInputMetaData()
.withField(new QFieldMetaData("workflowId", QFieldType.INTEGER))
.withField(new QFieldMetaData("workflowStepTypeName", QFieldType.STRING))
.withField(new QFieldMetaData("values", QFieldType.INTEGER)) // JSON
));
}
/***************************************************************************
**
***************************************************************************/
@Override
public void run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) throws QException
{
Integer workflowId = runBackendStepInput.getValueInteger("workflowId");
String workflowStepTypeName = runBackendStepInput.getValueString("workflowStepTypeName");
String values = runBackendStepInput.getValueString("values");
Map<String, Serializable> valueAsMap = ValueUtils.getValueAsMap(values);
WorkflowStepType workflowStepType = WorkflowsRegistry.of(QContext.getQInstance()).getWorkflowStepType(workflowStepTypeName);
runBackendStepOutput.addValue("summary", workflowStepType.getDynamicStepSummary(workflowId, valueAsMap));
if(OutboundLinkMode.VARIABLE.equals(workflowStepType.getOutboundLinkMode()))
{
List<OutboundLinkOption> dynamicOutboundLinkOptions = workflowStepType.getDynamicOutboundLinkOptions(workflowId, valueAsMap);
if(dynamicOutboundLinkOptions != null)
{
ArrayList<OutboundLinkOption> outboundLinkOptions = CollectionUtils.useOrWrap(dynamicOutboundLinkOptions, new TypeToken<>() {});
runBackendStepOutput.addValue("outboundLinkOptions", outboundLinkOptions);
}
}
}
}
@@ -48,6 +48,7 @@ import com.kingsrook.qqq.backend.core.utils.ValueUtils;
** process to get a dynamic summary of a workflow step, e.g., as it's being
** edited in a UI.
*******************************************************************************/
@Deprecated(since = "0.115.0 - November 2025 - Replaced by GetWorkflowStepDynamicValuesProcess")
public class GetWorkflowStepSummaryProcess implements BackendStep, MetaDataProducerInterface<QProcessMetaData>
{
public static final String NAME = "getWorkflowStepSummary";
@@ -58,7 +59,6 @@ public class GetWorkflowStepSummaryProcess implements BackendStep, MetaDataProdu
**
***************************************************************************/
@Override
public QProcessMetaData produce(QInstance qInstance) throws QException
{
return new QProcessMetaData()
@@ -41,12 +41,14 @@ import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.helpcontent.HelpContent;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerInterface;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
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.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.frontend.QFrontendFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.help.QHelpContent;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.PermissionLevel;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QBackendStepMetaData;
@@ -116,8 +118,12 @@ public class GetWorkflowTypeDefinitionProcess implements BackendStep, MetaDataPr
throw new QException("Workflow type not found: " + workflowTypeName);
}
////////////////////////////////////////////////////////////////////////////////
// save any help content on current workflow and put back after customization //
////////////////////////////////////////////////////////////////////////////////
Map<String, List<QHelpContent>> helpContent = workflowType.getHelpContent();
workflowType = workflowType.customizeBasedOnWorkflow(workflowRecord);
workflowType.setHelpContent(helpContent);
runBackendStepOutput.addValue("workflowType", workflowType);
////////////////////////////////////////////////////////////////////////////////
@@ -167,4 +173,24 @@ public class GetWorkflowTypeDefinitionProcess implements BackendStep, MetaDataPr
}
}
/***************************************************************************
**
***************************************************************************/
protected Map<String, List<HelpContent>> getWorkflowTypeHelpContent(Map<String, HelpContent> helpContentMap)
{
Map<String, List<HelpContent>> workflowTypeHelpContent = new LinkedHashMap<>();
String[] workflowTypeKeys = new String[] { "workflow:editor;field:workflowName", "workflow:editor;field:versionNo", "workflow:editor;field:apiName", "workflow:editor;field:apiVersion", "workflow:tester;field:workflowTestScenarioId" };
for(String key : workflowTypeKeys)
{
if(helpContentMap.containsKey(key))
{
workflowTypeHelpContent.put(key, List.of(helpContentMap.get(key)));
}
}
return (workflowTypeHelpContent);
}
}
@@ -29,8 +29,10 @@ import java.util.Map;
import java.util.Objects;
import com.fasterxml.jackson.core.type.TypeReference;
import com.kingsrook.qbits.workflows.definition.WorkflowStepType;
import com.kingsrook.qbits.workflows.definition.WorkflowType;
import com.kingsrook.qbits.workflows.definition.WorkflowsRegistry;
import com.kingsrook.qbits.workflows.execution.WorkflowStepValidatorInterface;
import com.kingsrook.qbits.workflows.execution.WorkflowTypeValidatorInterface;
import com.kingsrook.qbits.workflows.model.Workflow;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowRevision;
@@ -140,6 +142,38 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
throw (new QUserFacingException("Workflow not found by id: " + workflowId));
}
String stepsJSON = runBackendStepInput.getValueString("steps");
if(!StringUtils.hasContent(stepsJSON))
{
throw (new QUserFacingException("Workflow steps input was not provided."));
}
List<WorkflowStep> workflowSteps;
try
{
workflowSteps = JsonUtils.toObject(stepsJSON, new TypeReference<>() {});
}
catch(Exception e)
{
throw (new QUserFacingException("Error parsing workflow steps json: " + e.getMessage(), e));
}
String linksJSON = runBackendStepInput.getValueString("links");
if(!StringUtils.hasContent(linksJSON))
{
throw (new QUserFacingException("Workflow links input was not provided."));
}
List<WorkflowLink> workflowLinks;
try
{
workflowLinks = JsonUtils.toObject(linksJSON, new TypeReference<>() {});
}
catch(Exception e)
{
throw (new QUserFacingException("Error parsing workflow links json: " + e.getMessage(), e));
}
////////////////////////////
// look up next versionNo //
////////////////////////////
@@ -166,15 +200,15 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
// insert the workflow revision //
//////////////////////////////////
String commitMessage = runBackendStepInput.getValueString("commitMessage");
String userName = ObjectUtils.tryElse(() -> QContext.getQSession().getUser().getFullName(), "Unknown");
WorkflowRevision workflowRevision = new WorkflowRevision();
workflowRevision.setWorkflowId(workflowId);
workflowRevision.setVersionNo(versionNo);
workflowRevision.setCommitMessage(StringUtils.hasContent(commitMessage) ? commitMessage : "New workflow revision created by " + QContext.getQSession().getUser().getFullName());
workflowRevision.setCommitMessage(StringUtils.hasContent(commitMessage) ? commitMessage : "New workflow revision created by " + userName);
workflowRevision.setApiName(runBackendStepInput.getValueString("apiName"));
workflowRevision.setApiVersion(runBackendStepInput.getValueString("apiVersion"));
workflowRevision.setAuthor(ObjectUtils.tryElse(() -> QContext.getQSession().getUser().getFullName(), "Unknown"));
workflowRevision.setAuthor(userName);
List<WorkflowStep> workflowSteps = JsonUtils.toObject(runBackendStepInput.getValueString("steps"), new TypeReference<>() {});
if(!workflowSteps.isEmpty())
{
workflowRevision.setStartStepNo(workflowSteps.get(0).getStepNo());
@@ -208,19 +242,24 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
//////////////////////////////////////////////////////////////////////////////////////////////
// store steps (first setting revision id, validating, and putting a fresh summary on each) //
//////////////////////////////////////////////////////////////////////////////////////////////
List<String> errors = new ArrayList<>();
List<String> errors = new ArrayList<>();
List<String> errorsForThisStep = new ArrayList<>();
workflowSteps.forEach(step ->
{
try
{
step.setWorkflowRevisionId(insertedRevisionId);
WorkflowStepType workflowStepType = WorkflowsRegistry.of(QContext.getQInstance()).getWorkflowStepType(step.getWorkflowStepTypeName());
Map<String, Serializable> inputValues = ValueUtils.getValueAsMap(step.getInputValuesJson());
WorkflowStepType workflowStepType = WorkflowsRegistry.of(QContext.getQInstance()).getWorkflowStepType(step.getWorkflowStepTypeName());
if(workflowStepType == null)
{
throw (new QUserFacingException("Unknown workflow step type " + step.getWorkflowStepTypeName()));
}
////////////////////////////////////
// summary - if it fails, :shrug: //
////////////////////////////////////
Map<String, Serializable> inputValues = ValueUtils.getValueAsMap(step.getInputValuesJson());
try
{
step.setSummary(workflowStepType.getDynamicStepSummary(workflowId, inputValues));
@@ -237,18 +276,37 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
if(validatorCodeReference != null)
{
WorkflowStepValidatorInterface validator = QCodeLoader.getAdHoc(WorkflowStepValidatorInterface.class, validatorCodeReference);
validator.validate(step, inputValues, workflowRevisionRecord, workflowRecord, errors);
validator.validate(step, inputValues, workflowRevisionRecord, workflowRecord, errorsForThisStep);
if(!errorsForThisStep.isEmpty())
{
///////////////////////////////////////
// put Step # in front of all errors //
///////////////////////////////////////
errors.addAll(errorsForThisStep.stream().map(e -> "Step " + step.getStepNo() + ": " + e).toList());
errorsForThisStep.clear();
}
}
}
catch(Exception e)
{
errors.add("Error processing step [" + step.getSummary() + "]: " + e.getMessage());
errors.add("Error processing Step " + step.getStepNo() + ": " + e.getMessage());
}
});
////////////////////////////////////////////////////////////
// do workflow-level validation as well, if so configured //
////////////////////////////////////////////////////////////
WorkflowType workflowType = WorkflowsRegistry.of(QContext.getQInstance()).getWorkflowType(workflowRecord.getValueString("workflowTypeName"));
if(workflowType.getValidator() != null)
{
WorkflowTypeValidatorInterface validator = QCodeLoader.getAdHoc(WorkflowTypeValidatorInterface.class, workflowType.getValidator());
validator.validate(workflowRecord, workflowRevisionRecord, workflowSteps, workflowLinks, errors);
}
if(!errors.isEmpty())
{
throw (new QUserFacingException("Validation errors in steps: " + StringUtils.joinWithCommasAndAnd(errors)));
String message = errors.size() + " validation error" + StringUtils.plural(errors) + " occurred before the workflow could be saved:\n" + StringUtils.join("\n", errors);
throw (new QUserFacingException(message));
}
new InsertAction().execute(new InsertInput(WorkflowStep.TABLE_NAME).withRecordEntities(workflowSteps).withTransaction(transaction));
@@ -256,7 +314,6 @@ public class StoreNewWorkflowRevisionProcess implements BackendStep, MetaDataPro
/////////////////
// store links //
/////////////////
List<WorkflowLink> workflowLinks = JsonUtils.toObject(runBackendStepInput.getValueString("links"), new TypeReference<>() {});
workflowLinks.forEach(link -> link.setWorkflowRevisionId(insertedRevisionId));
new InsertAction().execute(new InsertInput(WorkflowLink.TABLE_NAME).withRecordEntities(workflowLinks).withTransaction(transaction));
@@ -32,11 +32,13 @@ import com.kingsrook.qbits.workflows.definition.WorkflowType;
import com.kingsrook.qbits.workflows.definition.WorkflowsRegistry;
import com.kingsrook.qbits.workflows.execution.WorkflowExecutionContext;
import com.kingsrook.qbits.workflows.execution.WorkflowInput;
import com.kingsrook.qbits.workflows.execution.WorkflowMultiForkingStepExecutorInterface;
import com.kingsrook.qbits.workflows.execution.WorkflowStepExecutorInterface;
import com.kingsrook.qbits.workflows.execution.WorkflowStepOutput;
import com.kingsrook.qbits.workflows.execution.WorkflowTypeExecutorInterface;
import com.kingsrook.qbits.workflows.execution.WorkflowTypeTesterInterface;
import com.kingsrook.qbits.workflows.model.Workflow;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowRevision;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
import com.kingsrook.qqq.backend.core.context.QContext;
@@ -56,6 +58,8 @@ public class TestWorkflowDefinitions
public static final String BOOLEAN_CONDITIONAL = "booleanConditional";
public static final String CONTAINER = "container";
public static final String SPLIT_BY_LETTERS_IN_NAME = "splitByLettersInName";
/***************************************************************************
@@ -93,6 +97,12 @@ public class TestWorkflowDefinitions
.withOutboundLinkMode(OutboundLinkMode.CONTAINER)
.withLabel("Container")
.withDescription("Group steps in the UI"));
WorkflowsRegistry.of(QContext.getQInstance()).registerWorkflowStepType(new WorkflowStepType()
.withName(SPLIT_BY_LETTERS_IN_NAME)
.withOutboundLinkMode(OutboundLinkMode.VARIABLE)
.withLabel("Split by letters in name")
.withExecutor(new QCodeReference(SplitByLettersInNameExecutor.class)));
}
@@ -225,4 +235,57 @@ public class TestWorkflowDefinitions
}
}
/***************************************************************************
*
***************************************************************************/
public static class SplitByLettersInNameExecutor implements WorkflowMultiForkingStepExecutorInterface
{
/***************************************************************************
*
***************************************************************************/
@Override
public WorkflowStepOutput conditionallyExecuteFork(WorkflowStep step, WorkflowLink fork, Map<String, Serializable> inputValues, WorkflowExecutionContext context)
{
String conditionValue = fork.getConditionValue();
String name = ValueUtils.getValueAsString(context.getValues().get("name"));
if(name.contains(conditionValue))
{
return (new WorkflowStepOutput(true, "name [" + name + "] contains [" + conditionValue + "]"));
}
else
{
return (new WorkflowStepOutput(false, "name [" + name + "] does not contain [" + conditionValue + "]"));
}
}
/***************************************************************************
*
***************************************************************************/
@Override
public WorkflowStepOutput makeWorkflowStepOutput(WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext context) throws QException
{
return new WorkflowStepOutput(1, "Output");
}
/***************************************************************************
*
***************************************************************************/
@Override
public void sortForks(List<WorkflowLink> forkLinks, WorkflowStep step, Map<String, Serializable> inputValues, WorkflowExecutionContext context)
{
/////////////////////
// noop by default //
/////////////////////
}
}
}
@@ -27,7 +27,6 @@ import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import com.kingsrook.qbits.workflows.implementations.recordworkflows.RecordWorkflowsDefinition;
import com.kingsrook.qbits.workflows.model.Workflow;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowRevision;
@@ -149,7 +148,7 @@ public class WorkflowsTestDataSource
public static Workflow insertWorkflowAndInitialRevision(String workflowTypeName, String tableName, String apiName, String apiVersion) throws QException
{
QRecord workflow = new InsertAction().execute(new InsertInput(Workflow.TABLE_NAME).withRecordEntity(new Workflow()
.withWorkflowTypeName(RecordWorkflowsDefinition.WORKFLOW_TYPE)
.withWorkflowTypeName(workflowTypeName)
.withTableName(tableName)
.withName("test-" + UUID.randomUUID())
)).getRecords().get(0);
@@ -0,0 +1,96 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.definition;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.workflows.BaseTest;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
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.help.QHelpContent;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
/*******************************************************************************
** Unit test for WorkflowsRegistry
*******************************************************************************/
class WorkflowsRegistryTest extends BaseTest
{
/*******************************************************************************
**
*******************************************************************************/
@Test
void test() throws QException
{
String stepTypeName = "myStepType";
WorkflowsRegistry workflowsRegistry = new WorkflowsRegistry();
workflowsRegistry.registerWorkflowStepType(new WorkflowStepType()
.withName(stepTypeName)
.withDescription("originalDescription")
.withLabel("originalLabel")
.withInputFields(List.of(new QFieldMetaData("myField", QFieldType.STRING))));
/////////////////////
// set description //
/////////////////////
workflowsRegistry.acceptHelpContent(QContext.getQInstance(), new QHelpContent("newDescription"), Map.of("workflowStepType", stepTypeName, "slot", "description"));
assertEquals("newDescription", workflowsRegistry.getWorkflowStepType(stepTypeName).getDescription());
///////////////////////
// clear description //
///////////////////////
workflowsRegistry.acceptHelpContent(QContext.getQInstance(), null, Map.of("workflowStepType", stepTypeName, "slot", "description"));
assertNull(workflowsRegistry.getWorkflowStepType(stepTypeName).getDescription());
///////////////
// set label //
///////////////
workflowsRegistry.acceptHelpContent(QContext.getQInstance(), new QHelpContent("newLabel"), Map.of("workflowStepType", stepTypeName, "slot", "label"));
assertEquals("newLabel", workflowsRegistry.getWorkflowStepType(stepTypeName).getLabel());
////////////////////////////////////////////////////////
// clear label, though we can't, so it says as it was //
////////////////////////////////////////////////////////
workflowsRegistry.acceptHelpContent(QContext.getQInstance(), null, Map.of("workflowStepType", stepTypeName, "slot", "label"));
assertEquals("newLabel", workflowsRegistry.getWorkflowStepType(stepTypeName).getLabel());
////////////////////
// set field help //
////////////////////
workflowsRegistry.acceptHelpContent(QContext.getQInstance(), new QHelpContent("fieldHelp"), Map.of("workflowStepType", stepTypeName, "field", "myField"));
assertEquals("fieldHelp", workflowsRegistry.getWorkflowStepType(stepTypeName).getInputFields().get(0).getHelpContents().get(0).getContent());
//////////////////////
// clear field help //
//////////////////////
workflowsRegistry.acceptHelpContent(QContext.getQInstance(), null, Map.of("workflowStepType", stepTypeName, "field", "myField"));
assertNull(workflowsRegistry.getWorkflowStepType(stepTypeName).getInputFields().get(0).getHelpContents());
}
}
@@ -0,0 +1,130 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.workflows.BaseTest;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
import com.kingsrook.qqq.backend.core.utils.ListingHash;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
/*******************************************************************************
** Unit test for FindFirstJoinPoint
*******************************************************************************/
class FindFirstJoinPointTest extends BaseTest
{
/*******************************************************************************
* 1
* / | \
* / | \
* 2 3 4
* | | / \
* | 5 6 7
* | | | |
* | | | 8
* | | \ /
* | | 9
* \ | /
* 10
*******************************************************************************/
@Test
void test()
{
Map<Integer, WorkflowStep> nodeMap = makeNodeMap(10);
ListingHash<Integer, WorkflowLink> outEdges = new ListingHash<>();
addEdge(outEdges, 1, 2);
addEdge(outEdges, 1, 3);
addEdge(outEdges, 1, 4);
addEdge(outEdges, 2, 10);
addEdge(outEdges, 3, 5);
addEdge(outEdges, 4, 6);
addEdge(outEdges, 5, 10);
addEdge(outEdges, 6, 9);
addEdge(outEdges, 7, 8);
addEdge(outEdges, 8, 9);
addEdge(outEdges, 9, 10);
/////////////////////////////////
// start from the top (node 1) //
/////////////////////////////////
assertEquals(10, FindFirstJoinPoint.execute(List.of(2, 3, 4), nodeMap, outEdges));
////////////////////////////////////////////
// start from the rightmost fork (node 4) //
////////////////////////////////////////////
assertEquals(9, FindFirstJoinPoint.execute(List.of(6, 7), nodeMap, outEdges));
//////////////////////////////////////////////////////////////////////////////////
// remove node 10 - so they all just end and don't re-join (so expect null out) //
//////////////////////////////////////////////////////////////////////////////////
nodeMap.remove(10);
outEdges.remove(9);
outEdges.remove(2);
outEdges.remove(5);
assertNull(FindFirstJoinPoint.execute(List.of(2, 3, 4), nodeMap, outEdges));
}
/***************************************************************************
*
***************************************************************************/
private void addEdge(ListingHash<Integer, WorkflowLink> outEdges, Integer fromStepNo, Integer toStepNo)
{
outEdges.add(fromStepNo, new WorkflowLink().withToStepNo(toStepNo));
}
/***************************************************************************
*
***************************************************************************/
private Map<Integer, WorkflowStep> makeNodeMap(int n)
{
Map<Integer, WorkflowStep> nodeMap = new HashMap<>();
for(int i = 1; i <= n; i++)
{
addNode(nodeMap, i);
}
return (nodeMap);
}
/***************************************************************************
*
***************************************************************************/
private void addNode(Map<Integer, WorkflowStep> nodeMap, Integer stepNo)
{
nodeMap.put(stepNo, new WorkflowStep().withStepNo(stepNo));
}
}
@@ -29,8 +29,16 @@ import com.kingsrook.qbits.workflows.BaseTest;
import com.kingsrook.qbits.workflows.TestWorkflowDefinitions;
import com.kingsrook.qbits.workflows.WorkflowsTestDataSource;
import com.kingsrook.qbits.workflows.model.Workflow;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qqq.backend.core.actions.tables.DeleteAction;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteInput;
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.utils.ValueUtils;
import com.kingsrook.qqq.backend.core.utils.collections.MapBuilder;
import com.kingsrook.qqq.backend.core.utils.lambdas.UnsafeFunction;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -301,6 +309,183 @@ class WorkflowExecutorTest extends BaseTest
/*******************************************************************************
**
*******************************************************************************/
@Test
void testMultiForkingStep() 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)
));
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(1, run.apply("dave"));
assertEquals(3, run.apply("barry"));
assertEquals(5, run.apply("carl"));
assertEquals(7, run.apply("braces"));
assertEquals(0, run.apply("lou"));
//////////////////////////////////////
// add a step (5) after the 3 forks //
//////////////////////////////////////
WorkflowsTestDataSource.insertSteps(workflow, List.of(
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 8))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(2, 5),
WorkflowsTestDataSource.newLink(3, 5),
WorkflowsTestDataSource.newLink(4, 5)
));
//////////////////////////////////
// get rid of the links to null //
//////////////////////////////////
new DeleteAction().execute(new DeleteInput(WorkflowLink.TABLE_NAME).withQueryFilter(new QQueryFilter(new QFilterCriteria("toStepNo", QCriteriaOperator.IS_BLANK))));
assertEquals(10, run.apply("bobby"));
assertEquals(15, run.apply("braces"));
assertEquals(8, run.apply("lou"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testNestedMultiForkingStep() throws Exception
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
/////////////////////////////////////////////////////////////////////////////
// build a workflow with 3 top-level forks, one of which has 2 nested ones //
// . 1 //
// ./ | \ //
// 2 3 4 //
// | | | \ //
// | | 5 6 //
// .\ \ / / //
// . 7 //
/////////////////////////////////////////////////////////////////////////////
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.SPLIT_BY_LETTERS_IN_NAME, Map.of()),
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4)), // "c"
WorkflowsTestDataSource.newStep(6, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 8)), // "d"
WorkflowsTestDataSource.newStep(7, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 16))
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "a"), // += 1
WorkflowsTestDataSource.newLink(1, 3, "b"), // += 2
WorkflowsTestDataSource.newLink(1, 4, ""), //
WorkflowsTestDataSource.newLink(4, 5, "c"), // += 4
WorkflowsTestDataSource.newLink(4, 6, "d"), // += 8
WorkflowsTestDataSource.newLink(2, 7), // += 16
WorkflowsTestDataSource.newLink(3, 7), // += 16
WorkflowsTestDataSource.newLink(5, 7), // += 16
WorkflowsTestDataSource.newLink(6, 7) // += 16
));
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(17, run.apply("allen"));
assertEquals(19, run.apply("barry"));
assertEquals(21, run.apply("carl"));
assertEquals(24, run.apply("donny"));
assertEquals(16, run.apply("lou"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testStackedMultiForkingStep() throws Exception
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
/////////////////////////////////////////////
// build a workflow with two 2-level forks //
// . 1 //
// ./ \ //
// 2 3 //
// .\ / //
// . 4 //
// ./ \ //
// 5 6 //
/////////////////////////////////////////////
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.SPLIT_BY_LETTERS_IN_NAME, Map.of()),
WorkflowsTestDataSource.newStep(5, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 4)), // "c"
WorkflowsTestDataSource.newStep(6, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("x", 8)) // "d"
));
WorkflowsTestDataSource.insertLinks(workflow, List.of(
WorkflowsTestDataSource.newLink(1, 2, "a"), // += 1
WorkflowsTestDataSource.newLink(1, 3, "b"), // += 2
WorkflowsTestDataSource.newLink(2, 4),
WorkflowsTestDataSource.newLink(3, 4),
WorkflowsTestDataSource.newLink(4, 5, "c"), // += 4
WorkflowsTestDataSource.newLink(4, 6, "d"), // += 8
WorkflowsTestDataSource.newLink(5, null),
WorkflowsTestDataSource.newLink(6, null)
));
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(1, run.apply("allen"));
assertEquals(3, run.apply("barry"));
assertEquals(5, run.apply("carl"));
assertEquals(8, run.apply("donny"));
assertEquals(4, run.apply("connie"));
assertEquals(12, run.apply("doc"));
assertEquals(15, run.apply("abcd"));
assertEquals(0, run.apply("lou"));
}
/***************************************************************************
**
***************************************************************************/
@@ -0,0 +1,172 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.execution.nodes;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qbits.workflows.BaseTest;
import com.kingsrook.qbits.workflows.TestWorkflowDefinitions;
import com.kingsrook.qbits.workflows.WorkflowsTestDataSource;
import com.kingsrook.qbits.workflows.model.WorkflowLink;
import com.kingsrook.qbits.workflows.model.WorkflowStep;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertSame;
/*******************************************************************************
** Unit test for StepNodeGraphBuilder
*******************************************************************************/
class StepNodeGraphBuilderTest extends BaseTest
{
/*******************************************************************************
**
*******************************************************************************/
@BeforeEach
void beforeEach() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testSimpleFlat()
{
List<WorkflowStep> steps = new ArrayList<>();
WorkflowStep step1 = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, null);
WorkflowStep step2 = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, null);
WorkflowStep step3 = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, null);
List<WorkflowLink> links = new ArrayList<>();
links.add(WorkflowsTestDataSource.newLink(step1.getStepNo(), step2.getStepNo()));
links.add(WorkflowsTestDataSource.newLink(step2.getStepNo(), step3.getStepNo()));
NodeSequence nodeSequence = new StepNodeGraphBuilder().buildNodeSequence(step1.getStepNo(), steps, links);
assertSame(step1, nodeSequence.get(0).step());
assertSame(step2, nodeSequence.get(1).step());
assertSame(step3, nodeSequence.get(2).step());
}
/*******************************************************************************
* we'll evolve this graph through these 4 versions:
*
* . add1 > add1 > add1 . > (wrap it all in a container)
* . | > | > |
* .branch > branch > branch
* ./ > / \ > / \
* add2 > add2 add3 > add2 add3
* . \ /
* . add4
*******************************************************************************/
@Test
void testSimpleBranch()
{
List<WorkflowStep> steps = new ArrayList<>();
List<WorkflowLink> links = new ArrayList<>();
WorkflowStep add1 = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, null);
WorkflowStep branch = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.BOOLEAN_CONDITIONAL, null);
WorkflowStep add2 = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, null);
links.add(WorkflowsTestDataSource.newLink(add1.getStepNo(), branch.getStepNo()));
links.add(WorkflowsTestDataSource.newLink(branch.getStepNo(), add2.getStepNo(), "true"));
{
NodeSequence nodeSequence = StepNodeGraphBuilder.buildNodeSequence(add1.getStepNo(), steps, links);
assertEquals(2, nodeSequence.size());
assertSame(add1, nodeSequence.get(0).step());
assertSame(branch, nodeSequence.get(1).step());
StepNode branchNode = nodeSequence.get(1);
assertEquals(1, branchNode.subSequences().size());
assertEquals(1, branchNode.subSequences().get("true").size());
assertSame(add2, branchNode.subSequences().get("true").get(0).step());
}
////////////////////////////////////
// add a step in the false branch //
////////////////////////////////////
WorkflowStep add3 = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, null);
links.add(WorkflowsTestDataSource.newLink(branch.getStepNo(), add3.getStepNo(), "false"));
{
NodeSequence nodeSequence = StepNodeGraphBuilder.buildNodeSequence(add1.getStepNo(), steps, links);
assertEquals(2, nodeSequence.size());
assertSame(add1, nodeSequence.get(0).step());
assertSame(branch, nodeSequence.get(1).step());
StepNode branchNode = nodeSequence.get(1);
assertEquals(2, branchNode.subSequences().size());
assertEquals(1, branchNode.subSequences().get("true").size());
assertSame(add2, branchNode.subSequences().get("true").get(0).step());
assertEquals(1, branchNode.subSequences().get("false").size());
assertSame(add3, branchNode.subSequences().get("false").get(0).step());
}
/////////////////////////////////////////////////
// add a step after the branch now, and re-run //
/////////////////////////////////////////////////
WorkflowStep add4 = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, null);
links.add(WorkflowsTestDataSource.newLink(add2.getStepNo(), add4.getStepNo()));
links.add(WorkflowsTestDataSource.newLink(add3.getStepNo(), add4.getStepNo()));
{
NodeSequence nodeSequence = StepNodeGraphBuilder.buildNodeSequence(add1.getStepNo(), steps, links);
assertEquals(3, nodeSequence.size());
assertSame(add1, nodeSequence.get(0).step());
assertSame(branch, nodeSequence.get(1).step());
assertSame(add4, nodeSequence.get(2).step());
}
///////////////////////////////////
// now put it all in a container //
///////////////////////////////////
WorkflowStep container = WorkflowsTestDataSource.newStep(steps, TestWorkflowDefinitions.CONTAINER, null);
links.add(WorkflowsTestDataSource.newLink(container.getStepNo(), add1.getStepNo(), "push"));
{
NodeSequence nodeSequence = StepNodeGraphBuilder.buildNodeSequence(container.getStepNo(), steps, links);
assertEquals(1, nodeSequence.size());
assertSame(container, nodeSequence.get(0).step());
StepNode containerNode = nodeSequence.get(0);
assertEquals(1, containerNode.subSequences().size());
NodeSequence containedSequence = containerNode.subSequences().get("push");
assertEquals(3, containedSequence.size());
assertSame(add1, containedSequence.get(0).step());
assertSame(branch, containedSequence.get(1).step());
assertSame(add4, containedSequence.get(2).step());
}
}
}
@@ -0,0 +1,124 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.implementations.recordworkflows;
import java.io.Serializable;
import java.util.Map;
import java.util.Set;
import com.kingsrook.qbits.workflows.BaseTest;
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.frontend.QFrontendFieldMetaData;
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
import com.kingsrook.qqq.frontend.materialdashboard.actions.formadjuster.FormAdjusterInput;
import com.kingsrook.qqq.frontend.materialdashboard.actions.formadjuster.FormAdjusterOutput;
import com.kingsrook.qqq.frontend.materialdashboard.actions.formadjuster.RunFormAdjusterProcess;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
/*******************************************************************************
** Unit test for UpdateInputRecordFieldMetaDataAdjuster
*******************************************************************************/
class UpdateInputRecordFieldMetaDataAdjusterTest extends BaseTest
{
/*******************************************************************************
**
*******************************************************************************/
@Test
void testExecute() throws QException
{
Map<String, Serializable> allValues = Map.of(
"workflowValuesJSON", JsonUtils.toJson(Map.of("tableName", TABLE_NAME_PERSON)),
"workflowRevisionValuesJSON", JsonUtils.toJson(Map.of()),
"value", 1
);
///////////////////////
// run for on-change //
///////////////////////
FormAdjusterOutput onChangeOutput = new UpdateInputRecordFieldMetaDataAdjuster().execute(new FormAdjusterInput()
.withFieldName("fieldName")
.withNewValue(TABLE_NAME_PERSON + ".firstName")
.withAllValues(allValues)
.withEvent(RunFormAdjusterProcess.EVENT_ON_CHANGE));
assertEquals(Set.of("value"), onChangeOutput.getFieldsToClear());
assertEquals(1, onChangeOutput.getUpdatedFieldMetaData().size());
assertThat(onChangeOutput.getUpdatedFieldDisplayValues()).isNullOrEmpty();
QFrontendFieldMetaData updatedValueField = onChangeOutput.getUpdatedFieldMetaData().get("value");
assertEquals("Value (First Name)", updatedValueField.getLabel());
/////////////////////
// run for on-load //
/////////////////////
new InsertAction().execute(new InsertInput(TABLE_NAME_SHAPE).withRecord(new QRecord().withValue("id", 1).withValue("name", "Square")));
FormAdjusterOutput onLoadOutput = new UpdateInputRecordFieldMetaDataAdjuster().execute(new FormAdjusterInput()
.withFieldName("fieldName")
.withNewValue(TABLE_NAME_PERSON + ".favoriteShapeId")
.withAllValues(allValues)
.withEvent(RunFormAdjusterProcess.EVENT_ON_LOAD));
assertThat(onLoadOutput.getFieldsToClear()).isNullOrEmpty();
assertEquals(Map.of("value", "Square"), onLoadOutput.getUpdatedFieldDisplayValues());
updatedValueField = onLoadOutput.getUpdatedFieldMetaData().get("value");
assertEquals("Value (Favorite Shape)", updatedValueField.getLabel());
assertEquals(TABLE_NAME_SHAPE, updatedValueField.getPossibleValueSourceName());
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testAdjustPossibleValueSourceFilterCriteriaInputs()
{
QFieldMetaData field = new QFieldMetaData();
UpdateInputRecordFieldMetaDataAdjuster.adjustPossibleValueSourceFilterCriteriaInputs(field.getPossibleValueSourceFilter());
assertNull(field.getPossibleValueSourceFilter());
field.setPossibleValueSourceFilter(new QQueryFilter(new QFilterCriteria("id", QCriteriaOperator.EQUALS, 1)));
UpdateInputRecordFieldMetaDataAdjuster.adjustPossibleValueSourceFilterCriteriaInputs(field.getPossibleValueSourceFilter());
assertEquals(1, field.getPossibleValueSourceFilter().getCriteria().get(0).getValues().get(0));
field.setPossibleValueSourceFilter(new QQueryFilter(new QFilterCriteria("someId", QCriteriaOperator.EQUALS, "${input.someId}")));
UpdateInputRecordFieldMetaDataAdjuster.adjustPossibleValueSourceFilterCriteriaInputs(field.getPossibleValueSourceFilter());
assertEquals("${input.someId}??${input.workflow.someId}", field.getPossibleValueSourceFilter().getCriteria().get(0).getValues().get(0));
field.setPossibleValueSourceFilter(new QQueryFilter().withSubFilter(new QQueryFilter(new QFilterCriteria("someId", QCriteriaOperator.EQUALS, "${input.someId}"))));
UpdateInputRecordFieldMetaDataAdjuster.adjustPossibleValueSourceFilterCriteriaInputs(field.getPossibleValueSourceFilter());
assertEquals("${input.someId}??${input.workflow.someId}", field.getPossibleValueSourceFilter().getSubFilters().get(0).getCriteria().get(0).getValues().get(0));
}
}
@@ -0,0 +1,161 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.implementations.recordworkflows;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.workflows.BaseTest;
import com.kingsrook.qbits.workflows.model.WorkflowRevision;
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Unit test for UpdateInputRecordFieldStep
*******************************************************************************/
class UpdateInputRecordFieldStepTest extends BaseTest
{
private static WorkflowRevision workflowRevisionV1 = new WorkflowRevision().withApiName(API_NAME).withApiVersion(V1);
private static WorkflowRevision workflowRevisionV2 = new WorkflowRevision().withApiName(API_NAME).withApiVersion(V2);
private static WorkflowRevision workflowRevisionV3 = new WorkflowRevision().withApiName(API_NAME).withApiVersion(V3);
private static WorkflowRevision workflowRevisionWithoutApi = new WorkflowRevision();
/*******************************************************************************
**
*******************************************************************************/
@Test
void testGetApiField() throws QException
{
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".firstName", TABLE_NAME_PERSON, workflowRevisionV1))
.isPresent().get().hasFieldOrPropertyWithValue("name", "firstName");
assertThat(UpdateInputRecordFieldStep.getApiField("firstName", TABLE_NAME_PERSON, workflowRevisionV1))
.isPresent().get().hasFieldOrPropertyWithValue("name", "firstName");
assertThat(UpdateInputRecordFieldStep.getApiField("noSuchField", TABLE_NAME_PERSON, workflowRevisionV1))
.isEmpty();
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".noSuchField", TABLE_NAME_PERSON, workflowRevisionV1))
.isEmpty();
/////////////////////////////////////
// this field is excluded from api //
/////////////////////////////////////
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".debt", TABLE_NAME_PERSON, workflowRevisionV1))
.isEmpty();
///////////////////////////////
// this field is added in V3 //
///////////////////////////////
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".salary", TABLE_NAME_PERSON, workflowRevisionV1))
.isEmpty();
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".salary", TABLE_NAME_PERSON, workflowRevisionV3))
.isPresent().get().hasFieldOrPropertyWithValue("name", "salary");
//////////////////////////////////////////
// confirm shoeCount/noOfShoes renaming //
//////////////////////////////////////////
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".shoeCount", TABLE_NAME_PERSON, workflowRevisionV1))
.isPresent().get().hasFieldOrPropertyWithValue("name", "shoeCount");
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".shoeCount", TABLE_NAME_PERSON, workflowRevisionV2))
.isEmpty();
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".noOfShoes", TABLE_NAME_PERSON, workflowRevisionV1))
.isEmpty();
assertThat(UpdateInputRecordFieldStep.getApiField(TABLE_NAME_PERSON + ".noOfShoes", TABLE_NAME_PERSON, workflowRevisionV2))
.isPresent().get().hasFieldOrPropertyWithValue("name", "noOfShoes");
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testGetStepSummary() throws QException
{
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName", "value", "John"), TABLE_NAME_PERSON, false))
.isEqualTo("First Name will be set to 'John'");
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName", "value", "John"), TABLE_NAME_PERSON, true))
.isEqualTo("First Name was set to 'John'");
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName", "value", ""), TABLE_NAME_PERSON, false))
.isEqualTo("First Name will be cleared out");
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName"), TABLE_NAME_PERSON, true))
.isEqualTo("First Name was cleared out");
new InsertAction().execute(new InsertInput(TABLE_NAME_SHAPE).withRecord(new QRecord().withValue("id", 1).withValue("name", "Square")));
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".favoriteShapeId", "value", "1"), TABLE_NAME_PERSON, false))
.isEqualTo("Favorite Shape will be set to 'Square'");
assertThat(UpdateInputRecordFieldStep.getStepSummary(Map.of("fieldName", TABLE_NAME_PERSON + ".favoriteShapeId", "value", "1"), TABLE_NAME_PERSON, true))
.isEqualTo("Favorite Shape was set to 'Square'");
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void testValidate() throws QException
{
assertThat(runValidate(Map.of("fieldName", TABLE_NAME_PERSON + ".firstName"), workflowRevisionV1)).isEmpty();
////////////////////////////////////////////////////////////////////////////////////
// debt field - found if not using api, else not found as it is excluded from api //
////////////////////////////////////////////////////////////////////////////////////
assertThat(runValidate(Map.of("fieldName", TABLE_NAME_PERSON + ".debt"), workflowRevisionWithoutApi)).isEmpty();
assertThat(runValidate(Map.of("fieldName", TABLE_NAME_PERSON + ".debt"), workflowRevisionV1)).hasSize(1)
.element(0).asString()
.contains("Could not find field 'person.debt' in table '" + TABLE_NAME_PERSON + "' for API '" + API_NAME + "' version 'v1'");
}
/***************************************************************************
*
***************************************************************************/
private List<String> runValidate(Map<String, Serializable> inputValues, WorkflowRevision workflowRevision) throws QException
{
List<String> errors = new ArrayList<>();
UpdateInputRecordFieldStep.validate(TABLE_NAME_PERSON, inputValues, workflowRevision == null ? null : workflowRevision.toQRecord(), errors);
return (errors);
}
}
@@ -0,0 +1,102 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.qbits.workflows.processes;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.workflows.BaseTest;
import com.kingsrook.qbits.workflows.TestWorkflowDefinitions;
import com.kingsrook.qbits.workflows.WorkflowsTestDataSource;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
/*******************************************************************************
** Unit test for StoreNewWorkflowRevisionProcess
*******************************************************************************/
class StoreNewWorkflowRevisionProcessTest extends BaseTest
{
/*******************************************************************************
**
*******************************************************************************/
@Test
void test() throws QException
{
TestWorkflowDefinitions.registerTestWorkflowTypes();
Integer workflowId = WorkflowsTestDataSource.insertTestWorkflow();
RunBackendStepInput input = new RunBackendStepInput();
RunBackendStepOutput output = new RunBackendStepOutput();
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
.hasMessageContaining("Workflow id is required");
input.addValue("workflowId", -999);
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
.hasMessageContaining("Workflow not found by id: -999");
input.addValue("workflowId", workflowId);
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
.hasMessageContaining("steps input was not provided");
input.addValue("steps", "1, 2, 3");
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
.hasMessageContaining("Error parsing workflow steps");
input.addValue("steps", JsonUtils.toJson(List.of(
WorkflowsTestDataSource.newStep(1, "myStepType", Map.of("foo", 1)),
WorkflowsTestDataSource.newStep(2, "yourStepType", Map.of("bar", true, "baz", false))
)));
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
.hasMessageContaining("links input was not provided");
input.addValue("links", "not json");
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
.hasMessageContaining("Error parsing workflow links");
input.addValue("links", JsonUtils.toJson(List.of(WorkflowsTestDataSource.newLink(1, 2))));
assertThatThrownBy(() -> new StoreNewWorkflowRevisionProcess().run(input, output))
.hasMessageContaining("2 validation errors occurred before the workflow could be saved:")
.hasMessageContaining("Error processing Step 1: Unknown workflow step type myStepType")
.hasMessageContaining("Error processing Step 2: Unknown workflow step type yourStepType");
input.addValue("steps", JsonUtils.toJson(List.of(
WorkflowsTestDataSource.newStep(1, TestWorkflowDefinitions.ADD_X_TO_SUM_ACTION, Map.of("foo", 1)),
WorkflowsTestDataSource.newStep(2, TestWorkflowDefinitions.BOOLEAN_CONDITIONAL, Map.of("bar", true, "baz", false))
)));
new StoreNewWorkflowRevisionProcess().run(input, output);
assertNotNull(output.getValue("workflowRevisionId"));
assertEquals(2, output.getValue("versionNo"));
new StoreNewWorkflowRevisionProcess().run(input, output);
assertEquals(3, output.getValue("versionNo"));
}
}