Skip to content

tasks.md

Latest commit

 

History

History
81 lines (57 loc) · 4.21 KB

tasks.md

File metadata and controls

81 lines (57 loc) · 4.21 KB
Raw

Spaces — Tasks Module

Parent: Spaces Overview · Related: Translations · Contents · Assets · Schemas

Purpose

Monitor and manage background jobs (Tasks) triggered by import and export operations across all other space modules. Tasks are asynchronous — they run server-side and the user polls for completion here.

Route

/features/spaces/:spaceId/tasks             [TRANSLATION_READ] → TasksComponent
/features/spaces/:spaceId/tasks/:taskId                        → TaskDetailComponent

Key Files

src/app/features/spaces/tasks/
  tasks.component.ts/html/scss
  task-detail/                       ← per-task detail view: status, file info, and paginated/filterable logs (routed)

TasksComponent

A paginated ll-table (see the Table) of all Tasks for the current space. Each row shows the task type, status, file info, description, and creation date; the id column hides below the @5xl container-query breakpoint. Rows are clickable and navigate to TaskDetailComponent via navigateToDetail(task).

Injected services: TaskService, HlmDialogService, NotificationService, Router

Key behaviour:

  • loadData() — fetches all tasks for the space, sorted client-side via TableDataSource/TableSort (newest first by default)
  • dataSource (TableDataSource<Task>) is wired to the TableSort and Paginator view children in ngAfterViewInit()
  • <ll-filter-toolbar> with multi-select Kind and Status filters, wired via onFilterChange(); dataSource.filterPredicate is set once in the constructor via FilterPredicateUtils.create() (search across id/file name/message)
  • navigateToDetail(task) — navigates to TaskDetailComponent for the row
  • onDownload(task) — downloads the output file of a completed export task from Firebase Storage
  • openDeleteDialog(task) — confirms then deletes the task record

TaskDetailComponent (routed)

Shows a single task's status/file info plus its paginated log entries (TaskLog), filterable by log Level (INFO/WARN/ERROR) via <ll-filter-toolbar>. Supports downloading the task's output file and expanding individual log rows for detail.

Key behaviour:

  • dataSource.filterPredicate — set in the constructor via FilterPredicateUtils.create<TaskLog>(); onFilterChange() applies the toolbar value
  • onDownload() — downloads the task's output file
  • isLogExpanded(id) / toggleLogExpanded(id) — track which log rows are expanded

Task Types

Most tasks are created by other modules' import/export actions and processed by Firebase Functions:

Created by Task type
Translations → Export TRANSLATION_EXPORT
Translations → Import TRANSLATION_IMPORT
Contents → Export CONTENT_EXPORT
Contents → Import CONTENT_IMPORT
Schemas → Export SCHEMA_EXPORT
Schemas → Import SCHEMA_IMPORT
Assets → Export ASSET_EXPORT
Assets → Import ASSET_IMPORT
Assets → Regenerate Metadata ASSET_REGEN_METADATA

Who can create a task

firestore.rules treats the task type as the permission required to create or delete it: a CONTENT_IMPORT task needs CONTENT_IMPORT, and so on. ASSET_REGEN_METADATA is not a permission, so only admins can create it. The rules also enforce the document shape TaskService writes: status must be INITIATED, only the fields for that kind are allowed, and an import's tmpPath must be spaces/{spaceId}/tasks/tmp/{timestamp}. Clients can't update tasks at all; only the task trigger writes status, results and errors. The trigger checks tmpPath again (functions/src/utils/task-path.ts) before moving the upload, because it runs with Admin SDK rights.

Reading tasks and their logs still requires any one of the eight import/export permissions. The task list is a single collection query, so it can't be filtered per kind.

Task Status Flow

INITIATED → IN_PROGRESS → FINISHED
                        → ERROR

Services Used

Service Purpose
TaskService Fetch tasks, delete, download result files
NotificationService Snackbar feedback