From 3a4992633ee62d5edfbb484d9c6bcb3cf158489d Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Mon, 31 Jul 2023 14:34:36 +0200 Subject: Migrate server to ESM Sorry for the very big commit that may lead to git log issues and merge conflicts, but it's a major step forward: * Server can be faster at startup because imports() are async and we can easily lazy import big modules * Angular doesn't seem to support ES import (with .js extension), so we had to correctly organize peertube into a monorepo: * Use yarn workspace feature * Use typescript reference projects for dependencies * Shared projects have been moved into "packages", each one is now a node module (with a dedicated package.json/tsconfig.json) * server/tools have been moved into apps/ and is now a dedicated app bundled and published on NPM so users don't have to build peertube cli tools manually * server/tests have been moved into packages/ so we don't compile them every time we want to run the server * Use isolatedModule option: * Had to move from const enum to const (https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums) * Had to explictely specify "type" imports when used in decorators * Prefer tsx (that uses esbuild under the hood) instead of ts-node to load typescript files (tests with mocha or scripts): * To reduce test complexity as esbuild doesn't support decorator metadata, we only test server files that do not import server models * We still build tests files into js files for a faster CI * Remove unmaintained peertube CLI import script * Removed some barrels to speed up execution (less imports) --- server/helpers/custom-validators/plugins.ts | 178 ---------------------------- 1 file changed, 178 deletions(-) delete mode 100644 server/helpers/custom-validators/plugins.ts (limited to 'server/helpers/custom-validators/plugins.ts') diff --git a/server/helpers/custom-validators/plugins.ts b/server/helpers/custom-validators/plugins.ts deleted file mode 100644 index a20de0c4a..000000000 --- a/server/helpers/custom-validators/plugins.ts +++ /dev/null @@ -1,178 +0,0 @@ -import validator from 'validator' -import { PluginPackageJSON } from '../../../shared/models/plugins/plugin-package-json.model' -import { PluginType } from '../../../shared/models/plugins/plugin.type' -import { CONSTRAINTS_FIELDS } from '../../initializers/constants' -import { isUrlValid } from './activitypub/misc' -import { exists, isArray, isSafePath } from './misc' - -const PLUGINS_CONSTRAINTS_FIELDS = CONSTRAINTS_FIELDS.PLUGINS - -function isPluginTypeValid (value: any) { - return exists(value) && - (value === PluginType.PLUGIN || value === PluginType.THEME) -} - -function isPluginNameValid (value: string) { - return exists(value) && - validator.isLength(value, PLUGINS_CONSTRAINTS_FIELDS.NAME) && - validator.matches(value, /^[a-z-0-9]+$/) -} - -function isNpmPluginNameValid (value: string) { - return exists(value) && - validator.isLength(value, PLUGINS_CONSTRAINTS_FIELDS.NAME) && - validator.matches(value, /^[a-z\-._0-9]+$/) && - (value.startsWith('peertube-plugin-') || value.startsWith('peertube-theme-')) -} - -function isPluginDescriptionValid (value: string) { - return exists(value) && validator.isLength(value, PLUGINS_CONSTRAINTS_FIELDS.DESCRIPTION) -} - -function isPluginStableVersionValid (value: string) { - if (!exists(value)) return false - - const parts = (value + '').split('.') - - return parts.length === 3 && parts.every(p => validator.isInt(p)) -} - -function isPluginStableOrUnstableVersionValid (value: string) { - if (!exists(value)) return false - - // suffix is beta.x or alpha.x - const [ stable, suffix ] = value.split('-') - if (!isPluginStableVersionValid(stable)) return false - - const suffixRegex = /^(rc|alpha|beta)\.\d+$/ - if (suffix && !suffixRegex.test(suffix)) return false - - return true -} - -function isPluginEngineValid (engine: any) { - return exists(engine) && exists(engine.peertube) -} - -function isPluginHomepage (value: string) { - return exists(value) && (!value || isUrlValid(value)) -} - -function isPluginBugs (value: string) { - return exists(value) && (!value || isUrlValid(value)) -} - -function areStaticDirectoriesValid (staticDirs: any) { - if (!exists(staticDirs) || typeof staticDirs !== 'object') return false - - for (const key of Object.keys(staticDirs)) { - if (!isSafePath(staticDirs[key])) return false - } - - return true -} - -function areClientScriptsValid (clientScripts: any[]) { - return isArray(clientScripts) && - clientScripts.every(c => { - return isSafePath(c.script) && isArray(c.scopes) - }) -} - -function areTranslationPathsValid (translations: any) { - if (!exists(translations) || typeof translations !== 'object') return false - - for (const key of Object.keys(translations)) { - if (!isSafePath(translations[key])) return false - } - - return true -} - -function areCSSPathsValid (css: any[]) { - return isArray(css) && css.every(c => isSafePath(c)) -} - -function isThemeNameValid (name: string) { - return isPluginNameValid(name) -} - -function isPackageJSONValid (packageJSON: PluginPackageJSON, pluginType: PluginType) { - let result = true - const badFields: string[] = [] - - if (!isNpmPluginNameValid(packageJSON.name)) { - result = false - badFields.push('name') - } - - if (!isPluginDescriptionValid(packageJSON.description)) { - result = false - badFields.push('description') - } - - if (!isPluginEngineValid(packageJSON.engine)) { - result = false - badFields.push('engine') - } - - if (!isPluginHomepage(packageJSON.homepage)) { - result = false - badFields.push('homepage') - } - - if (!exists(packageJSON.author)) { - result = false - badFields.push('author') - } - - if (!isPluginBugs(packageJSON.bugs)) { - result = false - badFields.push('bugs') - } - - if (pluginType === PluginType.PLUGIN && !isSafePath(packageJSON.library)) { - result = false - badFields.push('library') - } - - if (!areStaticDirectoriesValid(packageJSON.staticDirs)) { - result = false - badFields.push('staticDirs') - } - - if (!areCSSPathsValid(packageJSON.css)) { - result = false - badFields.push('css') - } - - if (!areClientScriptsValid(packageJSON.clientScripts)) { - result = false - badFields.push('clientScripts') - } - - if (!areTranslationPathsValid(packageJSON.translations)) { - result = false - badFields.push('translations') - } - - return { result, badFields } -} - -function isLibraryCodeValid (library: any) { - return typeof library.register === 'function' && - typeof library.unregister === 'function' -} - -export { - isPluginTypeValid, - isPackageJSONValid, - isThemeNameValid, - isPluginHomepage, - isPluginStableVersionValid, - isPluginStableOrUnstableVersionValid, - isPluginNameValid, - isPluginDescriptionValid, - isLibraryCodeValid, - isNpmPluginNameValid -} -- cgit v1.2.3