From 5f189c9c85449951254646ddf6cd6c84bc4c06ff Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 24 Jul 2019 10:21:22 +0200 Subject: [PATCH] Add hooks documentation --- server/tests/api/travis-1.sh | 2 +- server/tests/api/travis-2.sh | 2 +- server/tests/api/travis-3.sh | 2 +- server/tests/api/travis-4.sh | 2 +- server/tests/plugins/index.ts | 4 ++-- shared/models/plugins/client-hook.model.ts | 13 +++++++++++++ shared/models/plugins/server-hook.model.ts | 22 ++++++++++++++++++++++ support/doc/plugins/guide.md | 2 -- 8 files changed, 41 insertions(+), 8 deletions(-) diff --git a/server/tests/api/travis-1.sh b/server/tests/api/travis-1.sh index 4572416b7..db4021b25 100644 --- a/server/tests/api/travis-1.sh +++ b/server/tests/api/travis-1.sh @@ -6,5 +6,5 @@ checkParamFiles=$(find server/tests/api/check-params -type f | grep -v index.ts notificationsFiles=$(find server/tests/api/notifications -type f | grep -v index.ts | xargs echo) searchFiles=$(find server/tests/api/search -type f | grep -v index.ts | xargs echo) -MOCHA_PARALLEL=true mocha --timeout 5000 --retries 3 --exit --require ts-node/register --bail \ +MOCHA_PARALLEL=true mocha --timeout 5000 --exit --require ts-node/register --bail \ $notificationsFiles $searchFiles $checkParamFiles diff --git a/server/tests/api/travis-2.sh b/server/tests/api/travis-2.sh index 3c519ef68..ba7a061b0 100644 --- a/server/tests/api/travis-2.sh +++ b/server/tests/api/travis-2.sh @@ -5,5 +5,5 @@ set -eu serverFiles=$(find server/tests/api/server -type f | grep -v index.ts | xargs echo) usersFiles=$(find server/tests/api/users -type f | grep -v index.ts | xargs echo) -MOCHA_PARALLEL=true mocha --timeout 5000 --retries 3 --exit --require ts-node/register --bail \ +MOCHA_PARALLEL=true mocha --timeout 5000 --exit --require ts-node/register --bail \ $serverFiles $usersFiles diff --git a/server/tests/api/travis-3.sh b/server/tests/api/travis-3.sh index 97dadafca..82457222c 100644 --- a/server/tests/api/travis-3.sh +++ b/server/tests/api/travis-3.sh @@ -4,5 +4,5 @@ set -eu videosFiles=$(find server/tests/api/videos -type f | grep -v index.ts | xargs echo) -MOCHA_PARALLEL=true mocha --timeout 5000 --retries 3 --exit --require ts-node/register --bail \ +MOCHA_PARALLEL=true mocha --timeout 5000 --exit --require ts-node/register --bail \ $videosFiles diff --git a/server/tests/api/travis-4.sh b/server/tests/api/travis-4.sh index 6009b1f0e..875986182 100644 --- a/server/tests/api/travis-4.sh +++ b/server/tests/api/travis-4.sh @@ -5,5 +5,5 @@ set -eu redundancyFiles=$(find server/tests/api/redundancy -type f | grep -v index.ts | xargs echo) activitypubFiles=$(find server/tests/api/activitypub -type f | grep -v index.ts | xargs echo) -MOCHA_PARALLEL=true mocha-parallel-tests --max-parallel $1 --timeout 5000 --retries 3 --exit --require ts-node/register --bail \ +MOCHA_PARALLEL=true mocha-parallel-tests --max-parallel $1 --timeout 5000 --exit --require ts-node/register --bail \ $redundancyFiles $activitypubFiles diff --git a/server/tests/plugins/index.ts b/server/tests/plugins/index.ts index b640ecc9e..d97ca1515 100644 --- a/server/tests/plugins/index.ts +++ b/server/tests/plugins/index.ts @@ -1,2 +1,2 @@ -export * from './action-hooks' -export * from './filter-hooks' +import './action-hooks' +import './filter-hooks' diff --git a/shared/models/plugins/client-hook.model.ts b/shared/models/plugins/client-hook.model.ts index bf444fe5a..87e8092c0 100644 --- a/shared/models/plugins/client-hook.model.ts +++ b/shared/models/plugins/client-hook.model.ts @@ -1,29 +1,38 @@ // Data from API hooks: {hookType}:api.{location}.{elementType}.{actionType}.{target} export const clientFilterHookObject = { + // Filter params/result of the function that fetch videos of the trending page 'filter:api.trending-videos.videos.list.params': true, 'filter:api.trending-videos.videos.list.result': true, + // Filter params/result of the function that fetch videos of the local page 'filter:api.local-videos.videos.list.params': true, 'filter:api.local-videos.videos.list.result': true, + // Filter params/result of the function that fetch videos of the recently-added page 'filter:api.recently-added-videos.videos.list.params': true, 'filter:api.recently-added-videos.videos.list.result': true, + // Filter params/result of the function that fetch videos of the user subscription page 'filter:api.user-subscriptions-videos.videos.list.params': true, 'filter:api.user-subscriptions-videos.videos.list.result': true, + // Filter params/result of the function that fetch the video of the video-watch page 'filter:api.video-watch.video.get.params': true, 'filter:api.video-watch.video.get.result': true, + // Filter params/result of the function that fetch the threads of the video-watch page 'filter:api.video-watch.video-threads.list.params': true, 'filter:api.video-watch.video-threads.list.result': true, + // Filter params/result of the function that fetch the replies of a thread in the video-watch page 'filter:api.video-watch.video-thread-replies.list.params': true, 'filter:api.video-watch.video-thread-replies.list.result': true, + // Filter params/result of the function that fetch videos according to the user search 'filter:api.search.videos.list.params': true, 'filter:api.search.videos.list.result': true, + // Filter params/result of the function that fetch video-channels according to the user search 'filter:api.search.video-channels.list.params': true, 'filter:api.search.video-channels.list.result': true } @@ -31,11 +40,15 @@ export const clientFilterHookObject = { export type ClientFilterHookName = keyof typeof clientFilterHookObject export const clientActionHookObject = { + // Fired when the application is being initialized 'action:application.init': true, + // Fired when the video watch page is being initialized 'action:video-watch.init': true, + // Fired when the video watch page loaded the video 'action:video-watch.video.loaded': true, + // Fired when the search page is being initialized 'action:search.init': true } diff --git a/shared/models/plugins/server-hook.model.ts b/shared/models/plugins/server-hook.model.ts index fc4c51160..32c7f4688 100644 --- a/shared/models/plugins/server-hook.model.ts +++ b/shared/models/plugins/server-hook.model.ts @@ -1,35 +1,57 @@ // {hookType}:{api?}.{location}.{subLocation?}.{actionType}.{target} export const serverFilterHookObject = { + // Filter params/result used to list videos for the REST API + // (used by the trending page, recently-added page, local page etc) 'filter:api.videos.list.params': true, 'filter:api.videos.list.result': true, + // Filter the result of the get function + // Used to get detailed video information (video watch page for example) 'filter:api.video.get.result': true, + // Filter the result of the accept upload function + // If this function returns false then the upload is aborted with an error 'filter:api.video.upload.accept.result': true, + // Filter the result of the accept comment (thread or reply) functions + // If the functions return false then the user cannot post its comment 'filter:api.video-thread.create.accept.result': true, 'filter:api.video-comment-reply.create.accept.result': true, + // Filter params/result used to list threads of a specific video + // (used by the video watch page) 'filter:api.video-threads.list.params': true, 'filter:api.video-threads.list.result': true, + // Filter params/result used to list replies of a specific thread + // (used by the video watch page when we click on the "View replies" button) 'filter:api.video-thread-comments.list.params': true, 'filter:api.video-thread-comments.list.result': true, + // Filter result used to check if we need to auto blacklist a video + // (fired when a local or remote video is created or updated) 'filter:video.auto-blacklist.result': true } export type ServerFilterHookName = keyof typeof serverFilterHookObject export const serverActionHookObject = { + // Fired when the application has been loaded and is listening HTTP requests 'action:application.listening': true, + // Fired when a local video is updated 'action:api.video.updated': true, + // Fired when a local video is deleted 'action:api.video.deleted': true, + // Fired when a local video is uploaded 'action:api.video.uploaded': true, + // Fired when a local video is viewed 'action:api.video.viewed': true, + // Fired when a thread is created 'action:api.video-thread.created': true, + // Fired when a reply to a thread is created 'action:api.video-comment-reply.created': true, + // Fired when a comment (thread or reply) is deleted 'action:api.video-comment.deleted': true } diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index 252cbc2e2..0b2d337eb 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md @@ -297,5 +297,3 @@ If you want to create an antispam/moderation plugin, you could use the following * `filter:api.video-thread-comments.list.result`: to change/hide the text of replies * `filter:video.auto-blacklist.result`: to automatically blacklist local or remote videos - -