FOUR-16161: Add support for raw query conditions to advanced filters

[runyan-co]

Issue

Advanced Filters need to be able to support raw() filtering query conditions to allow for more granular filtering, e.g. raw(NOW() + 1 INTERVAL DAY) which can be used to query tasks which will expire in the next 24 hours (but is not limited to just that, of course).

Reproduction Steps

1. Have 250+ tasks with case numbers
2. Navigate to the /tasks page
3. Create an Advanced Filter to the "Case Number" column by adding a simple operator (one of the comparison operators or the between operator) and then set the value to be a SQL query wrapped with raw(), for example: raw(1 + 10). This is the one I used since SQL can do basic arithmetic and is useful to test against the integer value of the "Case Number" column.
4. Verify the correct number of results based on your query/filters.

Testing in Tinker

You can also test more granularly by opening tinker (php artisan tinker) and creating a new ProcessMaker\Filters\Filter instance.

Here is some example code you can use, but you can do much more than this if you'd like:

// Authenticate the super administrator so the permissions/gates work properly
Auth::login(User::find(1));

// Create a JSON-valid string representing the advanced filter
// This one looks for tasks coming due in less than 30 days
$advancedFilter = '[{"subject":{"type":"Status"},"operator":"=","value":"In Progress"},{"subject":{"type":"Field","value":"due_at"},"operator":"<","value":"raw(NOW() + INTERVAL 30 DAY)"}]'

// Create a new query builder instance (similar to the one in the API TaskController)
$query = \ProcessMaker\Models\ProcessRequestToken::with(['processRequest', 'user', 'draft']);

// Create the filter (this returns null because it directly updates the $query instance)
$filter = \ProcessMaker\Filters\Filter::filter($query, $advancedFilter);

// Check the result count and verify it's correct for the conditions set
$query->count();

// You can also review the entire query's parsed SQL this way as well:
$query->toRawSql();

// If you want the actual results, you can retrieve them this way
$query->get();

Solution

• Create a new ProcessMaker\Traits\InteractsWithRawFilter trait to contain the logic/query updates
• Updated the ProcessMaker\Filters\Filter to check for and appropriately implement any raw() filter values found

How to Test

All of the reproduction steps (for the UI and for tinker) would be best.

CICD

ci:next

Related Tickets & Packages

• FOUR-16161
• FOUR-13464

Code Review Checklist

• I have pulled this code locally and tested it on my instance, along with any associated packages.
• This code adheres to ProcessMaker Coding Guidelines.
• This code includes a unit test or an E2E test that tests its functionality, or is covered by an existing test.
• This solution fixes the bug reported in the original ticket.
• This solution does not alter the expected output of a component in a way that would break existing Processes.
• This solution does not implement any breaking changes that would invalidate documentation or cause existing Processes to fail.
• This solution has been tested with enterprise packages that rely on its functionality and does not introduce bugs in those packages.
• This code does not duplicate functionality that already exists in the framework or in ProcessMaker.
• This ticket conforms to the PRD associated with this part of ProcessMaker.

[runyan-co]

Other todo: resolve failing unit tests

[processmaker-sonarqube]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
97.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube