mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2025-12-27 09:23:52 -05:00
108 lines
4.0 KiB
TypeScript
108 lines
4.0 KiB
TypeScript
// Copyright (c) 2018, Compiler Explorer Authors
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import {Buffer} from 'buffer';
|
|
|
|
import {Counter} from 'prom-client';
|
|
|
|
import type {CacheableValue, GetResult} from '../../types/cache.interfaces.js';
|
|
import {logger} from '../logger.js';
|
|
import {getHash} from '../utils.js';
|
|
|
|
import {Cache, CacheStats} from './base.interfaces.js';
|
|
|
|
const HashVersion = 'Compiler Explorer Cache Version 1';
|
|
|
|
const GetCounter = new Counter({
|
|
name: 'ce_cache_get_total',
|
|
help: 'Total number of cache gets',
|
|
labelNames: ['result', 'name', 'type'],
|
|
});
|
|
|
|
const PutCounter = new Counter({
|
|
name: 'ce_cache_put_total',
|
|
help: 'Total number of cache puts',
|
|
labelNames: ['type', 'name'],
|
|
});
|
|
|
|
export abstract class BaseCache implements Cache {
|
|
readonly cacheName: string;
|
|
readonly details: string;
|
|
readonly type: string;
|
|
gets: number;
|
|
puts: number;
|
|
hits: number;
|
|
protected countersEnabled: boolean;
|
|
|
|
protected constructor(cacheName: string, details: string, type: string) {
|
|
this.cacheName = cacheName;
|
|
this.details = details;
|
|
this.type = type;
|
|
this.gets = 0;
|
|
this.hits = 0;
|
|
this.puts = 0;
|
|
this.countersEnabled = true;
|
|
}
|
|
|
|
stats(): CacheStats {
|
|
return {hits: this.hits, puts: this.puts, gets: this.gets};
|
|
}
|
|
|
|
statString(): string {
|
|
const pc = this.gets ? (100 * this.hits) / this.gets : 0;
|
|
const misses = this.gets - this.hits;
|
|
return `${this.puts} puts; ${this.gets} gets, ${this.hits} hits, ${misses} misses (${pc.toFixed(2)}%)`;
|
|
}
|
|
|
|
report(): void {
|
|
logger.info(`${this.cacheName} ${this.details}: cache stats: ${this.statString()}`);
|
|
}
|
|
|
|
static hash(object: CacheableValue): string {
|
|
return getHash(object, HashVersion);
|
|
}
|
|
|
|
async get(key: string): Promise<GetResult> {
|
|
this.gets++;
|
|
const result = await this.getInternal(key);
|
|
if (result.hit) this.hits++;
|
|
const resultTypeName = result.hit ? 'hit' : 'miss';
|
|
logger.debug(`Cache ${this.cacheName}: get ${key} ${resultTypeName}`);
|
|
if (this.countersEnabled) GetCounter.inc({type: this.type, name: this.cacheName, result: resultTypeName});
|
|
return result;
|
|
}
|
|
|
|
async put(key: string, value: any, creator?: string): Promise<void> {
|
|
if (!(value instanceof Buffer)) value = Buffer.from(value);
|
|
this.puts++;
|
|
logger.debug(`Cache ${this.cacheName}: put ${key}`);
|
|
if (this.countersEnabled) PutCounter.inc({type: this.type, name: this.cacheName});
|
|
return this.putInternal(key, value, creator);
|
|
}
|
|
|
|
abstract getInternal(key: string): Promise<GetResult>;
|
|
|
|
abstract putInternal(key: string, value: Buffer, creator?: string): Promise<void>;
|
|
}
|