Merge pull request 'feat/formatting' (#53) from feat/formatting into master

Reviewed-on: #53

.editorconfig

@@ -0,0 +1,7 @@
+root = true
+[*]
+indent_style = tab
+tab_width = 4
+[*.ts]
+indent_style = tab
+tab_width = 4

.gitea/workflows/compile.yaml

@@ -14,4 +14,4 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
       - name: Build Container
-        run: docker build .
+        run: docker build --target compile .

.gitea/workflows/docker-build.yaml

@@ -11,7 +11,6 @@ env:
 jobs:
   build-docker-image:
     runs-on: ubuntu-latest
-      #if: gitea.ref == 'refs/heads/master'
     container: catthehacker/ubuntu:act-latest
     permissions:
       contents: read
@@ -22,6 +21,8 @@ jobs:
       - name: Log in to the Container registry
         run: docker login -u ${{ env.USER }} -p ${{ secrets.TOKEN }} ${{ env.REGISTRY }}
       - name: Build Container
-        run: docker build -t "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest" -t "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ node -p "require('./package.json').version" }}".
+        run: docker build --target compile -t "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest" -t "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.VERSION }}" .
+        env:
+          version: $(cat package.json | awk 'match($0, /version/) {print $2}' | sed 's/[\",]//g') # extracts the version number from the package.json with bash magic
       - name: Push Container
         run: docker push --all-tags "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}"

.gitea/workflows/test.yaml

@@ -0,0 +1,18 @@
+name: Run unit tests
+on: [pull_request]
+env:
+  REGISTRY: gitea.brudi.xyz
+  IMAGE_NAME: ${{ gitea.repository }}
+  USER: ${{ gitea.actor }}
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container: catthehacker/ubuntu:act-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Run Tests
+        run: docker build --target test .
+

Dockerfile

@@ -1,11 +1,21 @@
-FROM node:alpine as Build
+FROM node:alpine as files 
-ENV NODE_ENV=production
+ENV TZ="Europe/Berlin"
 WORKDIR /app
-
 COPY [ "package-lock.json", "package.json", "index.ts", "tsconfig.json", "./" ]
 COPY server ./server
 
+FROM files as proddependencies
+ENV NODE_ENV=production
 RUN npm ci --omit=dev
 
+FROM proddependencies as compile 
 RUN npm run build
 CMD ["npm","run","start"]
+
+FROM files as dependencies
+RUN npm ci
+
+FROM dependencies as test
+COPY jest.config.js .
+COPY tests ./tests
+RUN npm run test

jest.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+  'roots': [
+    '<rootDir>/tests',
+    '<rootDir>/server'
+  ],
+  'transform': {
+    '^.+\\.tsx?$': 'ts-jest'
+  },
+  'testRegex': '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+  'moduleFileExtensions': [
+    'ts',
+    'tsx',
+    'js',
+    'jsx',
+    'json',
+    'node'
+  ],
+};

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "node-jellyfin-discord-bot",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "node-jellyfin-discord-bot",
-      "version": "1.1.0",
+      "version": "1.1.3",
       "license": "MIT",
       "dependencies": {
         "@discordjs/rest": "^1.7.0",
@@ -17,6 +17,7 @@
         "@types/uuid": "^9.0.1",
         "axios": "^1.3.5",
         "date-fns": "^2.29.3",
+        "date-fns-tz": "^2.0.0",
         "discord-api-types": "^0.37.38",
         "discord.js": "^14.9.0",
         "dotenv": "^16.0.3",
@@ -29,12 +30,13 @@
         "winston": "^3.8.2"
       },
       "devDependencies": {
-        "@types/jest": "^29.5.0",
+        "@types/jest": "^29.5.2",
         "@typescript-eslint/eslint-plugin": "^5.58.0",
         "@typescript-eslint/parser": "^5.58.0",
         "eslint": "^8.38.0",
         "jest": "^29.5.0",
         "jest-cli": "^29.5.0",
+        "mockdate": "^3.0.5",
         "nodemon": "^2.0.22",
         "rimraf": "^5.0.0",
         "ts-jest": "^29.1.0"
@@ -1567,9 +1569,9 @@
       }
     },
     "node_modules/@types/jest": {
-      "version": "29.5.0",
+      "version": "29.5.2",
-      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.0.tgz",
+      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.2.tgz",
-      "integrity": "sha512-3Emr5VOl/aoBwnWcH/EFQvlSAmjV+XtV9GGu5mwdYew5vhQh0IUZx/60x0TzHDu09Bi7HMx10t/namdJw5QIcg==",
+      "integrity": "sha512-mSoZVJF5YzGVCk+FsDxzDuH7s+SCkzrgKZzf0Z0T2WudhBUPoF6ktoTPC4R0ZoCPCV5xUvuU6ias5NvxcBcMMg==",
       "dev": true,
       "dependencies": {
         "expect": "^29.0.0",
@@ -2626,6 +2628,14 @@
         "url": "https://opencollective.com/date-fns"
       }
     },
