Updated engine readme, removed legacy system notes

Author: matt-aitken

internal-packages/run-engine/README.md

@@ -15,8 +15,7 @@ It is responsible for:
 - **Worker group**: A group of workers that all pull from the same queue, e.g. "us-east-1", "my-self-hosted-workers".
   - **Worker**: A worker is a 'server' that connects to the platform and receives runs.
     - **Supervisor**: Pulls new runs from the queue, communicates with the platform, spins up new Deploy executors.
-    - **Checkpointer**: Responsible for checkpointing runs.
-    - **Deploy executor**: Container that comes from a specific deploy from a user's project.
+    - **Deploy container**: Container that comes from a specific deploy from a user's project.
       - **Run controller**: The code that manages running the task.
       - **Run executor**: The actual task running.
 
@@ -188,109 +187,3 @@ This is useful:
 ## Emitting events
 
 The Run Engine emits events using its `eventBus`. This is used for runs completing, failing, or things that any workers should be aware of.
-
-# Legacy system
-
-These are all the TaskRun mutations happening right now:
-
-## 1. TriggerTaskService
-
-This is called from:
-
-- trigger task API
-- `BatchTriggerTaskService` for each item
-- `ReplayTaskRunService`
-- `TestTaskService`
-- `TriggerScheduledTaskService` when the CRON fires
-
-Directly creates a run if it doesn't exist, either in the `PENDING` or `DELAYED` states.
-Enqueues the run.
-
-[TriggerTaskService.call()](/apps//webapp/app/v3/services/triggerTask.server.ts#246)
-
-## 2. Batch trigger
-
-## 3. DevQueueConsumer executing a run
-
-### a. Lock run and set status to `EXECUTING`
-
-[DevQueueConsumer.#doWorkInternal()](/apps/webapp/app/v3/marqs/devQueueConsumer.server.ts#371)
-
-### b. If an error is thrown, unlock the run and set status to `PENDING`
-
-[DevQueueConsumer.#doWorkInternal()](/apps/webapp/app/v3/marqs/devQueueConsumer.server.ts#477)
-
-## 4. SharedQueueConsumer executing a run
-
-### a. `EXECUTE`, lock the run
-
-We lock the run and update some basic metadata (but not status).
-[SharedQueueConsumer.#doWorkInternal()](/apps/webapp/app/v3/marqs/sharedQueueConsumer.server.ts#394)
-
-### b. `EXECUTE`, if an error is thrown, unlock the run
-
-We unlock the run, but don't change the status.
-[SharedQueueConsumer.#doWorkInternal()](/apps/webapp/app/v3/marqs/sharedQueueConsumer.server.ts#552)
-
-### c. `EXECUTE`, if the run has no deployment set the status to `WAITING_FOR_DEPLOY`
-
-[SharedQueueConsumer.#doWorkInternal()](/apps/webapp/app/v3/marqs/sharedQueueConsumer.server.ts#876)
-
-## 5. CompleteAttemptService retrying a run
-
-### a. When an attempt has failed, we set the status to `RETRYING_AFTER_FAILURE`
-
-[CompleteAttemptService.#completeAttemptFailed()](/apps/webapp/app/v3/services/completeAttempt.server.ts#239)
-
-## 6. CreateTaskRunAttemptService creating a new attempt, setting the run to `EXECUTING`
-
-We call this when:
-
-- [Executing a DEV run from the CLI.](/packages/cli-v3//src/dev/workerRuntime.ts#305)
-- [Deprecated: directly from the SharedQueueCOnsumer when we don't support lazy attempts](/apps/webapp/app/v3/marqs/sharedQueueConsumer.server.ts#501)
-- [When we receive a `CREATE_TASK_RUN_ATTEMPT` message from the coordinator](/apps/webapp//app/v3//handleSocketIo.server.ts#187)
-
-This is the actual very simple TaskRun update:
-[CreateTaskRunAttemptService.call()](/apps/webapp/app/v3/services/createTaskRunAttempt.server.ts#134)
-
-## 7. EnqueueDelayedRunService set a run to `PENDING` when the `delay` has elapsed
-
-When the run attempt gets created it will be marked as `EXECUTING`.
-
-[EnqueueDelayedRunService.#call()](/apps/webapp/app/v3/services/enqueueDelayedRun.server.ts#41)
-
-## 8. FinalizeTaskRunService finalizing a run
-
-This service is called from many places, when a run is in a "final" state. This means the run can't be acted on anymore.
-
-We set the status, expiredAt and completedAt fields.
-
-[FinalizeTaskRunService.#call()](/apps/webapp/app/v3/services/finalizeTaskRun.server.ts#63)
-
-This function is called from:
-
-- [`FailedTaskRunService` when a run has SYSTEM_FAILURE](/apps/webapp/app/v3/failedTaskRun.server.ts#41)
-- [`CancelAttemptService` when an attempt is canceled](/apps/webapp/app/v3/services/cancelAttempt.server.ts#66)
-- [`CancelTaskRunService` when a run is canceled](/apps/webapp/app/v3/services/cancelTaskRun.server.ts#51)
-- `CompleteAttemptService` when a SYSTEM_FAILURE happens
-  - [No attempt](/apps/webapp/app/v3/services/completeAttempt.server.ts#74)
-  - [`completeAttemptFailed` and there's no checkpoint](/apps/webapp/app/v3/services/completeAttempt.server.ts#280)
-  - [`completeAttemptFailed` and the error is internal and a graceful exit timeout](/apps/webapp/app/v3/services/completeAttempt.server.ts#321)
-- `CompleteTaskRunService` when a run has failed (this isn't a bug)
-  - [`completeAttemptFailed`](/apps/webapp/app/v3/services/completeAttempt.server.ts#352)
-- `CompleteTaskRunService` when a run is completed successfully
-  - [`completeAttemptSuccessfully`](/apps/webapp/app/v3/services/completeAttempt.server.ts#135)
-- `CrashTaskRunService` when a run has crashed
-  - [`call`](/apps/webapp/app/v3/services/crashTaskRun.server.ts#47)
-- `ExpireEnqueuedRunService` when a run has expired
-  - [`call`](/apps/webapp/app/v3/services/expireEnqueuedRun.server.ts#42)
-
-## 9. RescheduleTaskRunService (when further delaying a delayed run)
-
-[RescheduleTaskRunService.#call()](/apps/webapp/app/v3/services/rescheduleTaskRun.server.ts#21)
-
-## 10. Triggering a scheduled run
-
-Graphile Worker calls this function based on the schedule. We add the schedule data onto the run, and call `TriggerTaskService.call()`.
-
-[TriggerScheduledRunService.#call()](/apps/webapp/app/v3/services/triggerScheduledTask.server.ts#131)