FOUR-32476: Improve DevLink installation errors#8987

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
eiresendez wants to merge 1 commit into
base:develop
Choose a base branch
from
+241 −7
Open

FOUR-32476: Improve DevLink installation errors #8987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions ProcessMaker/Exception/DevLinkRemoteValidationException.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
<?php

namespace ProcessMaker\Exception;

use RuntimeException;
use Throwable;

class DevLinkRemoteValidationException extends RuntimeException
{
public function __construct(string $message, ?Throwable $previous = null)
{
parent::__construct($message, 0, $previous);
}
}
31 changes: 27 additions & 4 deletions ProcessMaker/Jobs/DevLinkInstall.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,15 @@
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Http\Client\RequestException;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\Jobs\ImportV2;
use ProcessMaker\Models\Bundle;
Expand All@@ -21,6 +24,10 @@ class DevLinkInstall implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

const TYPE_INSTALL_BUNDLE = 'install_bundle';

const TYPE_REINSTALL_BUNDLE = 'reinstall_bundle';
Expand DownExpand Up@@ -95,11 +102,27 @@ public function handle(): void
public function failed(Throwable $exception): void
{
$logger = new Logger($this->userId, $this->operationId);
if ($exception instanceof DevLinkRemoteBundleException) {
Log::error($exception->getMessage(), ['exception' => $exception]);
$logger->error($exception->getMessage());

Log::error('DevLink operation failed.', [
'exception' => $exception,
'operation_id' => $this->operationId,
'dev_link_id' => $this->devLinkId,
'type' => $this->type,
]);

if (
$exception instanceof DevLinkRemoteBundleException
|| $exception instanceof DevLinkRemoteValidationException
|| $exception instanceof ValidationException
) {
$message = $exception instanceof ValidationException
? collect($exception->errors())->flatten()->first(fn ($message) => is_string($message))
: $exception->getMessage();
$logger->error($message ?: $exception->getMessage());
} elseif ($exception instanceof RequestException) {
$logger->error(__(self::REMOTE_ERROR_MESSAGE));
} else {
$logger->exception($exception);
$logger->error(__(self::UNEXPECTED_ERROR_MESSAGE));
}

// Unlock the job
Expand Down
13 changes: 13 additions & 0 deletions ProcessMaker/Models/DevLink.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\ImportExport\Importer;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\ImportExport\Options;
Expand DownExpand Up@@ -165,6 +166,18 @@ public function installRemoteBundle($remoteBundleId, $updateType)
throw new DevLinkRemoteBundleException($invalidAssets, $exception);
}

$invalidDependencies = $exception->response->json('errors.dependencies');
$validationMessage = $exception->response->json('error.message');
if (
$exception->response->status() === 422
&& is_array($invalidDependencies)
&& $invalidDependencies !== []
&& is_string($validationMessage)
&& trim($validationMessage) !== ''
) {
throw new DevLinkRemoteValidationException($validationMessage, $exception);
}

throw $exception;
}

Expand Down
152 changes: 149 additions & 3 deletions tests/Feature/Jobs/DevLinkInstallTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,17 @@

namespace Tests\Feature\Jobs;

use GuzzleHttp\Psr7\Response as PsrResponse;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Mockery;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\Events\ImportLog;
use ProcessMaker\Jobs\DevLinkInstall;
use ProcessMaker\Jobs\ImportV2;
Expand All@@ -16,9 +22,16 @@

class DevLinkInstallTest extends TestCase
{
public function testFailedJobIncludesOperationIdInErrorEvent()
private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

public function testFailedUnexpectedJobSanitizesErrorAndLogsCorrelatedException()
{
Event::fake([ImportLog::class]);
Log::spy();
Storage::fake('local');

$lock = Mockery::mock();
Expand All@@ -38,13 +51,81 @@ public function testFailedJobIncludesOperationIdInErrorEvent()
'operation-123',
);

$job->failed(new RuntimeException('Installation failed'));
$exception = new RuntimeException('Sensitive installation details');

$job->failed($exception);

Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
return $event->type === 'error'
&& str_contains($event->message, 'Installation failed')
&& $event->message === self::UNEXPECTED_ERROR_MESSAGE
&& !str_contains($event->message, RuntimeException::class)
&& !str_contains($event->message, 'Sensitive installation details')
&& $event->operationId === 'operation-123';
});

Log::shouldHaveReceived('error')
->once()
->withArgs(function (string $message, array $context) use ($exception) {
return $message === 'DevLink operation failed.'
&& $context['exception'] === $exception
&& $context['operation_id'] === 'operation-123'
&& $context['dev_link_id'] === 456
&& $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
});
}

public function testFailedRemoteRequestSanitizesHttpResponseBody()
{
Event::fake([ImportLog::class]);
Log::spy();
Storage::fake('local');

$lock = Mockery::mock();
$lock->shouldReceive('forceRelease')->once();
Cache::shouldReceive('lock')
->once()
->with(ImportV2::CACHE_LOCK_KEY)
->andReturn($lock);

$job = new DevLinkInstall(
123,
456,
Bundle::class,
789,
DevLinkInstall::MODE_UPDATE,
DevLinkInstall::TYPE_INSTALL_BUNDLE,
'operation-remote-error',
);
$exception = new RequestException(new Response(new PsrResponse(
500,
[],
json_encode([
'message' => 'The MAC is invalid.',
'exception' => 'Illuminate\\Contracts\\Encryption\\DecryptException',
'trace' => ['sensitive trace'],
])
)));

$job->failed($exception);

Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
return $event->type === 'error'
&& $event->message === self::REMOTE_ERROR_MESSAGE
&& !str_contains($event->message, '500')
&& !str_contains($event->message, 'MAC')
&& !str_contains($event->message, RequestException::class)
&& $event->operationId === 'operation-remote-error';
});

Log::shouldHaveReceived('error')
->once()
->withArgs(function (string $message, array $context) use ($exception) {
return $message === 'DevLink operation failed.'
&& $context['exception'] === $exception
&& $context['operation_id'] === 'operation-remote-error'
&& $context['dev_link_id'] === 456
&& $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
});
}

public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEvent()
Expand DownExpand Up@@ -83,4 +164,69 @@ public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEve
&& $event->operationId === 'operation-456';
});
}

public function testFailedRemoteValidationJobIncludesOperationIdInActionableErrorEvent()
{
Event::fake([ImportLog::class]);
Storage::fake('local');

$lock = Mockery::mock();
$lock->shouldReceive('forceRelease')->once();
Cache::shouldReceive('lock')
->once()
->with(ImportV2::CACHE_LOCK_KEY)
->andReturn($lock);

$job = new DevLinkInstall(
123,
456,
Bundle::class,
789,
DevLinkInstall::MODE_UPDATE,
DevLinkInstall::TYPE_INSTALL_BUNDLE,
'operation-remote-validation',
);

$job->failed(new DevLinkRemoteValidationException(self::MISSING_DISPLAY_SCREEN_MESSAGE));

Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
return $event->type === 'error'
&& $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
&& $event->operationId === 'operation-remote-validation';
});
}

public function testFailedLocalValidationJobIncludesOperationIdInActionableErrorEvent()
{
Event::fake([ImportLog::class]);
Storage::fake('local');
$exception = ValidationException::withMessages([
'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
]);

$lock = Mockery::mock();
$lock->shouldReceive('forceRelease')->once();
Cache::shouldReceive('lock')
->once()
->with(ImportV2::CACHE_LOCK_KEY)
->andReturn($lock);

$job = new DevLinkInstall(
123,
456,
Bundle::class,
789,
DevLinkInstall::MODE_UPDATE,
DevLinkInstall::TYPE_REINSTALL_BUNDLE,
'operation-local-validation',
);

$job->failed($exception);

Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
return $event->type === 'error'
&& $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
&& $event->operationId === 'operation-local-validation';
});
}
}
38 changes: 38 additions & 0 deletions tests/Model/DevLinkTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Models\Bundle;
use ProcessMaker\Models\DevLink;
use ProcessMaker\Models\Screen;
Expand All@@ -28,6 +29,8 @@ class DevLinkTest extends TestCase

private const EXPORT_LOCAL_BUNDLE_API_PATH = 'export-local-bundle/123';