+    "node_modules/date-fns-tz": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/date-fns-tz/-/date-fns-tz-2.0.0.tgz",
+      "integrity": "sha512-OAtcLdB9vxSXTWHdT8b398ARImVwQMyjfYGkKD2zaGpHseG2UPHbHjXELReErZFxWdSLph3c2zOaaTyHfOhERQ==",
+      "peerDependencies": {
+        "date-fns": ">=2.0.0"
+      }
+    },
     "node_modules/debug": {
       "version": "4.3.4",
       "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
@@ -4980,6 +4990,12 @@
         "node": ">=10"
       }
     },
+    "node_modules/mockdate": {
+      "version": "3.0.5",
+      "resolved": "https://registry.npmjs.org/mockdate/-/mockdate-3.0.5.tgz",
+      "integrity": "sha512-iniQP4rj1FhBdBYS/+eQv7j1tadJ9lJtdzgOpvsOHng/GbcDh2Fhdeq+ZRldrPYdXvCyfFUmFeEwEGXZB5I/AQ==",
+      "dev": true
+    },
     "node_modules/ms": {
       "version": "2.1.2",
       "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
@@ -8130,9 +8146,9 @@
       }
     },
     "@types/jest": {
-      "version": "29.5.0",
+      "version": "29.5.2",
-      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.0.tgz",
+      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.2.tgz",
-      "integrity": "sha512-3Emr5VOl/aoBwnWcH/EFQvlSAmjV+XtV9GGu5mwdYew5vhQh0IUZx/60x0TzHDu09Bi7HMx10t/namdJw5QIcg==",
+      "integrity": "sha512-mSoZVJF5YzGVCk+FsDxzDuH7s+SCkzrgKZzf0Z0T2WudhBUPoF6ktoTPC4R0ZoCPCV5xUvuU6ias5NvxcBcMMg==",
       "dev": true,
       "requires": {
         "expect": "^29.0.0",
@@ -8905,6 +8921,12 @@
       "resolved": "https://registry.npmjs.org/date-fns/-/date-fns-2.29.3.tgz",
       "integrity": "sha512-dDCnyH2WnnKusqvZZ6+jA1O51Ibt8ZMRNkDZdyAyK4YfbDwa/cEmuztzG5pk6hqlp9aSBPYcjOlktquahGwGeA=="
     },
+    "date-fns-tz": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/date-fns-tz/-/date-fns-tz-2.0.0.tgz",
+      "integrity": "sha512-OAtcLdB9vxSXTWHdT8b398ARImVwQMyjfYGkKD2zaGpHseG2UPHbHjXELReErZFxWdSLph3c2zOaaTyHfOhERQ==",
+      "requires": {}
+    },
     "debug": {
       "version": "4.3.4",
       "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
@@ -10705,6 +10727,12 @@
       "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
       "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw=="
     },
