1
0
Fork 0
mirror of https://github.com/Chocobozzz/PeerTube.git synced 2025-10-06 03:50:26 +02:00

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)
This commit is contained in:
Chocobozzz 2023-07-31 14:34:36 +02:00
parent 04d1da5621
commit 3a4992633e
No known key found for this signature in database
GPG key ID: 583A612D890159BE
2196 changed files with 12690 additions and 11574 deletions

View file

@ -0,0 +1,124 @@
import { FindOptions } from 'sequelize'
import { AllowNull, BelongsTo, Column, CreatedAt, DataType, ForeignKey, Model, Table, UpdatedAt } from 'sequelize-typescript'
import { MRunner } from '@server/types/models/runners/index.js'
import { Runner } from '@peertube/peertube-models'
import { AttributesOnly } from '@peertube/peertube-typescript-utils'
import { getSort } from '../shared/index.js'
import { RunnerRegistrationTokenModel } from './runner-registration-token.js'
import { CONSTRAINTS_FIELDS } from '@server/initializers/constants.js'
@Table({
tableName: 'runner',
indexes: [
{
fields: [ 'runnerToken' ],
unique: true
},
{
fields: [ 'runnerRegistrationTokenId' ]
},
{
fields: [ 'name' ],
unique: true
}
]
})
export class RunnerModel extends Model<Partial<AttributesOnly<RunnerModel>>> {
// Used to identify the appropriate runner when it uses the runner REST API
@AllowNull(false)
@Column
runnerToken: string
@AllowNull(false)
@Column
name: string
@AllowNull(true)
@Column(DataType.STRING(CONSTRAINTS_FIELDS.RUNNERS.DESCRIPTION.max))
description: string
@AllowNull(false)
@Column
lastContact: Date
@AllowNull(false)
@Column
ip: string
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
@ForeignKey(() => RunnerRegistrationTokenModel)
@Column
runnerRegistrationTokenId: number
@BelongsTo(() => RunnerRegistrationTokenModel, {
foreignKey: {
allowNull: false
},
onDelete: 'cascade'
})
RunnerRegistrationToken: Awaited<RunnerRegistrationTokenModel>
// ---------------------------------------------------------------------------
static load (id: number) {
return RunnerModel.findByPk(id)
}
static loadByToken (runnerToken: string) {
const query = {
where: { runnerToken }
}
return RunnerModel.findOne(query)
}
static loadByName (name: string) {
const query = {
where: { name }
}
return RunnerModel.findOne(query)
}
static listForApi (options: {
start: number
count: number
sort: string
}) {
const { start, count, sort } = options
const query: FindOptions = {
offset: start,
limit: count,
order: getSort(sort)
}
return Promise.all([
RunnerModel.count(query),
RunnerModel.findAll<MRunner>(query)
]).then(([ total, data ]) => ({ total, data }))
}
// ---------------------------------------------------------------------------
toFormattedJSON (this: MRunner): Runner {
return {
id: this.id,
name: this.name,
description: this.description,
ip: this.ip,
lastContact: this.lastContact,
createdAt: this.createdAt,
updatedAt: this.updatedAt
}
}
}