Skip to content

fix(FOUR-32802): prevent Available Columns timeout under Octane #9009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gproly wants to merge 2 commits into
base: develop
Choose a base branch
from
+148 −5
Open

fix(FOUR-32802): prevent Available Columns timeout under Octane #9009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c27041
fix(FOUR-32802): prevent Available Columns timeout under Octane
gproly Aug 25, 2026
97b6bbc
test(FOUR-32802): add regression tests for Available Columns API
gproly Aug 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions ProcessMaker/Http/Controllers/Api/V1_1/ProcessVariableController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,9 @@ public function getProcessesVariables(array $processIds, $excludeSavedSearch, $p
// and applies filtering for excluded fields.
$query = DB::table('asset_variables as av')
->join('var_finder_variables as vfv', 'av.id', '=', 'vfv.asset_variable_id')
->whereIn('av.process_id', $processIds)
->when($processIds !== [], function ($query) use ($processIds) {
$query->whereIn('av.process_id', $processIds);
})
->groupBy('vfv.field', 'vfv.label')
->select([
DB::raw('MAX(vfv.id) as id'),
Expand All @@ -256,7 +258,7 @@ public function getProcessesVariables(array $processIds, $excludeSavedSearch, $p
return $this->mergeOnlyAvailableColumns($paginator, $savedSearch, $activeColumns);
}

return $query->paginate($perPage, ['*'], 'page', $page);
return $paginator;
}

/**
Expand Down Expand Up @@ -288,9 +290,23 @@ private function mergeAvailableColumns(?SavedSearch $savedSearch = null)
$availableColumns = collect();

if ($savedSearch?->available_columns) {
$availableColumns = $savedSearch->available_columns->merge(
$savedSearch->getDataColumnsAttribute() ?? collect()
);
$availableColumns = $savedSearch->available_columns;

if (
$savedSearch->type === SavedSearch::TYPE_COLLECTION
|| !class_exists(ProcessVariable::class)
|| !Schema::hasTable('process_variables')
|| !self::$useVarFinder
) {
$availableColumns = $availableColumns->merge(
$savedSearch->getDataColumnsAttribute() ?? collect()
);
} else {
$availableColumns = $availableColumns
->merge($savedSearch->process_columns)
->unique('field')
->values();
}
}

return $availableColumns;
Expand Down
127 changes: 127 additions & 0 deletions tests/Feature/Api/V1_1/ProcessVariableControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,4 +544,131 @@ public function test_saved_search_with_no_available_columns(): void
$this->assertFalse($filteredFields->contains('initiated_at'));
$this->assertFalse($filteredFields->contains('completed_at'));
}

public function test_only_available_with_empty_process_ids_returns_defaults_and_variables(): void
{
$this->setupCreateUser();

if (!$this->isVariablesFinderEnabled) {
$this->markTestSkipped('VariableFinder is required for this test.');
}

$savedSearch = SavedSearch::factory()->create([
'type' => 'request',
'meta' => [
'icon' => 'bath',
'file' => null,
'collection_id' => null,
'columns' => [],
],
'pmql' => '',
]);

$response = $this->apiCall(
'GET',
'/api/1.1/processes/variables?processIds=&savedSearchId=' . $savedSearch->id . '&onlyAvailable='
);

$response->assertStatus(200);

$fields = collect($response->json('data'))->pluck('field');

$this->assertTrue($fields->contains('case_number'));
$this->assertTrue($fields->contains('name'));
$this->assertGreaterThan(10, $fields->count());
}

public function test_only_available_first_page_includes_defaults_and_paginated_variables(): void
{
$this->setupCreateUser();

if (!$this->isVariablesFinderEnabled) {
$this->markTestSkipped('VariableFinder is required for this test.');
}

$savedSearch = SavedSearch::factory()->create([
'type' => 'request',
'meta' => [
'icon' => 'bath',
'file' => null,
'collection_id' => null,
'columns' => [],
],
'pmql' => '',
]);

$response = $this->apiCall(
'GET',
'/api/1.1/processes/variables?processIds=1&savedSearchId=' . $savedSearch->id . '&onlyAvailable=&page=1&per_page=5'
);

$response->assertStatus(200);

$fields = collect($response->json('data'))->pluck('field');

$this->assertTrue($fields->contains('case_number'));
$this->assertGreaterThan(5, $fields->count());
}

public function test_second_page_without_only_available_omits_saved_search_defaults(): void
{
$this->setupCreateUser();

if (!$this->isVariablesFinderEnabled) {
$this->markTestSkipped('VariableFinder is required for this test.');
}

$savedSearch = SavedSearch::factory()->create([
'type' => 'request',
'meta' => [
'icon' => 'bath',
'file' => null,
'collection_id' => null,
'columns' => [],
],
'pmql' => '',
]);

$response = $this->apiCall(
'GET',
'/api/1.1/processes/variables?processIds=1&savedSearchId=' . $savedSearch->id . '&page=2&per_page=5'
);

$response->assertStatus(200);

$fields = collect($response->json('data'))->pluck('field');

$this->assertFalse($fields->contains('case_number'));
$this->assertFalse($fields->contains('case_title'));
$this->assertGreaterThan(0, $fields->count());
}

public function test_empty_process_ids_returns_variable_finder_rows(): void
{
$this->setupCreateUser();

if (!$this->isVariablesFinderEnabled) {
$this->markTestSkipped('VariableFinder is required for this test.');
}

$response = $this->apiCall('GET', '/api/1.1/processes/variables?processIds=&page=1&per_page=100');

$response->assertStatus(200);
$this->assertEquals(30, $response->json('meta.total'));
}

public function test_non_only_available_request_returns_single_paginated_page(): void
{
$this->setupCreateUser();

if (!$this->isVariablesFinderEnabled) {
$this->markTestSkipped('VariableFinder is required for this test.');
}

$response = $this->apiCall('GET', '/api/1.1/processes/variables?processIds=1&page=1&per_page=5');

$response->assertStatus(200);
$this->assertCount(5, $response->json('data'));
$this->assertEquals(10, $response->json('meta.total'));
}
}
Loading