Skip to content

observation/FOUR-26342 DevLink updates environment variables V2 #8521

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
gustavobascope wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

observation/FOUR-26342 DevLink updates environment variables V2 #8521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
58e9f8b
Added a method to replace copied variables with new ones in the script
gustavobascope Sep 15, 2025
7498504
Merge branch 'observation/FOUR-26310' of github.com:ProcessMaker/proc…
gustavobascope Sep 15, 2025
f8e108b
fix php-unit tests
gustavobascope Sep 16, 2025
964f7ed
Merge branch 'develop' of github.com:ProcessMaker/processmaker into o…
gustavobascope Sep 18, 2025
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
4 changes: 3 additions & 1 deletion ProcessMaker/Http/Controllers/Api/DevLinkController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,12 +355,14 @@ public function removeSharedAsset($id)

public function installRemoteAsset(Request $request, DevLink $devLink)
{
$updateType = $request->input('updateType', DevLinkInstall::MODE_UPDATE);

DevLinkInstall::dispatch(
$request->user()->id,
$devLink->id,
$request->input('class'),
$request->input('id'),
DevLinkInstall::MODE_UPDATE,
$updateType,
DevLinkInstall::TYPE_IMPORT_ASSET
);

Expand Down
187 changes: 183 additions & 4 deletions ProcessMaker/ImportExport/Exporters/ScriptExporter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

namespace ProcessMaker\ImportExport\Exporters;

use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\ImportExport\DependentType;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\ScriptCategory;
Expand Down Expand Up @@ -46,16 +48,19 @@ public function import() : bool
$this->model->script_executor_id = $executor->id;
}

// Update environment variable references in script code
$this->updateEnvironmentVariableReferences();

