ActivityPub-federated video streaming platform using P2P directly in your web browser
Improve job filters UX
Chocobozzzc4746d54b973
diff --git a/client/src/app/+admin/system/jobs/jobs.component.html b/client/src/app/+admin/system/jobs/jobs.component.htmlindex 9ebea30bf0..3fbf2b9087 100644--- a/client/src/app/+admin/system/jobs/jobs.component.html+++ b/client/src/app/+admin/system/jobs/jobs.component.html@@ -11,7 +11,7 @@[dataLoader]="dataLoader"[inputFilters]="inputFilters"refreshButton="true"- >+><ng-template #totalTitle let-totalRecords><ng-container i18n>{ totalRecords, plural, =0 {No job} =1 {1 job} other {{{ totalRecords | myNumberFormatter }} jobs}}</ng-container></ng-template>@@ -22,23 +22,29 @@}@if (table.isColumnDisplayed('type')) {- <td class="job-type" >- <span class="pt-badge ellipsis" [ngClass]="getRandomJobTypeBadge(job.type)">{{ job.type }}</span>+ <td class="job-type">+ <a routerLink="." [queryParams]="{ type: job.type }" [title]="getTypeFilterTitle(job.type)" class="pt-badge ellipsis" [ngClass]="getRandomJobTypeBadge(job.type)">{{ job.type }}</a></td>}@if (table.isColumnDisplayed('priority')) {- <td class="job-priority" >{{ job.priority }}</td>+ <td class="job-priority">{{ job.priority }}</td>}@if (table.isColumnDisplayed('state') && table.isColumnDisplayed('state')) {- <td class="job-state" >- <span class="ellipsis" [ngClass]="getJobStateClasses(job.state)">{{ job.state }}</span>+ <td class="job-state">+ <a+ routerLink="."+ [queryParams]="{ state: job.state }"+ class="ellipsis"+ [ngClass]="getJobStateClasses(job.state)"+ [title]="getStateFilterTitle(job.state)"+ >{{ job.state }}</a></td>}@if (table.isColumnDisplayed('progress')) {- <td class="job-progress" >+ <td class="job-progress">@if (hasProgress(job)) {{{ getProgress(job) }}}@@ -46,13 +52,13 @@}@if (table.isColumnDisplayed('createdAt')) {- <td class="job-date" >{{ job.createdAt }}</td>+ <td class="job-date">{{ job.createdAt }}</td>}@if (table.isColumnDisplayed('processed')) {<td class="fs-7"><div>{{ job.processedOn }}</div>- <div>{{ job.finishedOn}}</div>+ <div>{{ job.finishedOn }}</div></td>}</ng-template>@@ -85,6 +91,4 @@}</div></ng-template>-</my-table>-diff --git a/client/src/app/+admin/system/jobs/jobs.component.ts b/client/src/app/+admin/system/jobs/jobs.component.tsindex 6669a926e3..7ee8b46abb 100644--- a/client/src/app/+admin/system/jobs/jobs.component.ts+++ b/client/src/app/+admin/system/jobs/jobs.component.ts@@ -12,14 +12,7 @@ import { TableColumnInfo, TableComponent } from '../../../shared/shared-tables/timport { JobService } from './job.service'type ColumnName = 'id' | 'type' | 'priority' | 'state' | 'progress' | 'createdAt' | 'processed'--type DataLoaderParameter = {- pagination: RestPagination- sort: SortMeta- search?: string- jobType?: JobType- jobState?: JobState-}+type DataLoaderParameter = Parameters<JobsComponent['_dataLoader']>[0]@Component({selector: 'my-jobs',@@ -74,7 +67,7 @@ export class JobsComponent {readonly inputFilters: AdvancedFilterDef<DataLoaderParameter>[] = [{type: 'select',- key: 'jobType',+ key: 'type',title: $localize`Job type`,clearable: true,filter: true,@@ -86,7 +79,7 @@ export class JobsComponent {},{type: 'select',- key: 'jobState',+ key: 'state',title: $localize`Job state`,clearable: true,items: this.jobStates.map(s => ({@@ -159,19 +152,27 @@ export class JobsComponent {return this.peertubeBadgeService.getRandomBadge('type', type)}+ getStateFilterTitle (state: string) {+ return $localize`Filter by state: ${state.toLocaleUpperCase()}`+ }++ getTypeFilterTitle (type: string) {+ return $localize`Filter by type: ${type.toLocaleUpperCase()}`+ }+private _dataLoader (options: {pagination: RestPaginationsort: SortMeta- jobType?: JobType- jobState?: JobState+ type?: JobType+ state?: JobState}) {- const { pagination, sort, jobType, jobState } = options+ const { pagination, sort, type, state } = options- this.displayGlobalProgress = !jobType || jobType === 'video-transcoding'+ this.displayGlobalProgress = !type || type === 'video-transcoding'return this.jobsService.listJobs({- jobState,- jobType,+ jobState: state,+ jobType: type,pagination,sort})diff --git a/client/src/app/+admin/system/runners/runner-job-list/runner-job-list.component.html b/client/src/app/+admin/system/runners/runner-job-list/runner-job-list.component.htmlindex 1e138861da..62662adefc 100644--- a/client/src/app/+admin/system/runners/runner-job-list/runner-job-list.component.html+++ b/client/src/app/+admin/system/runners/runner-job-list/runner-job-list.component.html@@ -11,7 +11,7 @@searchInput="true"refreshButton="true"[inputFilters]="inputFilters"- >+><ng-template #totalTitle let-totalRecords><ng-container i18n>{ totalRecords, plural, =0 {No job} =1 {1 job} other {{{ totalRecords | myNumberFormatter }} jobs}}</ng-container></ng-template>@@ -23,13 +23,25 @@@if (table.isColumnDisplayed('type')) {<td>- <span class="pt-badge ellipsis" [title]="runnerJob.type" [ngClass]="getRandomRunnerTypeBadge(runnerJob.type)">{{ runnerJob.type }}</span>+ <a+ routerLink="."+ [queryParams]="{ type: runnerJob.type }"+ class="pt-badge ellipsis"+ [title]="getTypeFilterTitle(runnerJob.type)"+ [ngClass]="getRandomRunnerTypeBadge(runnerJob.type)"+ >{{ runnerJob.type }}</a></td>}@if (table.isColumnDisplayed('state')) {<td>- <span class="pt-badge ellipsis" [title]="runnerJob.state.label" [ngClass]="getStateBadgeColor(runnerJob)">{{ runnerJob.state.label }}</span>+ <a+ routerLink="."+ [queryParams]="{ state: runnerJob.state.id }"+ class="pt-badge ellipsis"+ [title]="getStateFilterTitle(runnerJob.state.label)"+ [ngClass]="getStateBadgeColor(runnerJob)"+ >{{ runnerJob.state.label }}</a></td>}@@ -61,23 +73,30 @@@if (table.isColumnDisplayed('processed')) {<td class="fs-7"><div>{{ runnerJob.startedAt }}</div>- <div>{{ runnerJob.finishedAt}}</div>+ <div>{{ runnerJob.finishedAt }}</div></td>}</ng-template><ng-template #actionCell let-runnerJob><my-action-dropdown- placement="bottom-right top-right left auto" container="body"- i18n-label label="Actions" [actions]="actions" [entry]="runnerJob"+ placement="bottom-right top-right left auto"+ container="body"+ i18n-label+ label="Actions"+ [actions]="actions"+ [entry]="runnerJob"></my-action-dropdown></ng-template><ng-template #expandedRow let-runnerJob><div class="mt-2 fs-7 font-monospace">- Parent job: {{ runnerJob.parent?.uuid || '-' }} <br />- Processed on {{ (runnerJob.startedAt || '-') }} <br />- Finished on {{ (runnerJob.finishedAt || '-') }} <br />+ Parent job: {{ runnerJob.parent?.uuid || '-' }}+ <br />+ Processed on {{ runnerJob.startedAt || '-' }}+ <br />+ Finished on {{ runnerJob.finishedAt || '-' }}+ <br /></div><div class="mt-2">@@ -91,7 +110,7 @@</div>@if (runnerJob.error) {- <pre class="text-danger" >{{ runnerJob.error }}</pre>+ <pre class="text-danger">{{ runnerJob.error }}</pre>}</ng-template>diff --git a/client/src/app/+admin/system/runners/runner-job-list/runner-job-list.component.ts b/client/src/app/+admin/system/runners/runner-job-list/runner-job-list.component.tsindex dbeaad0842..ed9826b3e3 100644--- a/client/src/app/+admin/system/runners/runner-job-list/runner-job-list.component.ts+++ b/client/src/app/+admin/system/runners/runner-job-list/runner-job-list.component.ts@@ -10,13 +10,12 @@ import { ActionDropdownComponent, DropdownAction } from '../../../../shared/sharimport { NumberFormatterPipe } from '../../../../shared/shared-main/common/number-formatter.pipe'import { DataLoaderOptionsBase, TableColumnInfo, TableComponent } from '../../../../shared/shared-tables/table.component'import { RunnerJobFormatted, RunnerService } from '../runner.service'+import { RouterLink } from '@angular/router'type RunnerJobStateFilter = 'completed' | 'pending' | 'processing' | 'errored'-type DataLoaderParameter = DataLoaderOptionsBase & {- state?: RunnerJobStateFilter- jobType?: RunnerJobType-}+type DataLoaderParameter = Parameters<RunnerJobListComponent['_dataLoader']>[0]+type ColumnName = 'uuid' | 'type' | 'state' | 'priority' | 'progress' | 'runner' | 'createdAt' | 'processed'@Component({@@ -24,6 +23,7 @@ type ColumnName = 'uuid' | 'type' | 'state' | 'priority' | 'progress' | 'runner'templateUrl: './runner-job-list.component.html',imports: [CommonModule,+ RouterLink,ActionDropdownComponent,TableComponent,NumberFormatterPipe@@ -55,7 +55,7 @@ export class RunnerJobListComponent implements OnInit {inputFilters: AdvancedFilterDef<DataLoaderParameter>[] = [{type: 'select',- key: 'jobType',+ key: 'type',title: $localize`Job type`,clearable: true,items: this.jobTypes.map(t => ({@@ -199,15 +199,24 @@ export class RunnerJobListComponent implements OnInit {return this.peertubeBadgeService.getRandomBadge('type', value)}+ getTypeFilterTitle (type: string) {+ return $localize`Filter jobs by type: ${type.toLocaleUpperCase()}`+ }++ getStateFilterTitle (state: string) {+ return $localize`Filter jobs by state: ${state.toLocaleUpperCase()}`+ }+private _dataLoader (options: DataLoaderOptionsBase & {state?: RunnerJobStateFilter- jobType?: RunnerJobType+ type?: RunnerJobType}) {- const { pagination, sort, search, state, jobType } = options+ const { pagination, sort, search, state, type } = optionslet stateOneOf: RunnerJobStateType[]+ let typeOneOf: RunnerJobType[]if (state) {stateOneOf = []@@ -222,7 +231,12 @@ export class RunnerJobListComponent implements OnInit {stateOneOf.push(RunnerJobState.PARENT_ERRORED)}}- return this.runnerService.listRunnerJobs({ pagination, sort, search, stateOneOf, jobType })++ if (type) {+ typeOneOf = [ type ]+ }++ return this.runnerService.listRunnerJobs({ pagination, sort, search, stateOneOf, typeOneOf })}private canCancelJob (job: RunnerJob) {diff --git a/client/src/app/+admin/system/runners/runner.service.ts b/client/src/app/+admin/system/runners/runner.service.tsindex 875bba57c4..d22cf31e96 100644--- a/client/src/app/+admin/system/runners/runner.service.ts+++ b/client/src/app/+admin/system/runners/runner.service.ts@@ -59,16 +59,16 @@ export class RunnerService {sort: SortMetasearch?: stringstateOneOf?: RunnerJobStateType[]- jobType?: RunnerJobType+ typeOneOf?: RunnerJobType[]}) {- const { pagination, sort, search, stateOneOf, jobType } = options+ const { pagination, sort, search, stateOneOf, typeOneOf } = optionslet params = new HttpParams()params = this.restService.addRestGetParams(params, pagination, sort)if (search) params = params.append('search', search)- if (jobType) params = params.append('jobType', jobType)- if (stateOneOf) params = this.restService.addObjectParams(params, { stateOneOf })++ params = this.restService.addObjectParams(params, { stateOneOf, typeOneOf })return forkJoin([this.authHttp.get<ResultList<RunnerJobAdmin>>(RunnerService.BASE_RUNNER_URL + '/jobs', { params }),diff --git a/packages/models/src/runners/list-runner-jobs-query.model.ts b/packages/models/src/runners/list-runner-jobs-query.model.tsindex 76f2ab27be..bfda2b127b 100644--- a/packages/models/src/runners/list-runner-jobs-query.model.ts+++ b/packages/models/src/runners/list-runner-jobs-query.model.ts@@ -1,4 +1,5 @@import { RunnerJobStateType } from './runner-jobs/runner-job-state.model.js'+import { RunnerJobType } from './runner-jobs/runner-job-type.type.js'export interface ListRunnerJobsQuery {start?: number@@ -6,4 +7,5 @@ export interface ListRunnerJobsQuery {sort?: stringsearch?: stringstateOneOf?: RunnerJobStateType[]+ typeOneOf?: RunnerJobType[]}diff --git a/packages/server-commands/src/runners/runner-jobs-command.ts b/packages/server-commands/src/runners/runner-jobs-command.tsindex 73426d09b9..b6f10e592b 100644--- a/packages/server-commands/src/runners/runner-jobs-command.ts+++ b/packages/server-commands/src/runners/runner-jobs-command.ts@@ -46,7 +46,7 @@ export class RunnerJobsCommand extends AbstractCommand {...options,path,- query: pick(options, [ 'start', 'count', 'sort', 'search', 'stateOneOf' ]),+ query: pick(options, [ 'start', 'count', 'sort', 'search', 'stateOneOf', 'typeOneOf' ]),implicitToken: true,defaultExpectedStatus: HttpStatusCode.OK_200})diff --git a/packages/tests/src/api/check-params/runners.ts b/packages/tests/src/api/check-params/runners.tsindex b2a34bb134..9cb6a4eaea 100644--- a/packages/tests/src/api/check-params/runners.ts+++ b/packages/tests/src/api/check-params/runners.ts@@ -23,6 +23,7 @@ import {VideoStudioCommand,waitJobs} from '@peertube/peertube-server-commands'+import { isRunnerJobTypeValid } from '@peertube/peertube-server/core/helpers/custom-validators/runners/jobs.js'import { checkBadCountPagination, checkBadSort, checkBadStartPagination } from '@tests/shared/checks.js'import { basename } from 'path'@@ -314,12 +315,49 @@ describe('Test managing runners', function () {})it('Should fail with an invalid state', async function () {- await server.runnerJobs.list({ start: 0, count: 5, sort: '-createdAt', stateOneOf: 42 as any })- await server.runnerJobs.list({ start: 0, count: 5, sort: '-createdAt', stateOneOf: [ 42 ] as any })+ await server.runnerJobs.list({+ start: 0,+ count: 5,+ sort: '-createdAt',+ stateOneOf: 42 as any,+ expectedStatus: HttpStatusCode.BAD_REQUEST_400+ })++ await server.runnerJobs.list({+ start: 0,+ count: 5,+ sort: '-createdAt',+ stateOneOf: [ 42 ] as any,+ expectedStatus: HttpStatusCode.BAD_REQUEST_400+ })+ })++ it('Should fail with an invalid type', async function () {+ await server.runnerJobs.list({+ start: 0,+ count: 5,+ sort: '-createdAt',+ typeOneOf: 42 as any,+ expectedStatus: HttpStatusCode.BAD_REQUEST_400+ })++ await server.runnerJobs.list({+ start: 0,+ count: 5,+ sort: '-createdAt',+ typeOneOf: [ 42 ] as any,+ expectedStatus: HttpStatusCode.BAD_REQUEST_400+ })})it('Should succeed with the correct params', async function () {- await server.runnerJobs.list({ start: 0, count: 5, sort: '-createdAt', stateOneOf: [ RunnerJobState.COMPLETED ] })+ await server.runnerJobs.list({+ start: 0,+ count: 5,+ sort: '-createdAt',+ stateOneOf: [ RunnerJobState.COMPLETED ],+ typeOneOf: [ 'vod-web-video-transcoding' ]+ })})})diff --git a/packages/tests/src/api/runners/runner-common.ts b/packages/tests/src/api/runners/runner-common.tsindex 0a295e1b24..be36439d34 100644--- a/packages/tests/src/api/runners/runner-common.ts+++ b/packages/tests/src/api/runners/runner-common.ts@@ -367,6 +367,17 @@ describe('Test runner common actions', function () {expect(data).to.have.lengthOf(0)expect(total).to.equal(0)}++ {+ const { total, data } = await server.runnerJobs.list({ typeOneOf: [ 'vod-hls-transcoding' ] })++ expect(data).to.not.have.lengthOf(0)+ expect(total).to.not.equal(0)++ for (const job of data) {+ expect(job.type).to.equal('vod-hls-transcoding')+ }+ }})})diff --git a/server/core/controllers/api/runners/jobs.ts b/server/core/controllers/api/runners/jobs.tsindex e7052ef7ec..c9f53a99be 100644--- a/server/core/controllers/api/runners/jobs.ts+++ b/server/core/controllers/api/runners/jobs.ts@@ -462,7 +462,8 @@ async function listRunnerJobs (req: express.Request, res: express.Response) {count: query.count,sort: query.sort,search: query.search,- stateOneOf: query.stateOneOf+ stateOneOf: query.stateOneOf,+ typeOneOf: query.typeOneOf})return res.json({diff --git a/server/core/helpers/custom-validators/runners/jobs.ts b/server/core/helpers/custom-validators/runners/jobs.tsindex c9097cfd7f..aa05b13423 100644--- a/server/core/helpers/custom-validators/runners/jobs.ts+++ b/server/core/helpers/custom-validators/runners/jobs.ts@@ -1,4 +1,5 @@import {+ GenerateStoryboardSuccess,LiveRTMPHLSTranscodingSuccess,RunnerJobSuccessPayload,RunnerJobType,@@ -7,8 +8,7 @@ import {VODAudioMergeTranscodingSuccess,VODHLSTranscodingSuccess,VODWebVideoTranscodingSuccess,- VideoStudioTranscodingSuccess,- GenerateStoryboardSuccess+ VideoStudioTranscodingSuccess} from '@peertube/peertube-models'import { CONSTRAINTS_FIELDS, RUNNER_JOB_STATES } from '@server/initializers/constants.js'import { UploadFilesForCheck } from 'express'@@ -78,6 +78,10 @@ export function isRunnerJobArrayOfStateValid (value: any) {return isArray(value) && value.every(v => isRunnerJobStateValid(v))}+export function isRunnerJobArrayOfTypeValid (value: any) {+ return isArray(value) && value.every(v => isRunnerJobTypeValid(v))+}+// ---------------------------------------------------------------------------// Private// ---------------------------------------------------------------------------diff --git a/server/core/middlewares/validators/runners/jobs.ts b/server/core/middlewares/validators/runners/jobs.tsindex 8d95e516ff..91904f2f5d 100644--- a/server/core/middlewares/validators/runners/jobs.ts+++ b/server/core/middlewares/validators/runners/jobs.ts@@ -11,6 +11,7 @@ import { exists, isUUIDValid } from '@server/helpers/custom-validators/misc.js'import {isRunnerJobAbortReasonValid,isRunnerJobArrayOfStateValid,+ isRunnerJobArrayOfTypeValid,isRunnerJobErrorMessageValid,isRunnerJobProgressValid,isRunnerJobSuccessPayloadValid,@@ -128,7 +129,14 @@ export const listRunnerJobsValidator = [.customSanitizer(arrayify).custom(isRunnerJobArrayOfStateValid),+ query('typeOneOf')+ .optional()+ .customSanitizer(arrayify)+ .custom(isRunnerJobArrayOfTypeValid),+(req: express.Request, res: express.Response, next: express.NextFunction) => {+ if (areValidationErrors(req, res, { tags })) return+return next()}]diff --git a/server/core/models/runner/runner-job.ts b/server/core/models/runner/runner-job.tsindex 901f57ab9e..ac5975b580 100644--- a/server/core/models/runner/runner-job.ts+++ b/server/core/models/runner/runner-job.ts@@ -244,8 +244,9 @@ export class RunnerJobModel extends SequelizeModel<RunnerJobModel> {sort: stringsearch?: stringstateOneOf?: RunnerJobStateType[]+ typeOneOf?: RunnerJobType[]}) {- const { start, count, sort, search, stateOneOf } = options+ const { start, count, sort, search, stateOneOf, typeOneOf } = optionsconst query = {offset: start,@@ -275,6 +276,14 @@ export class RunnerJobModel extends SequelizeModel<RunnerJobModel> {})}+ if (isArray(typeOneOf) && typeOneOf.length !== 0) {+ query.where.push({+ type: {+ [Op.in]: typeOneOf+ }+ })+ }+return Promise.all([RunnerJobModel.scope([ ScopeNames.WITH_RUNNER ]).count(query),RunnerJobModel.scope([ ScopeNames.WITH_RUNNER, ScopeNames.WITH_PARENT ]).findAll<MRunnerJobRunnerParent>(query)diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yamlindex a0f9126135..0553d89d2f 100644--- a/support/doc/api/openapi.yaml+++ b/support/doc/api/openapi.yaml@@ -7567,6 +7567,13 @@ paths:type: arrayitems:$ref: '#/components/schemas/RunnerJobState'+ - name: typeOneOf+ in: query+ required: false+ schema:+ type: array+ items:+ $ref: '#/components/schemas/RunnerJobType'responses:'200':description: successful operation