Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 249
Implement script runner microservice#7896
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
e5e6750b5bb7d651997999e2439062de211dc1b85a2a06185df43b19a884f2bFile filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <?php | ||
| namespace ProcessMaker\Enums; | ||
| enum ScriptExecutorType:string | ||
| { | ||
| case System = 'system'; | ||
| case Custom = 'custom'; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
| @@ -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) | ||
| @@ -68,6 +69,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e | ||
| } | ||
| $errorHandling = null; | ||
| $scriptExecutor = null; | ||
| try { | ||
| if (empty($scriptRef)) { | ||
| $code = $element->getScript(); | ||
| @@ -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); | ||
| } | ||
| @@ -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); | ||
| ||
| 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)]); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 = []) | ||
| ||
| { | ||
| if (!$timeout) { | ||
| $timeout = $this->timeout; | ||
| @@ -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); | ||
| } | ||
| /** | ||
| Original file line number | Diff line number | Diff 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("'", ''', $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; | ||
| } | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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?