shared/extra-utils/server/plugins.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import { expect } from 'chai'
   4 import { readJSON, writeJSON } from 'fs-extra'
   5 import { join } from 'path'
   6 import { RegisteredServerSettings } from '@shared/models'
   7 import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
   8 import { PeertubePluginIndexList } from '../../models/plugins/plugin-index/peertube-plugin-index-list.model'
   9 import { PluginType } from '../../models/plugins/plugin.type'
  10 import { buildServerDirectory, root } from '../miscs/miscs'
  11 import { makeGetRequest, makePostBodyRequest, makePutBodyRequest } from '../requests/requests'
  12 import { ServerInfo } from './servers'
  13
  14 function listPlugins (parameters: {
  15   url: string
  16   accessToken: string
  17   start?: number
  18   count?: number
  19   sort?: string
  20   pluginType?: PluginType
  21   uninstalled?: boolean
  22   expectedStatus?: HttpStatusCode
  23 }) {
  24   const { url, accessToken, start, count, sort, pluginType, uninstalled, expectedStatus = HttpStatusCode.OK_200 } = parameters
  25   const path = '/api/v1/plugins'
  26
  27   return makeGetRequest({
  28     url,
  29     path,
  30     token: accessToken,
  31     query: {
  32       start,
  33       count,
  34       sort,
  35       pluginType,
  36       uninstalled
  37     },
  38     statusCodeExpected: expectedStatus
  39   })
  40 }
  41
  42 function listAvailablePlugins (parameters: {
  43   url: string
  44   accessToken: string
  45   start?: number
  46   count?: number
  47   sort?: string
  48   pluginType?: PluginType
  49   currentPeerTubeEngine?: string
  50   search?: string
  51   expectedStatus?: HttpStatusCode
  52 }) {
  53   const {
  54     url,
  55     accessToken,
  56     start,
  57     count,
  58     sort,
  59     pluginType,
  60     search,
  61     currentPeerTubeEngine,
  62     expectedStatus = HttpStatusCode.OK_200
  63   } = parameters
  64   const path = '/api/v1/plugins/available'
  65
  66   const query: PeertubePluginIndexList = {
  67     start,
  68     count,
  69     sort,
  70     pluginType,
  71     currentPeerTubeEngine,
  72     search
  73   }
  74
  75   return makeGetRequest({
  76     url,
  77     path,
  78     token: accessToken,
  79     query,
  80     statusCodeExpected: expectedStatus
  81   })
  82 }
  83
  84 function getPlugin (parameters: {
  85   url: string
  86   accessToken: string
  87   npmName: string
  88   expectedStatus?: HttpStatusCode
  89 }) {
  90   const { url, accessToken, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
  91   const path = '/api/v1/plugins/' + npmName
  92
  93   return makeGetRequest({
  94     url,
  95     path,
  96     token: accessToken,
  97     statusCodeExpected: expectedStatus
  98   })
  99 }
 100
 101 function updatePluginSettings (parameters: {
 102   url: string
 103   accessToken: string
 104   npmName: string
 105   settings: any
 106   expectedStatus?: HttpStatusCode
 107 }) {
 108   const { url, accessToken, npmName, settings, expectedStatus = HttpStatusCode.NO_CONTENT_204 } = parameters
 109   const path = '/api/v1/plugins/' + npmName + '/settings'
 110
 111   return makePutBodyRequest({
 112     url,
 113     path,
 114     token: accessToken,
 115     fields: { settings },
 116     statusCodeExpected: expectedStatus
 117   })
 118 }
 119
 120 function getPluginRegisteredSettings (parameters: {
 121   url: string
 122   accessToken: string
 123   npmName: string
 124   expectedStatus?: HttpStatusCode
 125 }) {
 126   const { url, accessToken, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
 127   const path = '/api/v1/plugins/' + npmName + '/registered-settings'
 128
 129   return makeGetRequest({
 130     url,
 131     path,
 132     token: accessToken,
 133     statusCodeExpected: expectedStatus
 134   })
 135 }
 136
 137 async function testHelloWorldRegisteredSettings (server: ServerInfo) {
 138   const res = await getPluginRegisteredSettings({
 139     url: server.url,
 140     accessToken: server.accessToken,
 141     npmName: 'peertube-plugin-hello-world'
 142   })
 143
 144   const registeredSettings = (res.body as RegisteredServerSettings).registeredSettings
 145
 146   expect(registeredSettings).to.have.length.at.least(1)
 147
 148   const adminNameSettings = registeredSettings.find(s => s.name === 'admin-name')
 149   expect(adminNameSettings).to.not.be.undefined
 150 }
 151
 152 function getPublicSettings (parameters: {
 153   url: string
 154   npmName: string
 155   expectedStatus?: HttpStatusCode
 156 }) {
 157   const { url, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
 158   const path = '/api/v1/plugins/' + npmName + '/public-settings'
 159
 160   return makeGetRequest({
 161     url,
 162     path,
 163     statusCodeExpected: expectedStatus
 164   })
 165 }
 166
 167 function getPluginTranslations (parameters: {
 168   url: string
 169   locale: string
 170   expectedStatus?: HttpStatusCode
 171 }) {
 172   const { url, locale, expectedStatus = HttpStatusCode.OK_200 } = parameters
 173   const path = '/plugins/translations/' + locale + '.json'
 174
 175   return makeGetRequest({
 176     url,
 177     path,
 178     statusCodeExpected: expectedStatus
 179   })
 180 }
 181
 182 function installPlugin (parameters: {
 183   url: string
 184   accessToken: string
 185   path?: string
 186   npmName?: string
 187   expectedStatus?: HttpStatusCode
 188 }) {
 189   const { url, accessToken, npmName, path, expectedStatus = HttpStatusCode.OK_200 } = parameters
 190   const apiPath = '/api/v1/plugins/install'
 191
 192   return makePostBodyRequest({
 193     url,
 194     path: apiPath,
 195     token: accessToken,
 196     fields: { npmName, path },
 197     statusCodeExpected: expectedStatus
 198   })
 199 }
 200
 201 function updatePlugin (parameters: {
 202   url: string
 203   accessToken: string
 204   path?: string
 205   npmName?: string
 206   expectedStatus?: HttpStatusCode
 207 }) {
 208   const { url, accessToken, npmName, path, expectedStatus = HttpStatusCode.OK_200 } = parameters
 209   const apiPath = '/api/v1/plugins/update'
 210
 211   return makePostBodyRequest({
 212     url,
 213     path: apiPath,
 214     token: accessToken,
 215     fields: { npmName, path },
 216     statusCodeExpected: expectedStatus
 217   })
 218 }
 219
 220 function uninstallPlugin (parameters: {
 221   url: string
 222   accessToken: string
 223   npmName: string
 224   expectedStatus?: HttpStatusCode
 225 }) {
 226   const { url, accessToken, npmName, expectedStatus = HttpStatusCode.NO_CONTENT_204 } = parameters
 227   const apiPath = '/api/v1/plugins/uninstall'
 228
 229   return makePostBodyRequest({
 230     url,
 231     path: apiPath,
 232     token: accessToken,
 233     fields: { npmName },
 234     statusCodeExpected: expectedStatus
 235   })
 236 }
 237
 238 function getPluginsCSS (url: string) {
 239   const path = '/plugins/global.css'
 240
 241   return makeGetRequest({
 242     url,
 243     path,
 244     statusCodeExpected: HttpStatusCode.OK_200
 245   })
 246 }
 247
 248 function getPackageJSONPath (server: ServerInfo, npmName: string) {
 249   return buildServerDirectory(server, join('plugins', 'node_modules', npmName, 'package.json'))
 250 }
 251
 252 function updatePluginPackageJSON (server: ServerInfo, npmName: string, json: any) {
 253   const path = getPackageJSONPath(server, npmName)
 254
 255   return writeJSON(path, json)
 256 }
 257
 258 function getPluginPackageJSON (server: ServerInfo, npmName: string) {
 259   const path = getPackageJSONPath(server, npmName)
 260
 261   return readJSON(path)
 262 }
 263
 264 function getPluginTestPath (suffix = '') {
 265   return join(root(), 'server', 'tests', 'fixtures', 'peertube-plugin-test' + suffix)
 266 }
 267
 268 function getExternalAuth (options: {
 269   url: string
 270   npmName: string
 271   npmVersion: string
 272   authName: string
 273   query?: any
 274   statusCodeExpected?: HttpStatusCode
 275 }) {
 276   const { url, npmName, npmVersion, authName, statusCodeExpected, query } = options
 277
 278   const path = '/plugins/' + npmName + '/' + npmVersion + '/auth/' + authName
 279
 280   return makeGetRequest({
 281     url,
 282     path,
 283     query,
 284     statusCodeExpected: statusCodeExpected || HttpStatusCode.OK_200,
 285     redirects: 0
 286   })
 287 }
 288
 289 export {
 290   listPlugins,
 291   listAvailablePlugins,
 292   installPlugin,
 293   getPluginTranslations,
 294   getPluginsCSS,
 295   updatePlugin,
 296   getPlugin,
 297   uninstallPlugin,
 298   testHelloWorldRegisteredSettings,
 299   updatePluginSettings,
 300   getPluginRegisteredSettings,
 301   getPackageJSONPath,
 302   updatePluginPackageJSON,
 303   getPluginPackageJSON,
 304   getPluginTestPath,
 305   getPublicSettings,
 306   getExternalAuth
 307 }