ActivityPub-federated video streaming platform using P2P directly in your web browser
Add state filter on imports
Chocobozzz1bd9990013f0
diff --git a/client/src/app/+my-library/my-video-imports/my-video-imports.component.ts b/client/src/app/+my-library/my-video-imports/my-video-imports.component.tsindex 7f783c756f..b28bfd62ef 100644--- a/client/src/app/+my-library/my-video-imports/my-video-imports.component.ts+++ b/client/src/app/+my-library/my-video-imports/my-video-imports.component.ts@@ -1,5 +1,5 @@import { CommonModule } from '@angular/common'-import { Component, inject, OnInit, viewChild, ChangeDetectionStrategy } from '@angular/core'+import { ChangeDetectionStrategy, Component, inject, OnInit, viewChild } from '@angular/core'import { Notifier } from '@app/core'import { AdvancedFilterDef } from '@app/shared/shared-forms/advanced-input-filter.component'import { ActionDropdownComponent, DropdownAction } from '@app/shared/shared-main/buttons/action-dropdown.component'@@ -34,6 +34,45 @@ export class MyVideoImportsComponent implements OnInit {readonly table = viewChild<TableComponent<VideoImport, DataLoaderParameter>>('table')inputFilters: AdvancedFilterDef<DataLoaderParameter>[] = [+ {+ key: 'state',+ type: 'select',+ title: $localize`State`,+ clearable: true,+ items: [+ {+ // Filter require a string type+ id: '' + VideoImportState.PENDING,+ label: $localize`PENDING`,+ classes: [ 'pt-badge', this.getVideoImportStateClass(VideoImportState.PENDING) ]+ },+ {+ id: '' + VideoImportState.PROCESSING,+ label: $localize`PROCESSING`,+ classes: [ 'pt-badge', this.getVideoImportStateClass(VideoImportState.PROCESSING) ]+ },+ {+ id: '' + VideoImportState.SUCCESS,+ label: $localize`SUCCESS`,+ classes: [ 'pt-badge', this.getVideoImportStateClass(VideoImportState.SUCCESS) ]+ },+ {+ id: '' + VideoImportState.FAILED,+ label: $localize`FAILED`,+ classes: [ 'pt-badge', this.getVideoImportStateClass(VideoImportState.FAILED) ]+ },+ {+ id: '' + VideoImportState.REJECTED,+ label: $localize`REJECTED`,+ classes: [ 'pt-badge', this.getVideoImportStateClass(VideoImportState.REJECTED) ]+ },+ {+ id: '' + VideoImportState.CANCELLED,+ label: $localize`CANCELLED`,+ classes: [ 'pt-badge', this.getVideoImportStateClass(VideoImportState.CANCELLED) ]+ }+ ]+ },{key: 'targetUrl',type: 'text',@@ -187,9 +226,20 @@ export class MyVideoImportsComponent implements OnInit {videoChannelSyncId?: numbertargetUrl?: stringsearch?: string+ state?: string // Filter requires a string type}) {- return this.videoImportService.listMyVideoImports({ ...options, includeCollaborations: true })+ const { state, ...otherOptions } = options++ return this.videoImportService.listMyVideoImports({+ ...otherOptions,++ stateOneOf: state+ ? [ +state as VideoImportStateType ]+ : undefined,++ includeCollaborations: true+ })}private _hasExpandedRow (videoImport: VideoImport) {diff --git a/client/src/app/shared/shared-forms/advanced-input-filter.component.ts b/client/src/app/shared/shared-forms/advanced-input-filter.component.tsindex 53a7b2a630..a14062e867 100644--- a/client/src/app/shared/shared-forms/advanced-input-filter.component.ts+++ b/client/src/app/shared/shared-forms/advanced-input-filter.component.ts@@ -1,4 +1,4 @@-import { Component, OnDestroy, OnInit, computed, inject, input, output, signal, ChangeDetectionStrategy } from '@angular/core'+import { ChangeDetectionStrategy, Component, OnDestroy, OnInit, computed, inject, input, output, signal } from '@angular/core'import { FormsModule } from '@angular/forms'import { ActivatedRoute } from '@angular/router'import { NgbDropdown, NgbDropdownMenu, NgbDropdownToggle } from '@ng-bootstrap/ng-bootstrap'@@ -39,7 +39,7 @@ export type SelectFilterDef<ServiceParameters extends Record<string, any>> = {type: 'select'key: Keytitle: string- items: SelectOptionsItem<ServiceParameters[Key]>[]+ items: SelectOptionsItem<string>[] // Force a string to prevent type issues ("1" !== 1)clearable?: boolean // default truefilter?: boolean // default false}@@ -236,11 +236,12 @@ export class AdvancedInputFilterComponent<ServiceParameters extends Record<stringetSelectValue (key: string): string | undefined {const v = this.filterState()[key]+return v !== undefined ? String(v) : undefined}setSelectValue (key: string, value: string | undefined) {- this.filterState.update(s => ({ ...s, [key]: value || undefined }))+ this.filterState.update(s => ({ ...s, [key]: String(value) || undefined }))}// ---------------------------------------------------------------------------diff --git a/client/src/app/shared/shared-main/video/video-import.service.ts b/client/src/app/shared/shared-main/video/video-import.service.tsindex 6c764243c9..652beb4a6e 100644--- a/client/src/app/shared/shared-main/video/video-import.service.ts+++ b/client/src/app/shared/shared-main/video/video-import.service.ts@@ -3,7 +3,7 @@ import { inject, Injectable } from '@angular/core'import { RestExtractor, RestPagination, RestService, ServerService, UserService } from '@app/core'import { objectToFormData } from '@app/helpers'import { peertubeTranslate } from '@peertube/peertube-core-utils'-import { ResultList, Video, VideoImport, VideoImportCreate } from '@peertube/peertube-models'+import { ResultList, Video, VideoImport, VideoImportCreate, VideoImportStateType } from '@peertube/peertube-models'import { SortMeta } from 'primeng/api'import { from, Observable } from 'rxjs'import { catchError, concatMap, map, switchMap, toArray } from 'rxjs/operators'@@ -35,6 +35,7 @@ export class VideoImportService {videoChannelSyncId?: numbertargetUrl?: stringsearch?: string+ stateOneOf?: VideoImportStateType[]}): Observable<ResultList<VideoImport>> {const { pagination, sort, ...otherOptions } = optionsdiff --git a/packages/server-commands/src/videos/video-imports-command.ts b/packages/server-commands/src/videos/video-imports-command.tsindex 296227beac..59c9067b38 100644--- a/packages/server-commands/src/videos/video-imports-command.ts+++ b/packages/server-commands/src/videos/video-imports-command.ts@@ -1,4 +1,4 @@-import { HttpStatusCode, ResultList, VideoImport, VideoImportCreate, VideoImportState } from '@peertube/peertube-models'+import { HttpStatusCode, ResultList, VideoImport, VideoImportCreate, VideoImportState, VideoImportStateType } from '@peertube/peertube-models'import { unwrapBody } from '../requests/index.js'import { AbstractCommand, OverrideCommandOptions } from '../shared/index.js'@@ -117,15 +117,16 @@ export class VideoImportsCommand extends AbstractCommand {videoChannelSyncId?: numbersearch?: stringincludeCollaborations?: boolean+ stateOneOf?: VideoImportStateType[]} = {}) {- const { id, videoId, sort, targetUrl, videoChannelSyncId, search, includeCollaborations } = options+ const { id, videoId, sort, targetUrl, videoChannelSyncId, search, includeCollaborations, stateOneOf } = optionsconst path = '/api/v1/users/me/videos/imports'return this.getRequestBody<ResultList<VideoImport>>({...options,path,- query: { id, videoId, sort, targetUrl, videoChannelSyncId, search, includeCollaborations },+ query: { id, videoId, sort, targetUrl, videoChannelSyncId, search, includeCollaborations, stateOneOf },implicitToken: true,defaultExpectedStatus: HttpStatusCode.OK_200})diff --git a/packages/tests/src/api/check-params/video-imports.ts b/packages/tests/src/api/check-params/video-imports.tsindex 483f2f141e..cc1b8a5e5e 100644--- a/packages/tests/src/api/check-params/video-imports.ts+++ b/packages/tests/src/api/check-params/video-imports.ts@@ -1,7 +1,7 @@/* oxlint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */import { omit } from '@peertube/peertube-core-utils'-import { HttpStatusCode, NSFWFlag, VideoCommentPolicy, VideoImportCreate, VideoPrivacy } from '@peertube/peertube-models'+import { HttpStatusCode, NSFWFlag, VideoCommentPolicy, VideoImportCreate, VideoImportState, VideoPrivacy } from '@peertube/peertube-models'import { buildAbsoluteFixturePath } from '@peertube/peertube-node-utils'import {PeerTubeServer,@@ -80,9 +80,37 @@ describe('Test video imports API validator', function () {})})+ it('Should fail with an invalid stateOneOf', async function () {+ await makeGetRequest({+ url: server.url,+ path: myPath,+ query: { stateOneOf: 'invalid' },+ token: server.accessToken+ })+ })++ it('Should fail with an invalid stateOneOf array', async function () {+ await makeGetRequest({+ url: server.url,+ path: myPath,+ query: { stateOneOf: [ 42 ] },+ token: server.accessToken+ })+ })+it('Should succeed with the correct parameters', async function () {await makeGetRequest({ url: server.url, path: myPath, expectedStatus: HttpStatusCode.OK_200, token: server.accessToken })})++ it('Should succeed with a valid stateOneOf param', async function () {+ await makeGetRequest({+ url: server.url,+ path: myPath,+ query: { stateOneOf: [ VideoImportState.PENDING, VideoImportState.SUCCESS ] },+ expectedStatus: HttpStatusCode.OK_200,+ token: server.accessToken+ })+ })})describe('When adding a video import', function () {diff --git a/packages/tests/src/api/videos/video-imports.ts b/packages/tests/src/api/videos/video-imports.tsindex 3fa2733730..b24be016e1 100644--- a/packages/tests/src/api/videos/video-imports.ts+++ b/packages/tests/src/api/videos/video-imports.ts@@ -323,6 +323,23 @@ describe('Test video imports', function () {}})+ it('Should filter my imports on stateOneOf', async function () {+ const { total, data: videoImports } = await servers[0].videoImports.listMyVideoImports({+ stateOneOf: [ VideoImportState.SUCCESS ]+ })++ const totalExpected = areYoutubeImportTestsDisabled()+ ? 2+ : 3++ expect(total).to.equal(totalExpected)+ expect(videoImports).to.have.lengthOf(totalExpected)++ for (const videoImport of videoImports) {+ expect(videoImport.state.id).to.equal(VideoImportState.SUCCESS)+ }+ })+it('Should import a video on server 2 with some fields', async function () {if (areYoutubeImportTestsDisabled()) returndiff --git a/server/core/controllers/api/users/me.ts b/server/core/controllers/api/users/me.tsindex fe65152814..0af26eba1d 100644--- a/server/core/controllers/api/users/me.ts+++ b/server/core/controllers/api/users/me.ts@@ -223,7 +223,7 @@ async function listMyVideoImports (req: express.Request, res: express.Response)? user.Account.id: undefined,- ...pick(req.query, [ 'id', 'videoId', 'targetUrl', 'start', 'count', 'sort', 'search', 'videoChannelSyncId', 'includeCollaborations' ])+ ...pick(req.query, [ 'id', 'videoId', 'targetUrl', 'start', 'count', 'sort', 'search', 'videoChannelSyncId', 'includeCollaborations', 'stateOneOf' ])})return res.json(getFormattedObjects(resultList.data, resultList.total))diff --git a/server/core/helpers/custom-validators/video-imports.ts b/server/core/helpers/custom-validators/video-imports.tsindex 7d6bba9321..b4157816fe 100644--- a/server/core/helpers/custom-validators/video-imports.ts+++ b/server/core/helpers/custom-validators/video-imports.ts@@ -2,7 +2,7 @@ import 'multer'import { UploadFilesForCheck } from 'express'import validator from 'validator'import { CONSTRAINTS_FIELDS, MIMETYPES, VIDEO_IMPORT_STATES } from '../../initializers/constants.js'-import { exists, isFileValid } from './misc.js'+import { exists, isArray, isFileValid } from './misc.js'function isVideoImportTargetUrlValid (url: string) {const isURLOptions = {@@ -22,6 +22,10 @@ function isVideoImportStateValid (value: any) {return exists(value) && VIDEO_IMPORT_STATES[value] !== undefined}+function isVideoImportStateArrayValid (value: any) {+ return isArray(value) && value.every(v => isVideoImportStateValid(v))+}+// MacOS sends application/octet-streamconst videoTorrentImportRegex = [ ...Object.keys(MIMETYPES.TORRENT.MIMETYPE_EXT), 'application/octet-stream' ].map(m => `(${m})`)@@ -41,6 +45,7 @@ function isVideoImportTorrentFile (files: UploadFilesForCheck) {export {isVideoImportStateValid,+ isVideoImportStateArrayValid,isVideoImportTargetUrlValid,isVideoImportTorrentFile}diff --git a/server/core/middlewares/validators/videos/video-imports.ts b/server/core/middlewares/validators/videos/video-imports.tsindex 3c99c4d2f6..3fc5989dc4 100644--- a/server/core/middlewares/validators/videos/video-imports.ts+++ b/server/core/middlewares/validators/videos/video-imports.ts@@ -6,8 +6,12 @@ import { Hooks } from '@server/lib/plugins/hooks.js'import { MUserAccountId, MVideoImportDefault } from '@server/types/models/index.js'import express from 'express'import { body, param, query } from 'express-validator'-import { isIdValid, toBooleanOrNull, toIntOrNull } from '../../../helpers/custom-validators/misc.js'-import { isVideoImportTargetUrlValid, isVideoImportTorrentFile } from '../../../helpers/custom-validators/video-imports.js'+import { isIdValid, toArray, toBooleanOrNull, toIntOrNull } from '../../../helpers/custom-validators/misc.js'+import {+ isVideoImportStateArrayValid,+ isVideoImportTargetUrlValid,+ isVideoImportTorrentFile+} from '../../../helpers/custom-validators/video-imports.js'import { isValidPasswordProtectedPrivacy, isVideoMagnetUriValid, isVideoNameValid } from '../../../helpers/custom-validators/videos.js'import { cleanUpReqFiles } from '../../../helpers/express-utils.js'import { createLogger } from '../../../helpers/logger.js'@@ -113,6 +117,11 @@ export const listMyVideoImportsValidator = [.optional().custom(isIdValid),+ query('stateOneOf')+ .optional()+ .customSanitizer(toArray)+ .custom(isVideoImportStateArrayValid).withMessage('Should have a valid stateOneOf array'),+query('includeCollaborations').optional().customSanitizer(toBooleanOrNull),diff --git a/server/core/models/video/sql/import/video-import-list-query-builder.ts b/server/core/models/video/sql/import/video-import-list-query-builder.tsindex c0fdf97ac6..655e3e3819 100644--- a/server/core/models/video/sql/import/video-import-list-query-builder.ts+++ b/server/core/models/video/sql/import/video-import-list-query-builder.ts@@ -1,4 +1,4 @@-import { VideoChannelCollaboratorState } from '@peertube/peertube-models'+import { VideoChannelCollaboratorState, VideoImportStateType } from '@peertube/peertube-models'import { AbstractListQuery, AbstractListQueryOptions } from '@server/models/shared/abstract-list-query.js'import { getAvatarsJoin, getChannelJoin } from '@server/models/shared/sql/actor-helpers.js'import { Sequelize } from 'sequelize'@@ -12,6 +12,7 @@ export interface ListVideoImportsOptions extends AbstractListQueryOptions {search?: stringtargetUrl?: stringvideoChannelSyncId?: number+ stateOneOf?: VideoImportStateType[]collaborationAccountId?: number}@@ -89,6 +90,12 @@ export class VideoImportListQueryBuilder extends AbstractListQuery {this.replacements.videoChannelSyncId = this.options.videoChannelSyncId}+ if (this.options.stateOneOf?.length) {+ where.push('"VideoImportModel"."state" IN (:stateOneOf)')++ this.replacements.stateOneOf = this.options.stateOneOf+ }+if (this.options.search) {const escapedLikeSearch = this.sequelize.escape('%' + this.options.search + '%')diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yamlindex 4ef63a34fb..1bcec834dc 100644--- a/support/doc/api/openapi.yaml+++ b/support/doc/api/openapi.yaml@@ -2383,6 +2383,15 @@ paths:description: Search in video namesschema:type: string+ -+ name: stateOneOf+ in: query+ required: false+ description: Filter on import state+ schema:+ type: array+ items:+ $ref: '#/components/schemas/VideoImportStateConstant/properties/id'responses:'200':description: successful operation@@ -10905,7 +10914,12 @@ components:- 1- 2- 3- description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'+ - 4+ - 5+ - 6+ description: >+ The video import state (Pending = `1`, Success = `2`, Failed = `3`, Rejected = `4`, Cancelled = `5`,+ Processing = `6`)label:type: stringexample: Pending