Skip to content

Run Speedtests from the API #2204

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

Merged
alexjustesen merged 4 commits into from
May 19, 2025
Merged

Run Speedtests from the API #2204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d428f9f
run speedtests from the api
alexjustesen May 19, 2025
6888efb
fixed speedtests run route method from GET to POST
alexjustesen May 19, 2025
8fd1747
refactor: update table columns in ApiTokens page to include created_a…
alexjustesen May 19, 2025
e649ad3
refactor: enhance RunSpeedtest controller with OpenAPI annotations an…
alexjustesen May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions app/Actions/Ookla/StartSpeedtest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

use App\Enums\ResultService;
use App\Enums\ResultStatus;
use App\Events\SpeedtestStarted;
use App\Events\SpeedtestWaiting;
use App\Jobs\Ookla\ProcessSpeedtestBatch;
use App\Models\Result;
use Lorisleiva\Actions\Concerns\AsAction;
Expand All @@ -13,19 +13,21 @@ class StartSpeedtest
{
use AsAction;

public function handle(bool $scheduled = false, ?int $serverId = null): void
public function handle(bool $scheduled = false, ?int $serverId = null): Result
{
$result = Result::create([
'data->server->id' => $serverId,
'service' => ResultService::Ookla,
'status' => ResultStatus::Started,
'status' => ResultStatus::Waiting,
'scheduled' => $scheduled,
]);

ProcessSpeedtestBatch::dispatch(
result: $result,
);

SpeedtestStarted::dispatch($result);
SpeedtestWaiting::dispatch($result);

return $result;
}
}
2 changes: 2 additions & 0 deletions app/Enums/ResultStatus.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ enum ResultStatus: string implements HasColor, HasLabel
case Running = 'running';
case Started = 'started';
case Skipped = 'skipped';
case Waiting = 'waiting';

public function getColor(): ?string
{
Expand All @@ -26,6 +27,7 @@ public function getColor(): ?string
self::Running => 'info',
self::Started => 'info',
self::Skipped => 'gray',
self::Waiting => 'info',
};
}

Expand Down
20 changes: 20 additions & 0 deletions app/Events/SpeedtestWaiting.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

namespace App\Events;

use App\Models\Result;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class SpeedtestWaiting
{
use Dispatchable, InteractsWithSockets, SerializesModels;

/**
* Create a new event instance.
*/
public function __construct(
public Result $result,
) {}
}
21 changes: 18 additions & 3 deletions app/Filament/Pages/ApiTokens.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace App\Filament\Pages;

