Skip to content

A self-hosted media server and file management system

fix: subtitle resolver logging is over complex

aminnausin36846a469fa5
diff --git a/app/Services/Subtitles/SubtitleResolver.php b/app/Services/Subtitles/SubtitleResolver.php
index c9433c6d..1dce5370 100644
--- a/app/Services/Subtitles/SubtitleResolver.php
+++ b/app/Services/Subtitles/SubtitleResolver.php
@@ -4,90 +4,53 @@ namespace App\Services\Subtitles;
use App\Models\Metadata;
use App\Models\Subtitle;
-use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Response;
use Illuminate\Support\Facades\Storage;
use InvalidArgumentException;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
+// Resolves API Requests
class SubtitleResolver {
- public function __construct(protected SubtitleExtractor $extractor, protected SubtitleFormatter $formatter) {}
+ public function __construct(protected SubtitleExtractor $extractor, protected SubtitleFormatter $formatter) {
+ }
+ /**
+ * Resolves subtitles from web request
+ *
+ * 1. By matching model in database
+ * 2. Then by existing file on disk
+ * 3. Then by extracting from video to disk
+ * 4. Then by format
+ */
public function resolveSubtitles(Metadata $metadata, int $track, string $format, ?string $language = null): BinaryFileResponse {
- $startTime = microtime(true);
- $timings = [];
-
try {
- $queryStart = microtime(true);
- if ($track === 0 && $language) {
- // find external track by language
- $subtitle = $metadata->subtitles()
- ->where('track_id', 0)
- ->where('language', $language)
- ->firstOrFail();
- } else {
- $subtitle = $metadata->subtitles()
- ->where('track_id', $track)
- ->firstOrFail();
- }
- $timings['db_query'] = microtime(true) - $queryStart;
-
$format = ltrim(strtolower($format), '.');
-
- $pathStart = microtime(true);
+ $subtitle = $this->findSubtitle($metadata, $track, $language);
$requestedPath = $subtitle->getFilePath($format, $language);
- $timings['get_file_path'] = microtime(true) - $pathStart;
-
- $existsStart = microtime(true);
- $fileExists = $this->fileExists($requestedPath);
-
- $timings['file_exists_check'] = microtime(true) - $existsStart;
-
- if ($fileExists) {
- $timings['total'] = microtime(true) - $startTime;
- $timings['cache_hit'] = true;
-
- Log::info('Subtitle resolved (cached)', [
- 'metadata_uuid' => $metadata->uuid,
- 'track' => $track,
- 'format' => $format,
- 'timings_ms' => array_map(fn ($t) => round($t * 1000, 2), $timings),
- ]);
+ if ($this->fileExists($requestedPath)) {
return Response::file(Storage::disk('local')->path($requestedPath));
}
- $timings['cache_hit'] = false;
-
+ // If file does not exist already and videoId is missing, abort early
if (! $metadata->video_id) {
abort(404);
}
if ($subtitle->track_id === 0 && $subtitle->external_path && ! $subtitle->path) {
- $externalStart = microtime(true);
$this->resolveExternalSubtitle($subtitle);
- $timings['external_subtitle_copy'] = microtime(true) - $externalStart;
}
- $extractionCheckStart = microtime(true);
+ // If subtitle was never extracted or the extracted file is missing, extract again
$needsExtraction = ! $subtitle->path || ! $this->fileExists($subtitle->path);
- $timings['extraction_check'] = microtime(true) - $extractionCheckStart;
-
if ($needsExtraction) {
- $extractionStart = microtime(true);
$this->extractor->extractStream($metadata, $subtitle);
- $timings['extraction'] = microtime(true) - $extractionStart;
}
- $refreshStart = microtime(true);
- $subtitle->refresh();
- $timings['subtitle_refresh'] = microtime(true) - $refreshStart;
- $conversionStart = microtime(true);
+ // Generate the correct file format based on the request (returns the generated file if it already matches)
+ $subtitle->refresh();
$convertedPath = $this->formatter->convert($subtitle->path, $requestedPath, $format);
- $timings['format_conversion'] = microtime(true) - $conversionStart;
-
- $timings['total'] = microtime(true) - $startTime;
Log::info('Subtitle resolved (generated)', [
'metadata_uuid' => $metadata->uuid,
@@ -95,19 +58,14 @@ class SubtitleResolver {
'format' => $format,
'language' => $language,
'needed_extraction' => $needsExtraction,
- 'timings_ms' => array_map(fn ($t) => round($t * 1000, 2), $timings),
]);
return Response::file($convertedPath);
- } catch (ModelNotFoundException $e) {
- throw $e;
} catch (\Throwable $th) {
- $timings['total'] = microtime(true) - $startTime;
Log::error('Subtitle Resolver Failed', [
'error' => $th->getMessage(),
'metadata_uuid' => $metadata->uuid ?? null,
'track' => $track,
- 'timings_ms' => array_map(fn ($t) => round($t * 1000, 2), $timings),
]);
throw $th;
}
@@ -132,6 +90,20 @@ class SubtitleResolver {
]);
}
+ private function findSubtitle(Metadata $metadata, int $track, ?string $language): Subtitle {
+ if ($track === 0 && $language) {
+ // find external track by language
+ return $metadata->subtitles()
+ ->where('track_id', 0)
+ ->where('language', $language)
+ ->firstOrFail();
+ }
+
+ return $metadata->subtitles()
+ ->where('track_id', $track)
+ ->firstOrFail();
+ }
+
private function fileExists(string $path): bool {
return Storage::disk('local')->exists($path);
}