Skip to content

FOUR-30920: Remove expected DevLink ping 401 #8897

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
+106 −8
Open

FOUR-30920: Remove expected DevLink ping 401 #8897

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
17 changes: 14 additions & 3 deletions ProcessMaker/Http/Controllers/Api/DevLinkController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace ProcessMaker\Http\Controllers\Api;

use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Notification;
Expand Down Expand Up @@ -91,10 +92,20 @@ public function destroy(DevLink $devLink)
public function ping(DevLink $devLink)
{
try {
return $devLink->client()->get(route('api.devlink.pong', [], false));
} catch (\Exception $e) {
return response()->json(['error' => 'DevLink connection error'], $e->getCode());
$response = $devLink->client()->get(route('api.devlink.pong', [], false));
} catch (RequestException $e) {
$status = $e->response->status();

return response()->json([
'status' => in_array($status, [401, 403], true) ? 'authorization_required' : 'error',
]);
} catch (\Throwable $e) {
return response()->json(['status' => 'error']);
}

return response()->json([
'status' => $response->json('status') === 'ok' ? 'ok' : 'error',
]);
}

public function pong()
Expand Down
9 changes: 4 additions & 5 deletions resources/js/admin/devlink/components/Index.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,16 +101,15 @@ const create = (name, url) => {
ProcessMaker.apiClient
.get(`devlink/${newId}/ping`)
.then((response) => {
status.value = 'success';
window.location.href = fullUrl;
})
.catch((e) => {
if (e.response.status === 401) {
if (['ok', 'authorization_required'].includes(response.data.status)) {
status.value = 'success';
window.location.href = fullUrl;
} else {
status.value = 'error';
}
})
.catch(() => {
status.value = 'error';
});
});
};
Expand Down
88 changes: 88 additions & 0 deletions tests/Feature/Api/DevLinkTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Tests\Feature\Api;

use Illuminate\Http\Client\ConnectionException;
use Illuminate\Support\Facades\Http;
use ProcessMaker\Http\Controllers\Api\DevLinkController;
use ProcessMaker\Models\Bundle;
Expand Down Expand Up @@ -43,6 +44,93 @@ public function testAddAssets()
$this->assertEquals('Asset already exists in bundle', $response->json()['error']['message']);
}

public function testPingReturnsOkWhenRemotePongSucceeds()
{
$devLink = DevLink::factory()->create([
'url' => 'https://remote-instance.test',
'access_token' => 'token',
]);

Http::fake([
'remote-instance.test/*' => Http::response(['status' => 'ok'], 200),
]);

$response = $this->apiCall('GET', route('api.devlink.ping', ['devLink' => $devLink->id]));

$response->assertStatus(200);
$response->assertJson(['status' => 'ok']);
}

public function testPingReturnsAuthorizationRequiredWhenRemotePongReturnsUnauthorized()
{
$devLink = DevLink::factory()->create([
'url' => 'https://remote-instance.test',
'access_token' => 'token',
]);

Http::fake([
'remote-instance.test/*' => Http::response(['message' => 'Unauthorized'], 401),
]);

$response = $this->apiCall('GET', route('api.devlink.ping', ['devLink' => $devLink->id]));

$response->assertStatus(200);
$response->assertJson(['status' => 'authorization_required']);
}

public function testPingReturnsAuthorizationRequiredWhenRemotePongReturnsForbidden()
{
$devLink = DevLink::factory()->create([
'url' => 'https://remote-instance.test',
'access_token' => 'token',
]);

Http::fake([
'remote-instance.test/*' => Http::response(['message' => 'Forbidden'], 403),
]);

$response = $this->apiCall('GET', route('api.devlink.ping', ['devLink' => $devLink->id]));

$response->assertStatus(200);
$response->assertJson(['status' => 'authorization_required']);
}

public function testPingReturnsErrorWhenRemotePongFails()
{
$devLink = DevLink::factory()->create([
'url' => 'https://remote-instance.test',
'access_token' => 'token',
]);

Http::fake([
'remote-instance.test/*' => Http::response(['message' => 'Server error'], 500),
]);

$response = $this->apiCall('GET', route('api.devlink.ping', ['devLink' => $devLink->id]));

$response->assertStatus(200);
$response->assertJson(['status' => 'error']);
}

public function testPingReturnsErrorWhenRemotePongCannotConnect()
{
$devLink = DevLink::factory()->create([
'url' => 'https://remote-instance.test',
'access_token' => 'token',
]);

Http::fake([
'remote-instance.test/*' => function () {
throw new ConnectionException('Connection failed');
},
]);

$response = $this->apiCall('GET', route('api.devlink.ping', ['devLink' => $devLink->id]));

$response->assertStatus(200);
$response->assertJson(['status' => 'error']);
}

public function testInstallRemoteAsset()
{
$screen = Screen::factory()->create();
Expand Down
Loading