🤖
TUS Laravel/PHP Memo
TUS: https://tus.io/
Tus は http でファイルの分割アップロードをするプロトコルの一種です。そうとらえてます。違ったらごめん。
PHP のライブラリも作られており https://github.com/ankitpokhrel/tus-php を使っています。
Laravel 対応させたのもあるのですが、個人的には不満だったので、素のこれを Laravel で使ってます。
ここでは JS 側は省きます。
それのmemo書きです。
Routing
<?php
Route::middleware('auth')->group(function(){
Route::any('/tus/upload/{any?}', [TUSMainFileUploadController::class, 'upload'])
->where('any', '.*')
->name("tus.upload");
});
TUSMainFileUploadController
<?php
namespace App\Http\Controller;
use ACME\DoSomething\DoSomethingService;
use TusPhp\Events\UploadComplete;
use TusPhp\Events\UploadCreated;
use TusPhp\Events\UploadMerged;
use TusPhp\Events\UploadProgress;
use TusPhp\Request as TusPHPRequest;
use TusPhp\Tus\Server as TusServer;
class TUSMainFileUploadController extends Controller {
public function upload(){
// Laravel の TestCase を通す為のごり押し継承
// これをしないと、TestCase を通した時 SymfonyRequest がずっと GET リクエストと勘違いして TUS がリクエストデータを読めない事になる
$server = (new class ('redis') extends TusServer{
public function setRequest(TusPHPRequest $request): self
{
$this->request = $request;
return $this;
}
})->setRequest((new class () extends TusPHPRequest {
public function setRequest(HttpRequest $r): self
{
$this->request = $r;
return $this;
}
})->setRequest(request()));
$user = auth()->user();
$events = $server->event();
// アップロード開始イベント
$events->addListener('tus-server.upload.created', function(UploadCreated $created){
\Log::info("[TUS] File Created Request");
});
// アップロード中イベント
$events->addListener('tus-server.upload.progress', function(UploadProgress $uploadProgress){
\Log::info("[TUS] File Upload Progress");
});
// アップロードされたファイルをかき集めてるイベント
$events->addListener('tus-server.upload.merged', function(UploadMerged $merged){
\Log::info("[TUS] File Merged ?");
});
// アップロード完了イベント
$server->event()->addListener('tus-server.upload.complete', function (UploadComplete $event) use ($user){
\Log::info("[TUS] File Complete. Start Checking.");
try {
app(DoSomethingService::class)->handleUploadComplete($event, $user);
} catch (\Exception $e){
\Log::error($e);
}
});
$response = $server
->setUploadDir(storage_path('app/tus'))
->setApiPath('/tus/upload')
->serve();
return $response->send();
}
}
TestCase
<?php
namespace Tests\App\Http\Controller;
use ACME\DoSomething\DoSomethingService;
use Tests\TestCase;
class TUSMainFileUploadControllerTest extends TestCase {
public function test_running_tus() {
$user = \App\Model\User::factory()->create();
// TUS でファイルアップロードの機構が動くか見てるだけなので、実ファイルアップロードはしてない。
$this->app->instance(
DoSomethingService::class,
mock(DoSomethingService::class, function (\Mockery\MockInterface $m){
$m->shouldReceive('handleUploadComplete')->never();
})
);
$test = $this
->actingAs($user)
->get(route('tus.upload', []), ['Tus-Resumable' => '1.0.0']);
$test->assertNotFound();
// アップロード開始のリクエスト
$metadata = collect([
'filename' => 'hogeratta.png',
'filetype' => 'image/png',
'param1' => '123',
'public_date' => '2025/10/10 00:00:00'
])->map(fn($v, $k) => "{$k} " . base64_encode($v))
->flatten()
->implode(",");
$test = $this
->actingAs($user)
->post( route('tus.upload', []), [],
[
'Tus-Resumable' => '1.0.0',
'Upload-Length' => 6,
'Upload-Metadata' => $metadata
]
);
$test->assertStatus(201);
// 実データのアップロードは Location Header のUploadURLに投げる
$test->assertHeader("Location");
$location = $test->headers->get('Location');
$test = $this
->actingAs($user)
->patch($location, ['aaaaaa']);
// OctetStream になってないので 415 が返るのが正常。ここのテストはTUSが期待通りか見るための物なので、これでok
$test->assertStatus(415);
}
}
Discussion