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) --- .../controllers/feeds/shared/common-feed-utils.ts | 149 --------------------- 1 file changed, 149 deletions(-) delete mode 100644 server/controllers/feeds/shared/common-feed-utils.ts (limited to 'server/controllers/feeds/shared/common-feed-utils.ts') diff --git a/server/controllers/feeds/shared/common-feed-utils.ts b/server/controllers/feeds/shared/common-feed-utils.ts deleted file mode 100644 index 9e2f8adbb..000000000 --- a/server/controllers/feeds/shared/common-feed-utils.ts +++ /dev/null @@ -1,149 +0,0 @@ -import express from 'express' -import { Feed } from '@peertube/feed' -import { CustomTag, CustomXMLNS, Person } from '@peertube/feed/lib/typings' -import { mdToOneLinePlainText } from '@server/helpers/markdown' -import { CONFIG } from '@server/initializers/config' -import { WEBSERVER } from '@server/initializers/constants' -import { getBiggestActorImage } from '@server/lib/actor-image' -import { UserModel } from '@server/models/user/user' -import { MAccountDefault, MChannelBannerAccountDefault, MUser, MVideoFullLight } from '@server/types/models' -import { pick } from '@shared/core-utils' -import { ActorImageType } from '@shared/models' - -export function initFeed (parameters: { - name: string - description: string - imageUrl: string - isPodcast: boolean - link?: string - locked?: { isLocked: boolean, email: string } - author?: { - name: string - link: string - imageUrl: string - } - person?: Person[] - resourceType?: 'videos' | 'video-comments' - queryString?: string - medium?: string - stunServers?: string[] - trackers?: string[] - customXMLNS?: CustomXMLNS[] - customTags?: CustomTag[] -}) { - const webserverUrl = WEBSERVER.URL - const { name, description, link, imageUrl, isPodcast, resourceType, queryString, medium } = parameters - - return new Feed({ - title: name, - description: mdToOneLinePlainText(description), - // updated: TODO: somehowGetLatestUpdate, // optional, default = today - id: link || webserverUrl, - link: link || webserverUrl, - image: imageUrl, - favicon: webserverUrl + '/client/assets/images/favicon.png', - copyright: `All rights reserved, unless otherwise specified in the terms specified at ${webserverUrl}/about` + - ` and potential licenses granted by each content's rightholder.`, - generator: `Toraifōsu`, // ^.~ - medium: medium || 'video', - feedLinks: { - json: `${webserverUrl}/feeds/${resourceType}.json${queryString}`, - atom: `${webserverUrl}/feeds/${resourceType}.atom${queryString}`, - rss: isPodcast - ? `${webserverUrl}/feeds/podcast/videos.xml${queryString}` - : `${webserverUrl}/feeds/${resourceType}.xml${queryString}` - }, - - ...pick(parameters, [ 'stunServers', 'trackers', 'customXMLNS', 'customTags', 'author', 'person', 'locked' ]) - }) -} - -export function sendFeed (feed: Feed, req: express.Request, res: express.Response) { - const format = req.params.format - - if (format === 'atom' || format === 'atom1') { - return res.send(feed.atom1()).end() - } - - if (format === 'json' || format === 'json1') { - return res.send(feed.json1()).end() - } - - if (format === 'rss' || format === 'rss2') { - return res.send(feed.rss2()).end() - } - - // We're in the ambiguous '.xml' case and we look at the format query parameter - if (req.query.format === 'atom' || req.query.format === 'atom1') { - return res.send(feed.atom1()).end() - } - - return res.send(feed.rss2()).end() -} - -export async function buildFeedMetadata (options: { - videoChannel?: MChannelBannerAccountDefault - account?: MAccountDefault - video?: MVideoFullLight -}) { - const { video, videoChannel, account } = options - - let imageUrl = WEBSERVER.URL + '/client/assets/images/icons/icon-96x96.png' - let accountImageUrl: string - let name: string - let userName: string - let description: string - let email: string - let link: string - let accountLink: string - let user: MUser - - if (videoChannel) { - name = videoChannel.getDisplayName() - description = videoChannel.description - link = videoChannel.getClientUrl() - accountLink = videoChannel.Account.getClientUrl() - - if (videoChannel.Actor.hasImage(ActorImageType.AVATAR)) { - const videoChannelAvatar = getBiggestActorImage(videoChannel.Actor.Avatars) - imageUrl = WEBSERVER.URL + videoChannelAvatar.getStaticPath() - } - - if (videoChannel.Account.Actor.hasImage(ActorImageType.AVATAR)) { - const accountAvatar = getBiggestActorImage(videoChannel.Account.Actor.Avatars) - accountImageUrl = WEBSERVER.URL + accountAvatar.getStaticPath() - } - - user = await UserModel.loadById(videoChannel.Account.userId) - userName = videoChannel.Account.getDisplayName() - } else if (account) { - name = account.getDisplayName() - description = account.description - link = account.getClientUrl() - accountLink = link - - if (account.Actor.hasImage(ActorImageType.AVATAR)) { - const accountAvatar = getBiggestActorImage(account.Actor.Avatars) - imageUrl = WEBSERVER.URL + accountAvatar?.getStaticPath() - accountImageUrl = imageUrl - } - - user = await UserModel.loadById(account.userId) - } else if (video) { - name = video.name - description = video.description - link = video.url - } else { - name = CONFIG.INSTANCE.NAME - description = CONFIG.INSTANCE.DESCRIPTION - link = WEBSERVER.URL - } - - // If the user is local, has a verified email address, and allows it to be publicly displayed - // Return it so the owner can prove ownership of their feed - if (user && !user.pluginAuth && user.emailVerified && user.emailPublic) { - email = user.email - } - - return { name, userName, description, imageUrl, accountImageUrl, email, link, accountLink } -} -- cgit v1.2.3