aboutsummaryrefslogtreecommitdiff
path: root/back-end/src/Cache/SearchResultCache.cs
blob: c7a263ad1fd36d849dca2b273ec57687ff4d5919 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
// Copyright (C) 2024 Vaughn Nugent
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

using System;
using System.Threading;
using System.Threading.Tasks;

using VNLib.Net.Http;
using VNLib.Data.Caching;
using VNLib.Plugins;
using VNLib.Plugins.Extensions.Loading;
using VNLib.Plugins.Extensions.VNCache;
using VNLib.Plugins.Extensions.VNCache.DataModel;

namespace SimpleBookmark.Cache
{
    [ConfigurationName("search_cache", Required = false)]
    internal sealed class SearchResultCache
    {
        private readonly IEntityCache<ResultCacheEntry>? _cache;

        /// <summary>
        /// Gets a value that indicates if the configuration enabled result caching
        /// </summary>
        public bool IsEnabled => _cache != null;

        public SearchResultCache(PluginBase plugin) : this(plugin, null)
        { }

        public SearchResultCache(PluginBase plugin, IConfigScope? config)
        {
            string? cachePrefix = config?.GetRequiredProperty("cachePrefix", p => p.GetString()!);
            bool isEnabled = config?.GetRequiredProperty("enabled", p => p.GetBoolean()) ?? true;

            if (!isEnabled)
            {
                return;
            }

            IGlobalCacheProvider? cache = plugin.GetDefaultGlobalCache();
            if (cache != null)
            {
                if (cachePrefix != null)
                {
                    _cache = cache.GetPrefixedCache(cachePrefix)
                        .CreateEntityCache<ResultCacheEntry>(
                            new MemPackCacheSerializer(null),
                            new MemPackCacheSerializer(null)
                        );
                }
                else
                {
                    //non-prefixed cache
                    _cache = cache.CreateEntityCache<ResultCacheEntry>(
                        new MemPackCacheSerializer(null),
                        new MemPackCacheSerializer(null)
                    );
                }
            }
        }

        public async Task<IMemoryResponseReader?> GetCachedResultAsync(string[] keys, CancellationToken cancellation)
        {
            ResultCacheEntry? entry = await _cache!.GetAsync($"{keys}", cancellation);
            return entry is null ? null : new ResultResponseReader(entry);
        }

        public Task StoreResultAsync(Memory<byte> data, string[] keys, CancellationToken cancellation)
        {
            //Init new entry
            ResultCacheEntry entry = new()
            {
                Payload = data,
                Created = DateTime.UtcNow
            };

            return _cache!.UpsertAsync($"{keys}", entry, cancellation);
        }

        public Task DeleteEntry(string[] keys, CancellationToken cancellation) => _cache!.RemoveAsync($"{keys}", cancellation);

        private sealed class ResultResponseReader(ResultCacheEntry entry) : IMemoryResponseReader
        {
            private int _position;

            ///<inheritdoc/>
            public int Remaining => entry.Payload.Length - _position;

            ///<inheritdoc/>
            public void Advance(int written) => _position += written;

            ///<inheritdoc/>
            public void Close() => entry.Dispose();

            ///<inheritdoc/>
            public ReadOnlyMemory<byte> GetMemory() => entry.Payload.Slice(_position);
        }
    }
}