Init commit

packages/node-utils/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@peertube/peertube-node-utils",
+  "private": true,
+  "version": "0.0.0",
+  "main": "dist/index.js",
+  "files": [ "dist" ],
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "peertube:tsx": "./src/index.ts",
+    "default": "./dist/index.js"
+  },
+  "type": "module",
+  "devDependencies": {},
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w"
+  },
+  "dependencies": {}
+}

packages/node-utils/src/crypto.ts

@@ -0,0 +1,13 @@
+import { BinaryToTextEncoding, createHash } from 'crypto'
+
+export function sha256 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') {
+  return createHash('sha256').update(str).digest(encoding)
+}
+
+export function sha1 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') {
+  return createHash('sha1').update(str).digest(encoding)
+}
+
+export function md5 (str: string | Buffer) {
+  return createHash('md5').update(str).digest()
+}

packages/node-utils/src/env.ts

@@ -0,0 +1,66 @@
+export function parallelTests () {
+  return process.env.MOCHA_PARALLEL === 'true'
+}
+
+export function isGithubCI () {
+  return !!process.env.GITHUB_WORKSPACE
+}
+
+export function areHttpImportTestsDisabled () {
+  const disabled = process.env.DISABLE_HTTP_IMPORT_TESTS === 'true'
+
+  if (disabled) console.log('DISABLE_HTTP_IMPORT_TESTS env set to "true" so import tests are disabled')
+
+  return disabled
+}
+
+export function areYoutubeImportTestsDisabled () {
+  const disabled = process.env.DISABLE_HTTP_YOUTUBE_IMPORT_TESTS === 'true'
+
+  if (disabled) console.log('DISABLE_HTTP_YOUTUBE_IMPORT_TESTS env set to "true" so youtube import tests are disabled')
+
+  return disabled
+}
+
+export function areMockObjectStorageTestsDisabled () {
+  const disabled = process.env.ENABLE_OBJECT_STORAGE_TESTS !== 'true'
+
+  if (disabled) console.log('ENABLE_OBJECT_STORAGE_TESTS env is not set to "true" so object storage tests are disabled')
+
+  return disabled
+}
+
+export function areScalewayObjectStorageTestsDisabled () {
+  if (areMockObjectStorageTestsDisabled()) return true
+
+  const enabled = process.env.OBJECT_STORAGE_SCALEWAY_KEY_ID && process.env.OBJECT_STORAGE_SCALEWAY_ACCESS_KEY
+  if (!enabled) {
+    console.log(
+      'OBJECT_STORAGE_SCALEWAY_KEY_ID and/or OBJECT_STORAGE_SCALEWAY_ACCESS_KEY are not set, so scaleway object storage tests are disabled'
+    )
+
+    return true
+  }
+
+  return false
+}
+
+export function isTestInstance () {
+  return process.env.NODE_ENV === 'test'
+}
+
+export function isDevInstance () {
+  return process.env.NODE_ENV === 'dev'
+}
+
+export function isTestOrDevInstance () {
+  return isTestInstance() || isDevInstance()
+}
+
+export function isProdInstance () {
+  return process.env.NODE_ENV === 'production'
+}
+
+export function getAppNumber () {
+  return process.env.NODE_APP_INSTANCE || ''
+}

packages/node-utils/src/file.ts

@@ -0,0 +1,11 @@
+import { stat } from 'fs/promises'
+
+async function getFileSize (path: string) {
+  const stats = await stat(path)
+
+  return stats.size
+}
+
+export {
+  getFileSize
+}

packages/node-utils/src/index.ts

@@ -0,0 +1,6 @@
+export * from './crypto.js'
+export * from './env.js'
+export * from './file.js'
+export * from './p2p.js'
+export * from './path.js'
+export * from './uuid.js'

packages/node-utils/src/p2p.ts

@@ -0,0 +1,7 @@
+import { md5 } from './crypto.js'
+
+export function generateP2PMediaLoaderHash (input: string) {
+  // Create a string of 15 bytes, converted to base64 and then to ascii to have 20 characters
+  // See https://github.com/Novage/p2p-media-loader/issues/427
+  return Buffer.from(md5(input).subarray(1).toString('base64'), 'utf-8').toString('hex')
+}

packages/node-utils/src/path.ts

@@ -0,0 +1,62 @@
+import { basename, extname, isAbsolute, join, parse, resolve } from 'path'
+import { fileURLToPath } from 'url'
+
+let rootPath: string
+
+export function currentDir (metaUrl: string) {
+  return resolve(fileURLToPath(metaUrl), '..')
+}
+
+export function root (metaUrl?: string) {
+  if (rootPath) return rootPath
+
+  if (!metaUrl) {
+    metaUrl = import.meta.url
+
+    const filename = basename(metaUrl) === 'path.js' || basename(metaUrl) === 'path.ts'
+    if (!filename) throw new Error('meta url must be specified as this file has been bundled in another one')
+  }
+
+  rootPath = currentDir(metaUrl)
+
+  if (basename(rootPath) === 'src' || basename(rootPath) === 'dist') rootPath = resolve(rootPath, '..')
+  if ([ 'node-utils', 'peertube-cli', 'peertube-runner' ].includes(basename(rootPath))) rootPath = resolve(rootPath, '..')
+  if ([ 'packages', 'apps' ].includes(basename(rootPath))) rootPath = resolve(rootPath, '..')
+  if (basename(rootPath) === 'dist') rootPath = resolve(rootPath, '..')
+
+  return rootPath
+}
+
+export function buildPath (path: string) {
+  if (isAbsolute(path)) return path
+
+  return join(root(), path)
+}
+
+export function getLowercaseExtension (filename: string) {
+  const ext = extname(filename) || ''
+
+  return ext.toLowerCase()
+}
+
+export function buildAbsoluteFixturePath (path: string, customCIPath = false) {
+  if (isAbsolute(path)) return path
+
+  if (customCIPath && process.env.GITHUB_WORKSPACE) {
+    return join(process.env.GITHUB_WORKSPACE, 'fixtures', path)
+  }
+
+  return join(root(), 'packages', 'tests', 'fixtures', path)
+}
+
+export function getFilenameFromUrl (url: string) {
+  return getFilename(new URL(url).pathname)
+}
+
+export function getFilename (path: string) {
+  return parse(path).base
+}
+
+export function getFilenameWithoutExt (path: string) {
+  return parse(path).name
+}

packages/node-utils/src/uuid.ts

@@ -0,0 +1,36 @@
+import short, { SUUID } from 'short-uuid'
+import { v5 } from 'uuid'
+
+const translator = short()
+
+export function buildUUID () {
+  return short.uuid()
+}
+
+export function buildSUUID (): SUUID {
+  return short.generate()
+}
+
+export function uuidToShort (uuid: string) {
+  if (!uuid) return uuid
+
+  return translator.fromUUID(uuid)
+}
+
+export function shortToUUID (shortUUID: string) {
+  if (!shortUUID) return shortUUID
+
+  return translator.toUUID(shortUUID)
+}
+
+export function isShortUUID (value: string) {
+  if (!value) return false
+
+  return value.length === translator.maxLength
+}
+
+export function buildUUIDv5FromURL (url: string) {
+  return v5(url, v5.URL)
+}
+
+export type { SUUID }

packages/node-utils/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "src",
+    "tsBuildInfoFile": "./dist/.tsbuildinfo"
+  }
+}