mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-31 00:16:47 +01:00
2c826bdbba
## About the changes - `getActiveUsers` is using multiple stores, so it is refactored into read-model - Refactored Instance stats service into `features` to co-locate related code Closes https://linear.app/unleash/issue/UNL-230/active-users-prometheus ### Important files `src/lib/features/instance-stats/getActiveUsers.ts` ## Discussion points `getActiveUsers` is coded less _class-based_ then previous similar read-models. In one file instead of 3 (read-model interface, fake read model, sql read model). I find types and functions way more readable, but I'm ready to refactor it to interfaces and classes if consistency is more important.
223 lines
5.8 KiB
TypeScript
223 lines
5.8 KiB
TypeScript
/* eslint camelcase: "off" */
|
|
|
|
import { Logger, LogProvider } from '../logger';
|
|
import User from '../types/user';
|
|
|
|
import NotFoundError from '../error/notfound-error';
|
|
import {
|
|
ICreateUser,
|
|
IUserLookup,
|
|
IUserStore,
|
|
IUserUpdateFields,
|
|
} from '../types/stores/user-store';
|
|
import { Db } from './db';
|
|
|
|
const TABLE = 'users';
|
|
|
|
const USER_COLUMNS_PUBLIC = [
|
|
'id',
|
|
'name',
|
|
'username',
|
|
'email',
|
|
'image_url',
|
|
'seen_at',
|
|
'is_service',
|
|
];
|
|
|
|
const USER_COLUMNS = [...USER_COLUMNS_PUBLIC, 'login_attempts', 'created_at'];
|
|
|
|
const emptify = (value) => {
|
|
if (!value) {
|
|
return undefined;
|
|
}
|
|
return value;
|
|
};
|
|
|
|
const safeToLower = (s?: string) => (s ? s.toLowerCase() : s);
|
|
|
|
const mapUserToColumns = (user: ICreateUser) => ({
|
|
name: user.name,
|
|
username: user.username,
|
|
email: safeToLower(user.email),
|
|
image_url: user.imageUrl,
|
|
});
|
|
|
|
const rowToUser = (row) => {
|
|
if (!row) {
|
|
throw new NotFoundError('No user found');
|
|
}
|
|
return new User({
|
|
id: row.id,
|
|
name: emptify(row.name),
|
|
username: emptify(row.username),
|
|
email: emptify(row.email),
|
|
imageUrl: emptify(row.image_url),
|
|
loginAttempts: row.login_attempts,
|
|
seenAt: row.seen_at,
|
|
createdAt: row.created_at,
|
|
isService: row.is_service,
|
|
});
|
|
};
|
|
|
|
class UserStore implements IUserStore {
|
|
private db: Db;
|
|
|
|
private logger: Logger;
|
|
|
|
constructor(db: Db, getLogger: LogProvider) {
|
|
this.db = db;
|
|
this.logger = getLogger('user-store.ts');
|
|
}
|
|
|
|
async update(id: number, fields: IUserUpdateFields): Promise<User> {
|
|
await this.activeUsers()
|
|
.where('id', id)
|
|
.update(mapUserToColumns(fields));
|
|
return this.get(id);
|
|
}
|
|
|
|
async insert(user: ICreateUser): Promise<User> {
|
|
const rows = await this.db(TABLE)
|
|
.insert(mapUserToColumns(user))
|
|
.returning(USER_COLUMNS);
|
|
return rowToUser(rows[0]);
|
|
}
|
|
|
|
async upsert(user: ICreateUser): Promise<User> {
|
|
const id = await this.hasUser(user);
|
|
|
|
if (id) {
|
|
return this.update(id, user);
|
|
}
|
|
return this.insert(user);
|
|
}
|
|
|
|
buildSelectUser(q: IUserLookup): any {
|
|
const query = this.activeAll();
|
|
if (q.id) {
|
|
return query.where('id', q.id);
|
|
}
|
|
if (q.email) {
|
|
return query.where('email', safeToLower(q.email));
|
|
}
|
|
if (q.username) {
|
|
return query.where('username', q.username);
|
|
}
|
|
throw new Error('Can only find users with id, username or email.');
|
|
}
|
|
|
|
activeAll(): any {
|
|
return this.db(TABLE).where({
|
|
deleted_at: null,
|
|
});
|
|
}
|
|
|
|
activeUsers(): any {
|
|
return this.db(TABLE).where({
|
|
deleted_at: null,
|
|
is_service: false,
|
|
});
|
|
}
|
|
|
|
async hasUser(idQuery: IUserLookup): Promise<number | undefined> {
|
|
const query = this.buildSelectUser(idQuery);
|
|
const item = await query.first('id');
|
|
return item ? item.id : undefined;
|
|
}
|
|
|
|
async getAll(): Promise<User[]> {
|
|
const users = await this.activeUsers().select(USER_COLUMNS);
|
|
return users.map(rowToUser);
|
|
}
|
|
|
|
async search(query: string): Promise<User[]> {
|
|
const users = await this.activeUsers()
|
|
.select(USER_COLUMNS_PUBLIC)
|
|
.where('name', 'ILIKE', `%${query}%`)
|
|
.orWhere('username', 'ILIKE', `${query}%`)
|
|
.orWhere('email', 'ILIKE', `${query}%`);
|
|
return users.map(rowToUser);
|
|
}
|
|
|
|
async getAllWithId(userIdList: number[]): Promise<User[]> {
|
|
const users = await this.activeUsers()
|
|
.select(USER_COLUMNS_PUBLIC)
|
|
.whereIn('id', userIdList);
|
|
return users.map(rowToUser);
|
|
}
|
|
|
|
async getByQuery(idQuery: IUserLookup): Promise<User> {
|
|
const row = await this.buildSelectUser(idQuery).first(USER_COLUMNS);
|
|
return rowToUser(row);
|
|
}
|
|
|
|
async delete(id: number): Promise<void> {
|
|
return this.activeUsers()
|
|
.where({ id })
|
|
.update({
|
|
deleted_at: new Date(),
|
|
email: null,
|
|
username: null,
|
|
name: this.db.raw('name || ?', '(Deleted)'),
|
|
});
|
|
}
|
|
|
|
async getPasswordHash(userId: number): Promise<string> {
|
|
const item = await this.activeUsers()
|
|
.where('id', userId)
|
|
.first('password_hash');
|
|
|
|
if (!item) {
|
|
throw new NotFoundError('User not found');
|
|
}
|
|
|
|
return item.password_hash;
|
|
}
|
|
|
|
async setPasswordHash(userId: number, passwordHash: string): Promise<void> {
|
|
return this.activeUsers().where('id', userId).update({
|
|
password_hash: passwordHash,
|
|
});
|
|
}
|
|
|
|
async incLoginAttempts(user: User): Promise<void> {
|
|
return this.buildSelectUser(user).increment('login_attempts', 1);
|
|
}
|
|
|
|
async successfullyLogin(user: User): Promise<void> {
|
|
return this.buildSelectUser(user).update({
|
|
login_attempts: 0,
|
|
seen_at: new Date(),
|
|
});
|
|
}
|
|
|
|
async deleteAll(): Promise<void> {
|
|
await this.activeUsers().del();
|
|
}
|
|
|
|
async count(): Promise<number> {
|
|
return this.activeUsers()
|
|
.count('*')
|
|
.then((res) => Number(res[0].count));
|
|
}
|
|
|
|
destroy(): void {}
|
|
|
|
async exists(id: number): Promise<boolean> {
|
|
const result = await this.db.raw(
|
|
`SELECT EXISTS (SELECT 1 FROM ${TABLE} WHERE id = ? and deleted_at = null) AS present`,
|
|
[id],
|
|
);
|
|
const { present } = result.rows[0];
|
|
return present;
|
|
}
|
|
|
|
async get(id: number): Promise<User> {
|
|
const row = await this.activeUsers().where({ id }).first();
|
|
return rowToUser(row);
|
|
}
|
|
}
|
|
|
|
module.exports = UserStore;
|
|
export default UserStore;
|