Merge pull request #5510 from nichwall/typescript-migration-begin

Typescript initial migration framework

.github/workflows/docker-build.yml

@@ -19,6 +19,8 @@ on:
       - server/**
       - index.js
       - package.json
+      - tsconfig.server.json
+      - Dockerfile
 
 jobs:
   build:

.github/workflows/integration-test.yml

@@ -12,6 +12,7 @@ on:
       - test/**
       - index.js
       - package.json
+      - tsconfig.server.json
 
 jobs:
   build:
@@ -37,11 +38,11 @@ jobs:
         working-directory: client
         run: npm run generate
 
-      - name: get server dependencies
-        run: npm ci --only=production
+      - name: get server dependencies and compile server
+        run: npm ci && npm run build:server && npm prune --omit=dev
 
       - name: build binary
-        run: pkg -t node20-linux-x64 -o audiobookshelf .
+        run: pkg --config package.json -t node20-linux-x64 -o audiobookshelf dist-server/index.js
 
       - name: run audiobookshelf
         run: |

.gitignore

@@ -11,6 +11,7 @@
 /client/.nuxt/
 /client/dist/
 /dist/
+/dist-server/
 /deploy/
 /coverage/
 /.nyc_output/

Dockerfile

@@ -25,7 +25,7 @@ RUN apk add --no-cache --update \
   unzip
 
 WORKDIR /server
-COPY index.js package* /server
+COPY index.js package* tsconfig.server.json /server
 COPY /server /server/server
 
 RUN case "$TARGETPLATFORM" in \
@@ -38,7 +38,7 @@ RUN case "$TARGETPLATFORM" in \
   unzip /tmp/library.zip -d $NUSQLITE3_DIR && \
   rm /tmp/library.zip
 
-RUN npm ci --only=production
+RUN npm ci --include=dev && npm run build:server && npm prune --omit=dev
 
 ### STAGE 2: Create minimal runtime image ###
 FROM node:20-alpine
@@ -70,4 +70,4 @@ ENV NUSQLITE3_DIR=${NUSQLITE3_DIR}
 ENV NUSQLITE3_PATH=${NUSQLITE3_PATH}
 
 ENTRYPOINT ["tini", "--"]
-CMD ["node", "index.js"]
+CMD ["node", "dist-server/index.js"]

build/linuxpackager

@@ -16,7 +16,7 @@ echo "--------------------"
 
 cd client
 rm -rf node_modules
-npm ci --unsafe-perm=true --allow-root
+npm ci
 npm run generate
 cd ..
 
@@ -24,7 +24,8 @@ echo ">>> Building Server"
 echo "--------------------"
 
 rm -rf node_modules
-npm ci --unsafe-perm=true --allow-root
+npm ci
+npm run build:server
 
 echo ">>> Packaging"
 echo "--------------------"
@@ -48,7 +49,7 @@ Description: $DESCRIPTION"
 echo "$controlfile" > dist/debian/DEBIAN/control;
 
 # Package debian
-pkg -t node20-linux-x64 -o dist/debian/usr/share/audiobookshelf/audiobookshelf .
+pkg --config package.json -t node20-linux-x64 -o dist/debian/usr/share/audiobookshelf/audiobookshelf dist-server/index.js
 
 fakeroot dpkg-deb -Zxz --build dist/debian
 

index.js

@@ -16,7 +16,7 @@ const Path = require('path')
 process.env.NODE_ENV = options.dev ? 'development' : process.env.NODE_ENV || 'production'
 
 const server = require('./server/Server')
-global.appRoot = __dirname
+global.appRoot = Path.basename(__dirname) === 'dist-server' ? Path.resolve(__dirname, '..') : __dirname
 
 const isDev = process.env.NODE_ENV !== 'production'
 if (isDev || options['prod-with-dev-env']) {
@@ -32,9 +32,7 @@ if (isDev || options['prod-with-dev-env']) {
   if (devEnv.BackupPath) process.env.BACKUP_PATH = devEnv.BackupPath
   if (devEnv.ReactClientPath) process.env.REACT_CLIENT_PATH = devEnv.ReactClientPath
   if (devEnv.AllowedDevOrigins) {
-    process.env.ALLOWED_DEV_ORIGINS = Array.isArray(devEnv.AllowedDevOrigins)
-      ? devEnv.AllowedDevOrigins.join(',')
-      : String(devEnv.AllowedDevOrigins)
+    process.env.ALLOWED_DEV_ORIGINS = Array.isArray(devEnv.AllowedDevOrigins) ? devEnv.AllowedDevOrigins.join(',') : String(devEnv.AllowedDevOrigins)
   }
   process.env.SOURCE = 'local'
   process.env.ROUTER_BASE_PATH = devEnv.RouterBasePath ?? '/audiobookshelf'

package-lock.json

@@ -31,14 +31,16 @@
         "xml2js": "^0.5.0"
       },
       "bin": {
-        "audiobookshelf": "index.js"
+        "audiobookshelf": "dist-server/index.js"
       },
       "devDependencies": {
+        "@types/node": "^20.17.0",
         "chai": "^4.3.10",
         "mocha": "^10.2.0",
         "nodemon": "^2.0.20",
         "nyc": "^15.1.0",
-        "sinon": "^17.0.1"
+        "sinon": "^17.0.1",
+        "typescript": "^5.7.3"
       }
     },
     "node_modules/@ampproject/remapping": {
@@ -697,9 +699,13 @@
       "integrity": "sha512-iiUgKzV9AuaEkZqkOLDIvlQiL6ltuZd9tGcW3gwpnX8JbuiuhFlEGmmFXEXkN50Cvq7Os88IY2v0dkDqXYWVgA=="
     },
     "node_modules/@types/node": {
-      "version": "18.11.18",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.18.tgz",
-      "integrity": "sha512-DHQpWGjyQKSHj3ebjFI/wRKcqQcdR+MoFBygntYOZytCqNfkd2ZC4ARDJ2DQqhjH5p85Nnd3jhUJIXrszFX/JA=="
+      "version": "20.19.43",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.43.tgz",
+      "integrity": "sha512-6oYBAi5ikg4Pl+kGsoYtawUMBT2zZMCvPNF7pVLnHZfd1zf38DRiWn/gT01RYCdUqkv7Fhr+C9ot4/tb+2sVvA==",
+      "license": "MIT",
+      "dependencies": {
+        "undici-types": "~6.21.0"
+      }
     },
     "node_modules/@types/validator": {
       "version": "13.7.17",
@@ -5263,6 +5269,20 @@
         "is-typedarray": "^1.0.0"
       }
     },
+    "node_modules/typescript": {
+      "version": "5.9.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz",
+      "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    },
     "node_modules/uid-safe": {
       "version": "2.1.5",
       "resolved": "https://registry.npmjs.org/uid-safe/-/uid-safe-2.1.5.tgz",
@@ -5280,6 +5300,12 @@
       "integrity": "sha512-WxONCrssBM8TSPRqN5EmsjVrsv4A8X12J4ArBiiayv3DyyG3ZlIg6yysuuSYdZsVz3TKcTg2fd//Ujd4CHV1iA==",
       "dev": true
     },
+    "node_modules/undici-types": {
+      "version": "6.21.0",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz",
+      "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==",
+      "license": "MIT"
+    },
     "node_modules/unique-filename": {
       "version": "1.1.1",
       "resolved": "https://registry.npmjs.org/unique-filename/-/unique-filename-1.1.1.tgz",

package.json

@@ -3,33 +3,34 @@
   "version": "2.36.1",
   "buildNumber": 1,
   "description": "Self-hosted audiobook and podcast server",
-  "main": "index.js",
+  "main": "dist-server/index.js",
   "scripts": {
-    "dev": "nodemon --watch server index.js -- --dev",
-    "start": "node index.js",
-    "start-dev": "node index.js --prod-with-dev-env",
+    "build:server": "tsc -p tsconfig.server.json",
+    "dev": "nodemon --watch server --watch index.js --watch test --watch dev.js --ext js,ts --exec \"npm run build:server && node dist-server/index.js\" -- --dev",
+    "start": "node dist-server/index.js",
+    "start-dev": "node dist-server/index.js --prod-with-dev-env",
     "client": "cd client && npm ci && npm run generate",
-    "prod": "npm run client && npm ci && node index.js",
-    "build-win": "npm run client && pkg -t node20-win-x64 -o ./dist/win/audiobookshelf -C GZip .",
-    "build-win-no-compress": "npm run client && pkg -t node20-win-x64 -o ./dist/win/audiobookshelf .",
+    "prod": "npm run client && npm ci && npm run build:server && npm run start",
+    "build-win": "npm run client && npm run build:server && pkg --config package.json -t node20-win-x64 -o ./dist/win/audiobookshelf -C GZip dist-server/index.js",
+    "build-win-no-compress": "npm run client && npm run build:server && pkg --config package.json -t node20-win-x64 -o ./dist/win/audiobookshelf dist-server/index.js",
     "build-linux": "build/linuxpackager",
     "docker": "docker buildx build --platform linux/amd64,linux/arm64 --push .  -t advplyr/audiobookshelf",
     "docker-amd64-local": "docker buildx build --platform linux/amd64 --load .  -t advplyr/audiobookshelf-amd64-local",
     "docker-arm64-local": "docker buildx build --platform linux/arm64 --load .  -t advplyr/audiobookshelf-arm64-local",
     "deploy-linux": "node deploy/linux",
-    "test": "mocha",
-    "coverage": "nyc mocha"
+    "test": "npm run build:server && mocha dist-server/test",
+    "coverage": "npm run build:server && nyc mocha dist-server/test"
   },
-  "bin": "index.js",
+  "bin": "dist-server/index.js",
   "pkg": {
     "assets": [
       "client/dist/**/*",
       "node_modules/sqlite3/lib/binding/**/*.node",
