| | | 1 | | using System; |
| | | 2 | | using AsyncKeyedLock; |
| | | 3 | | using Microsoft.AspNetCore.Mvc.ApiExplorer; |
| | | 4 | | using Microsoft.Extensions.Caching.Memory; |
| | | 5 | | using Microsoft.Extensions.Logging; |
| | | 6 | | using Microsoft.Extensions.Options; |
| | | 7 | | using Microsoft.OpenApi.Models; |
| | | 8 | | using Swashbuckle.AspNetCore.Swagger; |
| | | 9 | | using Swashbuckle.AspNetCore.SwaggerGen; |
| | | 10 | | |
| | | 11 | | namespace Jellyfin.Server.Filters; |
| | | 12 | | |
| | | 13 | | /// <summary> |
| | | 14 | | /// OpenApi provider with caching. |
| | | 15 | | /// </summary> |
| | | 16 | | internal sealed class CachingOpenApiProvider : ISwaggerProvider |
| | | 17 | | { |
| | | 18 | | private const string CacheKey = "openapi.json"; |
| | | 19 | | |
| | 0 | 20 | | private static readonly MemoryCacheEntryOptions _cacheOptions = new() { SlidingExpiration = TimeSpan.FromMinutes(5) |
| | 0 | 21 | | private static readonly AsyncNonKeyedLocker _lock = new(1); |
| | 0 | 22 | | private static readonly TimeSpan _lockTimeout = TimeSpan.FromSeconds(1); |
| | | 23 | | |
| | | 24 | | private readonly IMemoryCache _memoryCache; |
| | | 25 | | private readonly SwaggerGenerator _swaggerGenerator; |
| | | 26 | | private readonly SwaggerGeneratorOptions _swaggerGeneratorOptions; |
| | | 27 | | private readonly ILogger<CachingOpenApiProvider> _logger; |
| | | 28 | | |
| | | 29 | | /// <summary> |
| | | 30 | | /// Initializes a new instance of the <see cref="CachingOpenApiProvider"/> class. |
| | | 31 | | /// </summary> |
| | | 32 | | /// <param name="optionsAccessor">The options accessor.</param> |
| | | 33 | | /// <param name="apiDescriptionsProvider">The api descriptions provider.</param> |
| | | 34 | | /// <param name="schemaGenerator">The schema generator.</param> |
| | | 35 | | /// <param name="memoryCache">The memory cache.</param> |
| | | 36 | | /// <param name="logger">The logger.</param> |
| | | 37 | | public CachingOpenApiProvider( |
| | | 38 | | IOptions<SwaggerGeneratorOptions> optionsAccessor, |
| | | 39 | | IApiDescriptionGroupCollectionProvider apiDescriptionsProvider, |
| | | 40 | | ISchemaGenerator schemaGenerator, |
| | | 41 | | IMemoryCache memoryCache, |
| | | 42 | | ILogger<CachingOpenApiProvider> logger) |
| | | 43 | | { |
| | 169 | 44 | | _swaggerGeneratorOptions = optionsAccessor.Value; |
| | 169 | 45 | | _swaggerGenerator = new SwaggerGenerator(_swaggerGeneratorOptions, apiDescriptionsProvider, schemaGenerator); |
| | 169 | 46 | | _memoryCache = memoryCache; |
| | 169 | 47 | | _logger = logger; |
| | 169 | 48 | | } |
| | | 49 | | |
| | | 50 | | /// <inheritdoc /> |
| | | 51 | | public OpenApiDocument GetSwagger(string documentName, string? host = null, string? basePath = null) |
| | | 52 | | { |
| | 0 | 53 | | if (_memoryCache.TryGetValue(CacheKey, out OpenApiDocument? openApiDocument) && openApiDocument is not null) |
| | | 54 | | { |
| | 0 | 55 | | return AdjustDocument(openApiDocument, host, basePath); |
| | | 56 | | } |
| | | 57 | | |
| | 0 | 58 | | using var acquired = _lock.LockOrNull(_lockTimeout); |
| | 0 | 59 | | if (_memoryCache.TryGetValue(CacheKey, out openApiDocument) && openApiDocument is not null) |
| | | 60 | | { |
| | 0 | 61 | | return AdjustDocument(openApiDocument, host, basePath); |
| | | 62 | | } |
| | | 63 | | |
| | 0 | 64 | | if (acquired is null) |
| | | 65 | | { |
| | 0 | 66 | | throw new InvalidOperationException("OpenApi document is generating"); |
| | | 67 | | } |
| | | 68 | | |
| | | 69 | | try |
| | | 70 | | { |
| | 0 | 71 | | openApiDocument = _swaggerGenerator.GetSwagger(documentName); |
| | 0 | 72 | | } |
| | 0 | 73 | | catch (Exception ex) |
| | | 74 | | { |
| | 0 | 75 | | _logger.LogError(ex, "OpenAPI generation error"); |
| | 0 | 76 | | throw; |
| | | 77 | | } |
| | | 78 | | |
| | 0 | 79 | | _memoryCache.Set(CacheKey, openApiDocument, _cacheOptions); |
| | 0 | 80 | | return AdjustDocument(openApiDocument, host, basePath); |
| | 0 | 81 | | } |
| | | 82 | | |
| | | 83 | | private OpenApiDocument AdjustDocument(OpenApiDocument document, string? host, string? basePath) |
| | | 84 | | { |
| | 0 | 85 | | document.Servers = _swaggerGeneratorOptions.Servers.Count != 0 |
| | 0 | 86 | | ? _swaggerGeneratorOptions.Servers |
| | 0 | 87 | | : string.IsNullOrEmpty(host) && string.IsNullOrEmpty(basePath) |
| | 0 | 88 | | ? [] |
| | 0 | 89 | | : [new OpenApiServer { Url = $"{host}{basePath}" }]; |
| | | 90 | | |
| | 0 | 91 | | return document; |
| | | 92 | | } |
| | | 93 | | } |