private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

public function testGetClientUrl()
{
$devLink = DevLink::factory()->create([
Expand DownExpand Up@@ -162,6 +165,41 @@ public function testInstallRemoteBundleReportsUnavailableRemoteAssets()
$devLink->installRemoteBundle(123, 'update');
}

public function testInstallRemoteBundleReportsUnavailableRemoteDependencies()
{
Http::preventStrayRequests();
Http::fake([
self::remoteApiUrl(self::LOCAL_BUNDLE_API_PATH) => Http::response(self::remoteBundleResponse('5')),
self::remoteApiUrl(self::EXPORT_LOCAL_BUNDLE_API_PATH) => Http::response(['payloads' => []]),
self::remoteApiUrl('export-local-bundle/123/settings') => Http::response(['settings' => []]),
self::remoteApiUrl('export-local-bundle/123/settings-payloads') => Http::response([
'error' => [
'code' => 422,
'message' => self::MISSING_DISPLAY_SCREEN_MESSAGE,
],
'errors' => [
'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
],
], 422),
]);

$devLink = DevLink::factory()->create([
'url' => self::REMOTE_INSTANCE_URL,
]);

try {
$devLink->installRemoteBundle(123, 'update');
$this->fail('Installing a remote bundle with an unavailable dependency should fail.');
} catch (DevLinkRemoteValidationException $exception) {
$this->assertSame(self::MISSING_DISPLAY_SCREEN_MESSAGE, $exception->getMessage());
}

$this->assertDatabaseMissing('bundles', [
'dev_link_id' => $devLink->id,
'remote_id' => 123,
]);
}

public function testInstallRemoteBundleImportsAndReinstallsEverySelectedMenu()
{
if (!hasPackage('package-dynamic-ui')) {
Expand Down
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
FOUR-32476: Improve DevLink installation errors#8987

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Open

eiresendez
wants to merge
1
commit into

base:develop
Choose a base branch

from


+241

−7

 Open


FOUR-32476: Improve DevLink installation errors
#8987
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


14 changes: 14 additions & 0 deletions
ProcessMaker/Exception/DevLinkRemoteValidationException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
<?php

namespace ProcessMaker\Exception;

use RuntimeException;
use Throwable;

class DevLinkRemoteValidationException extends RuntimeException
{
 public function __construct(string $message, ?Throwable $previous = null)
 {
 parent::__construct($message, 0, $previous);
 }
}

31 changes: 27 additions & 4 deletions
ProcessMaker/Jobs/DevLinkInstall.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,15 @@
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Http\Client\RequestException;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\Jobs\ImportV2;
use ProcessMaker\Models\Bundle;
Expand All@@ -21,6 +24,10 @@ class DevLinkInstall implements ShouldQueue
{
 use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 const TYPE_INSTALL_BUNDLE = 'install_bundle';

 const TYPE_REINSTALL_BUNDLE = 'reinstall_bundle';
Expand DownExpand Up@@ -95,11 +102,27 @@ public function handle(): void
 public function failed(Throwable $exception): void
 {
 $logger = new Logger($this->userId, $this->operationId);
 if ($exception instanceof DevLinkRemoteBundleException) {
 Log::error($exception->getMessage(), ['exception' => $exception]);
 $logger->error($exception->getMessage());

 Log::error('DevLink operation failed.', [
 'exception' => $exception,
 'operation_id' => $this->operationId,
 'dev_link_id' => $this->devLinkId,
 'type' => $this->type,
 ]);

 if (
 $exception instanceof DevLinkRemoteBundleException
 || $exception instanceof DevLinkRemoteValidationException
 || $exception instanceof ValidationException
 ) {
 $message = $exception instanceof ValidationException
 ? collect($exception->errors())->flatten()->first(fn ($message) => is_string($message))
 : $exception->getMessage();
 $logger->error($message ?: $exception->getMessage());
 } elseif ($exception instanceof RequestException) {
 $logger->error(__(self::REMOTE_ERROR_MESSAGE));
 } else {
 $logger->exception($exception);
 $logger->error(__(self::UNEXPECTED_ERROR_MESSAGE));
 }

 // Unlock the job
Expand Down

13 changes: 13 additions & 0 deletions
ProcessMaker/Models/DevLink.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\ImportExport\Importer;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\ImportExport\Options;
Expand DownExpand Up@@ -165,6 +166,18 @@ public function installRemoteBundle($remoteBundleId, $updateType)
 throw new DevLinkRemoteBundleException($invalidAssets, $exception);
 }

 $invalidDependencies = $exception->response->json('errors.dependencies');
 $validationMessage = $exception->response->json('error.message');
 if (
 $exception->response->status() === 422
 && is_array($invalidDependencies)
 && $invalidDependencies !== []
 && is_string($validationMessage)
 && trim($validationMessage) !== ''
 ) {
 throw new DevLinkRemoteValidationException($validationMessage, $exception);
 }

 throw $exception;
 }

Expand Down

152 changes: 149 additions & 3 deletions
tests/Feature/Jobs/DevLinkInstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,17 @@

namespace Tests\Feature\Jobs;

use GuzzleHttp\Psr7\Response as PsrResponse;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Mockery;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\Events\ImportLog;
use ProcessMaker\Jobs\DevLinkInstall;
use ProcessMaker\Jobs\ImportV2;
Expand All@@ -16,9 +22,16 @@

class DevLinkInstallTest extends TestCase
{
 public function testFailedJobIncludesOperationIdInErrorEvent()
 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 public function testFailedUnexpectedJobSanitizesErrorAndLogsCorrelatedException()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
Expand All@@ -38,13 +51,81 @@ public function testFailedJobIncludesOperationIdInErrorEvent()
 'operation-123',
 );

 $job->failed(new RuntimeException('Installation failed'));
 $exception = new RuntimeException('Sensitive installation details');

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && str_contains($event->message, 'Installation failed')
 && $event->message === self::UNEXPECTED_ERROR_MESSAGE
 && !str_contains($event->message, RuntimeException::class)
 && !str_contains($event->message, 'Sensitive installation details')
 && $event->operationId === 'operation-123';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-123'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteRequestSanitizesHttpResponseBody()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-error',
 );
 $exception = new RequestException(new Response(new PsrResponse(
 500,
 [],
 json_encode([
 'message' => 'The MAC is invalid.',
 'exception' => 'Illuminate\\Contracts\\Encryption\\DecryptException',
 'trace' => ['sensitive trace'],
 ])
 )));

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::REMOTE_ERROR_MESSAGE
 && !str_contains($event->message, '500')
 && !str_contains($event->message, 'MAC')
 && !str_contains($event->message, RequestException::class)
 && $event->operationId === 'operation-remote-error';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-remote-error'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEvent()
Expand DownExpand Up@@ -83,4 +164,69 @@ public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEve
 && $event->operationId === 'operation-456';
 });
 }

 public function testFailedRemoteValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-validation',
 );

 $job->failed(new DevLinkRemoteValidationException(self::MISSING_DISPLAY_SCREEN_MESSAGE));

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-remote-validation';
 });
 }

 public function testFailedLocalValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');
 $exception = ValidationException::withMessages([
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ]);

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_REINSTALL_BUNDLE,
 'operation-local-validation',
 );

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-local-validation';
 });
 }
}