-      "server/migrations/*.js"
+      "dist-server/server/migrations/*.js"
     ],
     "scripts": [
-      "index.js",
-      "server/**/*.js"
+      "dist-server/index.js",
+      "dist-server/server/**/*.js"
     ]
   },
   "mocha": {
@@ -60,11 +61,13 @@
     "xml2js": "^0.5.0"
   },
   "devDependencies": {
+    "@types/node": "^20.17.0",
     "chai": "^4.3.10",
     "mocha": "^10.2.0",
     "nodemon": "^2.0.20",
     "nyc": "^15.1.0",
-    "sinon": "^17.0.1"
+    "sinon": "^17.0.1",
+    "typescript": "^5.7.3"
   },
   "allowScripts": {
     "sqlite3@5.1.7": true

readme.md

@@ -183,7 +183,7 @@ cd ..
 
 After setting up your development environment, either using the dev container or using your own custom environment, the following commands will help you run the server and client.
 
-To run the server, you can use the command `npm run dev`. This will use the client that was built when you ran `npm run generate` in the client directory or when you started the dev container. If you make changes to the server, you will need to restart the server. If you make changes to the client, you will need to run the command `(cd client; npm run generate)` and then restart the server. By default the client runs at `localhost:3333`, though the port can be configured in `dev.js`.
+To run the server, you can use the command `npm run dev`. This will compile the server and use the client that was built when you ran `npm run generate` in the client directory or when you started the dev container. Server changes are compiled and restarted automatically. If you make changes to the client, you will need to run the command `(cd client; npm run generate)` and then restart the server. By default the client runs at `localhost:3333`, though the port can be configured in `dev.js`.
 
 You can also build a version of the client that supports live reloading. To do this, start the server, then run the command `(cd client; npm run dev)`. This will run a separate instance of the client at `localhost:3000` that will be automatically updated as you make changes to the client.
 

server/libs/archiver/archiverUtils/readableStream/internal/streams/lazy_transform.js

@@ -7,7 +7,7 @@ const { ObjectDefineProperties, ObjectDefineProperty, ObjectSetPrototypeOf } = r
 
 const stream = require('../../stream')
 
-const { getDefaultEncoding } = require('../crypto/util')
+const getDefaultEncoding = () => 'buffer'
 
 module.exports = LazyTransform
 

server/libs/watcher/types.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WatcherStats = exports.Stats = void 0;
-const ripstat_1 = require("ripstat");
+const ripstat_1 = require("./ripstat");
 Object.defineProperty(exports, "Stats", { enumerable: true, get: function () { return ripstat_1.Stats; } });
 const watcher_stats_1 = __importDefault(require("./watcher_stats"));
 exports.WatcherStats = watcher_stats_1.default;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUNBLFlBQVk7Ozs7OztBQUdaLHFDQUE4QjtBQWlGbUUsc0ZBakZ6RixlQUFLLE9BaUZ5RjtBQTlFdEcsb0VBQTJDO0FBOEUwSyx1QkE5RTlNLHVCQUFZLENBOEU4TSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUNBLFlBQVk7Ozs7OztBQUdaLHFDQUE4QjtBQWlGbUUsc0ZBakZ6RixlQUFLLE9BaUZ5RjtBQTlFdEcsb0VBQTJDO0FBOEUwSyx1QkE5RTlNLHVCQUFZLENBOEU4TSJ9

test/server/managers/MigrationManager.test.js

@@ -17,6 +17,7 @@ describe('MigrationManager', () => {
   let fsMoveStub
   let fsRemoveStub
   let fsEnsureDirStub
+  let fsPathExistsStub
   let processExitStub
   let configPath = '/path/to/config'
 

tsconfig.server.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "rootDir": ".",
+    "outDir": "dist-server",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "noEmitOnError": true,
+    "incremental": true,
+    "tsBuildInfoFile": "dist-server/.tsbuildinfo",
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["index.js", "dev.js", "server/**/*.js", "server/**/*.ts", "test/**/*.js", "test/**/*.ts"],
+  "exclude": ["node_modules", "dist-server", "client", "**/*.d.ts"]
+}