Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions ProcessMaker/Enums/ScriptExecutorType.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<?php

namespace ProcessMaker\Enums;

enum ScriptExecutorType:string
{
case System = 'system';
case Custom = 'custom';
}
2 changes: 1 addition & 1 deletion ProcessMaker/Events/ScriptResponseEvent.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ private function cacheResponse()
public function broadcastWith()
{
$date = new Carbon();
$response = $this->cacheResponse($this->response);
$response = $this->cacheResponse();

return [
'type' => '.' . \get_class($this),
Expand Down
7 changes: 7 additions & 0 deletions ProcessMaker/Http/Controllers/Api/ScriptController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use ProcessMaker\Models\ScriptCategory;
use ProcessMaker\Models\User;
use ProcessMaker\Query\SyntaxError;
use ProcessMaker\Services\ScriptMicroserviceService;
use ProcessMaker\Traits\ProjectAssetTrait;

class ScriptController extends Controller
Expand DownExpand Up@@ -286,6 +287,12 @@ public function execution($key)
return response()->json(Cache::get("srn.{$key}"));
}

public function microserviceExecution(Request $request)
{
$scriptMicroserviceService = new ScriptMicroserviceService();
$scriptMicroserviceService->handle($request);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gusys should we add error handling to catch any potential exceptions from the microservice execution?


/**
* Get a single script in a process.
*
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,7 @@ public function index(Request $request)
*/
public function store(Request $request)
{
$request->request->add(['type' => 'custom']);
$this->checkAuth($request);
$request->validate(ScriptExecutor::rules());

Expand Down
28 changes: 22 additions & 6 deletions ProcessMaker/Jobs/RunScriptTask.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\Facades\WorkflowManager;
Expand DownExpand Up@@ -32,9 +33,9 @@ class RunScriptTask extends BpmnAction implements ShouldQueue
/**
* Create a new job instance.
*
* @param \ProcessMaker\Models\Process $definitions
* @param \ProcessMaker\Models\ProcessRequest $instance
* @param \ProcessMaker\Models\ProcessRequestToken $token
* @param Definitions $definitions
* @param ProcessRequest $instance
* @param ProcessRequestToken $token
* @param array $data
*/
public function __construct(Definitions $definitions, ProcessRequest $instance, ProcessRequestToken $token, array $data, $attemptNum = 1)
Expand DownExpand Up@@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
}

$errorHandling = null;
$scriptExecutor = null;
try {
if (empty($scriptRef)) {
$code = $element->getScript();
Expand All@@ -86,6 +88,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
if (!$script) {
throw new ConfigurationException(__('Script ":id" not found', ['id' => $scriptRef]));
}
$scriptExecutor = $script->scriptExecutor;
$script = $script->versionFor($instance);
}

Expand All@@ -95,9 +98,22 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
$this->unlock();
$dataManager = new DataManager();
$data = $dataManager->getData($token);
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout());

$this->updateData($response);
$metadata = [
'script_task' => [
'script_id' => $scriptRef,
'definition_id' => $this->definitionsId,
'instance_id' => $this->instanceId,
'token_id' => $this->tokenId,
'data' => $data,
'attempts' => $this->attemptNum,
],
];
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 0, $metadata);

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys if this is an asynchronous execution, what endpoint are we using for the callback? Is it /scripts/microservice/execution? Is that also the callback when executed from TestScript.php?


if (!config('script-runner-microservice.enabled') ||
($scriptExecutor && $scriptExecutor->type === ScriptExecutorType::Custom)) {
$this->updateData($response);
}
} catch (ConfigurationException $exception) {
$this->unlock();
$this->updateData(['output' => $exception->getMessageForData($token)]);
Expand Down
14 changes: 12 additions & 2 deletions ProcessMaker/Jobs/TestScript.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Events\ScriptResponseEvent;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
Expand DownExpand Up@@ -60,8 +61,17 @@ public function handle()
try {
// Just set the code but do not save the object (preview only)
$this->script->code = $this->code;
$response = $this->script->runScript($this->data, $this->configuration);
$this->sendResponse(200, $response);
$metadata = [
'nonce' => $this->nonce,
'current_user' => $this->current_user?->id,
];
$response = $this->script->runScript($this->data, $this->configuration, '', null, 0, $metadata);
\Log::debug('Response api microservice: ' . print_r($response, true));

if (!config('script-runner-microservice.enabled') ||
$this->script->scriptExecutor && $this->script->scriptExecutor->type === ScriptExecutorType::Custom) {
$this->sendResponse(200, $response);
}
} catch (Throwable $exception) {
$this->sendResponse(500, [
'exception' => get_class($exception),
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Models/Script.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -149,7 +149,7 @@ public static function rules($existing = null)
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys could you change $sync = 1 to bool $sync = true? You can change it in ScriptMicroserviceRunner if you need to send it as an integer 'sync' => $sync ? 1 : 0,

There are a few other places we call runScript, like RunServiceTask.php. Do those need to be updated?

{
if (!$timeout) {
$timeout = $this->timeout;
Expand All@@ -158,14 +158,14 @@ public function runScript(array $data, array $config, $tokenId = '', $timeout =
if (!$this->scriptExecutor) {
throw new ScriptLanguageNotSupported($this->language);
}
$runner = new ScriptRunner($this->scriptExecutor);
$runner = new ScriptRunner($this);
$runner->setTokenId($tokenId);
$user = User::find($this->run_as_user_id);
if (!$user) {
throw new ConfigurationException('A user is required to run scripts');
}

return $runner->run($this->code, $data, $config, $timeout, $user);
return $runner->run($this->code, $data, $config, $timeout, $user, $sync, $metadata);
}

/**
Expand Down
9 changes: 8 additions & 1 deletion ProcessMaker/Models/ScriptExecutor.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Enum;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ScriptLanguageNotSupported;
use ProcessMaker\Facades\Docker;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -56,7 +58,7 @@ class ScriptExecutor extends ProcessMakerModel
use HideSystemResources;

protected $fillable = [
'title', 'description', 'language', 'config', 'is_system',
'title', 'description', 'language', 'config', 'is_system', 'type',
];

public static function install($params)
Expand DownExpand Up@@ -146,6 +148,11 @@ public static function rules($existing = null)
'required',
Rule::in(Script::scriptFormatValues()),
],
'type' => [
'sometimes',
new Enum(ScriptExecutorType::class),
'nullable',
],
];
}

Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/Models/ScriptExecutorVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
class ScriptExecutorVersion extends ProcessMakerModel
{
protected $fillable = [
'title', 'description', 'language', 'config', 'draft', 'is_system',
'title', 'description', 'language', 'config', 'draft', 'is_system', 'type',
];

/**
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/ScriptVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,15 +50,15 @@ public function parent()
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])
{
$script = $this->parent->replicate();
$except = $script->getGuarded();
foreach (collect($script->getAttributes())->except($except)->keys() as $prop) {
$script->$prop = $this->$prop;
}

return $script->runScript($data, $config, $tokenId, $timeout);
return $script->runScript($data, $config, $tokenId, $timeout, $sync, $metadata);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/ScriptRunners/Base.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ public function __construct(ScriptExecutor $scriptExecutor)
* @return array
* @throws RuntimeException
*/
public function run($code, array $data, array $config, $timeout, ?User $user)
public function run($code, array $data, array $config, $timeout, ?User $user, $sync, $metadata)
{
$isNayra = $this->scriptExecutor->language === self::NAYRA_LANG;

Expand Down
167 changes: 167 additions & 0 deletions ProcessMaker/ScriptRunners/ScriptMicroserviceRunner.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
<?php

namespace ProcessMaker\ScriptRunners;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\GenerateAccessToken;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
use stdClass;

class ScriptMicroserviceRunner
{
private string $tokenId = '';

private string $language;

public function __construct(protected Script $script)
{
$this->language = strtolower($script->language ?? $script->scriptExecutor->language);
}

public function getAccessToken()
{
if (Cache::has('keycloak.access_token')) {
return Cache::get('keycloak.access_token');
}

$response = Http::asForm()->post(config('script-runner-microservice.keycloak.base_url'), [
'grant_type' => 'password',
'client_id' => config('script-runner-microservice.keycloak.client_id'),
'client_secret' => config('script-runner-microservice.keycloak.client_secret'),
'username' => config('script-runner-microservice.keycloak.username'),
'password' => config('script-runner-microservice.keycloak.password'),
]);

if ($response->successful()) {
Cache::put('keycloak.access_token', $response->json()['access_token'], $response->json()['expires_in'] - 60);
}

return Cache::get('keycloak.access_token');
}

public function getScriptRunner()
{
$response = Cache::remember('script-runner-microservice.script-languages', now()->addDay(), function () {
return Http::withToken($this->getAccessToken())
->get(config('script-runner-microservice.base_url') . '/scripts')->collect();
});

return $response->filter(function ($item) {
return $item['language'] == $this->language;
})->first();
}

public function run($code, array $data, array $config, $timeout, $user, $sync, $metadata)
{
Log::debug('Language: ' . $this->language);
Log::debug('Sync: ' . $sync);
Log::debug('Metadata: ' . print_r($metadata, true));

$scriptRunner = $this->getScriptRunner();

if (!$scriptRunner) {
throw new ConfigurationException('No exists script executor for this language: ' . $this->language);
}
$metadata = array_merge($this->getMetadata($user), $metadata);
$environmentVariables = $this->getEnvironmentVariables($user);

$payload = [
'version' => config('script-runner-microservice.version') ?? $this->getProcessMakerVersion(),
'language' => $scriptRunner['language'],
'metadata'=> $metadata,
'data' => !empty($data) ? $this->sanitizeCss($data) : new stdClass(),
'config' => !empty($config) ? $config : new stdClass(),
'script' => base64_encode(str_replace("'", '&#39;', $code)),
'secrets' => $environmentVariables,
'callback' => config('script-runner-microservice.callback'),
'callback_secure' => true,
'callback_token' => $environmentVariables['API_TOKEN'],
'debug' => true,
'timeout' => $timeout,
'sync' => $sync,
];

Log::debug('Payload: ' . print_r($payload, true));

$response = Http::withToken($this->getAccessToken())
->post(config('script-runner-microservice.base_url') . '/requests/create', $payload);

$response->throw();

return $response->json();
}

private function getEnvironmentVariables(User $user)
{
$variablesParameter = [];
EnvironmentVariable::chunk(50, function (Collection $variables) use (&$variablesParameter) {
foreach ($variables as $variable) {
// Fix variables that have spaces
$variablesParameter[str_replace(' ', '_', $variable->name)] = $variable->value;
}
});

// Add the url to the host
$variablesParameter['HOST_URL'] = config('app.docker_host_url');

// Create tokens for the SDK if a user is set
$token = null;
if ($user) {
$accessToken = Cache::remember('script-runner-' . $user->id, now()->addWeek(), function () use ($user) {
$user->removeOldRunScriptTokens();
$token = new GenerateAccessToken($user);

return $token->getToken();
});
$variablesParameter['API_TOKEN'] = $accessToken;
$variablesParameter['API_HOST'] = config('app.docker_host_url') . '/api/1.0';
$variablesParameter['APP_URL'] = config('app.docker_host_url');
$variablesParameter['API_SSL_VERIFY'] = (config('app.api_ssl_verify') ? '1' : '0');
}

return $variablesParameter;
}

public function setTokenId($tokenId)
{
$this->tokenId = $tokenId;
}

public function getProcessMakerVersion()
{
return Cache::remember('script-runner-microservice.processmaker-version', now()->addDay(), function () {
$composer_json_path = json_decode(file_get_contents(base_path() . '/composer.json'));

return $composer_json_path->version;
});
}

public function getMetadata($user)
{
return [
'script_id' => $this->script->id,
'instance' => config('app.url'),
'user_id' => $user->id,
'user_email' => $user->email,
];
}

public function sanitizeCss($data)
{
if ($this->language !== 'javascript-ssr') {
return $data;
}
if (array_key_exists('css', $data)) {
$data['css'] = false;
}

return $data;
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions ProcessMaker/Enums/ScriptExecutorType.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<?php

namespace ProcessMaker\Enums;

enum ScriptExecutorType:string
{
case System = 'system';
case Custom = 'custom';
}
2 changes: 1 addition & 1 deletion ProcessMaker/Events/ScriptResponseEvent.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ private function cacheResponse()
public function broadcastWith()
{
$date = new Carbon();
$response = $this->cacheResponse($this->response);
$response = $this->cacheResponse();

return [
'type' => '.' . \get_class($this),
Expand Down
7 changes: 7 additions & 0 deletions ProcessMaker/Http/Controllers/Api/ScriptController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use ProcessMaker\Models\ScriptCategory;
use ProcessMaker\Models\User;
use ProcessMaker\Query\SyntaxError;
use ProcessMaker\Services\ScriptMicroserviceService;
use ProcessMaker\Traits\ProjectAssetTrait;

class ScriptController extends Controller
Expand DownExpand Up@@ -286,6 +287,12 @@ public function execution($key)
return response()->json(Cache::get("srn.{$key}"));
}

public function microserviceExecution(Request $request)
{
$scriptMicroserviceService = new ScriptMicroserviceService();
$scriptMicroserviceService->handle($request);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gusys should we add error handling to catch any potential exceptions from the microservice execution?


/**
* Get a single script in a process.
*
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,7 @@ public function index(Request $request)
*/
public function store(Request $request)
{
$request->request->add(['type' => 'custom']);
$this->checkAuth($request);
$request->validate(ScriptExecutor::rules());

Expand Down
28 changes: 22 additions & 6 deletions ProcessMaker/Jobs/RunScriptTask.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\Facades\WorkflowManager;
Expand DownExpand Up@@ -32,9 +33,9 @@ class RunScriptTask extends BpmnAction implements ShouldQueue
/**
* Create a new job instance.
*
* @param \ProcessMaker\Models\Process $definitions
* @param \ProcessMaker\Models\ProcessRequest $instance
* @param \ProcessMaker\Models\ProcessRequestToken $token
* @param Definitions $definitions
* @param ProcessRequest $instance
* @param ProcessRequestToken $token
* @param array $data
*/
public function __construct(Definitions $definitions, ProcessRequest $instance, ProcessRequestToken $token, array $data, $attemptNum = 1)
Expand DownExpand Up@@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
}

$errorHandling = null;
$scriptExecutor = null;
try {
if (empty($scriptRef)) {
$code = $element->getScript();
Expand All@@ -86,6 +88,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
if (!$script) {
throw new ConfigurationException(__('Script ":id" not found', ['id' => $scriptRef]));
}
$scriptExecutor = $script->scriptExecutor;
$script = $script->versionFor($instance);
}

Expand All@@ -95,9 +98,22 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
$this->unlock();
$dataManager = new DataManager();
$data = $dataManager->getData($token);
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout());

$this->updateData($response);
$metadata = [
'script_task' => [
'script_id' => $scriptRef,
'definition_id' => $this->definitionsId,
'instance_id' => $this->instanceId,
'token_id' => $this->tokenId,
'data' => $data,
'attempts' => $this->attemptNum,
],
];
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 0, $metadata);

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys if this is an asynchronous execution, what endpoint are we using for the callback? Is it /scripts/microservice/execution? Is that also the callback when executed from TestScript.php?


if (!config('script-runner-microservice.enabled') ||
($scriptExecutor && $scriptExecutor->type === ScriptExecutorType::Custom)) {
$this->updateData($response);
}
} catch (ConfigurationException $exception) {
$this->unlock();
$this->updateData(['output' => $exception->getMessageForData($token)]);
Expand Down
14 changes: 12 additions & 2 deletions ProcessMaker/Jobs/TestScript.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Events\ScriptResponseEvent;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
Expand DownExpand Up@@ -60,8 +61,17 @@ public function handle()
try {
// Just set the code but do not save the object (preview only)
$this->script->code = $this->code;
$response = $this->script->runScript($this->data, $this->configuration);
$this->sendResponse(200, $response);
$metadata = [
'nonce' => $this->nonce,
'current_user' => $this->current_user?->id,
];
$response = $this->script->runScript($this->data, $this->configuration, '', null, 0, $metadata);
\Log::debug('Response api microservice: ' . print_r($response, true));

if (!config('script-runner-microservice.enabled') ||
$this->script->scriptExecutor && $this->script->scriptExecutor->type === ScriptExecutorType::Custom) {
$this->sendResponse(200, $response);
}
} catch (Throwable $exception) {
$this->sendResponse(500, [
'exception' => get_class($exception),
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Models/Script.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -149,7 +149,7 @@ public static function rules($existing = null)
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys could you change $sync = 1 to bool $sync = true? You can change it in ScriptMicroserviceRunner if you need to send it as an integer 'sync' => $sync ? 1 : 0,

There are a few other places we call runScript, like RunServiceTask.php. Do those need to be updated?

{
if (!$timeout) {
$timeout = $this->timeout;
Expand All@@ -158,14 +158,14 @@ public function runScript(array $data, array $config, $tokenId = '', $timeout =
if (!$this->scriptExecutor) {
throw new ScriptLanguageNotSupported($this->language);
}
$runner = new ScriptRunner($this->scriptExecutor);
$runner = new ScriptRunner($this);
$runner->setTokenId($tokenId);
$user = User::find($this->run_as_user_id);
if (!$user) {
throw new ConfigurationException('A user is required to run scripts');
}

return $runner->run($this->code, $data, $config, $timeout, $user);
return $runner->run($this->code, $data, $config, $timeout, $user, $sync, $metadata);
}

/**
Expand Down
9 changes: 8 additions & 1 deletion ProcessMaker/Models/ScriptExecutor.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Enum;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ScriptLanguageNotSupported;
use ProcessMaker\Facades\Docker;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -56,7 +58,7 @@ class ScriptExecutor extends ProcessMakerModel
use HideSystemResources;

protected $fillable = [
'title', 'description', 'language', 'config', 'is_system',
'title', 'description', 'language', 'config', 'is_system', 'type',
];

public static function install($params)
Expand DownExpand Up@@ -146,6 +148,11 @@ public static function rules($existing = null)
'required',
Rule::in(Script::scriptFormatValues()),
],
'type' => [
'sometimes',
new Enum(ScriptExecutorType::class),
'nullable',
],
];
}

Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/Models/ScriptExecutorVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
class ScriptExecutorVersion extends ProcessMakerModel
{
protected $fillable = [
'title', 'description', 'language', 'config', 'draft', 'is_system',
'title', 'description', 'language', 'config', 'draft', 'is_system', 'type',
];

/**
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/ScriptVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,15 +50,15 @@ public function parent()
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])
{
$script = $this->parent->replicate();
$except = $script->getGuarded();
foreach (collect($script->getAttributes())->except($except)->keys() as $prop) {
$script->$prop = $this->$prop;
}

return $script->runScript($data, $config, $tokenId, $timeout);
return $script->runScript($data, $config, $tokenId, $timeout, $sync, $metadata);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/ScriptRunners/Base.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ public function __construct(ScriptExecutor $scriptExecutor)
* @return array
* @throws RuntimeException
*/
public function run($code, array $data, array $config, $timeout, ?User $user)
public function run($code, array $data, array $config, $timeout, ?User $user, $sync, $metadata)
{
$isNayra = $this->scriptExecutor->language === self::NAYRA_LANG;

Expand Down
167 changes: 167 additions & 0 deletions ProcessMaker/ScriptRunners/ScriptMicroserviceRunner.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
<?php

namespace ProcessMaker\ScriptRunners;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\GenerateAccessToken;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
use stdClass;

class ScriptMicroserviceRunner
{
private string $tokenId = '';

private string $language;

public function __construct(protected Script $script)
{
$this->language = strtolower($script->language ?? $script->scriptExecutor->language);
}

public function getAccessToken()
{
if (Cache::has('keycloak.access_token')) {
return Cache::get('keycloak.access_token');
}

$response = Http::asForm()->post(config('script-runner-microservice.keycloak.base_url'), [
'grant_type' => 'password',
'client_id' => config('script-runner-microservice.keycloak.client_id'),
'client_secret' => config('script-runner-microservice.keycloak.client_secret'),
'username' => config('script-runner-microservice.keycloak.username'),
'password' => config('script-runner-microservice.keycloak.password'),
]);

if ($response->successful()) {
Cache::put('keycloak.access_token', $response->json()['access_token'], $response->json()['expires_in'] - 60);
}

return Cache::get('keycloak.access_token');
}

public function getScriptRunner()
{
$response = Cache::remember('script-runner-microservice.script-languages', now()->addDay(), function () {
return Http::withToken($this->getAccessToken())
->get(config('script-runner-microservice.base_url') . '/scripts')->collect();
});

return $response->filter(function ($item) {
return $item['language'] == $this->language;
})->first();
}

public function run($code, array $data, array $config, $timeout, $user, $sync, $metadata)
{
Log::debug('Language: ' . $this->language);
Log::debug('Sync: ' . $sync);
Log::debug('Metadata: ' . print_r($metadata, true));

$scriptRunner = $this->getScriptRunner();

if (!$scriptRunner) {
throw new ConfigurationException('No exists script executor for this language: ' . $this->language);
}
$metadata = array_merge($this->getMetadata($user), $metadata);
$environmentVariables = $this->getEnvironmentVariables($user);

$payload = [
'version' => config('script-runner-microservice.version') ?? $this->getProcessMakerVersion(),
'language' => $scriptRunner['language'],
'metadata'=> $metadata,
'data' => !empty($data) ? $this->sanitizeCss($data) : new stdClass(),
'config' => !empty($config) ? $config : new stdClass(),
'script' => base64_encode(str_replace("'", '&#39;', $code)),
'secrets' => $environmentVariables,
'callback' => config('script-runner-microservice.callback'),
'callback_secure' => true,
'callback_token' => $environmentVariables['API_TOKEN'],
'debug' => true,
'timeout' => $timeout,
'sync' => $sync,
];

Log::debug('Payload: ' . print_r($payload, true));

$response = Http::withToken($this->getAccessToken())
->post(config('script-runner-microservice.base_url') . '/requests/create', $payload);

$response->throw();

return $response->json();
}

private function getEnvironmentVariables(User $user)
{
$variablesParameter = [];
EnvironmentVariable::chunk(50, function (Collection $variables) use (&$variablesParameter) {
foreach ($variables as $variable) {
// Fix variables that have spaces
$variablesParameter[str_replace(' ', '_', $variable->name)] = $variable->value;
}
});

// Add the url to the host
$variablesParameter['HOST_URL'] = config('app.docker_host_url');

// Create tokens for the SDK if a user is set
$token = null;
if ($user) {
$accessToken = Cache::remember('script-runner-' . $user->id, now()->addWeek(), function () use ($user) {
$user->removeOldRunScriptTokens();
$token = new GenerateAccessToken($user);

return $token->getToken();
});
$variablesParameter['API_TOKEN'] = $accessToken;
$variablesParameter['API_HOST'] = config('app.docker_host_url') . '/api/1.0';
$variablesParameter['APP_URL'] = config('app.docker_host_url');
$variablesParameter['API_SSL_VERIFY'] = (config('app.api_ssl_verify') ? '1' : '0');
}

return $variablesParameter;
}

public function setTokenId($tokenId)
{
$this->tokenId = $tokenId;
}

public function getProcessMakerVersion()
{
return Cache::remember('script-runner-microservice.processmaker-version', now()->addDay(), function () {
$composer_json_path = json_decode(file_get_contents(base_path() . '/composer.json'));

return $composer_json_path->version;
});
}

public function getMetadata($user)
{
return [
'script_id' => $this->script->id,
'instance' => config('app.url'),
'user_id' => $user->id,
'user_email' => $user->email,
];
}

public function sanitizeCss($data)
{
if ($this->language !== 'javascript-ssr') {
return $data;
}
if (array_key_exists('css', $data)) {
$data['css'] = false;
}

return $data;
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions ProcessMaker/Enums/ScriptExecutorType.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<?php

namespace ProcessMaker\Enums;

enum ScriptExecutorType:string
{
case System = 'system';
case Custom = 'custom';
}
2 changes: 1 addition & 1 deletion ProcessMaker/Events/ScriptResponseEvent.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ private function cacheResponse()
public function broadcastWith()
{
$date = new Carbon();
$response = $this->cacheResponse($this->response);
$response = $this->cacheResponse();

return [
'type' => '.' . \get_class($this),
Expand Down
7 changes: 7 additions & 0 deletions ProcessMaker/Http/Controllers/Api/ScriptController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use ProcessMaker\Models\ScriptCategory;
use ProcessMaker\Models\User;
use ProcessMaker\Query\SyntaxError;
use ProcessMaker\Services\ScriptMicroserviceService;
use ProcessMaker\Traits\ProjectAssetTrait;

class ScriptController extends Controller
Expand DownExpand Up@@ -286,6 +287,12 @@ public function execution($key)
return response()->json(Cache::get("srn.{$key}"));
}

public function microserviceExecution(Request $request)
{
$scriptMicroserviceService = new ScriptMicroserviceService();
$scriptMicroserviceService->handle($request);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gusys should we add error handling to catch any potential exceptions from the microservice execution?


/**
* Get a single script in a process.
*
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,7 @@ public function index(Request $request)
*/
public function store(Request $request)
{
$request->request->add(['type' => 'custom']);
$this->checkAuth($request);
$request->validate(ScriptExecutor::rules());

Expand Down
28 changes: 22 additions & 6 deletions ProcessMaker/Jobs/RunScriptTask.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\Facades\WorkflowManager;
Expand DownExpand Up@@ -32,9 +33,9 @@ class RunScriptTask extends BpmnAction implements ShouldQueue
/**
* Create a new job instance.
*
* @param \ProcessMaker\Models\Process $definitions
* @param \ProcessMaker\Models\ProcessRequest $instance
* @param \ProcessMaker\Models\ProcessRequestToken $token
* @param Definitions $definitions
* @param ProcessRequest $instance
* @param ProcessRequestToken $token
* @param array $data
*/
public function __construct(Definitions $definitions, ProcessRequest $instance, ProcessRequestToken $token, array $data, $attemptNum = 1)
Expand DownExpand Up@@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
}

$errorHandling = null;
$scriptExecutor = null;
try {
if (empty($scriptRef)) {
$code = $element->getScript();
Expand All@@ -86,6 +88,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
if (!$script) {
throw new ConfigurationException(__('Script ":id" not found', ['id' => $scriptRef]));
}
$scriptExecutor = $script->scriptExecutor;
$script = $script->versionFor($instance);
}

Expand All@@ -95,9 +98,22 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
$this->unlock();
$dataManager = new DataManager();
$data = $dataManager->getData($token);
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout());

$this->updateData($response);
$metadata = [
'script_task' => [
'script_id' => $scriptRef,
'definition_id' => $this->definitionsId,
'instance_id' => $this->instanceId,
'token_id' => $this->tokenId,
'data' => $data,
'attempts' => $this->attemptNum,
],
];
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 0, $metadata);

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys if this is an asynchronous execution, what endpoint are we using for the callback? Is it /scripts/microservice/execution? Is that also the callback when executed from TestScript.php?


if (!config('script-runner-microservice.enabled') ||
($scriptExecutor && $scriptExecutor->type === ScriptExecutorType::Custom)) {
$this->updateData($response);
}
} catch (ConfigurationException $exception) {
$this->unlock();
$this->updateData(['output' => $exception->getMessageForData($token)]);
Expand Down
14 changes: 12 additions & 2 deletions ProcessMaker/Jobs/TestScript.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Events\ScriptResponseEvent;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
Expand DownExpand Up@@ -60,8 +61,17 @@ public function handle()
try {
// Just set the code but do not save the object (preview only)
$this->script->code = $this->code;
$response = $this->script->runScript($this->data, $this->configuration);
$this->sendResponse(200, $response);
$metadata = [
'nonce' => $this->nonce,
'current_user' => $this->current_user?->id,
];
$response = $this->script->runScript($this->data, $this->configuration, '', null, 0, $metadata);
\Log::debug('Response api microservice: ' . print_r($response, true));

if (!config('script-runner-microservice.enabled') ||
$this->script->scriptExecutor && $this->script->scriptExecutor->type === ScriptExecutorType::Custom) {
$this->sendResponse(200, $response);
}
} catch (Throwable $exception) {
$this->sendResponse(500, [
'exception' => get_class($exception),
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Models/Script.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -149,7 +149,7 @@ public static function rules($existing = null)
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys could you change $sync = 1 to bool $sync = true? You can change it in ScriptMicroserviceRunner if you need to send it as an integer 'sync' => $sync ? 1 : 0,

There are a few other places we call runScript, like RunServiceTask.php. Do those need to be updated?

{
if (!$timeout) {
$timeout = $this->timeout;
Expand All@@ -158,14 +158,14 @@ public function runScript(array $data, array $config, $tokenId = '', $timeout =
if (!$this->scriptExecutor) {
throw new ScriptLanguageNotSupported($this->language);
}
$runner = new ScriptRunner($this->scriptExecutor);
$runner = new ScriptRunner($this);
$runner->setTokenId($tokenId);
$user = User::find($this->run_as_user_id);
if (!$user) {
throw new ConfigurationException('A user is required to run scripts');
}

return $runner->run($this->code, $data, $config, $timeout, $user);
return $runner->run($this->code, $data, $config, $timeout, $user, $sync, $metadata);
}

/**
Expand Down
9 changes: 8 additions & 1 deletion ProcessMaker/Models/ScriptExecutor.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Enum;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ScriptLanguageNotSupported;
use ProcessMaker\Facades\Docker;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -56,7 +58,7 @@ class ScriptExecutor extends ProcessMakerModel
use HideSystemResources;

protected $fillable = [
'title', 'description', 'language', 'config', 'is_system',
'title', 'description', 'language', 'config', 'is_system', 'type',
];

public static function install($params)
Expand DownExpand Up@@ -146,6 +148,11 @@ public static function rules($existing = null)
'required',
Rule::in(Script::scriptFormatValues()),
],
'type' => [
'sometimes',
new Enum(ScriptExecutorType::class),
'nullable',
],
];
}

Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/Models/ScriptExecutorVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
class ScriptExecutorVersion extends ProcessMakerModel
{
protected $fillable = [
'title', 'description', 'language', 'config', 'draft', 'is_system',
'title', 'description', 'language', 'config', 'draft', 'is_system', 'type',
];

/**
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/ScriptVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,15 +50,15 @@ public function parent()
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])
{
$script = $this->parent->replicate();
$except = $script->getGuarded();
foreach (collect($script->getAttributes())->except($except)->keys() as $prop) {
$script->$prop = $this->$prop;
}

return $script->runScript($data, $config, $tokenId, $timeout);
return $script->runScript($data, $config, $tokenId, $timeout, $sync, $metadata);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/ScriptRunners/Base.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ public function __construct(ScriptExecutor $scriptExecutor)
* @return array
* @throws RuntimeException
*/
public function run($code, array $data, array $config, $timeout, ?User $user)
public function run($code, array $data, array $config, $timeout, ?User $user, $sync, $metadata)
{
$isNayra = $this->scriptExecutor->language === self::NAYRA_LANG;

Expand Down
167 changes: 167 additions & 0 deletions ProcessMaker/ScriptRunners/ScriptMicroserviceRunner.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
<?php

namespace ProcessMaker\ScriptRunners;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\GenerateAccessToken;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
use stdClass;

class ScriptMicroserviceRunner
{
private string $tokenId = '';

private string $language;

public function __construct(protected Script $script)
{
$this->language = strtolower($script->language ?? $script->scriptExecutor->language);
}

public function getAccessToken()
{
if (Cache::has('keycloak.access_token')) {
return Cache::get('keycloak.access_token');
}

$response = Http::asForm()->post(config('script-runner-microservice.keycloak.base_url'), [
'grant_type' => 'password',
'client_id' => config('script-runner-microservice.keycloak.client_id'),
'client_secret' => config('script-runner-microservice.keycloak.client_secret'),
'username' => config('script-runner-microservice.keycloak.username'),
'password' => config('script-runner-microservice.keycloak.password'),
]);

if ($response->successful()) {
Cache::put('keycloak.access_token', $response->json()['access_token'], $response->json()['expires_in'] - 60);
}

return Cache::get('keycloak.access_token');
}

public function getScriptRunner()
{
$response = Cache::remember('script-runner-microservice.script-languages', now()->addDay(), function () {
return Http::withToken($this->getAccessToken())
->get(config('script-runner-microservice.base_url') . '/scripts')->collect();
});

return $response->filter(function ($item) {
return $item['language'] == $this->language;
})->first();
}

public function run($code, array $data, array $config, $timeout, $user, $sync, $metadata)
{
Log::debug('Language: ' . $this->language);
Log::debug('Sync: ' . $sync);
Log::debug('Metadata: ' . print_r($metadata, true));

$scriptRunner = $this->getScriptRunner();

if (!$scriptRunner) {
throw new ConfigurationException('No exists script executor for this language: ' . $this->language);
}
$metadata = array_merge($this->getMetadata($user), $metadata);
$environmentVariables = $this->getEnvironmentVariables($user);

$payload = [
'version' => config('script-runner-microservice.version') ?? $this->getProcessMakerVersion(),
'language' => $scriptRunner['language'],
'metadata'=> $metadata,
'data' => !empty($data) ? $this->sanitizeCss($data) : new stdClass(),
'config' => !empty($config) ? $config : new stdClass(),
'script' => base64_encode(str_replace("'", '&#39;', $code)),
'secrets' => $environmentVariables,
'callback' => config('script-runner-microservice.callback'),
'callback_secure' => true,
'callback_token' => $environmentVariables['API_TOKEN'],
'debug' => true,
'timeout' => $timeout,
'sync' => $sync,
];

Log::debug('Payload: ' . print_r($payload, true));

$response = Http::withToken($this->getAccessToken())
->post(config('script-runner-microservice.base_url') . '/requests/create', $payload);

$response->throw();

return $response->json();
}

private function getEnvironmentVariables(User $user)
{
$variablesParameter = [];
EnvironmentVariable::chunk(50, function (Collection $variables) use (&$variablesParameter) {
foreach ($variables as $variable) {
// Fix variables that have spaces
$variablesParameter[str_replace(' ', '_', $variable->name)] = $variable->value;
}
});

// Add the url to the host
$variablesParameter['HOST_URL'] = config('app.docker_host_url');

// Create tokens for the SDK if a user is set
$token = null;
if ($user) {
$accessToken = Cache::remember('script-runner-' . $user->id, now()->addWeek(), function () use ($user) {
$user->removeOldRunScriptTokens();
$token = new GenerateAccessToken($user);

return $token->getToken();
});
$variablesParameter['API_TOKEN'] = $accessToken;
$variablesParameter['API_HOST'] = config('app.docker_host_url') . '/api/1.0';
$variablesParameter['APP_URL'] = config('app.docker_host_url');
$variablesParameter['API_SSL_VERIFY'] = (config('app.api_ssl_verify') ? '1' : '0');
}

return $variablesParameter;
}

public function setTokenId($tokenId)
{
$this->tokenId = $tokenId;
}

public function getProcessMakerVersion()
{
return Cache::remember('script-runner-microservice.processmaker-version', now()->addDay(), function () {
$composer_json_path = json_decode(file_get_contents(base_path() . '/composer.json'));

return $composer_json_path->version;
});
}

public function getMetadata($user)
{
return [
'script_id' => $this->script->id,
'instance' => config('app.url'),
'user_id' => $user->id,
'user_email' => $user->email,
];
}

public function sanitizeCss($data)
{
if ($this->language !== 'javascript-ssr') {
return $data;
}
if (array_key_exists('css', $data)) {
$data['css'] = false;
}

return $data;
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions ProcessMaker/Enums/ScriptExecutorType.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<?php

namespace ProcessMaker\Enums;

enum ScriptExecutorType:string
{
case System = 'system';
case Custom = 'custom';
}
2 changes: 1 addition & 1 deletion ProcessMaker/Events/ScriptResponseEvent.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ private function cacheResponse()
public function broadcastWith()
{
$date = new Carbon();
$response = $this->cacheResponse($this->response);
$response = $this->cacheResponse();

return [
'type' => '.' . \get_class($this),
Expand Down
7 changes: 7 additions & 0 deletions ProcessMaker/Http/Controllers/Api/ScriptController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use ProcessMaker\Models\ScriptCategory;
use ProcessMaker\Models\User;
use ProcessMaker\Query\SyntaxError;
use ProcessMaker\Services\ScriptMicroserviceService;
use ProcessMaker\Traits\ProjectAssetTrait;

class ScriptController extends Controller
Expand DownExpand Up@@ -286,6 +287,12 @@ public function execution($key)
return response()->json(Cache::get("srn.{$key}"));
}

public function microserviceExecution(Request $request)
{
$scriptMicroserviceService = new ScriptMicroserviceService();
$scriptMicroserviceService->handle($request);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gusys should we add error handling to catch any potential exceptions from the microservice execution?


/**
* Get a single script in a process.
*
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,7 @@ public function index(Request $request)
*/
public function store(Request $request)
{
$request->request->add(['type' => 'custom']);
$this->checkAuth($request);
$request->validate(ScriptExecutor::rules());

Expand Down
28 changes: 22 additions & 6 deletions ProcessMaker/Jobs/RunScriptTask.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\Facades\WorkflowManager;
Expand DownExpand Up@@ -32,9 +33,9 @@ class RunScriptTask extends BpmnAction implements ShouldQueue
/**
* Create a new job instance.
*
* @param \ProcessMaker\Models\Process $definitions
* @param \ProcessMaker\Models\ProcessRequest $instance
* @param \ProcessMaker\Models\ProcessRequestToken $token
* @param Definitions $definitions
* @param ProcessRequest $instance
* @param ProcessRequestToken $token
* @param array $data
*/
public function __construct(Definitions $definitions, ProcessRequest $instance, ProcessRequestToken $token, array $data, $attemptNum = 1)
Expand DownExpand Up@@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
}

$errorHandling = null;
$scriptExecutor = null;
try {
if (empty($scriptRef)) {
$code = $element->getScript();
Expand All@@ -86,6 +88,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
if (!$script) {
throw new ConfigurationException(__('Script ":id" not found', ['id' => $scriptRef]));
}
$scriptExecutor = $script->scriptExecutor;
$script = $script->versionFor($instance);
}

Expand All@@ -95,9 +98,22 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
$this->unlock();
$dataManager = new DataManager();
$data = $dataManager->getData($token);
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout());

$this->updateData($response);
$metadata = [
'script_task' => [
'script_id' => $scriptRef,
'definition_id' => $this->definitionsId,
'instance_id' => $this->instanceId,
'token_id' => $this->tokenId,
'data' => $data,
'attempts' => $this->attemptNum,
],
];
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 0, $metadata);

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys if this is an asynchronous execution, what endpoint are we using for the callback? Is it /scripts/microservice/execution? Is that also the callback when executed from TestScript.php?


if (!config('script-runner-microservice.enabled') ||
($scriptExecutor && $scriptExecutor->type === ScriptExecutorType::Custom)) {
$this->updateData($response);
}
} catch (ConfigurationException $exception) {
$this->unlock();
$this->updateData(['output' => $exception->getMessageForData($token)]);
Expand Down
14 changes: 12 additions & 2 deletions ProcessMaker/Jobs/TestScript.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Events\ScriptResponseEvent;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
Expand DownExpand Up@@ -60,8 +61,17 @@ public function handle()
try {
// Just set the code but do not save the object (preview only)
$this->script->code = $this->code;
$response = $this->script->runScript($this->data, $this->configuration);
$this->sendResponse(200, $response);
$metadata = [
'nonce' => $this->nonce,
'current_user' => $this->current_user?->id,
];
$response = $this->script->runScript($this->data, $this->configuration, '', null, 0, $metadata);
\Log::debug('Response api microservice: ' . print_r($response, true));

if (!config('script-runner-microservice.enabled') ||
$this->script->scriptExecutor && $this->script->scriptExecutor->type === ScriptExecutorType::Custom) {
$this->sendResponse(200, $response);
}
} catch (Throwable $exception) {
$this->sendResponse(500, [
'exception' => get_class($exception),
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Models/Script.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -149,7 +149,7 @@ public static function rules($existing = null)
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys could you change $sync = 1 to bool $sync = true? You can change it in ScriptMicroserviceRunner if you need to send it as an integer 'sync' => $sync ? 1 : 0,

There are a few other places we call runScript, like RunServiceTask.php. Do those need to be updated?

{
if (!$timeout) {
$timeout = $this->timeout;
Expand All@@ -158,14 +158,14 @@ public function runScript(array $data, array $config, $tokenId = '', $timeout =
if (!$this->scriptExecutor) {
throw new ScriptLanguageNotSupported($this->language);
}
$runner = new ScriptRunner($this->scriptExecutor);
$runner = new ScriptRunner($this);
$runner->setTokenId($tokenId);
$user = User::find($this->run_as_user_id);
if (!$user) {
throw new ConfigurationException('A user is required to run scripts');
}

return $runner->run($this->code, $data, $config, $timeout, $user);
return $runner->run($this->code, $data, $config, $timeout, $user, $sync, $metadata);
}

/**
Expand Down
9 changes: 8 additions & 1 deletion ProcessMaker/Models/ScriptExecutor.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Enum;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ScriptLanguageNotSupported;
use ProcessMaker\Facades\Docker;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -56,7 +58,7 @@ class ScriptExecutor extends ProcessMakerModel
use HideSystemResources;

protected $fillable = [
'title', 'description', 'language', 'config', 'is_system',
'title', 'description', 'language', 'config', 'is_system', 'type',
];

public static function install($params)
Expand DownExpand Up@@ -146,6 +148,11 @@ public static function rules($existing = null)
'required',
Rule::in(Script::scriptFormatValues()),
],
'type' => [
'sometimes',
new Enum(ScriptExecutorType::class),
'nullable',
],
];
}

Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/Models/ScriptExecutorVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
class ScriptExecutorVersion extends ProcessMakerModel
{
protected $fillable = [
'title', 'description', 'language', 'config', 'draft', 'is_system',
'title', 'description', 'language', 'config', 'draft', 'is_system', 'type',
];

/**
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/ScriptVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,15 +50,15 @@ public function parent()
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])
{
$script = $this->parent->replicate();
$except = $script->getGuarded();
foreach (collect($script->getAttributes())->except($except)->keys() as $prop) {
$script->$prop = $this->$prop;
}

return $script->runScript($data, $config, $tokenId, $timeout);
return $script->runScript($data, $config, $tokenId, $timeout, $sync, $metadata);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/ScriptRunners/Base.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ public function __construct(ScriptExecutor $scriptExecutor)
* @return array
* @throws RuntimeException
*/
public function run($code, array $data, array $config, $timeout, ?User $user)
public function run($code, array $data, array $config, $timeout, ?User $user, $sync, $metadata)
{
$isNayra = $this->scriptExecutor->language === self::NAYRA_LANG;

Expand Down
167 changes: 167 additions & 0 deletions ProcessMaker/ScriptRunners/ScriptMicroserviceRunner.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
<?php

namespace ProcessMaker\ScriptRunners;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\GenerateAccessToken;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
use stdClass;

class ScriptMicroserviceRunner
{
private string $tokenId = '';

private string $language;

public function __construct(protected Script $script)
{
$this->language = strtolower($script->language ?? $script->scriptExecutor->language);
}

public function getAccessToken()
{
if (Cache::has('keycloak.access_token')) {
return Cache::get('keycloak.access_token');
}

$response = Http::asForm()->post(config('script-runner-microservice.keycloak.base_url'), [
'grant_type' => 'password',
'client_id' => config('script-runner-microservice.keycloak.client_id'),
'client_secret' => config('script-runner-microservice.keycloak.client_secret'),
'username' => config('script-runner-microservice.keycloak.username'),
'password' => config('script-runner-microservice.keycloak.password'),
]);

if ($response->successful()) {
Cache::put('keycloak.access_token', $response->json()['access_token'], $response->json()['expires_in'] - 60);
}

return Cache::get('keycloak.access_token');
}

public function getScriptRunner()
{
$response = Cache::remember('script-runner-microservice.script-languages', now()->addDay(), function () {
return Http::withToken($this->getAccessToken())
->get(config('script-runner-microservice.base_url') . '/scripts')->collect();
});

return $response->filter(function ($item) {
return $item['language'] == $this->language;
})->first();
}

public function run($code, array $data, array $config, $timeout, $user, $sync, $metadata)
{
Log::debug('Language: ' . $this->language);
Log::debug('Sync: ' . $sync);
Log::debug('Metadata: ' . print_r($metadata, true));

$scriptRunner = $this->getScriptRunner();

if (!$scriptRunner) {
throw new ConfigurationException('No exists script executor for this language: ' . $this->language);
}
$metadata = array_merge($this->getMetadata($user), $metadata);
$environmentVariables = $this->getEnvironmentVariables($user);

$payload = [
'version' => config('script-runner-microservice.version') ?? $this->getProcessMakerVersion(),
'language' => $scriptRunner['language'],
'metadata'=> $metadata,
'data' => !empty($data) ? $this->sanitizeCss($data) : new stdClass(),
'config' => !empty($config) ? $config : new stdClass(),
'script' => base64_encode(str_replace("'", '&#39;', $code)),
'secrets' => $environmentVariables,
'callback' => config('script-runner-microservice.callback'),
'callback_secure' => true,
'callback_token' => $environmentVariables['API_TOKEN'],
'debug' => true,
'timeout' => $timeout,
'sync' => $sync,
];

Log::debug('Payload: ' . print_r($payload, true));

$response = Http::withToken($this->getAccessToken())
->post(config('script-runner-microservice.base_url') . '/requests/create', $payload);

$response->throw();

return $response->json();
}

private function getEnvironmentVariables(User $user)
{
$variablesParameter = [];
EnvironmentVariable::chunk(50, function (Collection $variables) use (&$variablesParameter) {
foreach ($variables as $variable) {
// Fix variables that have spaces
$variablesParameter[str_replace(' ', '_', $variable->name)] = $variable->value;
}
});

// Add the url to the host
$variablesParameter['HOST_URL'] = config('app.docker_host_url');

// Create tokens for the SDK if a user is set
$token = null;
if ($user) {
$accessToken = Cache::remember('script-runner-' . $user->id, now()->addWeek(), function () use ($user) {
$user->removeOldRunScriptTokens();
$token = new GenerateAccessToken($user);

return $token->getToken();
});
$variablesParameter['API_TOKEN'] = $accessToken;
$variablesParameter['API_HOST'] = config('app.docker_host_url') . '/api/1.0';
$variablesParameter['APP_URL'] = config('app.docker_host_url');
$variablesParameter['API_SSL_VERIFY'] = (config('app.api_ssl_verify') ? '1' : '0');
}

return $variablesParameter;
}

public function setTokenId($tokenId)
{
$this->tokenId = $tokenId;
}

public function getProcessMakerVersion()
{
return Cache::remember('script-runner-microservice.processmaker-version', now()->addDay(), function () {
$composer_json_path = json_decode(file_get_contents(base_path() . '/composer.json'));

return $composer_json_path->version;
});
}

public function getMetadata($user)
{
return [
'script_id' => $this->script->id,
'instance' => config('app.url'),
'user_id' => $user->id,
'user_email' => $user->email,
];
}

public function sanitizeCss($data)
{
if ($this->language !== 'javascript-ssr') {
return $data;
}
if (array_key_exists('css', $data)) {
$data['css'] = false;
}

return $data;
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions ProcessMaker/Enums/ScriptExecutorType.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<?php

namespace ProcessMaker\Enums;

enum ScriptExecutorType:string
{
case System = 'system';
case Custom = 'custom';
}
2 changes: 1 addition & 1 deletion ProcessMaker/Events/ScriptResponseEvent.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ private function cacheResponse()
public function broadcastWith()
{
$date = new Carbon();
$response = $this->cacheResponse($this->response);
$response = $this->cacheResponse();

return [
'type' => '.' . \get_class($this),
Expand Down
7 changes: 7 additions & 0 deletions ProcessMaker/Http/Controllers/Api/ScriptController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use ProcessMaker\Models\ScriptCategory;
use ProcessMaker\Models\User;
use ProcessMaker\Query\SyntaxError;
use ProcessMaker\Services\ScriptMicroserviceService;
use ProcessMaker\Traits\ProjectAssetTrait;

class ScriptController extends Controller
Expand DownExpand Up@@ -286,6 +287,12 @@ public function execution($key)
return response()->json(Cache::get("srn.{$key}"));
}

public function microserviceExecution(Request $request)
{
$scriptMicroserviceService = new ScriptMicroserviceService();
$scriptMicroserviceService->handle($request);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gusys should we add error handling to catch any potential exceptions from the microservice execution?


/**
* Get a single script in a process.
*
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,7 @@ public function index(Request $request)
*/
public function store(Request $request)
{
$request->request->add(['type' => 'custom']);
$this->checkAuth($request);
$request->validate(ScriptExecutor::rules());

Expand Down
28 changes: 22 additions & 6 deletions ProcessMaker/Jobs/RunScriptTask.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\Facades\WorkflowManager;
Expand DownExpand Up@@ -32,9 +33,9 @@ class RunScriptTask extends BpmnAction implements ShouldQueue
/**
* Create a new job instance.
*
* @param \ProcessMaker\Models\Process $definitions
* @param \ProcessMaker\Models\ProcessRequest $instance
* @param \ProcessMaker\Models\ProcessRequestToken $token
* @param Definitions $definitions
* @param ProcessRequest $instance
* @param ProcessRequestToken $token
* @param array $data
*/
public function __construct(Definitions $definitions, ProcessRequest $instance, ProcessRequestToken $token, array $data, $attemptNum = 1)
Expand DownExpand Up@@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
}

$errorHandling = null;
$scriptExecutor = null;
try {
if (empty($scriptRef)) {
$code = $element->getScript();
Expand All@@ -86,6 +88,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
if (!$script) {
throw new ConfigurationException(__('Script ":id" not found', ['id' => $scriptRef]));
}
$scriptExecutor = $script->scriptExecutor;
$script = $script->versionFor($instance);
}

Expand All@@ -95,9 +98,22 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
$this->unlock();
$dataManager = new DataManager();
$data = $dataManager->getData($token);
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout());

$this->updateData($response);
$metadata = [
'script_task' => [
'script_id' => $scriptRef,
'definition_id' => $this->definitionsId,
'instance_id' => $this->instanceId,
'token_id' => $this->tokenId,
'data' => $data,
'attempts' => $this->attemptNum,
],
];
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 0, $metadata);

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys if this is an asynchronous execution, what endpoint are we using for the callback? Is it /scripts/microservice/execution? Is that also the callback when executed from TestScript.php?


if (!config('script-runner-microservice.enabled') ||
($scriptExecutor && $scriptExecutor->type === ScriptExecutorType::Custom)) {
$this->updateData($response);
}
} catch (ConfigurationException $exception) {
$this->unlock();
$this->updateData(['output' => $exception->getMessageForData($token)]);
Expand Down
14 changes: 12 additions & 2 deletions ProcessMaker/Jobs/TestScript.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Events\ScriptResponseEvent;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
Expand DownExpand Up@@ -60,8 +61,17 @@ public function handle()
try {
// Just set the code but do not save the object (preview only)
$this->script->code = $this->code;
$response = $this->script->runScript($this->data, $this->configuration);
$this->sendResponse(200, $response);
$metadata = [
'nonce' => $this->nonce,
'current_user' => $this->current_user?->id,
];
$response = $this->script->runScript($this->data, $this->configuration, '', null, 0, $metadata);
\Log::debug('Response api microservice: ' . print_r($response, true));

if (!config('script-runner-microservice.enabled') ||
$this->script->scriptExecutor && $this->script->scriptExecutor->type === ScriptExecutorType::Custom) {
$this->sendResponse(200, $response);
}
} catch (Throwable $exception) {
$this->sendResponse(500, [
'exception' => get_class($exception),
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Models/Script.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -149,7 +149,7 @@ public static function rules($existing = null)
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys could you change $sync = 1 to bool $sync = true? You can change it in ScriptMicroserviceRunner if you need to send it as an integer 'sync' => $sync ? 1 : 0,

There are a few other places we call runScript, like RunServiceTask.php. Do those need to be updated?

{
if (!$timeout) {
$timeout = $this->timeout;
Expand All@@ -158,14 +158,14 @@ public function runScript(array $data, array $config, $tokenId = '', $timeout =
if (!$this->scriptExecutor) {
throw new ScriptLanguageNotSupported($this->language);
}
$runner = new ScriptRunner($this->scriptExecutor);
$runner = new ScriptRunner($this);
$runner->setTokenId($tokenId);
$user = User::find($this->run_as_user_id);
if (!$user) {
throw new ConfigurationException('A user is required to run scripts');
}

return $runner->run($this->code, $data, $config, $timeout, $user);
return $runner->run($this->code, $data, $config, $timeout, $user, $sync, $metadata);
}

/**
Expand Down
9 changes: 8 additions & 1 deletion ProcessMaker/Models/ScriptExecutor.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Enum;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ScriptLanguageNotSupported;
use ProcessMaker\Facades\Docker;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -56,7 +58,7 @@ class ScriptExecutor extends ProcessMakerModel
use HideSystemResources;

protected $fillable = [
'title', 'description', 'language', 'config', 'is_system',
'title', 'description', 'language', 'config', 'is_system', 'type',
];

public static function install($params)
Expand DownExpand Up@@ -146,6 +148,11 @@ public static function rules($existing = null)
'required',
Rule::in(Script::scriptFormatValues()),
],
'type' => [
'sometimes',
new Enum(ScriptExecutorType::class),
'nullable',
],
];
}

Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/Models/ScriptExecutorVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
class ScriptExecutorVersion extends ProcessMakerModel
{
protected $fillable = [
'title', 'description', 'language', 'config', 'draft', 'is_system',
'title', 'description', 'language', 'config', 'draft', 'is_system', 'type',
];

/**
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/ScriptVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,15 +50,15 @@ public function parent()
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])
{
$script = $this->parent->replicate();
$except = $script->getGuarded();
foreach (collect($script->getAttributes())->except($except)->keys() as $prop) {
$script->$prop = $this->$prop;
}

return $script->runScript($data, $config, $tokenId, $timeout);
return $script->runScript($data, $config, $tokenId, $timeout, $sync, $metadata);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/ScriptRunners/Base.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ public function __construct(ScriptExecutor $scriptExecutor)
* @return array
* @throws RuntimeException
*/
public function run($code, array $data, array $config, $timeout, ?User $user)
public function run($code, array $data, array $config, $timeout, ?User $user, $sync, $metadata)
{
$isNayra = $this->scriptExecutor->language === self::NAYRA_LANG;

Expand Down
167 changes: 167 additions & 0 deletions ProcessMaker/ScriptRunners/ScriptMicroserviceRunner.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
<?php

namespace ProcessMaker\ScriptRunners;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\GenerateAccessToken;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
use stdClass;

class ScriptMicroserviceRunner
{
private string $tokenId = '';

private string $language;

public function __construct(protected Script $script)
{
$this->language = strtolower($script->language ?? $script->scriptExecutor->language);
}

public function getAccessToken()
{
if (Cache::has('keycloak.access_token')) {
return Cache::get('keycloak.access_token');
}

$response = Http::asForm()->post(config('script-runner-microservice.keycloak.base_url'), [
'grant_type' => 'password',
'client_id' => config('script-runner-microservice.keycloak.client_id'),
'client_secret' => config('script-runner-microservice.keycloak.client_secret'),
'username' => config('script-runner-microservice.keycloak.username'),
'password' => config('script-runner-microservice.keycloak.password'),
]);

if ($response->successful()) {
Cache::put('keycloak.access_token', $response->json()['access_token'], $response->json()['expires_in'] - 60);
}

return Cache::get('keycloak.access_token');
}

public function getScriptRunner()
{
$response = Cache::remember('script-runner-microservice.script-languages', now()->addDay(), function () {
return Http::withToken($this->getAccessToken())
->get(config('script-runner-microservice.base_url') . '/scripts')->collect();
});

return $response->filter(function ($item) {
return $item['language'] == $this->language;
})->first();
}

public function run($code, array $data, array $config, $timeout, $user, $sync, $metadata)
{
Log::debug('Language: ' . $this->language);
Log::debug('Sync: ' . $sync);
Log::debug('Metadata: ' . print_r($metadata, true));

$scriptRunner = $this->getScriptRunner();

if (!$scriptRunner) {
throw new ConfigurationException('No exists script executor for this language: ' . $this->language);
}
$metadata = array_merge($this->getMetadata($user), $metadata);
$environmentVariables = $this->getEnvironmentVariables($user);

$payload = [
'version' => config('script-runner-microservice.version') ?? $this->getProcessMakerVersion(),
'language' => $scriptRunner['language'],
'metadata'=> $metadata,
'data' => !empty($data) ? $this->sanitizeCss($data) : new stdClass(),
'config' => !empty($config) ? $config : new stdClass(),
'script' => base64_encode(str_replace("'", '&#39;', $code)),
'secrets' => $environmentVariables,
'callback' => config('script-runner-microservice.callback'),
'callback_secure' => true,
'callback_token' => $environmentVariables['API_TOKEN'],
'debug' => true,
'timeout' => $timeout,
'sync' => $sync,
];

Log::debug('Payload: ' . print_r($payload, true));

$response = Http::withToken($this->getAccessToken())
->post(config('script-runner-microservice.base_url') . '/requests/create', $payload);

$response->throw();

return $response->json();
}

private function getEnvironmentVariables(User $user)
{
$variablesParameter = [];
EnvironmentVariable::chunk(50, function (Collection $variables) use (&$variablesParameter) {
foreach ($variables as $variable) {
// Fix variables that have spaces
$variablesParameter[str_replace(' ', '_', $variable->name)] = $variable->value;
}
});

// Add the url to the host
$variablesParameter['HOST_URL'] = config('app.docker_host_url');

// Create tokens for the SDK if a user is set
$token = null;
if ($user) {
$accessToken = Cache::remember('script-runner-' . $user->id, now()->addWeek(), function () use ($user) {
$user->removeOldRunScriptTokens();
$token = new GenerateAccessToken($user);

return $token->getToken();
});
$variablesParameter['API_TOKEN'] = $accessToken;
$variablesParameter['API_HOST'] = config('app.docker_host_url') . '/api/1.0';
$variablesParameter['APP_URL'] = config('app.docker_host_url');
$variablesParameter['API_SSL_VERIFY'] = (config('app.api_ssl_verify') ? '1' : '0');
}

return $variablesParameter;
}

public function setTokenId($tokenId)
{
$this->tokenId = $tokenId;
}

public function getProcessMakerVersion()
{
return Cache::remember('script-runner-microservice.processmaker-version', now()->addDay(), function () {
$composer_json_path = json_decode(file_get_contents(base_path() . '/composer.json'));

return $composer_json_path->version;
});
}

public function getMetadata($user)
{
return [
'script_id' => $this->script->id,
'instance' => config('app.url'),
'user_id' => $user->id,
'user_email' => $user->email,
];
}

public function sanitizeCss($data)
{
if ($this->language !== 'javascript-ssr') {
return $data;
}
if (array_key_exists('css', $data)) {
$data['css'] = false;
}

return $data;
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions ProcessMaker/Enums/ScriptExecutorType.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<?php

namespace ProcessMaker\Enums;

enum ScriptExecutorType:string
{
case System = 'system';
case Custom = 'custom';
}
2 changes: 1 addition & 1 deletion ProcessMaker/Events/ScriptResponseEvent.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ private function cacheResponse()
public function broadcastWith()
{
$date = new Carbon();
$response = $this->cacheResponse($this->response);
$response = $this->cacheResponse();

return [
'type' => '.' . \get_class($this),
Expand Down
7 changes: 7 additions & 0 deletions ProcessMaker/Http/Controllers/Api/ScriptController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use ProcessMaker\Models\ScriptCategory;
use ProcessMaker\Models\User;
use ProcessMaker\Query\SyntaxError;
use ProcessMaker\Services\ScriptMicroserviceService;
use ProcessMaker\Traits\ProjectAssetTrait;

class ScriptController extends Controller
Expand DownExpand Up@@ -286,6 +287,12 @@ public function execution($key)
return response()->json(Cache::get("srn.{$key}"));
}

public function microserviceExecution(Request $request)
{
$scriptMicroserviceService = new ScriptMicroserviceService();
$scriptMicroserviceService->handle($request);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gusys should we add error handling to catch any potential exceptions from the microservice execution?


/**
* Get a single script in a process.
*
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,7 @@ public function index(Request $request)
*/
public function store(Request $request)
{
$request->request->add(['type' => 'custom']);
$this->checkAuth($request);
$request->validate(ScriptExecutor::rules());

Expand Down
28 changes: 22 additions & 6 deletions ProcessMaker/Jobs/RunScriptTask.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\Facades\WorkflowManager;
Expand DownExpand Up@@ -32,9 +33,9 @@ class RunScriptTask extends BpmnAction implements ShouldQueue
/**
* Create a new job instance.
*
* @param \ProcessMaker\Models\Process $definitions
* @param \ProcessMaker\Models\ProcessRequest $instance
* @param \ProcessMaker\Models\ProcessRequestToken $token
* @param Definitions $definitions
* @param ProcessRequest $instance
* @param ProcessRequestToken $token
* @param array $data
*/
public function __construct(Definitions $definitions, ProcessRequest $instance, ProcessRequestToken $token, array $data, $attemptNum = 1)
Expand DownExpand Up@@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
}

$errorHandling = null;
$scriptExecutor = null;
try {
if (empty($scriptRef)) {
$code = $element->getScript();
Expand All@@ -86,6 +88,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
if (!$script) {
throw new ConfigurationException(__('Script ":id" not found', ['id' => $scriptRef]));
}
$scriptExecutor = $script->scriptExecutor;
$script = $script->versionFor($instance);
}

Expand All@@ -95,9 +98,22 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
$this->unlock();
$dataManager = new DataManager();
$data = $dataManager->getData($token);
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout());

$this->updateData($response);
$metadata = [
'script_task' => [
'script_id' => $scriptRef,
'definition_id' => $this->definitionsId,
'instance_id' => $this->instanceId,
'token_id' => $this->tokenId,
'data' => $data,
'attempts' => $this->attemptNum,
],
];
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 0, $metadata);

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys if this is an asynchronous execution, what endpoint are we using for the callback? Is it /scripts/microservice/execution? Is that also the callback when executed from TestScript.php?


if (!config('script-runner-microservice.enabled') ||
($scriptExecutor && $scriptExecutor->type === ScriptExecutorType::Custom)) {
$this->updateData($response);
}
} catch (ConfigurationException $exception) {
$this->unlock();
$this->updateData(['output' => $exception->getMessageForData($token)]);
Expand Down
14 changes: 12 additions & 2 deletions ProcessMaker/Jobs/TestScript.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Events\ScriptResponseEvent;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
Expand DownExpand Up@@ -60,8 +61,17 @@ public function handle()
try {
// Just set the code but do not save the object (preview only)
$this->script->code = $this->code;
$response = $this->script->runScript($this->data, $this->configuration);
$this->sendResponse(200, $response);
$metadata = [
'nonce' => $this->nonce,
'current_user' => $this->current_user?->id,
];
$response = $this->script->runScript($this->data, $this->configuration, '', null, 0, $metadata);
\Log::debug('Response api microservice: ' . print_r($response, true));

if (!config('script-runner-microservice.enabled') ||
$this->script->scriptExecutor && $this->script->scriptExecutor->type === ScriptExecutorType::Custom) {
$this->sendResponse(200, $response);
}
} catch (Throwable $exception) {
$this->sendResponse(500, [
'exception' => get_class($exception),
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Models/Script.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -149,7 +149,7 @@ public static function rules($existing = null)
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys could you change $sync = 1 to bool $sync = true? You can change it in ScriptMicroserviceRunner if you need to send it as an integer 'sync' => $sync ? 1 : 0,

There are a few other places we call runScript, like RunServiceTask.php. Do those need to be updated?

{
if (!$timeout) {
$timeout = $this->timeout;
Expand All@@ -158,14 +158,14 @@ public function runScript(array $data, array $config, $tokenId = '', $timeout =
if (!$this->scriptExecutor) {
throw new ScriptLanguageNotSupported($this->language);
}
$runner = new ScriptRunner($this->scriptExecutor);
$runner = new ScriptRunner($this);
$runner->setTokenId($tokenId);
$user = User::find($this->run_as_user_id);
if (!$user) {
throw new ConfigurationException('A user is required to run scripts');
}

return $runner->run($this->code, $data, $config, $timeout, $user);
return $runner->run($this->code, $data, $config, $timeout, $user, $sync, $metadata);
}

/**
Expand Down
9 changes: 8 additions & 1 deletion ProcessMaker/Models/ScriptExecutor.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Enum;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ScriptLanguageNotSupported;
use ProcessMaker\Facades\Docker;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -56,7 +58,7 @@ class ScriptExecutor extends ProcessMakerModel
use HideSystemResources;

protected $fillable = [
'title', 'description', 'language', 'config', 'is_system',
'title', 'description', 'language', 'config', 'is_system', 'type',
];

public static function install($params)
Expand DownExpand Up@@ -146,6 +148,11 @@ public static function rules($existing = null)
'required',
Rule::in(Script::scriptFormatValues()),
],
'type' => [
'sometimes',
new Enum(ScriptExecutorType::class),
'nullable',
],
];
}

Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/Models/ScriptExecutorVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
class ScriptExecutorVersion extends ProcessMakerModel
{
protected $fillable = [
'title', 'description', 'language', 'config', 'draft', 'is_system',
'title', 'description', 'language', 'config', 'draft', 'is_system', 'type',
];

/**
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/ScriptVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,15 +50,15 @@ public function parent()
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])
{
$script = $this->parent->replicate();
$except = $script->getGuarded();
foreach (collect($script->getAttributes())->except($except)->keys() as $prop) {
$script->$prop = $this->$prop;
}

return $script->runScript($data, $config, $tokenId, $timeout);
return $script->runScript($data, $config, $tokenId, $timeout, $sync, $metadata);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/ScriptRunners/Base.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ public function __construct(ScriptExecutor $scriptExecutor)
* @return array
* @throws RuntimeException
*/
public function run($code, array $data, array $config, $timeout, ?User $user)
public function run($code, array $data, array $config, $timeout, ?User $user, $sync, $metadata)
{
$isNayra = $this->scriptExecutor->language === self::NAYRA_LANG;

Expand Down
167 changes: 167 additions & 0 deletions ProcessMaker/ScriptRunners/ScriptMicroserviceRunner.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
<?php

namespace ProcessMaker\ScriptRunners;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\GenerateAccessToken;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
use stdClass;

class ScriptMicroserviceRunner
{
private string $tokenId = '';

private string $language;

public function __construct(protected Script $script)
{
$this->language = strtolower($script->language ?? $script->scriptExecutor->language);
}

public function getAccessToken()
{
if (Cache::has('keycloak.access_token')) {
return Cache::get('keycloak.access_token');
}

$response = Http::asForm()->post(config('script-runner-microservice.keycloak.base_url'), [
'grant_type' => 'password',
'client_id' => config('script-runner-microservice.keycloak.client_id'),
'client_secret' => config('script-runner-microservice.keycloak.client_secret'),
'username' => config('script-runner-microservice.keycloak.username'),
'password' => config('script-runner-microservice.keycloak.password'),
]);

if ($response->successful()) {
Cache::put('keycloak.access_token', $response->json()['access_token'], $response->json()['expires_in'] - 60);
}

return Cache::get('keycloak.access_token');
}

public function getScriptRunner()
{
$response = Cache::remember('script-runner-microservice.script-languages', now()->addDay(), function () {
return Http::withToken($this->getAccessToken())
->get(config('script-runner-microservice.base_url') . '/scripts')->collect();
});

return $response->filter(function ($item) {
return $item['language'] == $this->language;
})->first();
}

public function run($code, array $data, array $config, $timeout, $user, $sync, $metadata)
{
Log::debug('Language: ' . $this->language);
Log::debug('Sync: ' . $sync);
Log::debug('Metadata: ' . print_r($metadata, true));

$scriptRunner = $this->getScriptRunner();

if (!$scriptRunner) {
throw new ConfigurationException('No exists script executor for this language: ' . $this->language);
}
$metadata = array_merge($this->getMetadata($user), $metadata);
$environmentVariables = $this->getEnvironmentVariables($user);

$payload = [
'version' => config('script-runner-microservice.version') ?? $this->getProcessMakerVersion(),
'language' => $scriptRunner['language'],
'metadata'=> $metadata,
'data' => !empty($data) ? $this->sanitizeCss($data) : new stdClass(),
'config' => !empty($config) ? $config : new stdClass(),
'script' => base64_encode(str_replace("'", '&#39;', $code)),
'secrets' => $environmentVariables,
'callback' => config('script-runner-microservice.callback'),
'callback_secure' => true,
'callback_token' => $environmentVariables['API_TOKEN'],
'debug' => true,
'timeout' => $timeout,
'sync' => $sync,
];

Log::debug('Payload: ' . print_r($payload, true));

$response = Http::withToken($this->getAccessToken())
->post(config('script-runner-microservice.base_url') . '/requests/create', $payload);

$response->throw();

return $response->json();
}

private function getEnvironmentVariables(User $user)
{
$variablesParameter = [];
EnvironmentVariable::chunk(50, function (Collection $variables) use (&$variablesParameter) {
foreach ($variables as $variable) {
// Fix variables that have spaces
$variablesParameter[str_replace(' ', '_', $variable->name)] = $variable->value;
}
});

// Add the url to the host
$variablesParameter['HOST_URL'] = config('app.docker_host_url');

// Create tokens for the SDK if a user is set
$token = null;
if ($user) {
$accessToken = Cache::remember('script-runner-' . $user->id, now()->addWeek(), function () use ($user) {
$user->removeOldRunScriptTokens();
$token = new GenerateAccessToken($user);

return $token->getToken();
});
$variablesParameter['API_TOKEN'] = $accessToken;
$variablesParameter['API_HOST'] = config('app.docker_host_url') . '/api/1.0';
$variablesParameter['APP_URL'] = config('app.docker_host_url');
$variablesParameter['API_SSL_VERIFY'] = (config('app.api_ssl_verify') ? '1' : '0');
}

return $variablesParameter;
}

public function setTokenId($tokenId)
{
$this->tokenId = $tokenId;
}

public function getProcessMakerVersion()
{
return Cache::remember('script-runner-microservice.processmaker-version', now()->addDay(), function () {
$composer_json_path = json_decode(file_get_contents(base_path() . '/composer.json'));

return $composer_json_path->version;
});
}

public function getMetadata($user)
{
return [
'script_id' => $this->script->id,
'instance' => config('app.url'),
'user_id' => $user->id,
'user_email' => $user->email,
];
}

public function sanitizeCss($data)
{
if ($this->language !== 'javascript-ssr') {
return $data;
}
if (array_key_exists('css', $data)) {
$data['css'] = false;
}

return $data;
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions ProcessMaker/Enums/ScriptExecutorType.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<?php

namespace ProcessMaker\Enums;

enum ScriptExecutorType:string
{
case System = 'system';
case Custom = 'custom';
}
2 changes: 1 addition & 1 deletion ProcessMaker/Events/ScriptResponseEvent.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ private function cacheResponse()
public function broadcastWith()
{
$date = new Carbon();
$response = $this->cacheResponse($this->response);
$response = $this->cacheResponse();

return [
'type' => '.' . \get_class($this),
Expand Down
7 changes: 7 additions & 0 deletions ProcessMaker/Http/Controllers/Api/ScriptController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use ProcessMaker\Models\ScriptCategory;
use ProcessMaker\Models\User;
use ProcessMaker\Query\SyntaxError;
use ProcessMaker\Services\ScriptMicroserviceService;
use ProcessMaker\Traits\ProjectAssetTrait;

class ScriptController extends Controller
Expand DownExpand Up@@ -286,6 +287,12 @@ public function execution($key)
return response()->json(Cache::get("srn.{$key}"));
}

public function microserviceExecution(Request $request)
{
$scriptMicroserviceService = new ScriptMicroserviceService();
$scriptMicroserviceService->handle($request);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gusys should we add error handling to catch any potential exceptions from the microservice execution?


/**
* Get a single script in a process.
*
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,7 @@ public function index(Request $request)
*/
public function store(Request $request)
{
$request->request->add(['type' => 'custom']);
$this->checkAuth($request);
$request->validate(ScriptExecutor::rules());

Expand Down
28 changes: 22 additions & 6 deletions ProcessMaker/Jobs/RunScriptTask.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\Facades\WorkflowManager;
Expand DownExpand Up@@ -32,9 +33,9 @@ class RunScriptTask extends BpmnAction implements ShouldQueue
/**
* Create a new job instance.
*
* @param \ProcessMaker\Models\Process $definitions
* @param \ProcessMaker\Models\ProcessRequest $instance
* @param \ProcessMaker\Models\ProcessRequestToken $token
* @param Definitions $definitions
* @param ProcessRequest $instance
* @param ProcessRequestToken $token
* @param array $data
*/
public function __construct(Definitions $definitions, ProcessRequest $instance, ProcessRequestToken $token, array $data, $attemptNum = 1)
Expand DownExpand Up@@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
}

$errorHandling = null;
$scriptExecutor = null;
try {
if (empty($scriptRef)) {
$code = $element->getScript();
Expand All@@ -86,6 +88,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
if (!$script) {
throw new ConfigurationException(__('Script ":id" not found', ['id' => $scriptRef]));
}
$scriptExecutor = $script->scriptExecutor;
$script = $script->versionFor($instance);
}

Expand All@@ -95,9 +98,22 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
$this->unlock();
$dataManager = new DataManager();
$data = $dataManager->getData($token);
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout());

$this->updateData($response);
$metadata = [
'script_task' => [
'script_id' => $scriptRef,
'definition_id' => $this->definitionsId,
'instance_id' => $this->instanceId,
'token_id' => $this->tokenId,
'data' => $data,
'attempts' => $this->attemptNum,
],
];
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 0, $metadata);

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys if this is an asynchronous execution, what endpoint are we using for the callback? Is it /scripts/microservice/execution? Is that also the callback when executed from TestScript.php?


if (!config('script-runner-microservice.enabled') ||
($scriptExecutor && $scriptExecutor->type === ScriptExecutorType::Custom)) {
$this->updateData($response);
}
} catch (ConfigurationException $exception) {
$this->unlock();
$this->updateData(['output' => $exception->getMessageForData($token)]);
Expand Down
14 changes: 12 additions & 2 deletions ProcessMaker/Jobs/TestScript.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Events\ScriptResponseEvent;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
Expand DownExpand Up@@ -60,8 +61,17 @@ public function handle()
try {
// Just set the code but do not save the object (preview only)
$this->script->code = $this->code;
$response = $this->script->runScript($this->data, $this->configuration);
$this->sendResponse(200, $response);
$metadata = [
'nonce' => $this->nonce,
'current_user' => $this->current_user?->id,
];
$response = $this->script->runScript($this->data, $this->configuration, '', null, 0, $metadata);
\Log::debug('Response api microservice: ' . print_r($response, true));

if (!config('script-runner-microservice.enabled') ||
$this->script->scriptExecutor && $this->script->scriptExecutor->type === ScriptExecutorType::Custom) {
$this->sendResponse(200, $response);
}
} catch (Throwable $exception) {
$this->sendResponse(500, [
'exception' => get_class($exception),
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Models/Script.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -149,7 +149,7 @@ public static function rules($existing = null)
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys could you change $sync = 1 to bool $sync = true? You can change it in ScriptMicroserviceRunner if you need to send it as an integer 'sync' => $sync ? 1 : 0,

There are a few other places we call runScript, like RunServiceTask.php. Do those need to be updated?

{
if (!$timeout) {
$timeout = $this->timeout;
Expand All@@ -158,14 +158,14 @@ public function runScript(array $data, array $config, $tokenId = '', $timeout =
if (!$this->scriptExecutor) {
throw new ScriptLanguageNotSupported($this->language);
}
$runner = new ScriptRunner($this->scriptExecutor);
$runner = new ScriptRunner($this);
$runner->setTokenId($tokenId);
$user = User::find($this->run_as_user_id);
if (!$user) {
throw new ConfigurationException('A user is required to run scripts');
}

return $runner->run($this->code, $data, $config, $timeout, $user);
return $runner->run($this->code, $data, $config, $timeout, $user, $sync, $metadata);
}

/**
Expand Down
9 changes: 8 additions & 1 deletion ProcessMaker/Models/ScriptExecutor.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Enum;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ScriptLanguageNotSupported;
use ProcessMaker\Facades\Docker;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -56,7 +58,7 @@ class ScriptExecutor extends ProcessMakerModel
use HideSystemResources;

protected $fillable = [
'title', 'description', 'language', 'config', 'is_system',
'title', 'description', 'language', 'config', 'is_system', 'type',
];

public static function install($params)
Expand DownExpand Up@@ -146,6 +148,11 @@ public static function rules($existing = null)
'required',
Rule::in(Script::scriptFormatValues()),
],
'type' => [
'sometimes',
new Enum(ScriptExecutorType::class),
'nullable',
],
];
}

Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/Models/ScriptExecutorVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
class ScriptExecutorVersion extends ProcessMakerModel
{
protected $fillable = [
'title', 'description', 'language', 'config', 'draft', 'is_system',
'title', 'description', 'language', 'config', 'draft', 'is_system', 'type',
];

/**
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/ScriptVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,15 +50,15 @@ public function parent()
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])
{
$script = $this->parent->replicate();
$except = $script->getGuarded();
foreach (collect($script->getAttributes())->except($except)->keys() as $prop) {
$script->$prop = $this->$prop;
}

return $script->runScript($data, $config, $tokenId, $timeout);
return $script->runScript($data, $config, $tokenId, $timeout, $sync, $metadata);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/ScriptRunners/Base.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ public function __construct(ScriptExecutor $scriptExecutor)
* @return array
* @throws RuntimeException
*/
public function run($code, array $data, array $config, $timeout, ?User $user)
public function run($code, array $data, array $config, $timeout, ?User $user, $sync, $metadata)
{
$isNayra = $this->scriptExecutor->language === self::NAYRA_LANG;

Expand Down
167 changes: 167 additions & 0 deletions ProcessMaker/ScriptRunners/ScriptMicroserviceRunner.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
<?php

namespace ProcessMaker\ScriptRunners;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\GenerateAccessToken;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
use stdClass;

class ScriptMicroserviceRunner
{
private string $tokenId = '';

private string $language;

public function __construct(protected Script $script)
{
$this->language = strtolower($script->language ?? $script->scriptExecutor->language);
}

public function getAccessToken()
{
if (Cache::has('keycloak.access_token')) {
return Cache::get('keycloak.access_token');
}

$response = Http::asForm()->post(config('script-runner-microservice.keycloak.base_url'), [
'grant_type' => 'password',
'client_id' => config('script-runner-microservice.keycloak.client_id'),
'client_secret' => config('script-runner-microservice.keycloak.client_secret'),
'username' => config('script-runner-microservice.keycloak.username'),
'password' => config('script-runner-microservice.keycloak.password'),
]);

if ($response->successful()) {
Cache::put('keycloak.access_token', $response->json()['access_token'], $response->json()['expires_in'] - 60);
}

return Cache::get('keycloak.access_token');
}

public function getScriptRunner()
{
$response = Cache::remember('script-runner-microservice.script-languages', now()->addDay(), function () {
return Http::withToken($this->getAccessToken())
->get(config('script-runner-microservice.base_url') . '/scripts')->collect();
});

return $response->filter(function ($item) {
return $item['language'] == $this->language;
})->first();
}

public function run($code, array $data, array $config, $timeout, $user, $sync, $metadata)
{
Log::debug('Language: ' . $this->language);
Log::debug('Sync: ' . $sync);
Log::debug('Metadata: ' . print_r($metadata, true));

$scriptRunner = $this->getScriptRunner();

if (!$scriptRunner) {
throw new ConfigurationException('No exists script executor for this language: ' . $this->language);
}
$metadata = array_merge($this->getMetadata($user), $metadata);
$environmentVariables = $this->getEnvironmentVariables($user);

$payload = [
'version' => config('script-runner-microservice.version') ?? $this->getProcessMakerVersion(),
'language' => $scriptRunner['language'],
'metadata'=> $metadata,
'data' => !empty($data) ? $this->sanitizeCss($data) : new stdClass(),
'config' => !empty($config) ? $config : new stdClass(),
'script' => base64_encode(str_replace("'", '&#39;', $code)),
'secrets' => $environmentVariables,
'callback' => config('script-runner-microservice.callback'),
'callback_secure' => true,
'callback_token' => $environmentVariables['API_TOKEN'],
'debug' => true,
'timeout' => $timeout,
'sync' => $sync,
];

Log::debug('Payload: ' . print_r($payload, true));

$response = Http::withToken($this->getAccessToken())
->post(config('script-runner-microservice.base_url') . '/requests/create', $payload);

$response->throw();

return $response->json();
}

private function getEnvironmentVariables(User $user)
{
$variablesParameter = [];
EnvironmentVariable::chunk(50, function (Collection $variables) use (&$variablesParameter) {
foreach ($variables as $variable) {
// Fix variables that have spaces
$variablesParameter[str_replace(' ', '_', $variable->name)] = $variable->value;
}
});

// Add the url to the host
$variablesParameter['HOST_URL'] = config('app.docker_host_url');

// Create tokens for the SDK if a user is set
$token = null;
if ($user) {
$accessToken = Cache::remember('script-runner-' . $user->id, now()->addWeek(), function () use ($user) {
$user->removeOldRunScriptTokens();
$token = new GenerateAccessToken($user);

return $token->getToken();
});
$variablesParameter['API_TOKEN'] = $accessToken;
$variablesParameter['API_HOST'] = config('app.docker_host_url') . '/api/1.0';
$variablesParameter['APP_URL'] = config('app.docker_host_url');
$variablesParameter['API_SSL_VERIFY'] = (config('app.api_ssl_verify') ? '1' : '0');
}

return $variablesParameter;
}

public function setTokenId($tokenId)
{
$this->tokenId = $tokenId;
}

public function getProcessMakerVersion()
{
return Cache::remember('script-runner-microservice.processmaker-version', now()->addDay(), function () {
$composer_json_path = json_decode(file_get_contents(base_path() . '/composer.json'));

return $composer_json_path->version;
});
}

public function getMetadata($user)
{
return [
'script_id' => $this->script->id,
'instance' => config('app.url'),
'user_id' => $user->id,
'user_email' => $user->email,
];
}

public function sanitizeCss($data)
{
if ($this->language !== 'javascript-ssr') {
return $data;
}
if (array_key_exists('css', $data)) {
$data['css'] = false;
}

return $data;
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions ProcessMaker/Enums/ScriptExecutorType.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
<?php

namespace ProcessMaker\Enums;

enum ScriptExecutorType:string
{
case System = 'system';
case Custom = 'custom';
}
2 changes: 1 addition & 1 deletion ProcessMaker/Events/ScriptResponseEvent.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ private function cacheResponse()
public function broadcastWith()
{
$date = new Carbon();
$response = $this->cacheResponse($this->response);
$response = $this->cacheResponse();

return [
'type' => '.' . \get_class($this),
Expand Down
7 changes: 7 additions & 0 deletions ProcessMaker/Http/Controllers/Api/ScriptController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
use ProcessMaker\Models\ScriptCategory;
use ProcessMaker\Models\User;
use ProcessMaker\Query\SyntaxError;
use ProcessMaker\Services\ScriptMicroserviceService;
use ProcessMaker\Traits\ProjectAssetTrait;

class ScriptController extends Controller
Expand DownExpand Up@@ -286,6 +287,12 @@ public function execution($key)
return response()->json(Cache::get("srn.{$key}"));
}

public function microserviceExecution(Request $request)
{
$scriptMicroserviceService = new ScriptMicroserviceService();
$scriptMicroserviceService->handle($request);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @gusys should we add error handling to catch any potential exceptions from the microservice execution?


/**
* Get a single script in a process.
*
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,6 +103,7 @@ public function index(Request $request)
*/
public function store(Request $request)
{
$request->request->add(['type' => 'custom']);
$this->checkAuth($request);
$request->validate(ScriptExecutor::rules());

Expand Down
28 changes: 22 additions & 6 deletions ProcessMaker/Jobs/RunScriptTask.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\Facades\WorkflowManager;
Expand DownExpand Up@@ -32,9 +33,9 @@ class RunScriptTask extends BpmnAction implements ShouldQueue
/**
* Create a new job instance.
*
* @param \ProcessMaker\Models\Process $definitions
* @param \ProcessMaker\Models\ProcessRequest $instance
* @param \ProcessMaker\Models\ProcessRequestToken $token
* @param Definitions $definitions
* @param ProcessRequest $instance
* @param ProcessRequestToken $token
* @param array $data
*/
public function __construct(Definitions $definitions, ProcessRequest $instance, ProcessRequestToken $token, array $data, $attemptNum = 1)
Expand DownExpand Up@@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
}

$errorHandling = null;
$scriptExecutor = null;
try {
if (empty($scriptRef)) {
$code = $element->getScript();
Expand All@@ -86,6 +88,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
if (!$script) {
throw new ConfigurationException(__('Script ":id" not found', ['id' => $scriptRef]));
}
$scriptExecutor = $script->scriptExecutor;
$script = $script->versionFor($instance);
}

Expand All@@ -95,9 +98,22 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
$this->unlock();
$dataManager = new DataManager();
$data = $dataManager->getData($token);
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout());

$this->updateData($response);
$metadata = [
'script_task' => [
'script_id' => $scriptRef,
'definition_id' => $this->definitionsId,
'instance_id' => $this->instanceId,
'token_id' => $this->tokenId,
'data' => $data,
'attempts' => $this->attemptNum,
],
];
$response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 0, $metadata);

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys if this is an asynchronous execution, what endpoint are we using for the callback? Is it /scripts/microservice/execution? Is that also the callback when executed from TestScript.php?


if (!config('script-runner-microservice.enabled') ||
($scriptExecutor && $scriptExecutor->type === ScriptExecutorType::Custom)) {
$this->updateData($response);
}
} catch (ConfigurationException $exception) {
$this->unlock();
$this->updateData(['output' => $exception->getMessageForData($token)]);
Expand Down
14 changes: 12 additions & 2 deletions ProcessMaker/Jobs/TestScript.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Events\ScriptResponseEvent;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
Expand DownExpand Up@@ -60,8 +61,17 @@ public function handle()
try {
// Just set the code but do not save the object (preview only)
$this->script->code = $this->code;
$response = $this->script->runScript($this->data, $this->configuration);
$this->sendResponse(200, $response);
$metadata = [
'nonce' => $this->nonce,
'current_user' => $this->current_user?->id,
];
$response = $this->script->runScript($this->data, $this->configuration, '', null, 0, $metadata);
\Log::debug('Response api microservice: ' . print_r($response, true));

if (!config('script-runner-microservice.enabled') ||
$this->script->scriptExecutor && $this->script->scriptExecutor->type === ScriptExecutorType::Custom) {
$this->sendResponse(200, $response);
}
} catch (Throwable $exception) {
$this->sendResponse(500, [
'exception' => get_class($exception),
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Models/Script.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -149,7 +149,7 @@ public static function rules($existing = null)
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])

@nolanpronolanproJan 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gusys could you change $sync = 1 to bool $sync = true? You can change it in ScriptMicroserviceRunner if you need to send it as an integer 'sync' => $sync ? 1 : 0,

There are a few other places we call runScript, like RunServiceTask.php. Do those need to be updated?

{
if (!$timeout) {
$timeout = $this->timeout;
Expand All@@ -158,14 +158,14 @@ public function runScript(array $data, array $config, $tokenId = '', $timeout =
if (!$this->scriptExecutor) {
throw new ScriptLanguageNotSupported($this->language);
}
$runner = new ScriptRunner($this->scriptExecutor);
$runner = new ScriptRunner($this);
$runner->setTokenId($tokenId);
$user = User::find($this->run_as_user_id);
if (!$user) {
throw new ConfigurationException('A user is required to run scripts');
}

return $runner->run($this->code, $data, $config, $timeout, $user);
return $runner->run($this->code, $data, $config, $timeout, $user, $sync, $metadata);
}

/**
Expand Down
9 changes: 8 additions & 1 deletion ProcessMaker/Models/ScriptExecutor.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\Enum;
use ProcessMaker\Enums\ScriptExecutorType;
use ProcessMaker\Exception\ScriptLanguageNotSupported;
use ProcessMaker\Facades\Docker;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -56,7 +58,7 @@ class ScriptExecutor extends ProcessMakerModel
use HideSystemResources;

protected $fillable = [
'title', 'description', 'language', 'config', 'is_system',
'title', 'description', 'language', 'config', 'is_system', 'type',
];

public static function install($params)
Expand DownExpand Up@@ -146,6 +148,11 @@ public static function rules($existing = null)
'required',
Rule::in(Script::scriptFormatValues()),
],
'type' => [
'sometimes',
new Enum(ScriptExecutorType::class),
'nullable',
],
];
}

Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/Models/ScriptExecutorVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
class ScriptExecutorVersion extends ProcessMakerModel
{
protected $fillable = [
'title', 'description', 'language', 'config', 'draft', 'is_system',
'title', 'description', 'language', 'config', 'draft', 'is_system', 'type',
];

/**
Expand Down
4 changes: 2 additions & 2 deletions ProcessMaker/Models/ScriptVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,15 +50,15 @@ public function parent()
* @param array $data
* @param array $config
*/
public function runScript(array $data, array $config, $tokenId = '', $timeout = null)
public function runScript(array $data, array $config, $tokenId = '', $timeout = null, $sync = 1, $metadata = [])
{
$script = $this->parent->replicate();
$except = $script->getGuarded();
foreach (collect($script->getAttributes())->except($except)->keys() as $prop) {
$script->$prop = $this->$prop;
}

return $script->runScript($data, $config, $tokenId, $timeout);
return $script->runScript($data, $config, $tokenId, $timeout, $sync, $metadata);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ProcessMaker/ScriptRunners/Base.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,7 +65,7 @@ public function __construct(ScriptExecutor $scriptExecutor)
* @return array
* @throws RuntimeException
*/
public function run($code, array $data, array $config, $timeout, ?User $user)
public function run($code, array $data, array $config, $timeout, ?User $user, $sync, $metadata)
{
$isNayra = $this->scriptExecutor->language === self::NAYRA_LANG;

Expand Down
167 changes: 167 additions & 0 deletions ProcessMaker/ScriptRunners/ScriptMicroserviceRunner.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
<?php

namespace ProcessMaker\ScriptRunners;

use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\ConfigurationException;
use ProcessMaker\Exception\ScriptException;
use ProcessMaker\GenerateAccessToken;
use ProcessMaker\Models\EnvironmentVariable;
use ProcessMaker\Models\Script;
use ProcessMaker\Models\User;
use stdClass;

class ScriptMicroserviceRunner
{
private string $tokenId = '';

private string $language;

public function __construct(protected Script $script)
{
$this->language = strtolower($script->language ?? $script->scriptExecutor->language);
}

public function getAccessToken()
{
if (Cache::has('keycloak.access_token')) {
return Cache::get('keycloak.access_token');
}

$response = Http::asForm()->post(config('script-runner-microservice.keycloak.base_url'), [
'grant_type' => 'password',
'client_id' => config('script-runner-microservice.keycloak.client_id'),
'client_secret' => config('script-runner-microservice.keycloak.client_secret'),
'username' => config('script-runner-microservice.keycloak.username'),
'password' => config('script-runner-microservice.keycloak.password'),
]);

if ($response->successful()) {
Cache::put('keycloak.access_token', $response->json()['access_token'], $response->json()['expires_in'] - 60);
}

return Cache::get('keycloak.access_token');
}

public function getScriptRunner()
{
$response = Cache::remember('script-runner-microservice.script-languages', now()->addDay(), function () {
return Http::withToken($this->getAccessToken())
->get(config('script-runner-microservice.base_url') . '/scripts')->collect();
});

return $response->filter(function ($item) {
return $item['language'] == $this->language;
})->first();
}

public function run($code, array $data, array $config, $timeout, $user, $sync, $metadata)
{
Log::debug('Language: ' . $this->language);
Log::debug('Sync: ' . $sync);
Log::debug('Metadata: ' . print_r($metadata, true));

$scriptRunner = $this->getScriptRunner();

if (!$scriptRunner) {
throw new ConfigurationException('No exists script executor for this language: ' . $this->language);
}
$metadata = array_merge($this->getMetadata($user), $metadata);
$environmentVariables = $this->getEnvironmentVariables($user);

$payload = [
'version' => config('script-runner-microservice.version') ?? $this->getProcessMakerVersion(),
'language' => $scriptRunner['language'],
'metadata'=> $metadata,
'data' => !empty($data) ? $this->sanitizeCss($data) : new stdClass(),
'config' => !empty($config) ? $config : new stdClass(),
'script' => base64_encode(str_replace("'", '&#39;', $code)),
'secrets' => $environmentVariables,
'callback' => config('script-runner-microservice.callback'),
'callback_secure' => true,
'callback_token' => $environmentVariables['API_TOKEN'],
'debug' => true,
'timeout' => $timeout,
'sync' => $sync,
];

Log::debug('Payload: ' . print_r($payload, true));

$response = Http::withToken($this->getAccessToken())
->post(config('script-runner-microservice.base_url') . '/requests/create', $payload);

$response->throw();

return $response->json();
}

private function getEnvironmentVariables(User $user)
{
$variablesParameter = [];
EnvironmentVariable::chunk(50, function (Collection $variables) use (&$variablesParameter) {
foreach ($variables as $variable) {
// Fix variables that have spaces
$variablesParameter[str_replace(' ', '_', $variable->name)] = $variable->value;
}
});

// Add the url to the host
$variablesParameter['HOST_URL'] = config('app.docker_host_url');

// Create tokens for the SDK if a user is set
$token = null;
if ($user) {
$accessToken = Cache::remember('script-runner-' . $user->id, now()->addWeek(), function () use ($user) {
$user->removeOldRunScriptTokens();
$token = new GenerateAccessToken($user);

return $token->getToken();
});
$variablesParameter['API_TOKEN'] = $accessToken;
$variablesParameter['API_HOST'] = config('app.docker_host_url') . '/api/1.0';
$variablesParameter['APP_URL'] = config('app.docker_host_url');
$variablesParameter['API_SSL_VERIFY'] = (config('app.api_ssl_verify') ? '1' : '0');
}

return $variablesParameter;
}

public function setTokenId($tokenId)
{
$this->tokenId = $tokenId;
}

public function getProcessMakerVersion()
{
return Cache::remember('script-runner-microservice.processmaker-version', now()->addDay(), function () {
$composer_json_path = json_decode(file_get_contents(base_path() . '/composer.json'));

return $composer_json_path->version;
});
}

public function getMetadata($user)
{
return [
'script_id' => $this->script->id,
'instance' => config('app.url'),
'user_id' => $user->id,
'user_email' => $user->email,
];
}

public function sanitizeCss($data)
{
if ($this->language !== 'javascript-ssr') {
return $data;
}
if (array_key_exists('css', $data)) {
$data['css'] = false;
}

return $data;
}
}
Loading