mirror of
https://github.com/outline/outline.git
synced 2026-06-13 11:25:03 +03:00
Tom Moor
5610df5a26
* chore: Reduce no-explicit-any warnings in server directory Tightens types across test response bodies, decorator signatures, the TestServer wrapper, base class generics, and presenter Record types. Where any is genuinely load-bearing (Sequelize model generics, PropertyDescriptor decorator returns, plugin-registered template classes, Fix mixin), keeps any with a targeted eslint-disable plus reason rather than masking the constraint. Cuts server-only no-explicit-any warnings from 162 to 70. * fix: groups test asserts on first response instead of second Caught by Copilot review on the no-explicit-any cleanup. Also fixes the pre-existing getChangsetSkipped → getChangesetSkipped typo surfaced while reviewing nearby decorator code.
85 lines
2.9 KiB
TypeScript
85 lines
2.9 KiB
TypeScript
import isNil from "lodash/isNil";
|
|
import type { InferAttributes } from "sequelize";
|
|
import type { ModelClassGetter } from "sequelize-typescript";
|
|
import env from "@server/env";
|
|
import { CacheHelper } from "@server/utils/CacheHelper";
|
|
import type Model from "../base/Model";
|
|
|
|
type RelationOptions = {
|
|
/** Reference name used in cache key. */
|
|
as: string;
|
|
/** The foreign key to use for the relationship query. */
|
|
foreignKey: string;
|
|
};
|
|
|
|
/**
|
|
* A decorator that caches the count of a relationship and registers model lifecycle hooks
|
|
* to invalidate the cache when models are added or removed from the relationship.
|
|
*/
|
|
export function CounterCache<
|
|
TCreationAttributes extends InferAttributes<Model>,
|
|
TModelAttributes extends InferAttributes<Model>,
|
|
T extends typeof Model,
|
|
>(
|
|
classResolver: ModelClassGetter<TCreationAttributes, TModelAttributes>,
|
|
options: RelationOptions
|
|
) {
|
|
return function (target: InstanceType<T>, _propertyKey: string) {
|
|
if (env.isTest) {
|
|
// No-op cache in test environment
|
|
return;
|
|
}
|
|
const modelClass = classResolver() as typeof Model;
|
|
const cacheKeyPrefix = `count:${target.constructor.name}:${options.as}`;
|
|
|
|
// Add hooks after model is added to the sequelize instance
|
|
setImmediate(() => {
|
|
const recalculateCache =
|
|
(offset: number) => async (model: InstanceType<T>) => {
|
|
const cacheKey = `${cacheKeyPrefix}:${
|
|
model[options.foreignKey as keyof typeof model]
|
|
}`;
|
|
|
|
const count = await modelClass.count({
|
|
where: {
|
|
[options.foreignKey]:
|
|
model[options.foreignKey as keyof typeof model],
|
|
},
|
|
});
|
|
await CacheHelper.setData(cacheKey, count + offset);
|
|
};
|
|
|
|
// Because the transaction is not complete until after the response is sent, we need to
|
|
// offset the count by 1 to account for the record. TODO: Need to find a better way to handle
|
|
// this as a rollback would not decrement the count.
|
|
modelClass.addHook("afterCreate", recalculateCache(1));
|
|
modelClass.addHook("afterDestroy", recalculateCache(-1));
|
|
});
|
|
|
|
return {
|
|
get() {
|
|
const cacheKey = `${cacheKeyPrefix}:${this.id}`;
|
|
|
|
return CacheHelper.getData<number>(cacheKey).then((value) => {
|
|
if (!isNil(value)) {
|
|
return value;
|
|
}
|
|
|
|
// calculate and cache count
|
|
return modelClass
|
|
.count({
|
|
where: {
|
|
[options.foreignKey]: this.id,
|
|
},
|
|
})
|
|
.then((count) => {
|
|
void CacheHelper.setData(cacheKey, count);
|
|
return count;
|
|
});
|
|
});
|
|
},
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TS rejects PropertyDescriptor as legacy decorator return type; descriptor is consumed by Sequelize at runtime.
|
|
} as any;
|
|
};
|
|
}
|