diff options
author | Chocobozzz <me@florianbigard.com> | 2023-07-31 14:34:36 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2023-08-11 15:02:33 +0200 |
commit | 3a4992633ee62d5edfbb484d9c6bcb3cf158489d (patch) | |
tree | e4510b39bdac9c318fdb4b47018d08f15368b8f0 /server/controllers/feeds/shared | |
parent | 04d1da5621d25d59bd5fa1543b725c497bf5d9a8 (diff) | |
download | PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.gz PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.zst PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.zip |
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)
Diffstat (limited to 'server/controllers/feeds/shared')
-rw-r--r-- | server/controllers/feeds/shared/common-feed-utils.ts | 149 | ||||
-rw-r--r-- | server/controllers/feeds/shared/index.ts | 2 | ||||
-rw-r--r-- | server/controllers/feeds/shared/video-feed-utils.ts | 66 |
3 files changed, 0 insertions, 217 deletions
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 @@ | |||
1 | import express from 'express' | ||
2 | import { Feed } from '@peertube/feed' | ||
3 | import { CustomTag, CustomXMLNS, Person } from '@peertube/feed/lib/typings' | ||
4 | import { mdToOneLinePlainText } from '@server/helpers/markdown' | ||
5 | import { CONFIG } from '@server/initializers/config' | ||
6 | import { WEBSERVER } from '@server/initializers/constants' | ||
7 | import { getBiggestActorImage } from '@server/lib/actor-image' | ||
8 | import { UserModel } from '@server/models/user/user' | ||
9 | import { MAccountDefault, MChannelBannerAccountDefault, MUser, MVideoFullLight } from '@server/types/models' | ||
10 | import { pick } from '@shared/core-utils' | ||
11 | import { ActorImageType } from '@shared/models' | ||
12 | |||
13 | export function initFeed (parameters: { | ||
14 | name: string | ||
15 | description: string | ||
16 | imageUrl: string | ||
17 | isPodcast: boolean | ||
18 | link?: string | ||
19 | locked?: { isLocked: boolean, email: string } | ||
20 | author?: { | ||
21 | name: string | ||
22 | link: string | ||
23 | imageUrl: string | ||
24 | } | ||
25 | person?: Person[] | ||
26 | resourceType?: 'videos' | 'video-comments' | ||
27 | queryString?: string | ||
28 | medium?: string | ||
29 | stunServers?: string[] | ||
30 | trackers?: string[] | ||
31 | customXMLNS?: CustomXMLNS[] | ||
32 | customTags?: CustomTag[] | ||
33 | }) { | ||
34 | const webserverUrl = WEBSERVER.URL | ||
35 | const { name, description, link, imageUrl, isPodcast, resourceType, queryString, medium } = parameters | ||
36 | |||
37 | return new Feed({ | ||
38 | title: name, | ||
39 | description: mdToOneLinePlainText(description), | ||
40 | // updated: TODO: somehowGetLatestUpdate, // optional, default = today | ||
41 | id: link || webserverUrl, | ||
42 | link: link || webserverUrl, | ||
43 | image: imageUrl, | ||
44 | favicon: webserverUrl + '/client/assets/images/favicon.png', | ||
45 | copyright: `All rights reserved, unless otherwise specified in the terms specified at ${webserverUrl}/about` + | ||
46 | ` and potential licenses granted by each content's rightholder.`, | ||
47 | generator: `ToraifÅsu`, // ^.~ | ||
48 | medium: medium || 'video', | ||
49 | feedLinks: { | ||
50 | json: `${webserverUrl}/feeds/${resourceType}.json${queryString}`, | ||
51 | atom: `${webserverUrl}/feeds/${resourceType}.atom${queryString}`, | ||
52 | rss: isPodcast | ||
53 | ? `${webserverUrl}/feeds/podcast/videos.xml${queryString}` | ||
54 | : `${webserverUrl}/feeds/${resourceType}.xml${queryString}` | ||
55 | }, | ||
56 | |||
57 | ...pick(parameters, [ 'stunServers', 'trackers', 'customXMLNS', 'customTags', 'author', 'person', 'locked' ]) | ||
58 | }) | ||
59 | } | ||
60 | |||
61 | export function sendFeed (feed: Feed, req: express.Request, res: express.Response) { | ||
62 | const format = req.params.format | ||
63 | |||
64 | if (format === 'atom' || format === 'atom1') { | ||
65 | return res.send(feed.atom1()).end() | ||
66 | } | ||
67 | |||
68 | if (format === 'json' || format === 'json1') { | ||
69 | return res.send(feed.json1()).end() | ||
70 | } | ||
71 | |||
72 | if (format === 'rss' || format === 'rss2') { | ||
73 | return res.send(feed.rss2()).end() | ||
74 | } | ||
75 | |||
76 | // We're in the ambiguous '.xml' case and we look at the format query parameter | ||
77 | if (req.query.format === 'atom' || req.query.format === 'atom1') { | ||
78 | return res.send(feed.atom1()).end() | ||
79 | } | ||
80 | |||
81 | return res.send(feed.rss2()).end() | ||
82 | } | ||
83 | |||
84 | export async function buildFeedMetadata (options: { | ||
85 | videoChannel?: MChannelBannerAccountDefault | ||
86 | account?: MAccountDefault | ||
87 | video?: MVideoFullLight | ||
88 | }) { | ||
89 | const { video, videoChannel, account } = options | ||
90 | |||
91 | let imageUrl = WEBSERVER.URL + '/client/assets/images/icons/icon-96x96.png' | ||
92 | let accountImageUrl: string | ||
93 | let name: string | ||
94 | let userName: string | ||
95 | let description: string | ||
96 | let email: string | ||
97 | let link: string | ||
98 | let accountLink: string | ||
99 | let user: MUser | ||
100 | |||
101 | if (videoChannel) { | ||
102 | name = videoChannel.getDisplayName() | ||
103 | description = videoChannel.description | ||
104 | link = videoChannel.getClientUrl() | ||
105 | accountLink = videoChannel.Account.getClientUrl() | ||
106 | |||
107 | if (videoChannel.Actor.hasImage(ActorImageType.AVATAR)) { | ||
108 | const videoChannelAvatar = getBiggestActorImage(videoChannel.Actor.Avatars) | ||
109 | imageUrl = WEBSERVER.URL + videoChannelAvatar.getStaticPath() | ||
110 | } | ||
111 | |||
112 | if (videoChannel.Account.Actor.hasImage(ActorImageType.AVATAR)) { | ||
113 | const accountAvatar = getBiggestActorImage(videoChannel.Account.Actor.Avatars) | ||
114 | accountImageUrl = WEBSERVER.URL + accountAvatar.getStaticPath() | ||
115 | } | ||
116 | |||
117 | user = await UserModel.loadById(videoChannel.Account.userId) | ||
118 | userName = videoChannel.Account.getDisplayName() | ||
119 | } else if (account) { | ||
120 | name = account.getDisplayName() | ||
121 | description = account.description | ||
122 | link = account.getClientUrl() | ||
123 | accountLink = link | ||
124 | |||
125 | if (account.Actor.hasImage(ActorImageType.AVATAR)) { | ||
126 | const accountAvatar = getBiggestActorImage(account.Actor.Avatars) | ||
127 | imageUrl = WEBSERVER.URL + accountAvatar?.getStaticPath() | ||
128 | accountImageUrl = imageUrl | ||
129 | } | ||
130 | |||
131 | user = await UserModel.loadById(account.userId) | ||
132 | } else if (video) { | ||
133 | name = video.name | ||
134 | description = video.description | ||
135 | link = video.url | ||
136 | } else { | ||
137 | name = CONFIG.INSTANCE.NAME | ||
138 | description = CONFIG.INSTANCE.DESCRIPTION | ||
139 | link = WEBSERVER.URL | ||
140 | } | ||
141 | |||
142 | // If the user is local, has a verified email address, and allows it to be publicly displayed | ||
143 | // Return it so the owner can prove ownership of their feed | ||
144 | if (user && !user.pluginAuth && user.emailVerified && user.emailPublic) { | ||
145 | email = user.email | ||
146 | } | ||
147 | |||
148 | return { name, userName, description, imageUrl, accountImageUrl, email, link, accountLink } | ||
149 | } | ||
diff --git a/server/controllers/feeds/shared/index.ts b/server/controllers/feeds/shared/index.ts deleted file mode 100644 index 0136c8477..000000000 --- a/server/controllers/feeds/shared/index.ts +++ /dev/null | |||
@@ -1,2 +0,0 @@ | |||
1 | export * from './video-feed-utils' | ||
2 | export * from './common-feed-utils' | ||
diff --git a/server/controllers/feeds/shared/video-feed-utils.ts b/server/controllers/feeds/shared/video-feed-utils.ts deleted file mode 100644 index b154e04fa..000000000 --- a/server/controllers/feeds/shared/video-feed-utils.ts +++ /dev/null | |||
@@ -1,66 +0,0 @@ | |||
1 | import { mdToOneLinePlainText, toSafeHtml } from '@server/helpers/markdown' | ||
2 | import { CONFIG } from '@server/initializers/config' | ||
3 | import { WEBSERVER } from '@server/initializers/constants' | ||
4 | import { getServerActor } from '@server/models/application/application' | ||
5 | import { getCategoryLabel } from '@server/models/video/formatter' | ||
6 | import { DisplayOnlyForFollowerOptions } from '@server/models/video/sql/video' | ||
7 | import { VideoModel } from '@server/models/video/video' | ||
8 | import { MThumbnail, MUserDefault } from '@server/types/models' | ||
9 | import { VideoInclude } from '@shared/models' | ||
10 | |||
11 | export async function getVideosForFeeds (options: { | ||
12 | sort: string | ||
13 | nsfw: boolean | ||
14 | isLocal: boolean | ||
15 | include: VideoInclude | ||
16 | |||
17 | accountId?: number | ||
18 | videoChannelId?: number | ||
19 | displayOnlyForFollower?: DisplayOnlyForFollowerOptions | ||
20 | user?: MUserDefault | ||
21 | }) { | ||
22 | const server = await getServerActor() | ||
23 | |||
24 | const { data } = await VideoModel.listForApi({ | ||
25 | start: 0, | ||
26 | count: CONFIG.FEEDS.VIDEOS.COUNT, | ||
27 | displayOnlyForFollower: { | ||
28 | actorId: server.id, | ||
29 | orLocalVideos: true | ||
30 | }, | ||
31 | hasFiles: true, | ||
32 | countVideos: false, | ||
33 | |||
34 | ...options | ||
35 | }) | ||
36 | |||
37 | return data | ||
38 | } | ||
39 | |||
40 | export function getCommonVideoFeedAttributes (video: VideoModel) { | ||
41 | const localLink = WEBSERVER.URL + video.getWatchStaticPath() | ||
42 | |||
43 | const thumbnailModels: MThumbnail[] = [] | ||
44 | if (video.hasPreview()) thumbnailModels.push(video.getPreview()) | ||
45 | thumbnailModels.push(video.getMiniature()) | ||
46 | |||
47 | return { | ||
48 | title: video.name, | ||
49 | link: localLink, | ||
50 | description: mdToOneLinePlainText(video.getTruncatedDescription()), | ||
51 | content: toSafeHtml(video.description), | ||
52 | |||
53 | date: video.publishedAt, | ||
54 | nsfw: video.nsfw, | ||
55 | |||
56 | category: video.category | ||
57 | ? [ { name: getCategoryLabel(video.category) } ] | ||
58 | : undefined, | ||
59 | |||
60 | thumbnails: thumbnailModels.map(t => ({ | ||
61 | url: WEBSERVER.URL + t.getLocalStaticPath(), | ||
62 | width: t.width, | ||
63 | height: t.height | ||
64 | })) | ||
65 | } | ||
66 | } | ||