use Carbon\Carbon;
use Filament\Forms\Components\CheckboxList;
use Filament\Forms\Components\DateTimePicker;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Concerns\InteractsWithForms;
Expand Down Expand Up @@ -73,6 +74,16 @@ public function table(Table $table): Table
->maxLength('100')
->required()
->autocomplete(false),
CheckboxList::make('abilities')
->options([
'results:read' => 'Read results',
'speedtests:run' => 'Run speedtest',
])
->descriptions([
'results:read' => 'Allow this token to read results.',
'speedtests:run' => 'Allow this token to run speedtests.',
])
->bulkToggleable(),
DateTimePicker::make('token_expires_at')
->label('Expires at')
->nullable()
Expand All @@ -81,6 +92,7 @@ public function table(Table $table): Table
->action(function (array $data) {
$token = Auth::user()->createToken(
name: $data['token_name'],
abilities: $data['abilities'],
expiresAt: $data['token_expires_at'] ? Carbon::parse($data['token_expires_at']) : null,
);

Expand All @@ -91,11 +103,14 @@ public function table(Table $table): Table
->modalWidth(MaxWidth::ExtraLarge),
])
->columns([
TextColumn::make('id')
->label('ID')
->sortable(),
TextColumn::make('name')
->searchable(),
TextColumn::make('abilities')
->badge(),
TextColumn::make('created_at')
->alignEnd()
->dateTime()
->sortable(),
TextColumn::make('last_used_at')
->alignEnd()
->dateTime()
Expand Down
17 changes: 13 additions & 4 deletions app/Http/Controllers/Api/V1/ApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ abstract class ApiController
* Send a response.
*
* @param mixed $data
* @param array $filters
* @param string $message
* @param int $code
* @return \Illuminate\Http\JsonResponse
Expand All @@ -29,7 +30,10 @@ public static function sendResponse($data, $filters = [], $message = 'ok', $code
$response['message'] = $message;
}

return response()->json($response, $code);
return response()->json(
data: $response,
status: $code,
);
}

/**
Expand All @@ -44,10 +48,15 @@ public static function throw($e, $code = 500)
{
Log::info($e);

$response = [
'message' => $e->getMessage(),
];

throw new HttpResponseException(
response: response()->json([
'message' => $e->getMessage(),
], $code)
response: response()->json(
data: $response,
status: $code,
),
);
}
}
64 changes: 64 additions & 0 deletions app/Http/Controllers/Api/V1/RunSpeedtest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?php

namespace App\Http\Controllers\Api\V1;

use App\Actions\Ookla\StartSpeedtest;
use App\Http\Resources\V1\ResultResource;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\Validator;
use OpenApi\Attributes as OA;

class RunSpeedtest extends ApiController
{
#[OA\Post(
path: '/api/v1/speedtests/run',
description: 'Run a new Ookla speedtest. Optionally provide a server_id.',
parameters: [
new OA\Parameter(
name: 'server_id',
in: 'query',
required: false,
schema: new OA\Schema(type: 'integer'),
description: 'Optional Ookla speedtest server ID'
),
],
responses: [
new OA\Response(response: Response::HTTP_CREATED, description: 'Created'),
new OA\Response(response: Response::HTTP_FORBIDDEN, description: 'Forbidden'),
new OA\Response(response: Response::HTTP_UNPROCESSABLE_ENTITY, description: 'Validation error'),
]
)]
public function __invoke(Request $request)
{
if ($request->user()->tokenCant('speedtests:run')) {
return self::sendResponse(
data: null,
message: 'You do not have permission to run speedtests.',
code: Response::HTTP_FORBIDDEN,
);
}

$validator = Validator::make($request->all(), [
'server_id' => 'sometimes|integer',
]);

if ($validator->fails()) {
return ApiController::sendResponse(
data: $validator->errors(),
message: 'Validation failed.',
code: Response::HTTP_UNPROCESSABLE_ENTITY,
);
}

$result = StartSpeedtest::run(
serverId: $validated['server_id'] ?? null,
);

return self::sendResponse(
data: new ResultResource($result),
message: 'Speedtest added to the queue.',
code: Response::HTTP_CREATED,
);
}
}
1 change: 1 addition & 0 deletions app/Jobs/Ookla/ProcessSpeedtestBatch.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public function handle(): void
{
Bus::batch([
[
new StartSpeedtestJob($this->result),
new CheckForInternetConnectionJob($this->result),
new SkipSpeedtestJob($this->result),
new SelectSpeedtestServerJob($this->result),
Expand Down
45 changes: 45 additions & 0 deletions app/Jobs/Ookla/StartSpeedtestJob.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

namespace App\Jobs\Ookla;

use App\Enums\ResultStatus;
use App\Events\SpeedtestStarted;
use App\Models\Result;
use Illuminate\Bus\Batchable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Illuminate\Queue\Middleware\SkipIfBatchCancelled;

class StartSpeedtestJob implements ShouldQueue
{
use Batchable, Queueable;

/**
* Create a new job instance.
*/
public function __construct(
public Result $result,
) {}

/**
* Get the middleware the job should pass through.
*/
public function middleware(): array
{
return [
new SkipIfBatchCancelled,
];
}

/**
* Execute the job.
*/
public function handle(): void
{
$this->result->update([
'status' => ResultStatus::Started,
]);

SpeedtestStarted::dispatch($this->result);
}
}
29 changes: 29 additions & 0 deletions database/migrations/2025_05_19_160458_reset_existing_api_token_abilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Laravel\Sanctum\PersonalAccessToken;

return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
PersonalAccessToken::all()->each(function (PersonalAccessToken $token) {
$token->abilities = [
'results:read',
];

$token->save();
});
}

/**
* Reverse the migrations.
*/
public function down(): void
{
//
}
};
4 changes: 4 additions & 0 deletions routes/api/v1/routes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

use App\Http\Controllers\Api\V1\LatestResult;
use App\Http\Controllers\Api\V1\ListResults;
use App\Http\Controllers\Api\V1\RunSpeedtest;
use App\Http\Controllers\Api\V1\ShowResult;
use App\Http\Controllers\Api\V1\Stats;
use Illuminate\Support\Facades\Route;
Expand All @@ -16,6 +17,9 @@
Route::get('/results/{result}', ShowResult::class)
->name('results.show');

Route::post('/speedtests/run', RunSpeedtest::class)
->name('speedtests.run');

Route::get('/stats', Stats::class)
->name('stats');
});