Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve typing on Database Events #9819

Closed
wants to merge 3 commits into from
Closed

Improve typing on Database Events #9819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9f477c
Update typing in batchEvent
charlesBochet Jan 23, 2025
266963b
Fix
charlesBochet Jan 23, 2025
c53794b
Fix
charlesBochet Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...server/src/engine/core-modules/event-emitter/types/object-record-non-destructive-event.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import { ObjectRecordDeleteEvent } from 'src/engine/core-modules/event-emitter/t
import { ObjectRecordRestoreEvent } from 'src/engine/core-modules/event-emitter/types/object-record-restore.event';
import { ObjectRecordUpdateEvent } from 'src/engine/core-modules/event-emitter/types/object-record-update.event';

export type ObjectRecordNonDestructiveEvent =
| ObjectRecordCreateEvent
| ObjectRecordUpdateEvent
| ObjectRecordDeleteEvent
| ObjectRecordRestoreEvent;
export type ObjectRecordNonDestructiveEvent<T = object> =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I didn't add it because it wasn't needed)

| ObjectRecordCreateEvent<T>
| ObjectRecordUpdateEvent<T>
| ObjectRecordDeleteEvent<T>
| ObjectRecordRestoreEvent<T>;
4 changes: 2 additions & 2 deletions .../twenty-server/src/engine/core-modules/event-emitter/types/object-record-restore.event.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { ObjectRecordCreateEvent } from 'src/engine/core-modules/event-emitter/types/object-record-create.event';
import { ObjectRecordBaseEvent } from 'src/engine/core-modules/event-emitter/types/object-record.base.event';

export class ObjectRecordRestoreEvent<
T = object,
> extends ObjectRecordCreateEvent<T> {
> extends ObjectRecordBaseEvent<T> {
properties: {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was enforced on purpose because from an API perspective I think the RestoreEvent should always have the properties that the create event has, because people don't want to implemented two different hooks with different logics. I think adding it creates a protection and if there's a need to remove it then it will raise the point

after: T;
};
Expand Down
5 changes: 4 additions & 1 deletion ...enty-server/src/modules/timeline/jobs/upsert-timeline-activity-from-internal-event.job.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queu
import { InjectObjectMetadataRepository } from 'src/engine/object-metadata-repository/object-metadata-repository.decorator';
import { WorkspaceEventBatch } from 'src/engine/workspace-event-emitter/types/workspace-event.type';
import { TimelineActivityService } from 'src/modules/timeline/services/timeline-activity.service';
import { TimelineActivityWorkspaceEntity } from 'src/modules/timeline/standard-objects/timeline-activity.workspace-entity';
import { WorkspaceMemberRepository } from 'src/modules/workspace-member/repositories/workspace-member.repository';
import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';

Expand All @@ -18,7 +19,9 @@ export class UpsertTimelineActivityFromInternalEvent {

@Process(UpsertTimelineActivityFromInternalEvent.name)
async handle(
workspaceEventBatch: WorkspaceEventBatch<ObjectRecordNonDestructiveEvent>,
workspaceEventBatch: WorkspaceEventBatch<
ObjectRecordNonDestructiveEvent<TimelineActivityWorkspaceEntity>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment

>,
): Promise<void> {
for (const eventData of workspaceEventBatch.events) {
if (eventData.userId) {
Expand Down
7 changes: 5 additions & 2 deletions packages/twenty-server/src/modules/timeline/services/timeline-activity.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ import { WorkspaceDataSourceService } from 'src/engine/workspace-datasource/work
import { TimelineActivityRepository } from 'src/modules/timeline/repositiories/timeline-activity.repository';
import { TimelineActivityWorkspaceEntity } from 'src/modules/timeline/standard-objects/timeline-activity.workspace-entity';

type TimelineActivity = Omit<ObjectRecordNonDestructiveEvent, 'properties'> & {
type TimelineActivity = Omit<
ObjectRecordNonDestructiveEvent<TimelineActivityWorkspaceEntity>,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The event itself is not about a timeline activity, there's a confusion

'properties'
> & {
name: string;
objectName?: string;
linkedRecordCachedName?: string;
Expand All @@ -34,7 +37,7 @@ export class TimelineActivityService {
eventName,
workspaceId,
}: {
event: ObjectRecordBaseEvent;
event: ObjectRecordBaseEvent<TimelineActivityWorkspaceEntity>;
eventName: string;
workspaceId: string;
}) {
Expand Down
Loading