Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-31 00:16:47 +01:00
Code Issues Projects Releases Wiki Activity

refactor: allow user events to take in only what they need (#6545)

Browse Source
This commit is contained in:
Simon Hornby 2024-03-14 12:14:33 +02:00 committed by GitHub
parent ba53bd7bf9
commit a2c4b8c320
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/lib/features/events/event-service.ts
View File

@ -104,16 +104,10 @@ export default class EventService {
}; };
} }
/**
* @deprecated use storeUserEvent instead
*/
async storeEvent(event: IBaseEvent): Promise<void> { async storeEvent(event: IBaseEvent): Promise<void> {
return this.storeEvents([event]); return this.storeEvents([event]);
} }
/**
* @deprecated use storeUserEvents instead
*/
async storeEvents(events: IBaseEvent[]): Promise<void> { async storeEvents(events: IBaseEvent[]): Promise<void> {
let enhancedEvents = events; let enhancedEvents = events;
for (const enhancer of [this.enhanceEventsWithTags.bind(this)]) { for (const enhancer of [this.enhanceEventsWithTags.bind(this)]) {
@ -122,10 +116,18 @@ export default class EventService {
return this.eventStore.batchStore(enhancedEvents); return this.eventStore.batchStore(enhancedEvents);
} }
/**
* @deprecated this is tech debt, we should migrate to storeEvents and send the right
* userId and username parameters in IBaseEvent
*/
async storeUserEvent(event: IUserEvent): Promise<void> { async storeUserEvent(event: IUserEvent): Promise<void> {
return this.storeUserEvents([event]); return this.storeUserEvents([event]);
} }
/**
* @deprecated this is tech debt, we should migrate to storeEvents and send the right
* userId and username parameters in IBaseEvent
*/
async storeUserEvents(events: IUserEvent[]): Promise<void> { async storeUserEvents(events: IUserEvent[]): Promise<void> {
let enhancedEvents = events.map(({ byUser, ...event }) => { let enhancedEvents = events.map(({ byUser, ...event }) => {
return { return {

24
src/lib/types/events.ts
View File

@ -1304,11 +1304,11 @@ export class PotentiallyStaleOnEvent extends BaseEvent {
} }
export class UserCreatedEvent extends BaseEvent { export class UserCreatedEvent extends BaseEvent {
readonly data: IUserWithRootRole; readonly data: IUserEventData;
constructor(eventData: { constructor(eventData: {
createdBy: string | IUser; createdBy: string | IUser;
userCreated: IUserWithRootRole; userCreated: IUserEventData;
createdByUserId: number; createdByUserId: number;
}) { }) {
super(USER_CREATED, eventData.createdBy, eventData.createdByUserId); super(USER_CREATED, eventData.createdBy, eventData.createdByUserId);
@ -1317,13 +1317,13 @@ export class UserCreatedEvent extends BaseEvent {
} }
export class UserUpdatedEvent extends BaseEvent { export class UserUpdatedEvent extends BaseEvent {
readonly data: IUserWithRootRole; readonly data: IUserEventData;
readonly preData: IUserWithRootRole; readonly preData: IUserEventData;
constructor(eventData: { constructor(eventData: {
createdBy: string | IUser; createdBy: string | IUser;
preUser: IUserWithRootRole; preUser: IUserEventData;
postUser: IUserWithRootRole; postUser: IUserEventData;
createdByUserId: number; createdByUserId: number;
}) { }) {
super(USER_UPDATED, eventData.createdBy, eventData.createdByUserId); super(USER_UPDATED, eventData.createdBy, eventData.createdByUserId);
@ -1333,11 +1333,11 @@ export class UserUpdatedEvent extends BaseEvent {
} }
export class UserDeletedEvent extends BaseEvent { export class UserDeletedEvent extends BaseEvent {
readonly preData: IUserWithRootRole; readonly preData: IUserEventData;
constructor(eventData: { constructor(eventData: {
createdBy: string | IUser; createdBy: string | IUser;
deletedUser: IUserWithRootRole; deletedUser: IUserEventData;
createdByUserId: number; createdByUserId: number;
}) { }) {
super(USER_DELETED, eventData.createdBy, eventData.createdByUserId); super(USER_DELETED, eventData.createdBy, eventData.createdByUserId);
@ -1345,7 +1345,13 @@ export class UserDeletedEvent extends BaseEvent {
} }
} }
function mapUserToData(user: IUserWithRootRole): any { interface IUserEventData
extends Pick<
IUserWithRootRole,
'id' | 'name' | 'username' | 'email' | 'rootRole'
> {}
function mapUserToData(user: IUserEventData): any {
return { return {
id: user.id, id: user.id,
name: user.name, name: user.name,