38 changes: 38 additions & 0 deletions
tests/Model/DevLinkTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Models\Bundle;
use ProcessMaker\Models\DevLink;
use ProcessMaker\Models\Screen;
Expand All@@ -28,6 +29,8 @@ class DevLinkTest extends TestCase

 private const EXPORT_LOCAL_BUNDLE_API_PATH = 'export-local-bundle/123';

 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 public function testGetClientUrl()
 {
 $devLink = DevLink::factory()->create([
Expand DownExpand Up@@ -162,6 +165,41 @@ public function testInstallRemoteBundleReportsUnavailableRemoteAssets()
 $devLink->installRemoteBundle(123, 'update');
 }

 public function testInstallRemoteBundleReportsUnavailableRemoteDependencies()
 {
 Http::preventStrayRequests();
 Http::fake([
 self::remoteApiUrl(self::LOCAL_BUNDLE_API_PATH) => Http::response(self::remoteBundleResponse('5')),
 self::remoteApiUrl(self::EXPORT_LOCAL_BUNDLE_API_PATH) => Http::response(['payloads' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings') => Http::response(['settings' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings-payloads') => Http::response([
 'error' => [
 'code' => 422,
 'message' => self::MISSING_DISPLAY_SCREEN_MESSAGE,
 ],
 'errors' => [
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ],
 ], 422),
 ]);

 $devLink = DevLink::factory()->create([
 'url' => self::REMOTE_INSTANCE_URL,
 ]);

 try {
 $devLink->installRemoteBundle(123, 'update');
 $this->fail('Installing a remote bundle with an unavailable dependency should fail.');
 } catch (DevLinkRemoteValidationException $exception) {
 $this->assertSame(self::MISSING_DISPLAY_SCREEN_MESSAGE, $exception->getMessage());
 }

 $this->assertDatabaseMissing('bundles', [
 'dev_link_id' => $devLink->id,
 'remote_id' => 123,
 ]);
 }

 public function testInstallRemoteBundleImportsAndReinstallsEverySelectedMenu()
 {
 if (!hasPackage('package-dynamic-ui')) {
Expand Down
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
FOUR-32476: Improve DevLink installation errors#8987

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Open

eiresendez
wants to merge
1
commit into

base:develop
Choose a base branch

from


+241

−7

 Open


FOUR-32476: Improve DevLink installation errors
#8987
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


14 changes: 14 additions & 0 deletions
ProcessMaker/Exception/DevLinkRemoteValidationException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
<?php

namespace ProcessMaker\Exception;

use RuntimeException;
use Throwable;

class DevLinkRemoteValidationException extends RuntimeException
{
 public function __construct(string $message, ?Throwable $previous = null)
 {
 parent::__construct($message, 0, $previous);
 }
}

31 changes: 27 additions & 4 deletions
ProcessMaker/Jobs/DevLinkInstall.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,15 @@
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Http\Client\RequestException;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\Jobs\ImportV2;
use ProcessMaker\Models\Bundle;
Expand All@@ -21,6 +24,10 @@ class DevLinkInstall implements ShouldQueue
{
 use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 const TYPE_INSTALL_BUNDLE = 'install_bundle';

 const TYPE_REINSTALL_BUNDLE = 'reinstall_bundle';
Expand DownExpand Up@@ -95,11 +102,27 @@ public function handle(): void
 public function failed(Throwable $exception): void
 {
 $logger = new Logger($this->userId, $this->operationId);
 if ($exception instanceof DevLinkRemoteBundleException) {
 Log::error($exception->getMessage(), ['exception' => $exception]);
 $logger->error($exception->getMessage());

 Log::error('DevLink operation failed.', [
 'exception' => $exception,
 'operation_id' => $this->operationId,
 'dev_link_id' => $this->devLinkId,
 'type' => $this->type,
 ]);

 if (
 $exception instanceof DevLinkRemoteBundleException
 || $exception instanceof DevLinkRemoteValidationException
 || $exception instanceof ValidationException
 ) {
 $message = $exception instanceof ValidationException
 ? collect($exception->errors())->flatten()->first(fn ($message) => is_string($message))
 : $exception->getMessage();
 $logger->error($message ?: $exception->getMessage());
 } elseif ($exception instanceof RequestException) {
 $logger->error(__(self::REMOTE_ERROR_MESSAGE));
 } else {
 $logger->exception($exception);
 $logger->error(__(self::UNEXPECTED_ERROR_MESSAGE));
 }

 // Unlock the job
Expand Down

13 changes: 13 additions & 0 deletions
ProcessMaker/Models/DevLink.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\ImportExport\Importer;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\ImportExport\Options;
Expand DownExpand Up@@ -165,6 +166,18 @@ public function installRemoteBundle($remoteBundleId, $updateType)
 throw new DevLinkRemoteBundleException($invalidAssets, $exception);
 }

 $invalidDependencies = $exception->response->json('errors.dependencies');
 $validationMessage = $exception->response->json('error.message');
 if (
 $exception->response->status() === 422
 && is_array($invalidDependencies)
 && $invalidDependencies !== []
 && is_string($validationMessage)
 && trim($validationMessage) !== ''
 ) {
 throw new DevLinkRemoteValidationException($validationMessage, $exception);
 }

 throw $exception;
 }

Expand Down

152 changes: 149 additions & 3 deletions
tests/Feature/Jobs/DevLinkInstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,17 @@

namespace Tests\Feature\Jobs;

use GuzzleHttp\Psr7\Response as PsrResponse;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Mockery;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\Events\ImportLog;
use ProcessMaker\Jobs\DevLinkInstall;
use ProcessMaker\Jobs\ImportV2;
Expand All@@ -16,9 +22,16 @@

class DevLinkInstallTest extends TestCase
{
 public function testFailedJobIncludesOperationIdInErrorEvent()
 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 public function testFailedUnexpectedJobSanitizesErrorAndLogsCorrelatedException()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
Expand All@@ -38,13 +51,81 @@ public function testFailedJobIncludesOperationIdInErrorEvent()
 'operation-123',
 );

 $job->failed(new RuntimeException('Installation failed'));
 $exception = new RuntimeException('Sensitive installation details');

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && str_contains($event->message, 'Installation failed')
 && $event->message === self::UNEXPECTED_ERROR_MESSAGE
 && !str_contains($event->message, RuntimeException::class)
 && !str_contains($event->message, 'Sensitive installation details')
 && $event->operationId === 'operation-123';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-123'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteRequestSanitizesHttpResponseBody()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-error',
 );
 $exception = new RequestException(new Response(new PsrResponse(
 500,
 [],
 json_encode([
 'message' => 'The MAC is invalid.',
 'exception' => 'Illuminate\\Contracts\\Encryption\\DecryptException',
 'trace' => ['sensitive trace'],
 ])
 )));

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::REMOTE_ERROR_MESSAGE
 && !str_contains($event->message, '500')
 && !str_contains($event->message, 'MAC')
 && !str_contains($event->message, RequestException::class)
 && $event->operationId === 'operation-remote-error';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-remote-error'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEvent()
Expand DownExpand Up@@ -83,4 +164,69 @@ public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEve
 && $event->operationId === 'operation-456';
 });
 }

 public function testFailedRemoteValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-validation',
 );

 $job->failed(new DevLinkRemoteValidationException(self::MISSING_DISPLAY_SCREEN_MESSAGE));

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-remote-validation';
 });
 }

 public function testFailedLocalValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');
 $exception = ValidationException::withMessages([
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ]);

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_REINSTALL_BUNDLE,
 'operation-local-validation',
 );

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-local-validation';
 });
 }
}

