cotugno/immich
2
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-16 10:28:54 -07:00
Code Issues Packages Projects Releases Wiki Activity

refactor(server): asset serve files (#2052)

Browse Source
This commit is contained in:
Jason Rasmussen 2023-03-23 22:40:30 -04:00 committed by GitHub
parent 586590e9ec
commit bbd897b8ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 81 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

196
server/apps/immich/src/api-v1/asset/asset.service.ts
View File

@ -13,7 +13,7 @@ import { InjectRepository } from '@nestjs/typeorm';
import { QueryFailedError, Repository } from 'typeorm'; import { QueryFailedError, Repository } from 'typeorm';
import { AuthUserDto } from '../../decorators/auth-user.decorator'; import { AuthUserDto } from '../../decorators/auth-user.decorator';
import { AssetEntity, AssetType, SharedLinkType, SystemConfig } from '@app/infra'; import { AssetEntity, AssetType, SharedLinkType, SystemConfig } from '@app/infra';
import { constants, createReadStream, ReadStream, stat } from 'fs'; import { constants, createReadStream, stat } from 'fs';
import { ServeFileDto } from './dto/serve-file.dto'; import { ServeFileDto } from './dto/serve-file.dto';
import { Response as Res } from 'express'; import { Response as Res } from 'express';
import { promisify } from 'util'; import { promisify } from 'util';
@ -67,6 +67,11 @@ import { getFileNameWithoutExtension } from '@app/domain';
const fileInfo = promisify(stat); const fileInfo = promisify(stat);
interface ServableFile {
filepath: string;
contentType: string;
}
@Injectable() @Injectable()
export class AssetService { export class AssetService {
readonly logger = new Logger(AssetService.name); readonly logger = new Logger(AssetService.name);
@ -216,37 +221,15 @@ export class AssetService {
throw new NotFoundException(); throw new NotFoundException();
} }
public async getAssetThumbnail( async getAssetThumbnail(assetId: string, query: GetAssetThumbnailDto, res: Res, headers: Record<string, string>) {
assetId: string,
query: GetAssetThumbnailDto,
res: Res,
headers: Record<string, string>,
) {
let fileReadStream: ReadStream;
const asset = await this._assetRepository.get(assetId); const asset = await this._assetRepository.get(assetId);
if (!asset) { if (!asset) {
throw new NotFoundException('Asset not found'); throw new NotFoundException('Asset not found');
} }
try { try {
if (query.format == GetAssetThumbnailFormatEnum.WEBP && asset.webpPath && asset.webpPath.length > 0) { const thumbnailPath = this.getThumbnailPath(asset, query.format);
if (await processETag(asset.webpPath, res, headers)) { return this.streamFile(thumbnailPath, res, headers);
return;
}
await fs.access(asset.webpPath, constants.R_OK);
fileReadStream = createReadStream(asset.webpPath);
} else {
if (!asset.resizePath) {
throw new NotFoundException('resizePath not set');
}
if (await processETag(asset.resizePath, res, headers)) {
return;
}
await fs.access(asset.resizePath, constants.R_OK);
fileReadStream = createReadStream(asset.resizePath);
}
return new StreamableFile(fileReadStream);
} catch (e) { } catch (e) {
res.header('Cache-Control', 'none'); res.header('Cache-Control', 'none');
Logger.error(`Cannot create read stream for asset ${asset.id}`, 'getAssetThumbnail'); Logger.error(`Cannot create read stream for asset ${asset.id}`, 'getAssetThumbnail');
@ -264,11 +247,9 @@ export class AssetService {
res: Res, res: Res,
headers: Record<string, string>, headers: Record<string, string>,
) { ) {
const allowOriginalFile = !authUser.isPublicUser || authUser.isAllowDownload; const allowOriginalFile = !!(!authUser.isPublicUser || authUser.isAllowDownload);
let fileReadStream: ReadStream;
const asset = await this._assetRepository.getById(assetId); const asset = await this._assetRepository.getById(assetId);
if (!asset) { if (!asset) {
throw new NotFoundException('Asset does not exist'); throw new NotFoundException('Asset does not exist');
} }
@ -276,69 +257,8 @@ export class AssetService {
// Handle Sending Images // Handle Sending Images
if (asset.type == AssetType.IMAGE) { if (asset.type == AssetType.IMAGE) {
try { try {
/** const { filepath, contentType } = this.getServePath(asset, query, allowOriginalFile);
* Serve file viewer on the web return this.streamFile(filepath, res, headers, contentType);
*/
if (query.isWeb && asset.mimeType != 'image/gif') {
res.set({
'Content-Type': 'image/jpeg',
});
if (!asset.resizePath) {
Logger.error('Error serving IMAGE asset for web', 'ServeFile');
throw new InternalServerErrorException(`Failed to serve image asset for web`, 'ServeFile');
}
if (await processETag(asset.resizePath, res, headers)) {
return;
}
await fs.access(asset.resizePath, constants.R_OK | constants.W_OK);
fileReadStream = createReadStream(asset.resizePath);
return new StreamableFile(fileReadStream);
}
/**
* Serve thumbnail image for both web and mobile app
*/
if ((!query.isThumb && allowOriginalFile) || (query.isWeb && asset.mimeType === 'image/gif')) {
res.set({
'Content-Type': asset.mimeType,
});
if (await processETag(asset.originalPath, res, headers)) {
return;
}
await fs.access(asset.originalPath, constants.R_OK | constants.W_OK);
fileReadStream = createReadStream(asset.originalPath);
} else {
if (asset.webpPath && asset.webpPath.length > 0) {
res.set({
'Content-Type': 'image/webp',
});
if (await processETag(asset.webpPath, res, headers)) {
return;
}
await fs.access(asset.webpPath, constants.R_OK | constants.W_OK);
fileReadStream = createReadStream(asset.webpPath);
} else {
res.set({
'Content-Type': 'image/jpeg',
});
if (!asset.resizePath) {
throw new Error('resizePath not set');
}
if (await processETag(asset.resizePath, res, headers)) {
return;
}
await fs.access(asset.resizePath, constants.R_OK | constants.W_OK);
fileReadStream = createReadStream(asset.resizePath);
}
}
return new StreamableFile(fileReadStream);
} catch (e) { } catch (e) {
Logger.error(`Cannot create read stream for asset ${asset.id} ${JSON.stringify(e)}`, 'serveFile[IMAGE]'); Logger.error(`Cannot create read stream for asset ${asset.id} ${JSON.stringify(e)}`, 'serveFile[IMAGE]');
throw new InternalServerErrorException( throw new InternalServerErrorException(
@ -350,7 +270,6 @@ export class AssetService {
try { try {
// Handle Video // Handle Video
let videoPath = asset.originalPath; let videoPath = asset.originalPath;
let mimeType = asset.mimeType; let mimeType = asset.mimeType;
await fs.access(videoPath, constants.R_OK | constants.W_OK); await fs.access(videoPath, constants.R_OK | constants.W_OK);
@ -382,9 +301,7 @@ export class AssetService {
if (start >= size || end >= size) { if (start >= size || end >= size) {
console.error('Bad Request'); console.error('Bad Request');
// Return the 416 Range Not Satisfiable. // Return the 416 Range Not Satisfiable.
res.status(416).set({ res.status(416).set({ 'Content-Range': `bytes */${size}` });
'Content-Range': `bytes */${size}`,
});
throw new BadRequestException('Bad Request Range'); throw new BadRequestException('Bad Request Range');
} }
@ -397,20 +314,14 @@ export class AssetService {
'Content-Type': mimeType, 'Content-Type': mimeType,
}); });
const videoStream = createReadStream(videoPath, { start: start, end: end }); const videoStream = createReadStream(videoPath, { start, end });
return new StreamableFile(videoStream); return new StreamableFile(videoStream);
} else {
res.set({
'Content-Type': mimeType,
});
if (await processETag(asset.originalPath, res, headers)) {
return;
}
return new StreamableFile(createReadStream(videoPath));
} }
return this.streamFile(asset.originalPath, res, headers, mimeType);
} catch (e) { } catch (e) {
Logger.error(`Error serving VIDEO asset id ${asset.id}`, 'serveFile[VIDEO]'); this.logger.error(`Error serving VIDEO asset=${asset.id}`);
throw new InternalServerErrorException(`Failed to serve video asset ${e}`, 'ServeFile'); throw new InternalServerErrorException(`Failed to serve video asset ${e}`, 'ServeFile');
} }
} }
@ -648,15 +559,70 @@ export class AssetService {
getExifPermission(authUser: AuthUserDto) { getExifPermission(authUser: AuthUserDto) {
return !authUser.isPublicUser || authUser.isShowExif; return !authUser.isPublicUser || authUser.isShowExif;
} }
}
async function processETag(path: string, res: Res, headers: Record<string, string>): Promise<boolean> { private getThumbnailPath(asset: AssetEntity, format: GetAssetThumbnailFormatEnum) {
const { size, mtimeNs } = await fs.stat(path, { bigint: true }); switch (format) {
const etag = `W/"${size}-${mtimeNs}"`; case GetAssetThumbnailFormatEnum.WEBP:
res.setHeader('ETag', etag); if (asset.webpPath && asset.webpPath.length > 0) {
if (etag === headers['if-none-match']) { return asset.webpPath;
res.status(304); }
return true;
case GetAssetThumbnailFormatEnum.JPEG:
default:
if (!asset.resizePath) {
throw new NotFoundException('resizePath not set');
}
return asset.resizePath;
}
}
private getServePath(asset: AssetEntity, query: ServeFileDto, allowOriginalFile: boolean): ServableFile {
/**
* Serve file viewer on the web
*/
if (query.isWeb && asset.mimeType != 'image/gif') {
if (!asset.resizePath) {
this.logger.error('Error serving IMAGE asset for web');
throw new InternalServerErrorException(`Failed to serve image asset for web`, 'ServeFile');
}
return { filepath: asset.resizePath, contentType: 'image/jpeg' };
}
/**
* Serve thumbnail image for both web and mobile app
*/
if ((!query.isThumb && allowOriginalFile) || (query.isWeb && asset.mimeType === 'image/gif')) {
return { filepath: asset.originalPath, contentType: asset.mimeType as string };
}
if (asset.webpPath && asset.webpPath.length > 0) {
return { filepath: asset.webpPath, contentType: 'image/webp' };
}
if (!asset.resizePath) {
throw new Error('resizePath not set');
}
return { filepath: asset.resizePath, contentType: 'image/jpeg' };
}
private async streamFile(filepath: string, res: Res, headers: Record<string, string>, contentType?: string | null) {
if (contentType) {
res.header('Content-Type', contentType);
}
// etag
const { size, mtimeNs } = await fs.stat(filepath, { bigint: true });
const etag = `W/"${size}-${mtimeNs}"`;
res.setHeader('ETag', etag);
if (etag === headers['if-none-match']) {
res.status(304);
return;
}
await fs.access(filepath, constants.R_OK);
return new StreamableFile(createReadStream(filepath));
} }
return false;
} }