1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-31 00:16:47 +01:00
unleash.unleash/src/lib/db/feature-strategy-store.ts
andreas-unleash d21ccb7f1c
Feat: last seen in feature environment (#4391)
- Adds last_seen_at column in feature_environments and lastSeenAt
property to the FeatureEnvironment models

Closes
[1-1181](https://linear.app/unleash/issue/1-1181/implement-storing-last-seen-per-environment-be)

---------

Signed-off-by: andreas-unleash <andreas@getunleash.ai>
2023-08-04 09:59:54 +03:00

725 lines
23 KiB
TypeScript

import { Knex } from 'knex';
import EventEmitter from 'events';
import { v4 as uuidv4 } from 'uuid';
import metricsHelper from '../util/metrics-helper';
import { DB_TIME } from '../metric-events';
import { Logger, LogProvider } from '../logger';
import NotFoundError from '../error/notfound-error';
import {
FeatureToggleWithEnvironment,
IConstraint,
IEnvironmentOverview,
IFeatureOverview,
IFeatureStrategiesStore,
IFeatureStrategy,
IFeatureToggleClient,
IFlagResolver,
IStrategyConfig,
IStrategyVariant,
ITag,
PartialDeep,
PartialSome,
} from '../types';
import FeatureToggleStore from './feature-toggle-store';
import { ensureStringValue, mapValues } from '../util';
import { IFeatureProjectUserParams } from '../routes/admin-api/project/project-features';
import { Db } from './db';
import Raw = Knex.Raw;
const COLUMNS = [
'id',
'feature_name',
'project_name',
'environment',
'strategy_name',
'title',
'parameters',
'constraints',
'variants',
'created_at',
'disabled',
];
/*
const mapperToColumnNames = {
createdAt: 'created_at',
featureName: 'feature_name',
strategyName: 'strategy_name',
};
*/
const T = {
features: 'features',
featureStrategies: 'feature_strategies',
featureStrategySegment: 'feature_strategy_segment',
featureEnvs: 'feature_environments',
strategies: 'strategies',
};
interface IFeatureStrategiesTable {
id: string;
feature_name: string;
project_name: string;
environment: string;
title?: string | null;
strategy_name: string;
parameters: object;
constraints: string;
variants: string;
sort_order: number;
created_at?: Date;
disabled?: boolean | null;
}
export interface ILoadFeatureToggleWithEnvsParams {
featureName: string;
archived: boolean;
withEnvironmentVariants: boolean;
userId?: number;
}
function mapRow(row: IFeatureStrategiesTable): IFeatureStrategy {
return {
id: row.id,
featureName: row.feature_name,
projectId: row.project_name,
environment: row.environment,
strategyName: row.strategy_name,
title: row.title,
parameters: mapValues(row.parameters || {}, ensureStringValue),
constraints: (row.constraints as unknown as IConstraint[]) || [],
variants: (row.variants as unknown as IStrategyVariant[]) || [],
createdAt: row.created_at,
sortOrder: row.sort_order,
disabled: row.disabled,
};
}
function mapInput(input: IFeatureStrategy): IFeatureStrategiesTable {
return {
id: input.id,
feature_name: input.featureName,
project_name: input.projectId,
environment: input.environment,
strategy_name: input.strategyName,
title: input.title,
parameters: input.parameters,
constraints: JSON.stringify(input.constraints || []),
variants: JSON.stringify(input.variants || []),
created_at: input.createdAt,
sort_order: input.sortOrder ?? 9999,
disabled: input.disabled,
};
}
interface StrategyUpdate {
strategy_name: string;
parameters: object;
constraints: string;
variants: string;
title?: string;
disabled?: boolean;
}
function mapStrategyUpdate(
input: Partial<IStrategyConfig>,
): Partial<StrategyUpdate> {
const update: Partial<StrategyUpdate> = {};
if (input.name !== null) {
update.strategy_name = input.name;
}
if (input.parameters !== null) {
update.parameters = input.parameters;
}
if (input.title !== null) {
update.title = input.title;
}
if (input.disabled !== null) {
update.disabled = input.disabled;
}
update.constraints = JSON.stringify(input.constraints || []);
update.variants = JSON.stringify(input.variants || []);
return update;
}
class FeatureStrategiesStore implements IFeatureStrategiesStore {
private db: Db;
private logger: Logger;
private readonly timer: Function;
private flagResolver: IFlagResolver;
constructor(
db: Db,
eventBus: EventEmitter,
getLogger: LogProvider,
flagResolver: IFlagResolver,
) {
this.db = db;
this.logger = getLogger('feature-toggle-store.ts');
this.timer = (action) =>
metricsHelper.wrapTimer(eventBus, DB_TIME, {
store: 'feature-toggle-strategies',
action,
});
this.flagResolver = flagResolver;
}
async delete(key: string): Promise<void> {
await this.db(T.featureStrategies).where({ id: key }).del();
}
async deleteAll(): Promise<void> {
await this.db(T.featureStrategies).delete();
}
destroy(): void {}
async exists(key: string): Promise<boolean> {
const result = await this.db.raw(
`SELECT EXISTS(SELECT 1 FROM ${T.featureStrategies} WHERE id = ?) AS present`,
[key],
);
const { present } = result.rows[0];
return present;
}
async get(key: string): Promise<IFeatureStrategy> {
const row = await this.db(T.featureStrategies)
.where({ id: key })
.first();
if (!row) {
throw new NotFoundError(`Could not find strategy with id=${key}`);
}
return mapRow(row);
}
private async nextSortOrder(featureName: string, environment: string) {
const [{ max }] = await this.db(T.featureStrategies)
.max('sort_order as max')
.where({
feature_name: featureName,
environment,
});
return Number.isInteger(max) ? max + 1 : 0;
}
async createStrategyFeatureEnv(
strategyConfig: PartialSome<IFeatureStrategy, 'id' | 'createdAt'>,
): Promise<IFeatureStrategy> {
const sortOrder =
strategyConfig.sortOrder ??
(await this.nextSortOrder(
strategyConfig.featureName,
strategyConfig.environment,
));
const strategyRow = mapInput({
id: uuidv4(),
...strategyConfig,
sortOrder,
});
const rows = await this.db<IFeatureStrategiesTable>(T.featureStrategies)
.insert(strategyRow)
.returning('*');
return mapRow(rows[0]);
}
async removeAllStrategiesForFeatureEnv(
featureName: string,
environment: string,
): Promise<void> {
await this.db('feature_strategies')
.where({ feature_name: featureName, environment })
.del();
}
async getAll(): Promise<IFeatureStrategy[]> {
const stopTimer = this.timer('getAll');
const rows = await this.db
.select(COLUMNS)
.from<IFeatureStrategiesTable>(T.featureStrategies);
stopTimer();
return rows.map(mapRow);
}
async getAllByFeatures(
features: string[],
environment?: string,
): Promise<IFeatureStrategy[]> {
const query = this.db
.select(COLUMNS)
.from<IFeatureStrategiesTable>(T.featureStrategies)
.whereIn('feature_name', features)
.orderBy('feature_name', 'asc');
if (environment) {
query.where('environment', environment);
}
const rows = await query;
return rows.map(mapRow);
}
async getStrategiesForFeatureEnv(
projectId: string,
featureName: string,
environment: string,
): Promise<IFeatureStrategy[]> {
const stopTimer = this.timer('getForFeature');
const rows = await this.db<IFeatureStrategiesTable>(T.featureStrategies)
.where({
project_name: projectId,
feature_name: featureName,
environment,
})
.orderBy([
{ column: 'sort_order', order: 'asc' },
{ column: 'created_at', order: 'asc' },
]);
stopTimer();
return rows.map(mapRow);
}
async getFeatureToggleWithEnvs(
featureName: string,
userId?: number,
archived: boolean = false,
): Promise<FeatureToggleWithEnvironment> {
return this.loadFeatureToggleWithEnvs({
featureName,
archived,
withEnvironmentVariants: false,
userId,
});
}
async getFeatureToggleWithVariantEnvs(
featureName: string,
userId?: number,
archived: boolean = false,
): Promise<FeatureToggleWithEnvironment> {
return this.loadFeatureToggleWithEnvs({
featureName,
archived,
withEnvironmentVariants: true,
userId,
});
}
async loadFeatureToggleWithEnvs({
featureName,
archived,
withEnvironmentVariants,
userId,
}: ILoadFeatureToggleWithEnvsParams): Promise<FeatureToggleWithEnvironment> {
const stopTimer = this.timer('getFeatureAdmin');
let query = this.db('features_view')
.where('name', featureName)
.modify(FeatureToggleStore.filterByArchived, archived);
let selectColumns = ['features_view.*'] as (string | Raw<any>)[];
if (userId) {
query = query.leftJoin(`favorite_features`, function () {
this.on(
'favorite_features.feature',
'features_view.name',
).andOnVal('favorite_features.user_id', '=', userId);
});
selectColumns = [
...selectColumns,
this.db.raw(
'favorite_features.feature is not null as favorite',
),
];
}
const rows = await query.select(selectColumns);
stopTimer();
if (rows.length > 0) {
const featureToggle = rows.reduce((acc, r) => {
if (acc.environments === undefined) {
acc.environments = {};
}
acc.name = r.name;
acc.favorite = r.favorite;
acc.impressionData = r.impression_data;
acc.description = r.description;
acc.project = r.project;
acc.stale = r.stale;
acc.lastSeenAt = r.last_seen_at;
acc.createdAt = r.created_at;
acc.type = r.type;
if (!acc.environments[r.environment]) {
acc.environments[r.environment] = {
name: r.environment,
lastSeenAt: r.env_last_seen_at,
};
}
const env = acc.environments[r.environment];
const variants = r.variants || [];
variants.sort((a, b) => a.name.localeCompare(b.name));
if (withEnvironmentVariants) {
env.variants = variants;
}
// this code sets variants at the feature level (should be deprecated with variants per environment)
const currentVariants = new Map(
acc.variants?.map((v) => [v.name, v]),
);
variants.forEach((variant) => {
currentVariants.set(variant.name, variant);
});
acc.variants = Array.from(currentVariants.values());
env.enabled = r.enabled;
env.type = r.environment_type;
env.sortOrder = r.environment_sort_order;
if (!env.strategies) {
env.strategies = [];
}
if (r.strategy_id) {
const found = env.strategies.find(
(strategy) => strategy.id === r.strategy_id,
);
if (!found) {
env.strategies.push(
FeatureStrategiesStore.getAdminStrategy(r),
);
}
}
if (r.segments) {
this.addSegmentIdsToStrategy(env, r);
}
acc.environments[r.environment] = env;
return acc;
}, {});
featureToggle.environments = Object.values(
featureToggle.environments,
).sort((a, b) => {
// @ts-expect-error
return a.sortOrder - b.sortOrder;
});
featureToggle.environments = featureToggle.environments.map((e) => {
e.strategies = e.strategies.sort(
(a, b) => a.sortOrder - b.sortOrder,
);
if (e.strategies && e.strategies.length === 0) {
e.enabled = false;
}
return e;
});
featureToggle.archived = archived;
return featureToggle;
}
throw new NotFoundError(
`Could not find feature toggle with name ${featureName}`,
);
}
private addSegmentIdsToStrategy(
featureToggle: PartialDeep<IFeatureToggleClient>,
row: Record<string, any>,
) {
const strategy = featureToggle.strategies?.find(
(s) => s?.id === row.strategy_id,
);
if (!strategy) {
return;
}
if (!strategy.segments) {
strategy.segments = [];
}
strategy.segments.push(row.segments);
}
private static getEnvironment(r: any): IEnvironmentOverview {
return {
name: r.environment,
enabled: r.enabled,
type: r.environment_type,
sortOrder: r.environment_sort_order,
variantCount: r.variants?.length || 0,
lastSeenAt: r.env_last_seen_at,
};
}
private addTag(
featureToggle: Record<string, any>,
row: Record<string, any>,
): void {
const tags = featureToggle.tags || [];
const newTag = FeatureStrategiesStore.rowToTag(row);
featureToggle.tags = [...tags, newTag];
}
private isNewTag(
featureToggle: Record<string, any>,
row: Record<string, any>,
): boolean {
return (
row.tag_type &&
row.tag_value &&
!featureToggle.tags?.some(
(tag) =>
tag.type === row.tag_type && tag.value === row.tag_value,
)
);
}
private static rowToTag(r: any): ITag {
return {
value: r.tag_value,
type: r.tag_type,
};
}
async getFeatureOverview({
projectId,
archived,
userId,
tag,
namePrefix,
}: IFeatureProjectUserParams): Promise<IFeatureOverview[]> {
let query = this.db('features').where({ project: projectId });
if (tag) {
const tagQuery = this.db
.from('feature_tag')
.select('feature_name')
.whereIn(['tag_type', 'tag_value'], tag);
query = query.whereIn('features.name', tagQuery);
}
if (namePrefix && namePrefix.trim()) {
let namePrefixQuery = namePrefix;
if (!namePrefix.endsWith('%')) {
namePrefixQuery = namePrefixQuery + '%';
}
query = query.whereILike('features.name', namePrefixQuery);
}
query = query
.modify(FeatureToggleStore.filterByArchived, archived)
.leftJoin(
'feature_environments',
'feature_environments.feature_name',
'features.name',
)
.leftJoin(
'environments',
'feature_environments.environment',
'environments.name',
)
.leftJoin('feature_tag as ft', 'ft.feature_name', 'features.name');
let selectColumns = [
'features.name as feature_name',
'features.description as description',
'features.type as type',
'features.created_at as created_at',
'features.last_seen_at as last_seen_at',
'features.stale as stale',
'features.impression_data as impression_data',
'feature_environments.enabled as enabled',
'feature_environments.environment as environment',
'feature_environments.variants as variants',
'feature_environments.last_seen_at as env_last_seen_at',
'environments.type as environment_type',
'environments.sort_order as environment_sort_order',
'ft.tag_value as tag_value',
'ft.tag_type as tag_type',
] as (string | Raw<any>)[];
if (userId) {
query = query.leftJoin(`favorite_features`, function () {
this.on('favorite_features.feature', 'features.name').andOnVal(
'favorite_features.user_id',
'=',
userId,
);
});
selectColumns = [
...selectColumns,
this.db.raw(
'favorite_features.feature is not null as favorite',
),
];
}
query = query.select(selectColumns);
const rows = await query;
if (rows.length > 0) {
const overview = rows.reduce((acc, row) => {
if (acc[row.feature_name] !== undefined) {
acc[row.feature_name].environments.push(
FeatureStrategiesStore.getEnvironment(row),
);
if (this.isNewTag(acc[row.feature_name], row)) {
this.addTag(acc[row.feature_name], row);
}
} else {
acc[row.feature_name] = {
type: row.type,
description: row.description,
favorite: row.favorite,
name: row.feature_name,
createdAt: row.created_at,
lastSeenAt: row.last_seen_at,
stale: row.stale,
impressionData: row.impression_data,
environments: [
FeatureStrategiesStore.getEnvironment(row),
],
};
if (this.isNewTag(acc[row.feature_name], row)) {
this.addTag(acc[row.feature_name], row);
}
}
return acc;
}, {});
return Object.values(overview).map((o: IFeatureOverview) => ({
...o,
environments: o.environments
.filter((f) => f.name)
.sort((a, b) => {
if (a.sortOrder === b.sortOrder) {
return a.name.localeCompare(b.name);
}
return a.sortOrder - b.sortOrder;
}),
}));
}
return [];
}
async getStrategyById(id: string): Promise<IFeatureStrategy> {
const strat = await this.db(T.featureStrategies).where({ id }).first();
if (strat) {
return mapRow(strat);
}
throw new NotFoundError(`Could not find strategy with id: ${id}`);
}
async updateSortOrder(id: string, sortOrder: number): Promise<void> {
await this.db<IFeatureStrategiesTable>(T.featureStrategies)
.where({ id })
.update({ sort_order: sortOrder });
}
async updateStrategy(
id: string,
updates: Partial<IFeatureStrategy>,
): Promise<IFeatureStrategy> {
const update = mapStrategyUpdate(updates);
const row = await this.db<IFeatureStrategiesTable>(T.featureStrategies)
.where({ id })
.update(update)
.returning('*');
return mapRow(row[0]);
}
private static getAdminStrategy(
r: any,
includeId: boolean = true,
): IStrategyConfig {
const strategy = {
name: r.strategy_name,
constraints: r.constraints || [],
variants: r.strategy_variants || [],
parameters: r.parameters,
sortOrder: r.sort_order,
id: r.strategy_id,
title: r.strategy_title || '',
disabled: r.strategy_disabled || false,
};
if (!includeId) {
delete strategy.id;
}
return strategy;
}
async deleteConfigurationsForProjectAndEnvironment(
projectId: String,
environment: String,
): Promise<void> {
await this.db(T.featureStrategies)
.where({ project_name: projectId, environment })
.del();
}
async setProjectForStrategiesBelongingToFeature(
featureName: string,
newProjectId: string,
): Promise<void> {
await this.db(T.featureStrategies)
.where({ feature_name: featureName })
.update({ project_name: newProjectId });
}
async getStrategiesBySegment(
segmentId: number,
): Promise<IFeatureStrategy[]> {
const stopTimer = this.timer('getStrategiesBySegment');
const rows = await this.db
.select(this.prefixColumns())
.from<IFeatureStrategiesTable>(T.featureStrategies)
.join(
T.featureStrategySegment,
`${T.featureStrategySegment}.feature_strategy_id`,
`${T.featureStrategies}.id`,
)
.where(`${T.featureStrategySegment}.segment_id`, '=', segmentId);
stopTimer();
return rows.map(mapRow);
}
async getStrategiesByContextField(
contextFieldName: string,
): Promise<IFeatureStrategy[]> {
const stopTimer = this.timer('getStrategiesByContextField');
const rows = await this.db
.select(this.prefixColumns())
.from<IFeatureStrategiesTable>(T.featureStrategies)
.where(
this.db.raw(
"EXISTS (SELECT 1 FROM jsonb_array_elements(constraints) AS elem WHERE elem ->> 'contextName' = ?)",
contextFieldName,
),
);
stopTimer();
return rows.map(mapRow);
}
prefixColumns(): string[] {
return COLUMNS.map((c) => `${T.featureStrategies}.${c}`);
}
async getCustomStrategiesInUseCount(): Promise<number> {
const stopTimer = this.timer('getCustomStrategiesInUseCount');
const notBuiltIn = '0';
const columns = [
this.db.raw('count(fes.strategy_name) as times_used'),
'fes.strategy_name',
];
const rows = await this.db(`${T.strategies} as str`)
.select(columns)
.join(
`${T.featureStrategies} as fes`,
'fes.strategy_name',
'str.name',
)
.where(`str.built_in`, '=', notBuiltIn)
.groupBy('strategy_name');
stopTimer();
return rows.length;
}
}
module.exports = FeatureStrategiesStore;
export default FeatureStrategiesStore;