38 changes: 38 additions & 0 deletions
tests/Model/DevLinkTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Models\Bundle;
use ProcessMaker\Models\DevLink;
use ProcessMaker\Models\Screen;
Expand All@@ -28,6 +29,8 @@ class DevLinkTest extends TestCase

 private const EXPORT_LOCAL_BUNDLE_API_PATH = 'export-local-bundle/123';

 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 public function testGetClientUrl()
 {
 $devLink = DevLink::factory()->create([
Expand DownExpand Up@@ -162,6 +165,41 @@ public function testInstallRemoteBundleReportsUnavailableRemoteAssets()
 $devLink->installRemoteBundle(123, 'update');
 }

 public function testInstallRemoteBundleReportsUnavailableRemoteDependencies()
 {
 Http::preventStrayRequests();
 Http::fake([
 self::remoteApiUrl(self::LOCAL_BUNDLE_API_PATH) => Http::response(self::remoteBundleResponse('5')),
 self::remoteApiUrl(self::EXPORT_LOCAL_BUNDLE_API_PATH) => Http::response(['payloads' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings') => Http::response(['settings' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings-payloads') => Http::response([
 'error' => [
 'code' => 422,
 'message' => self::MISSING_DISPLAY_SCREEN_MESSAGE,
 ],
 'errors' => [
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ],
 ], 422),
 ]);

 $devLink = DevLink::factory()->create([
 'url' => self::REMOTE_INSTANCE_URL,
 ]);

 try {
 $devLink->installRemoteBundle(123, 'update');
 $this->fail('Installing a remote bundle with an unavailable dependency should fail.');
 } catch (DevLinkRemoteValidationException $exception) {
 $this->assertSame(self::MISSING_DISPLAY_SCREEN_MESSAGE, $exception->getMessage());
 }

 $this->assertDatabaseMissing('bundles', [
 'dev_link_id' => $devLink->id,
 'remote_id' => 123,
 ]);
 }

 public function testInstallRemoteBundleImportsAndReinstallsEverySelectedMenu()
 {
 if (!hasPackage('package-dynamic-ui')) {
Expand Down
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
FOUR-32476: Improve DevLink installation errors#8987

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Open

eiresendez
wants to merge
1
commit into

base:develop
Choose a base branch

from


+241

−7

 Open


FOUR-32476: Improve DevLink installation errors
#8987
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


14 changes: 14 additions & 0 deletions
ProcessMaker/Exception/DevLinkRemoteValidationException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
<?php

namespace ProcessMaker\Exception;

use RuntimeException;
use Throwable;

class DevLinkRemoteValidationException extends RuntimeException
{
 public function __construct(string $message, ?Throwable $previous = null)
 {
 parent::__construct($message, 0, $previous);
 }
}

31 changes: 27 additions & 4 deletions
ProcessMaker/Jobs/DevLinkInstall.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,15 @@
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Http\Client\RequestException;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\Jobs\ImportV2;
use ProcessMaker\Models\Bundle;
Expand All@@ -21,6 +24,10 @@ class DevLinkInstall implements ShouldQueue
{
 use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 const TYPE_INSTALL_BUNDLE = 'install_bundle';

 const TYPE_REINSTALL_BUNDLE = 'reinstall_bundle';
Expand DownExpand Up@@ -95,11 +102,27 @@ public function handle(): void
 public function failed(Throwable $exception): void
 {
 $logger = new Logger($this->userId, $this->operationId);
 if ($exception instanceof DevLinkRemoteBundleException) {
 Log::error($exception->getMessage(), ['exception' => $exception]);
 $logger->error($exception->getMessage());

 Log::error('DevLink operation failed.', [
 'exception' => $exception,
 'operation_id' => $this->operationId,
 'dev_link_id' => $this->devLinkId,
 'type' => $this->type,
 ]);

 if (
 $exception instanceof DevLinkRemoteBundleException
 || $exception instanceof DevLinkRemoteValidationException
 || $exception instanceof ValidationException
 ) {
 $message = $exception instanceof ValidationException
 ? collect($exception->errors())->flatten()->first(fn ($message) => is_string($message))
 : $exception->getMessage();
 $logger->error($message ?: $exception->getMessage());
 } elseif ($exception instanceof RequestException) {
 $logger->error(__(self::REMOTE_ERROR_MESSAGE));
 } else {
 $logger->exception($exception);
 $logger->error(__(self::UNEXPECTED_ERROR_MESSAGE));
 }

 // Unlock the job
Expand Down

13 changes: 13 additions & 0 deletions
ProcessMaker/Models/DevLink.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\ImportExport\Importer;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\ImportExport\Options;
Expand DownExpand Up@@ -165,6 +166,18 @@ public function installRemoteBundle($remoteBundleId, $updateType)
 throw new DevLinkRemoteBundleException($invalidAssets, $exception);
 }

 $invalidDependencies = $exception->response->json('errors.dependencies');
 $validationMessage = $exception->response->json('error.message');
 if (
 $exception->response->status() === 422
 && is_array($invalidDependencies)
 && $invalidDependencies !== []
 && is_string($validationMessage)
 && trim($validationMessage) !== ''
 ) {
 throw new DevLinkRemoteValidationException($validationMessage, $exception);
 }

 throw $exception;
 }

Expand Down

152 changes: 149 additions & 3 deletions
tests/Feature/Jobs/DevLinkInstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,17 @@

namespace Tests\Feature\Jobs;

use GuzzleHttp\Psr7\Response as PsrResponse;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Mockery;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\Events\ImportLog;
use ProcessMaker\Jobs\DevLinkInstall;
use ProcessMaker\Jobs\ImportV2;
Expand All@@ -16,9 +22,16 @@

class DevLinkInstallTest extends TestCase
{
 public function testFailedJobIncludesOperationIdInErrorEvent()
 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 public function testFailedUnexpectedJobSanitizesErrorAndLogsCorrelatedException()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
Expand All@@ -38,13 +51,81 @@ public function testFailedJobIncludesOperationIdInErrorEvent()
 'operation-123',
 );

 $job->failed(new RuntimeException('Installation failed'));
 $exception = new RuntimeException('Sensitive installation details');

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && str_contains($event->message, 'Installation failed')
 && $event->message === self::UNEXPECTED_ERROR_MESSAGE
 && !str_contains($event->message, RuntimeException::class)
 && !str_contains($event->message, 'Sensitive installation details')
 && $event->operationId === 'operation-123';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-123'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteRequestSanitizesHttpResponseBody()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-error',
 );
 $exception = new RequestException(new Response(new PsrResponse(
 500,
 [],
 json_encode([
 'message' => 'The MAC is invalid.',
 'exception' => 'Illuminate\\Contracts\\Encryption\\DecryptException',
 'trace' => ['sensitive trace'],
 ])
 )));

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::REMOTE_ERROR_MESSAGE
 && !str_contains($event->message, '500')
 && !str_contains($event->message, 'MAC')
 && !str_contains($event->message, RequestException::class)
 && $event->operationId === 'operation-remote-error';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-remote-error'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEvent()
Expand DownExpand Up@@ -83,4 +164,69 @@ public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEve
 && $event->operationId === 'operation-456';
 });
 }

 public function testFailedRemoteValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-validation',
 );

 $job->failed(new DevLinkRemoteValidationException(self::MISSING_DISPLAY_SCREEN_MESSAGE));

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-remote-validation';
 });
 }

 public function testFailedLocalValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');
 $exception = ValidationException::withMessages([
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ]);

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_REINSTALL_BUNDLE,
 'operation-local-validation',
 );

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-local-validation';
 });
 }
}