// Pre-save cleanup for data source scripts to prevent constraint violations
if ($this->mode === 'update' && $this->model->exists) {
// Check if this script has any data source relationships that might cause conflicts
$hasDataSourceRelationships = \DB::table('data_source_scripts')
$hasDataSourceRelationships = DB::table('data_source_scripts')
->where('script_id', $this->model->id)
->exists();

if ($hasDataSourceRelationships) {
// Clean up any conflicting records in data_source_scripts
\DB::table('data_source_scripts')
DB::table('data_source_scripts')
->where('script_id', $this->model->id)
->where('id', '!=', $this->model->id)
->delete();
Expand All @@ -72,11 +77,185 @@ private function getEnvironmentVariables() : array

// Search for environment variable present in the code
foreach ($environmentVariables as $variable) {
if (preg_match('/[^a-zA-Z0-9\s]' . $variable->name . '[^a-zA-Z0-9\s]?/', $this->model->code)) {
$environmentVariablesFound[] = $variable;
// Multiple patterns to catch different usage styles
$patterns = [
// JavaScript patterns
'/\bprocess\.env\.' . preg_quote($variable->name, '/') . '\b/', // process.env.VAR
'/\bprocess\.env\[\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\]/', // process.env['VAR']

// PHP patterns
'/\bconfig\s*\(\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\)/', // config('VAR')
'/\benv\s*\(\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\)/', // env('VAR')
'/\$_ENV\s*\[\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\]/', // $_ENV['VAR']
'/\$_SERVER\s*\[\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\]/', // $_SERVER['VAR']

// Java patterns
'/\bSystem\.getenv\s*\(\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\)/', // System.getenv("VAR")
'/\bSystem\.getProperty\s*\(\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\)/', // System.getProperty("VAR")

// C# patterns
'/\bEnvironment\.GetEnvironmentVariable\s*\(\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\)/', // Environment.GetEnvironmentVariable("VAR")
'/\bConfigurationManager\.AppSettings\s*\[\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\]/', // ConfigurationManager.AppSettings["VAR"]

// Python patterns
'/\bos\.environ\s*\[\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\]/', // os.environ['VAR']
'/\bos\.environ\.get\s*\(\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\)/', // os.environ.get('VAR')
'/\bos\.getenv\s*\(\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\)/', // os.getenv('VAR')

// Additional PHP patterns
'/\bgetenv\s*\(\s*[\'"]' . preg_quote($variable->name, '/') . '[\'"]\s*\)/', // getenv('VAR')
];

foreach ($patterns as $pattern) {
if (preg_match($pattern, $this->model->code)) {
$environmentVariablesFound[] = $variable;
break;
}
}
}

return $environmentVariablesFound;
}

/**
* Update environment variable references in script code when variables are renamed during import
*
* Note: This is a basic implementation. For a complete solution, you would need to:
* 1. Track original variable names during export phase
* 2. Map original names to new names after duplicate handling
* 3. Update all references in the script code
*/
private function updateEnvironmentVariableReferences(): void
{
// Only process in copy mode where variables might be renamed
if ($this->mode !== 'copy') {
return;
}

// Get the original variables that were detected during export
$originalVariables = $this->getEnvironmentVariables();
$variableMapping = [];

// Compare with the imported variables to detect name changes
foreach ($this->getDependents(DependentType::ENVIRONMENT_VARIABLES, true) as $dependent) {
$importedVar = $dependent->model;

// Find matching original variable by comparing the base name
foreach ($originalVariables as $originalVar) {
$mapped = false;

// Check if this is a renamed version (has suffix like _1, _2, etc.)
if (preg_match('/^' . preg_quote($originalVar->name) . '_\d+$/', $importedVar->name)) {
$variableMapping[$originalVar->name] = $importedVar->name;
$mapped = true;
}
// Check if it's exactly the same name (no rename needed)
elseif ($originalVar->name === $importedVar->name) {
// Don't add to mapping since no replacement is needed
$mapped = true;
}
// Check if it has other suffixes like _copy, _duplicate, etc.
elseif (preg_match('/^' . preg_quote($originalVar->name) . '_(copy|duplicate|\d+)$/i', $importedVar->name)) {
$variableMapping[$originalVar->name] = $importedVar->name;
$mapped = true;
}

if ($mapped) {
break;
}
}
}

// Update script code with new variable names
if (!empty($variableMapping)) {
$updatedCode = $this->model->code;

foreach ($variableMapping as $oldName => $newName) {
// Update common patterns for environment variable access
$patterns = [
// JavaScript patterns - process.env.VARIABLE_NAME → process.env.VARIABLE_NAME_1
'/\bprocess\.env\.' . preg_quote($oldName, '/') . '\b/',
'/\bprocess\.env\[\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\]/',
'/\bprocess\.env\[\s*"' . preg_quote($oldName, '/') . '"\s*\]/', // Double quotes

// PHP patterns
// config('VARIABLE_NAME') → config('VARIABLE_NAME_1')
'/\bconfig\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',
// env('VARIABLE_NAME') → env('VARIABLE_NAME_1')
'/\benv\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',
// $_ENV['VARIABLE_NAME'] → $_ENV['VARIABLE_NAME_1']
'/\$_ENV\s*\[\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\]/',
// $_SERVER['VARIABLE_NAME'] → $_SERVER['VARIABLE_NAME_1']
'/\$_SERVER\s*\[\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\]/',
// getenv('VARIABLE_NAME') → getenv('VARIABLE_NAME_1')
'/\bgetenv\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',
// Config::get('VARIABLE_NAME') → Config::get('VARIABLE_NAME_1')
'/\bConfig\s*::\s*get\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',

// Java patterns
// System.getenv("VARIABLE_NAME") → System.getenv("VARIABLE_NAME_1")
'/\bSystem\.getenv\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',
// System.getProperty("VARIABLE_NAME") → System.getProperty("VARIABLE_NAME_1")
'/\bSystem\.getProperty\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',

// C# patterns
// Environment.GetEnvironmentVariable("VARIABLE_NAME") → Environment.GetEnvironmentVariable("VARIABLE_NAME_1")
'/\bEnvironment\.GetEnvironmentVariable\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',
// ConfigurationManager.AppSettings["VARIABLE_NAME"] → ConfigurationManager.AppSettings["VARIABLE_NAME_1"]
'/\bConfigurationManager\.AppSettings\s*\[\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\]/',

// Python patterns
// os.environ['VARIABLE_NAME'] → os.environ['VARIABLE_NAME_1']
'/\bos\.environ\s*\[\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\]/',
// os.environ.get('VARIABLE_NAME') → os.environ.get('VARIABLE_NAME_1')
'/\bos\.environ\.get\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',
// os.getenv('VARIABLE_NAME') → os.getenv('VARIABLE_NAME_1')
'/\bos\.getenv\s*\(\s*[\'"]' . preg_quote($oldName, '/') . '[\'"]\s*\)/',
];

foreach ($patterns as $patternIndex => $pattern) {
$updatedCode = preg_replace_callback($pattern, function ($matches) use ($oldName, $newName, $patternIndex) {
$original = $matches[0];

// Handle different replacement patterns
switch ($patternIndex) {
case 0: // process.env.VARIABLE_NAME
return str_replace('process.env.' . $oldName, 'process.env.' . $newName, $original);
case 1: // process.env['VARIABLE_NAME']
case 2: // process.env["VARIABLE_NAME"]
return str_replace($oldName, $newName, $original);
case 6: // System.getenv for Java
return str_replace($oldName, $newName, $original);
case 7: // System.getProperty for Java
return str_replace($oldName, $newName, $original);
case 8: // Environment.GetEnvironmentVariable for C#
return str_replace($oldName, $newName, $original);
case 9: // ConfigurationManager.AppSettings for C#
return str_replace($oldName, $newName, $original);
case 10: // os.environ for Python
case 11: // os.environ.get for Python
case 12: // os.getenv for Python
return str_replace($oldName, $newName, $original);
default: // All other patterns (PHP)
return str_replace($oldName, $newName, $original);
}
}, $updatedCode);
}
}

// Only update if changes were made
if ($updatedCode !== $this->model->code) {
$this->model->code = $updatedCode;

// Log the variable name changes (summary)
Log::info('ScriptExporter: Updated variable references in script', [
'script_id' => $this->model->id,
'script_title' => $this->model->title,
'variables_updated' => count($variableMapping),
'mappings' => $variableMapping,
'mode' => $this->mode,
]);
}
}
}
}
2 changes: 1 addition & 1 deletion ProcessMaker/Jobs/DevLinkInstall.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public function handle(): void
$bundle->reinstall($this->importMode, $logger);
break;
case self::TYPE_IMPORT_ASSET:
$devLink->installRemoteAsset($this->class, $this->id, $logger);
$devLink->installRemoteAsset($this->class, $this->id, $this->importMode, $logger);
break;
default:
break;
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/DevLink.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,14 +191,14 @@ public function installRemoteBundle($remoteBundleId, $updateType)
$this->logger->setStatus('done');
}

public function installRemoteAsset(string $class, int $id, Logger $logger) : ProcessMakerModel
public function installRemoteAsset(string $class, int $id, string $updateType, Logger $logger) : ProcessMakerModel
{
$payload = $this->client()->get(
route('api.devlink.export-local-asset', ['class' => $class, 'id' => $id], false)
)->json();

$options = new Options([
'mode' => 'update',
'mode' => $updateType,
]);

$logger->setSteps([$payload]);
Expand Down
Loading