+    "mockdate": {
+      "version": "3.0.5",
+      "resolved": "https://registry.npmjs.org/mockdate/-/mockdate-3.0.5.tgz",
+      "integrity": "sha512-iniQP4rj1FhBdBYS/+eQv7j1tadJ9lJtdzgOpvsOHng/GbcDh2Fhdeq+ZRldrPYdXvCyfFUmFeEwEGXZB5I/AQ==",
+      "dev": true
+    },
     "ms": {
       "version": "2.1.2",
       "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-jellyfin-discord-bot",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "description": "A discord bot to sync jellyfin accounts with discord roles",
   "main": "index.js",
   "license": "MIT",
@@ -13,6 +13,7 @@
     "@types/uuid": "^9.0.1",
     "axios": "^1.3.5",
     "date-fns": "^2.29.3",
+    "date-fns-tz": "^2.0.0",
     "discord-api-types": "^0.37.38",
     "discord.js": "^14.9.0",
     "dotenv": "^16.0.3",
@@ -32,15 +33,18 @@
     "debuggable": "node build/index.js --inspect-brk",
     "monitor": "nodemon build/index.js",
     "lint": "eslint . --ext .ts",
-    "lint-fix": "eslint . --ext .ts --fix"
+    "lint-fix": "eslint . --ext .ts --fix",
+    "test": "jest",
+    "test-watch": "jest --watch"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.0",
+    "@types/jest": "^29.5.2",
     "@typescript-eslint/eslint-plugin": "^5.58.0",
     "@typescript-eslint/parser": "^5.58.0",
     "eslint": "^8.38.0",
     "jest": "^29.5.0",
     "jest-cli": "^29.5.0",
+    "mockdate": "^3.0.5",
     "nodemon": "^2.0.22",
     "rimraf": "^5.0.0",
     "ts-jest": "^29.1.0"

server/helper/dateHelper.ts

@@ -1,6 +1,8 @@
-import { format } from "date-fns";
+import { format, isToday, toDate } from "date-fns";
+import { utcToZonedTime } from "date-fns-tz"
 import { GuildScheduledEvent } from "discord.js";
 import { logger } from "../logger";
+import de from "date-fns/locale/de";
 
 export function createDateStringFromEvent(event: GuildScheduledEvent, requestId: string, guildId?: string): string {
 	if (!event.scheduledStartAt) {
@@ -8,9 +10,14 @@ export function createDateStringFromEvent(event: GuildScheduledEvent, requestId:
 		return `"habe keinen Startzeitpunkt ermitteln können"`
 	}
 
-    const date = format(event.scheduledStartAt, "dd.MM")
+	const timeZone = 'Europe/Berlin'
-    const time = format(event.scheduledStartAt, "HH:mm")
+	const zonedDateTime = utcToZonedTime(event.scheduledStartAt, timeZone)
+	const time = format(zonedDateTime, "HH:mm", { locale: de })
 
+	if (isToday(zonedDateTime)) {
+		return `heute um ${time}`
+	}
 
+	const date = format(zonedDateTime, "eeee dd.MM", { locale: de })
 	return `am ${date} um ${time}`
 }

server/jellyfin/handler.ts

@@ -2,7 +2,7 @@ import { GuildMember } from "discord.js";
 import { JellyfinConfig, Maybe, PermissionLevel } from "../interfaces";
 import { logger } from "../logger";
 import { CreateUserByNameOperationRequest, DeleteUserRequest, GetItemsRequest, ItemsApi, SystemApi, UpdateUserPasswordOperationRequest, UpdateUserPolicyOperationRequest, UserApi } from "./apis";
-import { BaseItemDto, UpdateUserPasswordRequest } from "./models";
+import { BaseItemDto, UpdateUserPasswordRequest, UpdateUserPolicyRequest } from "./models";
 import { UserDto } from "./models/UserDto";
 import { Configuration, ConfigurationParameters } from "./runtime";
 
@@ -52,24 +52,46 @@ export class JellyfinHandler {
 		return (Math.random() * 10000 + 10000).toFixed(0)
 	}
 
-  public async createUserAccountForDiscordUser(discordUser: GuildMember, level: PermissionLevel, guildId?: string, requestId?: string): Promise<UserDto> {
+	public async createUserAccountForDiscordUser(discordUser: GuildMember, level: PermissionLevel, requestId: string, guildId?: string): Promise<UserDto> {
 		const newUserName = this.generateJFUserName(discordUser, level)
 		logger.info(`New Username for ${discordUser.displayName}: ${newUserName}`, { guildId, requestId })
 		const req: CreateUserByNameOperationRequest = {
 			createUserByNameRequest: {
 				name: newUserName,
-        password: this.generatePasswordForUser(),
+				password: this.generatePasswordForUser()
 			}
 		}
 		logger.debug(JSON.stringify(req), { requestId, guildId })
 		const createResult = await this.userApi.createUserByName(req)
 		if (createResult) {
+			if (createResult.policy) {
+				this.setUserPermissions(createResult, requestId, guildId)
+			}
 			(await discordUser.createDM()).send(`Ich hab dir mal nen Account angelegt :)\nDein Username ist ${createResult.name}, dein Password ist "${req.createUserByNameRequest.password}"!`)
 			return createResult
 		}
 		else throw new Error('Could not create User in Jellyfin')
 	}
 
+	public async setUserPermissions(user: UserDto, requestId: string, guildId?: string) {
+		if (!user.policy || !user.id) {
+			logger.error(`Cannot update user policy. User ${user.name} has no policy to modify`, { guildId, requestId })
+			return
+		}
+		user.policy.enableVideoPlaybackTranscoding = false
+
+		const operation: UpdateUserPolicyRequest = {
+			...user.policy,
+			enableVideoPlaybackTranscoding: false
+		}
+
+		const request: UpdateUserPolicyOperationRequest = {
+			userId: user.id,
+			updateUserPolicyRequest: operation
+		}
+		this.userApi.updateUserPolicy(request)
+	}
+
 	public async isUserAlreadyPresent(discordUser: GuildMember, requestId?: string): Promise<boolean> {
 		const jfuser = await this.getUser(discordUser, requestId)
 		logger.debug(`Presence for DiscordUser ${discordUser.id}:${jfuser !== undefined}`, { guildId: discordUser.guild.id, requestId })

tests/helpers/date.test.ts

@@ -0,0 +1,16 @@
+import { GuildScheduledEvent } from "discord.js"
+import { createDateStringFromEvent } from "../../server/helper/dateHelper"
+import MockDate from 'mockdate'
+
+beforeAll(() => {
+  MockDate.set('01-01-2023')
+})
+
+function getTestDate(date: string): GuildScheduledEvent {
+  return <GuildScheduledEvent>{ scheduledStartAt: new Date(date) }
+}
+test('createDateStringFromEvent - correct formatting', () => {
+  expect(createDateStringFromEvent(getTestDate('01-01-2023 12:30'), "")).toEqual('heute um 12:30')
+  expect(createDateStringFromEvent(getTestDate('01-02-2023 12:30'), "")).toEqual('am Montag 02.01 um 12:30')
+  expect(createDateStringFromEvent(getTestDate('01-03-2023 12:30'), "")).toEqual('am Dienstag 03.01 um 12:30')
+})

tests/helpers/memberRoles.test.ts

@@ -0,0 +1,28 @@
+import { Collection, GuildMember, Role } from "discord.js"
+import { filterRolesFromMemberUpdate } from "../../server/helper/roleFilter"
+
+function buildFakeRole(id: string, name: string): Role {
+  return <Role>{ id, name }
+
+}
+test('filterRolesFromMemberUpdate', () => {
+  const oldMemberRoles: Collection<string, Role> = new Collection<string, Role>()
+  oldMemberRoles.set('1', buildFakeRole('01', 'Role01'))
+  oldMemberRoles.set('2', buildFakeRole('02', 'Role02'))
+
+  const newMemberRoles: Collection<string, Role> = new Collection<string, Role>()
+  newMemberRoles.set('1', buildFakeRole('01', 'Role01'))
+  newMemberRoles.set('2', buildFakeRole('02', 'Role02'))
+  newMemberRoles.set('3', buildFakeRole('03', 'Role03'))
+
+  const oldMember: GuildMember = <GuildMember>{ roles: { cache: oldMemberRoles }, guild: { id: "guildid" } }
+  const newMember: GuildMember = <GuildMember>{ roles: { cache: newMemberRoles }, guild: { id: "guildid" } }
+  const output = filterRolesFromMemberUpdate(oldMember, newMember)
+
+  const expectedAddedRoles: Collection<string, Role> = new Collection<string, Role>()
+  expectedAddedRoles.set('3', buildFakeRole('03', 'Role03'))
+  const expectedRemovedRoles: Collection<string, Role> = new Collection<string, Role>()
+
+  expect(output.addedRoles).toEqual(expectedAddedRoles)
+  expect(output.removedRoles).toEqual(expectedRemovedRoles)
+})