38 changes: 38 additions & 0 deletions
tests/Model/DevLinkTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Models\Bundle;
use ProcessMaker\Models\DevLink;
use ProcessMaker\Models\Screen;
Expand All@@ -28,6 +29,8 @@ class DevLinkTest extends TestCase

 private const EXPORT_LOCAL_BUNDLE_API_PATH = 'export-local-bundle/123';

 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 public function testGetClientUrl()
 {
 $devLink = DevLink::factory()->create([
Expand DownExpand Up@@ -162,6 +165,41 @@ public function testInstallRemoteBundleReportsUnavailableRemoteAssets()
 $devLink->installRemoteBundle(123, 'update');
 }

 public function testInstallRemoteBundleReportsUnavailableRemoteDependencies()
 {
 Http::preventStrayRequests();
 Http::fake([
 self::remoteApiUrl(self::LOCAL_BUNDLE_API_PATH) => Http::response(self::remoteBundleResponse('5')),
 self::remoteApiUrl(self::EXPORT_LOCAL_BUNDLE_API_PATH) => Http::response(['payloads' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings') => Http::response(['settings' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings-payloads') => Http::response([
 'error' => [
 'code' => 422,
 'message' => self::MISSING_DISPLAY_SCREEN_MESSAGE,
 ],
 'errors' => [
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ],
 ], 422),
 ]);

 $devLink = DevLink::factory()->create([
 'url' => self::REMOTE_INSTANCE_URL,
 ]);

 try {
 $devLink->installRemoteBundle(123, 'update');
 $this->fail('Installing a remote bundle with an unavailable dependency should fail.');
 } catch (DevLinkRemoteValidationException $exception) {
 $this->assertSame(self::MISSING_DISPLAY_SCREEN_MESSAGE, $exception->getMessage());
 }

 $this->assertDatabaseMissing('bundles', [
 'dev_link_id' => $devLink->id,
 'remote_id' => 123,
 ]);
 }

 public function testInstallRemoteBundleImportsAndReinstallsEverySelectedMenu()
 {
 if (!hasPackage('package-dynamic-ui')) {
Expand Down
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
FOUR-32476: Improve DevLink installation errors#8987

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Open

eiresendez
wants to merge
1
commit into

base:develop
Choose a base branch

from


+241

−7

 Open


FOUR-32476: Improve DevLink installation errors
#8987
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


14 changes: 14 additions & 0 deletions
ProcessMaker/Exception/DevLinkRemoteValidationException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
<?php

namespace ProcessMaker\Exception;

use RuntimeException;
use Throwable;

class DevLinkRemoteValidationException extends RuntimeException
{
 public function __construct(string $message, ?Throwable $previous = null)
 {
 parent::__construct($message, 0, $previous);
 }
}

31 changes: 27 additions & 4 deletions
ProcessMaker/Jobs/DevLinkInstall.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,15 @@
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Http\Client\RequestException;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\Jobs\ImportV2;
use ProcessMaker\Models\Bundle;
Expand All@@ -21,6 +24,10 @@ class DevLinkInstall implements ShouldQueue
{
 use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 const TYPE_INSTALL_BUNDLE = 'install_bundle';

 const TYPE_REINSTALL_BUNDLE = 'reinstall_bundle';
Expand DownExpand Up@@ -95,11 +102,27 @@ public function handle(): void
 public function failed(Throwable $exception): void
 {
 $logger = new Logger($this->userId, $this->operationId);
 if ($exception instanceof DevLinkRemoteBundleException) {
 Log::error($exception->getMessage(), ['exception' => $exception]);
 $logger->error($exception->getMessage());

 Log::error('DevLink operation failed.', [
 'exception' => $exception,
 'operation_id' => $this->operationId,
 'dev_link_id' => $this->devLinkId,
 'type' => $this->type,
 ]);

 if (
 $exception instanceof DevLinkRemoteBundleException
 || $exception instanceof DevLinkRemoteValidationException
 || $exception instanceof ValidationException
 ) {
 $message = $exception instanceof ValidationException
 ? collect($exception->errors())->flatten()->first(fn ($message) => is_string($message))
 : $exception->getMessage();
 $logger->error($message ?: $exception->getMessage());
 } elseif ($exception instanceof RequestException) {
 $logger->error(__(self::REMOTE_ERROR_MESSAGE));
 } else {
 $logger->exception($exception);
 $logger->error(__(self::UNEXPECTED_ERROR_MESSAGE));
 }

 // Unlock the job
Expand Down

13 changes: 13 additions & 0 deletions
ProcessMaker/Models/DevLink.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\ImportExport\Importer;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\ImportExport\Options;
Expand DownExpand Up@@ -165,6 +166,18 @@ public function installRemoteBundle($remoteBundleId, $updateType)
 throw new DevLinkRemoteBundleException($invalidAssets, $exception);
 }

 $invalidDependencies = $exception->response->json('errors.dependencies');
 $validationMessage = $exception->response->json('error.message');
 if (
 $exception->response->status() === 422
 && is_array($invalidDependencies)
 && $invalidDependencies !== []
 && is_string($validationMessage)
 && trim($validationMessage) !== ''
 ) {
 throw new DevLinkRemoteValidationException($validationMessage, $exception);
 }

 throw $exception;
 }

Expand Down

152 changes: 149 additions & 3 deletions
tests/Feature/Jobs/DevLinkInstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,17 @@

namespace Tests\Feature\Jobs;

use GuzzleHttp\Psr7\Response as PsrResponse;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Mockery;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\Events\ImportLog;
use ProcessMaker\Jobs\DevLinkInstall;
use ProcessMaker\Jobs\ImportV2;
Expand All@@ -16,9 +22,16 @@

class DevLinkInstallTest extends TestCase
{
 public function testFailedJobIncludesOperationIdInErrorEvent()
 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 public function testFailedUnexpectedJobSanitizesErrorAndLogsCorrelatedException()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
Expand All@@ -38,13 +51,81 @@ public function testFailedJobIncludesOperationIdInErrorEvent()
 'operation-123',
 );

 $job->failed(new RuntimeException('Installation failed'));
 $exception = new RuntimeException('Sensitive installation details');

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && str_contains($event->message, 'Installation failed')
 && $event->message === self::UNEXPECTED_ERROR_MESSAGE
 && !str_contains($event->message, RuntimeException::class)
 && !str_contains($event->message, 'Sensitive installation details')
 && $event->operationId === 'operation-123';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-123'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteRequestSanitizesHttpResponseBody()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-error',
 );
 $exception = new RequestException(new Response(new PsrResponse(
 500,
 [],
 json_encode([
 'message' => 'The MAC is invalid.',
 'exception' => 'Illuminate\\Contracts\\Encryption\\DecryptException',
 'trace' => ['sensitive trace'],
 ])
 )));

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::REMOTE_ERROR_MESSAGE
 && !str_contains($event->message, '500')
 && !str_contains($event->message, 'MAC')
 && !str_contains($event->message, RequestException::class)
 && $event->operationId === 'operation-remote-error';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-remote-error'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEvent()
Expand DownExpand Up@@ -83,4 +164,69 @@ public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEve
 && $event->operationId === 'operation-456';
 });
 }

 public function testFailedRemoteValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-validation',
 );

 $job->failed(new DevLinkRemoteValidationException(self::MISSING_DISPLAY_SCREEN_MESSAGE));

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-remote-validation';
 });
 }

 public function testFailedLocalValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');
 $exception = ValidationException::withMessages([
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ]);

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_REINSTALL_BUNDLE,
 'operation-local-validation',
 );

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-local-validation';
 });
 }
}

