Runner metadata events

[prastoin]

Introduction

Followup #17622

Refactoring the actions handler to be returning a metadata event
It has to be done incrementally, as if not update metadata event would be stale as depends on the incremental action execution order and optimistic application

What's next

• Builder should consume and regroup each metadata even in order to batch emit them ( within a single metadata actions batch order matters ) => refactoring feat: emit metadata events for schema changes with actor context for webhooks #17622 in order to consume runner returned metadata events

[cubic-dev-ai]

No issues found across 10 files

[github-actions]

🚀 Preview Environment Ready!

Your preview environment is available at: http://bore.pub:30605

This environment will automatically shut down when the PR is closed or after 5 hours.

[greptile-apps]

Greptile Overview

Greptile Summary

This PR refactors the workspace migration runner/action-handler flow to emit MetadataEvent[] alongside the existing optimistic cache updates, and adds utilities to derive create/update/delete metadata events from flat migration actions.

The new flow is wired through BaseWorkspaceMigrationRunnerActionHandlerService.execute (now returning { partialOptimisticCache, metadataEvents }) and WorkspaceMigrationRunnerService.run (now aggregating and returning { allFlatEntityMaps, metadataEvents }). This fits into the migration system by letting downstream consumers react to metadata mutations without re-deriving diffs from the cache.

Key merge blockers are: (1) run() return type changed but existing call sites still treat it as returning AllFlatEntityMaps, and (2) event derivation currently uses pre-optimistic state, which can make after/diff inconsistent with what the runner actually applied.

Confidence Score: 2/5

• This PR is not safe to merge until return-type integration and event correctness are fixed.
• Runner/action-handler signatures changed and at least two existing call sites still use the old return type. Additionally, metadata events are derived from pre-optimistic state, which can produce incorrect event payloads relative to the applied action order/state. These are correctness/integration issues likely to break compilation or downstream consumers.
• packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts; packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/interfaces/workspace-migration-runner-action-handler-service.interface.ts; packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/types/metadata-event.ts

Important Files Changed

Filename	Overview
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-builder/types/workspace-migration-action-common.ts	Generalized AllFlatWorkspaceMigrationAction with action-type generic; no functional issues spotted.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/interfaces/workspace-migration-runner-action-handler-service.interface.ts	Action handler execute now returns {partialOptimisticCache, metadataEvents}; events currently derived from pre-optimistic state.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts	Runner service aggregates metadataEvents and changes run() return type; callers need updates to handle new return shape.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/types/metadata-event.ts	Introduces MetadataEvent union types; UpdateMetadataEvent includes full before/after which may violate event-payload guidance.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/derive-metadata-events-from-create-action.util.ts	Adds create-event derivation; function signature includes unused allFlatEntityMaps argument.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/derive-metadata-events-from-delete-action.util.ts	Adds delete-event derivation; uses as MetadataEvent assertion which can hide payload/type mismatches.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/derive-metadata-events-from-update-action.util.ts	Adds update-event derivation with diff/updatedFields; includes full before/after in event payload (heavy) and uses type assertions.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/optimistically-apply-create-action-on-all-flat-entity-maps.util.ts	Refactors optimistic create apply to accept AllFlatWorkspaceMigrationAction<'create'>; no behavior change observed.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/optimistically-apply-delete-action-on-all-flat-entity-maps.util.ts	Refactors optimistic delete apply to accept AllFlatWorkspaceMigrationAction<'delete'>; no behavior change observed.
packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/utils/optimistically-apply-update-action-on-all-flat-entity-maps.util.ts	Refactors optimistic update apply to accept AllFlatWorkspaceMigrationAction<'update'>; no behavior change observed.

Sequence Diagram

sequenceDiagram
  participant Builder as MigrationBuilder
  participant Runner as WorkspaceMigrationRunnerService
  participant Handler as RunnerActionHandlerService
  participant Derive as deriveMetadataEventsFrom*Action
  participant Apply as optimisticallyApply*Action
  participant State as FlatEntityMaps

  Builder->>Runner: execute(actions)
  loop for each action
    Runner->>Handler: handle(action, context)
    Handler-->>Runner: { metadataEvents[], result }
    Runner->>State: apply optimistic change
    Runner->>Apply: optimisticallyApply*(action, State)
    Apply-->>Runner: updated State
    Runner->>Derive: deriveMetadataEventsFrom*(action, before/after)
    Derive-->>Runner: metadataEvents
    Runner-->>Runner: accumulate metadataEvents
  end
  Runner-->>Builder: { appliedActions, metadataEvents }

Loading

[greptile-apps]

_{10 files reviewed, 5 comments}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

Additional Comments (1)

packages/twenty-server/src/engine/workspace-manager/workspace-migration/workspace-migration-runner/services/workspace-migration-runner.service.ts
Breaking return type change

WorkspaceMigrationRunnerService.run now returns { allFlatEntityMaps, metadataEvents } instead of AllFlatEntityMaps, but existing callers still ignore/destructure the old return type (e.g. workspace:-migration-validate-build-and-run-service.ts:251 and application.resolver.ts:154). This will be a TS error (or silently drop metadataEvents if callers were expecting the maps directly). Update all call sites and any interface typings that expect Promise<AllFlatEntityMaps> to match the new shape.

[charlesBochet]

LGTM :)