✅♻️🩹 backend: add company_id to editing_session_key (#525)

2024-08-25 22:26:29 +02:00
parent 3b81a21e08
commit 9b0dcc1068
5 changed files with 123 additions and 25 deletions
@@ -0,0 +1,53 @@
+import "reflect-metadata";
+import { expect, jest, test, describe, beforeEach, afterEach } from "@jest/globals";
+import { randomUUID } from "crypto";
+import { EditingSessionKeyFormat } from "../../../../../src/services/documents/entities/drive-file";
+
+describe('DriveFile EditingSessionKeyFormat', () => {
+  const mockAppId = 'tdrive_random_application_id';
+  const mockCompanyId = randomUUID();
+  const mockUserId = randomUUID();
+  const mockTimestamp = new Date();
+  const mockTimestampWith0MS = mockTimestamp.getTime() - (mockTimestamp.getTime() % 1000);
+
+  const checkIsUUID = (value: string) => {
+    expect(value).toMatch(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
+    expect(value).not.toMatch(/^0{8}-0{4}-0{4}-0{4}-0{12}$/i);
+  };
+
+  const checkKeyIsOOCompatible = (key: string) => {
+    // OnlyOffice key limits: see https://api.onlyoffice.com/editors/config/document#key
+    expect(key).toMatch(/^[0-9a-zA-Z._=-]{1,128}$/);
+  };
+
+  test('generates a valid value that can be parsed', async () => {
+    checkIsUUID(mockUserId);
+    checkIsUUID(mockCompanyId);
+    const key = EditingSessionKeyFormat.generate(mockAppId, mockCompanyId, mockUserId, mockTimestamp);
+    checkKeyIsOOCompatible(key);
+    const parsed = EditingSessionKeyFormat.parse(key);
+    expect(parsed.applicationId).toBe(mockAppId);
+    expect(parsed.userId).toBe(mockUserId);
+    expect(parsed.companyId).toBe(mockCompanyId);
+    expect(parsed.timestamp.getTime()).toBe(mockTimestampWith0MS);
+  });
+
+  test('generates unique values', async () => {
+    const key = EditingSessionKeyFormat.generate(mockAppId, mockCompanyId, mockUserId, mockTimestamp);
+    const key2 = EditingSessionKeyFormat.generate(mockAppId, mockCompanyId, mockUserId, mockTimestamp);
+    expect(key).not.toBe(key2);
+  });
+
+  test('checks the appId', async () => {
+    expect(() => {
+      EditingSessionKeyFormat.generate('invalid app id !', mockCompanyId, mockUserId);
+    }).toThrow('Invalid applicationId string');
+  });
+
+  test('checks final length', async () => {
+    expect(() => {
+      const tooLongAppID = new Array(100).join('x');
+      EditingSessionKeyFormat.generate(tooLongAppID, mockCompanyId, mockUserId);
+    }).toThrow('Must be <128 chars,');
+  });
+});