38 changes: 38 additions & 0 deletions
tests/Model/DevLinkTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Models\Bundle;
use ProcessMaker\Models\DevLink;
use ProcessMaker\Models\Screen;
Expand All@@ -28,6 +29,8 @@ class DevLinkTest extends TestCase

 private const EXPORT_LOCAL_BUNDLE_API_PATH = 'export-local-bundle/123';

 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 public function testGetClientUrl()
 {
 $devLink = DevLink::factory()->create([
Expand DownExpand Up@@ -162,6 +165,41 @@ public function testInstallRemoteBundleReportsUnavailableRemoteAssets()
 $devLink->installRemoteBundle(123, 'update');
 }

 public function testInstallRemoteBundleReportsUnavailableRemoteDependencies()
 {
 Http::preventStrayRequests();
 Http::fake([
 self::remoteApiUrl(self::LOCAL_BUNDLE_API_PATH) => Http::response(self::remoteBundleResponse('5')),
 self::remoteApiUrl(self::EXPORT_LOCAL_BUNDLE_API_PATH) => Http::response(['payloads' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings') => Http::response(['settings' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings-payloads') => Http::response([
 'error' => [
 'code' => 422,
 'message' => self::MISSING_DISPLAY_SCREEN_MESSAGE,
 ],
 'errors' => [
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ],
 ], 422),
 ]);

 $devLink = DevLink::factory()->create([
 'url' => self::REMOTE_INSTANCE_URL,
 ]);

 try {
 $devLink->installRemoteBundle(123, 'update');
 $this->fail('Installing a remote bundle with an unavailable dependency should fail.');
 } catch (DevLinkRemoteValidationException $exception) {
 $this->assertSame(self::MISSING_DISPLAY_SCREEN_MESSAGE, $exception->getMessage());
 }

 $this->assertDatabaseMissing('bundles', [
 'dev_link_id' => $devLink->id,
 'remote_id' => 123,
 ]);
 }

 public function testInstallRemoteBundleImportsAndReinstallsEverySelectedMenu()
 {
 if (!hasPackage('package-dynamic-ui')) {
Expand Down
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
FOUR-32476: Improve DevLink installation errors#8987

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Open

eiresendez
wants to merge
1
commit into

base:develop
Choose a base branch

from


+241

−7

 Open


FOUR-32476: Improve DevLink installation errors
#8987
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


14 changes: 14 additions & 0 deletions
ProcessMaker/Exception/DevLinkRemoteValidationException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
<?php

namespace ProcessMaker\Exception;

use RuntimeException;
use Throwable;

class DevLinkRemoteValidationException extends RuntimeException
{
 public function __construct(string $message, ?Throwable $previous = null)
 {
 parent::__construct($message, 0, $previous);
 }
}

31 changes: 27 additions & 4 deletions
ProcessMaker/Jobs/DevLinkInstall.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,15 @@
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Http\Client\RequestException;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\Jobs\ImportV2;
use ProcessMaker\Models\Bundle;
Expand All@@ -21,6 +24,10 @@ class DevLinkInstall implements ShouldQueue
{
 use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 const TYPE_INSTALL_BUNDLE = 'install_bundle';

 const TYPE_REINSTALL_BUNDLE = 'reinstall_bundle';
Expand DownExpand Up@@ -95,11 +102,27 @@ public function handle(): void
 public function failed(Throwable $exception): void
 {
 $logger = new Logger($this->userId, $this->operationId);
 if ($exception instanceof DevLinkRemoteBundleException) {
 Log::error($exception->getMessage(), ['exception' => $exception]);
 $logger->error($exception->getMessage());

 Log::error('DevLink operation failed.', [
 'exception' => $exception,
 'operation_id' => $this->operationId,
 'dev_link_id' => $this->devLinkId,
 'type' => $this->type,
 ]);

 if (
 $exception instanceof DevLinkRemoteBundleException
 || $exception instanceof DevLinkRemoteValidationException
 || $exception instanceof ValidationException
 ) {
 $message = $exception instanceof ValidationException
 ? collect($exception->errors())->flatten()->first(fn ($message) => is_string($message))
 : $exception->getMessage();
 $logger->error($message ?: $exception->getMessage());
 } elseif ($exception instanceof RequestException) {
 $logger->error(__(self::REMOTE_ERROR_MESSAGE));
 } else {
 $logger->exception($exception);
 $logger->error(__(self::UNEXPECTED_ERROR_MESSAGE));
 }

 // Unlock the job
Expand Down

13 changes: 13 additions & 0 deletions
ProcessMaker/Models/DevLink.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\ImportExport\Importer;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\ImportExport\Options;
Expand DownExpand Up@@ -165,6 +166,18 @@ public function installRemoteBundle($remoteBundleId, $updateType)
 throw new DevLinkRemoteBundleException($invalidAssets, $exception);
 }

 $invalidDependencies = $exception->response->json('errors.dependencies');
 $validationMessage = $exception->response->json('error.message');
 if (
 $exception->response->status() === 422
 && is_array($invalidDependencies)
 && $invalidDependencies !== []
 && is_string($validationMessage)
 && trim($validationMessage) !== ''
 ) {
 throw new DevLinkRemoteValidationException($validationMessage, $exception);
 }

 throw $exception;
 }

Expand Down

152 changes: 149 additions & 3 deletions
tests/Feature/Jobs/DevLinkInstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,17 @@

namespace Tests\Feature\Jobs;

use GuzzleHttp\Psr7\Response as PsrResponse;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Mockery;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\Events\ImportLog;
use ProcessMaker\Jobs\DevLinkInstall;
use ProcessMaker\Jobs\ImportV2;
Expand All@@ -16,9 +22,16 @@

class DevLinkInstallTest extends TestCase
{
 public function testFailedJobIncludesOperationIdInErrorEvent()
 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 public function testFailedUnexpectedJobSanitizesErrorAndLogsCorrelatedException()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
Expand All@@ -38,13 +51,81 @@ public function testFailedJobIncludesOperationIdInErrorEvent()
 'operation-123',
 );

 $job->failed(new RuntimeException('Installation failed'));
 $exception = new RuntimeException('Sensitive installation details');

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && str_contains($event->message, 'Installation failed')
 && $event->message === self::UNEXPECTED_ERROR_MESSAGE
 && !str_contains($event->message, RuntimeException::class)
 && !str_contains($event->message, 'Sensitive installation details')
 && $event->operationId === 'operation-123';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-123'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteRequestSanitizesHttpResponseBody()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-error',
 );
 $exception = new RequestException(new Response(new PsrResponse(
 500,
 [],
 json_encode([
 'message' => 'The MAC is invalid.',
 'exception' => 'Illuminate\\Contracts\\Encryption\\DecryptException',
 'trace' => ['sensitive trace'],
 ])
 )));

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::REMOTE_ERROR_MESSAGE
 && !str_contains($event->message, '500')
 && !str_contains($event->message, 'MAC')
 && !str_contains($event->message, RequestException::class)
 && $event->operationId === 'operation-remote-error';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-remote-error'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEvent()
Expand DownExpand Up@@ -83,4 +164,69 @@ public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEve
 && $event->operationId === 'operation-456';
 });
 }

 public function testFailedRemoteValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-validation',
 );

 $job->failed(new DevLinkRemoteValidationException(self::MISSING_DISPLAY_SCREEN_MESSAGE));

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-remote-validation';
 });
 }

 public function testFailedLocalValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');
 $exception = ValidationException::withMessages([
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ]);

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_REINSTALL_BUNDLE,
 'operation-local-validation',
 );

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-local-validation';
 });
 }
}

38 changes: 38 additions & 0 deletions
tests/Model/DevLinkTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Models\Bundle;
use ProcessMaker\Models\DevLink;
use ProcessMaker\Models\Screen;
Expand All@@ -28,6 +29,8 @@ class DevLinkTest extends TestCase

 private const EXPORT_LOCAL_BUNDLE_API_PATH = 'export-local-bundle/123';

 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 public function testGetClientUrl()
 {
 $devLink = DevLink::factory()->create([
Expand DownExpand Up@@ -162,6 +165,41 @@ public function testInstallRemoteBundleReportsUnavailableRemoteAssets()
 $devLink->installRemoteBundle(123, 'update');
 }

 public function testInstallRemoteBundleReportsUnavailableRemoteDependencies()
 {
 Http::preventStrayRequests();
 Http::fake([
 self::remoteApiUrl(self::LOCAL_BUNDLE_API_PATH) => Http::response(self::remoteBundleResponse('5')),
 self::remoteApiUrl(self::EXPORT_LOCAL_BUNDLE_API_PATH) => Http::response(['payloads' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings') => Http::response(['settings' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings-payloads') => Http::response([
 'error' => [
 'code' => 422,
 'message' => self::MISSING_DISPLAY_SCREEN_MESSAGE,
 ],
 'errors' => [
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ],
 ], 422),
 ]);

 $devLink = DevLink::factory()->create([
 'url' => self::REMOTE_INSTANCE_URL,
 ]);

 try {
 $devLink->installRemoteBundle(123, 'update');
 $this->fail('Installing a remote bundle with an unavailable dependency should fail.');
 } catch (DevLinkRemoteValidationException $exception) {
 $this->assertSame(self::MISSING_DISPLAY_SCREEN_MESSAGE, $exception->getMessage());
 }

 $this->assertDatabaseMissing('bundles', [
 'dev_link_id' => $devLink->id,
 'remote_id' => 123,
 ]);
 }

 public function testInstallRemoteBundleImportsAndReinstallsEverySelectedMenu()
 {
 if (!hasPackage('package-dynamic-ui')) {
Expand Down
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
FOUR-32476: Improve DevLink installation errors#8987

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Open

eiresendez
wants to merge
1
commit into

base:develop
Choose a base branch

from


+241

−7

 Open


FOUR-32476: Improve DevLink installation errors
#8987
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


14 changes: 14 additions & 0 deletions
ProcessMaker/Exception/DevLinkRemoteValidationException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
<?php

namespace ProcessMaker\Exception;

use RuntimeException;
use Throwable;

class DevLinkRemoteValidationException extends RuntimeException
{
 public function __construct(string $message, ?Throwable $previous = null)
 {
 parent::__construct($message, 0, $previous);
 }
}

31 changes: 27 additions & 4 deletions
ProcessMaker/Jobs/DevLinkInstall.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,15 @@
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Http\Client\RequestException;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\Jobs\ImportV2;
use ProcessMaker\Models\Bundle;
Expand All@@ -21,6 +24,10 @@ class DevLinkInstall implements ShouldQueue
{
 use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 const TYPE_INSTALL_BUNDLE = 'install_bundle';

 const TYPE_REINSTALL_BUNDLE = 'reinstall_bundle';
Expand DownExpand Up@@ -95,11 +102,27 @@ public function handle(): void
 public function failed(Throwable $exception): void
 {
 $logger = new Logger($this->userId, $this->operationId);
 if ($exception instanceof DevLinkRemoteBundleException) {
 Log::error($exception->getMessage(), ['exception' => $exception]);
 $logger->error($exception->getMessage());

 Log::error('DevLink operation failed.', [
 'exception' => $exception,
 'operation_id' => $this->operationId,
 'dev_link_id' => $this->devLinkId,
 'type' => $this->type,
 ]);

 if (
 $exception instanceof DevLinkRemoteBundleException
 || $exception instanceof DevLinkRemoteValidationException
 || $exception instanceof ValidationException
 ) {
 $message = $exception instanceof ValidationException
 ? collect($exception->errors())->flatten()->first(fn ($message) => is_string($message))
 : $exception->getMessage();
 $logger->error($message ?: $exception->getMessage());
 } elseif ($exception instanceof RequestException) {
 $logger->error(__(self::REMOTE_ERROR_MESSAGE));
 } else {
 $logger->exception($exception);
 $logger->error(__(self::UNEXPECTED_ERROR_MESSAGE));
 }

 // Unlock the job
Expand Down

13 changes: 13 additions & 0 deletions
ProcessMaker/Models/DevLink.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\ImportExport\Importer;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\ImportExport\Options;
Expand DownExpand Up@@ -165,6 +166,18 @@ public function installRemoteBundle($remoteBundleId, $updateType)
 throw new DevLinkRemoteBundleException($invalidAssets, $exception);
 }

 $invalidDependencies = $exception->response->json('errors.dependencies');
 $validationMessage = $exception->response->json('error.message');
 if (
 $exception->response->status() === 422
 && is_array($invalidDependencies)
 && $invalidDependencies !== []
 && is_string($validationMessage)
 && trim($validationMessage) !== ''
 ) {
 throw new DevLinkRemoteValidationException($validationMessage, $exception);
 }

 throw $exception;
 }

Expand Down

152 changes: 149 additions & 3 deletions
tests/Feature/Jobs/DevLinkInstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,17 @@

namespace Tests\Feature\Jobs;

use GuzzleHttp\Psr7\Response as PsrResponse;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Mockery;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\Events\ImportLog;
use ProcessMaker\Jobs\DevLinkInstall;
use ProcessMaker\Jobs\ImportV2;
Expand All@@ -16,9 +22,16 @@

class DevLinkInstallTest extends TestCase
{
 public function testFailedJobIncludesOperationIdInErrorEvent()
 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 public function testFailedUnexpectedJobSanitizesErrorAndLogsCorrelatedException()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
Expand All@@ -38,13 +51,81 @@ public function testFailedJobIncludesOperationIdInErrorEvent()
 'operation-123',
 );

 $job->failed(new RuntimeException('Installation failed'));
 $exception = new RuntimeException('Sensitive installation details');

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && str_contains($event->message, 'Installation failed')
 && $event->message === self::UNEXPECTED_ERROR_MESSAGE
 && !str_contains($event->message, RuntimeException::class)
 && !str_contains($event->message, 'Sensitive installation details')
 && $event->operationId === 'operation-123';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-123'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteRequestSanitizesHttpResponseBody()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-error',
 );
 $exception = new RequestException(new Response(new PsrResponse(
 500,
 [],
 json_encode([
 'message' => 'The MAC is invalid.',
 'exception' => 'Illuminate\\Contracts\\Encryption\\DecryptException',
 'trace' => ['sensitive trace'],
 ])
 )));

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::REMOTE_ERROR_MESSAGE
 && !str_contains($event->message, '500')
 && !str_contains($event->message, 'MAC')
 && !str_contains($event->message, RequestException::class)
 && $event->operationId === 'operation-remote-error';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-remote-error'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEvent()
Expand DownExpand Up@@ -83,4 +164,69 @@ public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEve
 && $event->operationId === 'operation-456';
 });
 }

 public function testFailedRemoteValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-validation',
 );

 $job->failed(new DevLinkRemoteValidationException(self::MISSING_DISPLAY_SCREEN_MESSAGE));

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-remote-validation';
 });
 }

 public function testFailedLocalValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');
 $exception = ValidationException::withMessages([
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ]);

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_REINSTALL_BUNDLE,
 'operation-local-validation',
 );

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-local-validation';
 });
 }
}

38 changes: 38 additions & 0 deletions
tests/Model/DevLinkTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Models\Bundle;
use ProcessMaker\Models\DevLink;
use ProcessMaker\Models\Screen;
Expand All@@ -28,6 +29,8 @@ class DevLinkTest extends TestCase

 private const EXPORT_LOCAL_BUNDLE_API_PATH = 'export-local-bundle/123';

 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 public function testGetClientUrl()
 {
 $devLink = DevLink::factory()->create([
Expand DownExpand Up@@ -162,6 +165,41 @@ public function testInstallRemoteBundleReportsUnavailableRemoteAssets()
 $devLink->installRemoteBundle(123, 'update');
 }

 public function testInstallRemoteBundleReportsUnavailableRemoteDependencies()
 {
 Http::preventStrayRequests();
 Http::fake([
 self::remoteApiUrl(self::LOCAL_BUNDLE_API_PATH) => Http::response(self::remoteBundleResponse('5')),
 self::remoteApiUrl(self::EXPORT_LOCAL_BUNDLE_API_PATH) => Http::response(['payloads' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings') => Http::response(['settings' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings-payloads') => Http::response([
 'error' => [
 'code' => 422,
 'message' => self::MISSING_DISPLAY_SCREEN_MESSAGE,
 ],
 'errors' => [
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ],
 ], 422),
 ]);

 $devLink = DevLink::factory()->create([
 'url' => self::REMOTE_INSTANCE_URL,
 ]);

 try {
 $devLink->installRemoteBundle(123, 'update');
 $this->fail('Installing a remote bundle with an unavailable dependency should fail.');
 } catch (DevLinkRemoteValidationException $exception) {
 $this->assertSame(self::MISSING_DISPLAY_SCREEN_MESSAGE, $exception->getMessage());
 }

 $this->assertDatabaseMissing('bundles', [
 'dev_link_id' => $devLink->id,
 'remote_id' => 123,
 ]);
 }

 public function testInstallRemoteBundleImportsAndReinstallsEverySelectedMenu()
 {
 if (!hasPackage('package-dynamic-ui')) {
Expand Down
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
FOUR-32476: Improve DevLink installation errors#8987

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Open

eiresendez
wants to merge
1
commit into

base:develop
Choose a base branch

from


+241

−7

 Open


FOUR-32476: Improve DevLink installation errors
#8987
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


14 changes: 14 additions & 0 deletions
ProcessMaker/Exception/DevLinkRemoteValidationException.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
<?php

namespace ProcessMaker\Exception;

use RuntimeException;
use Throwable;

class DevLinkRemoteValidationException extends RuntimeException
{
 public function __construct(string $message, ?Throwable $previous = null)
 {
 parent::__construct($message, 0, $previous);
 }
}

31 changes: 27 additions & 4 deletions
ProcessMaker/Jobs/DevLinkInstall.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,12 +5,15 @@
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Http\Client\RequestException;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\Jobs\ImportV2;
use ProcessMaker\Models\Bundle;
Expand All@@ -21,6 +24,10 @@ class DevLinkInstall implements ShouldQueue
{
 use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 const TYPE_INSTALL_BUNDLE = 'install_bundle';

 const TYPE_REINSTALL_BUNDLE = 'reinstall_bundle';
Expand DownExpand Up@@ -95,11 +102,27 @@ public function handle(): void
 public function failed(Throwable $exception): void
 {
 $logger = new Logger($this->userId, $this->operationId);
 if ($exception instanceof DevLinkRemoteBundleException) {
 Log::error($exception->getMessage(), ['exception' => $exception]);
 $logger->error($exception->getMessage());

 Log::error('DevLink operation failed.', [
 'exception' => $exception,
 'operation_id' => $this->operationId,
 'dev_link_id' => $this->devLinkId,
 'type' => $this->type,
 ]);

 if (
 $exception instanceof DevLinkRemoteBundleException
 || $exception instanceof DevLinkRemoteValidationException
 || $exception instanceof ValidationException
 ) {
 $message = $exception instanceof ValidationException
 ? collect($exception->errors())->flatten()->first(fn ($message) => is_string($message))
 : $exception->getMessage();
 $logger->error($message ?: $exception->getMessage());
 } elseif ($exception instanceof RequestException) {
 $logger->error(__(self::REMOTE_ERROR_MESSAGE));
 } else {
 $logger->exception($exception);
 $logger->error(__(self::UNEXPECTED_ERROR_MESSAGE));
 }

 // Unlock the job
Expand Down

13 changes: 13 additions & 0 deletions
ProcessMaker/Models/DevLink.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Str;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\ImportExport\Importer;
use ProcessMaker\ImportExport\Logger;
use ProcessMaker\ImportExport\Options;
Expand DownExpand Up@@ -165,6 +166,18 @@ public function installRemoteBundle($remoteBundleId, $updateType)
 throw new DevLinkRemoteBundleException($invalidAssets, $exception);
 }

 $invalidDependencies = $exception->response->json('errors.dependencies');
 $validationMessage = $exception->response->json('error.message');
 if (
 $exception->response->status() === 422
 && is_array($invalidDependencies)
 && $invalidDependencies !== []
 && is_string($validationMessage)
 && trim($validationMessage) !== ''
 ) {
 throw new DevLinkRemoteValidationException($validationMessage, $exception);
 }

 throw $exception;
 }

Expand Down

152 changes: 149 additions & 3 deletions
tests/Feature/Jobs/DevLinkInstallTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,17 @@

namespace Tests\Feature\Jobs;

use GuzzleHttp\Psr7\Response as PsrResponse;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Storage;
use Mockery;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Exception\ValidationException;
use ProcessMaker\Events\ImportLog;
use ProcessMaker\Jobs\DevLinkInstall;
use ProcessMaker\Jobs\ImportV2;
Expand All@@ -16,9 +22,16 @@

class DevLinkInstallTest extends TestCase
{
 public function testFailedJobIncludesOperationIdInErrorEvent()
 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 private const REMOTE_ERROR_MESSAGE = 'The remote instance could not complete the DevLink request. Check the source instance logs and try again.';

 private const UNEXPECTED_ERROR_MESSAGE = 'The DevLink operation could not be completed. Check the target instance logs and try again.';

 public function testFailedUnexpectedJobSanitizesErrorAndLogsCorrelatedException()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
Expand All@@ -38,13 +51,81 @@ public function testFailedJobIncludesOperationIdInErrorEvent()
 'operation-123',
 );

 $job->failed(new RuntimeException('Installation failed'));
 $exception = new RuntimeException('Sensitive installation details');

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && str_contains($event->message, 'Installation failed')
 && $event->message === self::UNEXPECTED_ERROR_MESSAGE
 && !str_contains($event->message, RuntimeException::class)
 && !str_contains($event->message, 'Sensitive installation details')
 && $event->operationId === 'operation-123';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-123'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteRequestSanitizesHttpResponseBody()
 {
 Event::fake([ImportLog::class]);
 Log::spy();
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-error',
 );
 $exception = new RequestException(new Response(new PsrResponse(
 500,
 [],
 json_encode([
 'message' => 'The MAC is invalid.',
 'exception' => 'Illuminate\\Contracts\\Encryption\\DecryptException',
 'trace' => ['sensitive trace'],
 ])
 )));

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::REMOTE_ERROR_MESSAGE
 && !str_contains($event->message, '500')
 && !str_contains($event->message, 'MAC')
 && !str_contains($event->message, RequestException::class)
 && $event->operationId === 'operation-remote-error';
 });

 Log::shouldHaveReceived('error')
 ->once()
 ->withArgs(function (string $message, array $context) use ($exception) {
 return $message === 'DevLink operation failed.'
 && $context['exception'] === $exception
 && $context['operation_id'] === 'operation-remote-error'
 && $context['dev_link_id'] === 456
 && $context['type'] === DevLinkInstall::TYPE_INSTALL_BUNDLE;
 });
 }

 public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEvent()
Expand DownExpand Up@@ -83,4 +164,69 @@ public function testFailedRemoteBundleJobIncludesOperationIdInActionableErrorEve
 && $event->operationId === 'operation-456';
 });
 }

 public function testFailedRemoteValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_INSTALL_BUNDLE,
 'operation-remote-validation',
 );

 $job->failed(new DevLinkRemoteValidationException(self::MISSING_DISPLAY_SCREEN_MESSAGE));

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-remote-validation';
 });
 }

 public function testFailedLocalValidationJobIncludesOperationIdInActionableErrorEvent()
 {
 Event::fake([ImportLog::class]);
 Storage::fake('local');
 $exception = ValidationException::withMessages([
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ]);

 $lock = Mockery::mock();
 $lock->shouldReceive('forceRelease')->once();
 Cache::shouldReceive('lock')
 ->once()
 ->with(ImportV2::CACHE_LOCK_KEY)
 ->andReturn($lock);

 $job = new DevLinkInstall(
 123,
 456,
 Bundle::class,
 789,
 DevLinkInstall::MODE_UPDATE,
 DevLinkInstall::TYPE_REINSTALL_BUNDLE,
 'operation-local-validation',
 );

 $job->failed($exception);

 Event::assertDispatched(ImportLog::class, function (ImportLog $event) {
 return $event->type === 'error'
 && $event->message === self::MISSING_DISPLAY_SCREEN_MESSAGE
 && $event->operationId === 'operation-local-validation';
 });
 }
}

38 changes: 38 additions & 0 deletions
tests/Model/DevLinkTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Storage;
use ProcessMaker\Exception\DevLinkRemoteBundleException;
use ProcessMaker\Exception\DevLinkRemoteValidationException;
use ProcessMaker\Models\Bundle;
use ProcessMaker\Models\DevLink;
use ProcessMaker\Models\Screen;
Expand All@@ -28,6 +29,8 @@ class DevLinkTest extends TestCase

 private const EXPORT_LOCAL_BUNDLE_API_PATH = 'export-local-bundle/123';

 private const MISSING_DISPLAY_SCREEN_MESSAGE = 'The dashboard "DevLink Dashboard" references a Display Screen that is no longer available. Assign a valid Display Screen on the source instance and try again.';

 public function testGetClientUrl()
 {
 $devLink = DevLink::factory()->create([
Expand DownExpand Up@@ -162,6 +165,41 @@ public function testInstallRemoteBundleReportsUnavailableRemoteAssets()
 $devLink->installRemoteBundle(123, 'update');
 }

 public function testInstallRemoteBundleReportsUnavailableRemoteDependencies()
 {
 Http::preventStrayRequests();
 Http::fake([
 self::remoteApiUrl(self::LOCAL_BUNDLE_API_PATH) => Http::response(self::remoteBundleResponse('5')),
 self::remoteApiUrl(self::EXPORT_LOCAL_BUNDLE_API_PATH) => Http::response(['payloads' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings') => Http::response(['settings' => []]),
 self::remoteApiUrl('export-local-bundle/123/settings-payloads') => Http::response([
 'error' => [
 'code' => 422,
 'message' => self::MISSING_DISPLAY_SCREEN_MESSAGE,
 ],
 'errors' => [
 'dependencies' => [self::MISSING_DISPLAY_SCREEN_MESSAGE],
 ],
 ], 422),
 ]);

 $devLink = DevLink::factory()->create([
 'url' => self::REMOTE_INSTANCE_URL,
 ]);

 try {
 $devLink->installRemoteBundle(123, 'update');
 $this->fail('Installing a remote bundle with an unavailable dependency should fail.');
 } catch (DevLinkRemoteValidationException $exception) {
 $this->assertSame(self::MISSING_DISPLAY_SCREEN_MESSAGE, $exception->getMessage());
 }

 $this->assertDatabaseMissing('bundles', [
 'dev_link_id' => $devLink->id,
 'remote_id' => 123,
 ]);
 }

 public function testInstallRemoteBundleImportsAndReinstallsEverySelectedMenu()
 {
 if (!hasPackage('package-dynamic-ui')) {
Expand Down
Loading