refactor: move formatLocks out of adapter and into Method

sciactive · Aug 4, 2022 · 869f31d · 869f31d
1 parent 92ae750
commit 869f31d
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 56 deletions.
diff --git a/src/FileSystemAdapter/Adapter.ts b/src/FileSystemAdapter/Adapter.ts
@@ -361,53 +361,6 @@ export default class Adapter implements AdapterInterface {
     });
   }
 
-  async formatLocks(locks: Lock[], baseUrl: URL) {
-    const xml = { activelock: [] as any[] };
-
-    if (locks != null) {
-      for (let lock of locks) {
-        const secondsLeft =
-          lock.timeout === Infinity
-            ? Infinity
-            : (lock.date.getTime() + lock.timeout - new Date().getTime()) /
-              1000;
-
-        if (secondsLeft <= 0) {
-          continue;
-        }
-
-        xml.activelock.push({
-          locktype: {
-            write: {},
-          },
-          lockscope: {
-            [lock.scope]: {},
-          },
-          depth: {
-            _: `${lock.depth}`,
-          },
-          owner: lock.owner,
-          timeout:
-            secondsLeft === Infinity
-              ? { _: 'Infinite' }
-              : { _: `Second-${secondsLeft}` },
-          locktoken: { href: { _: lock.token } },
-          lockroot: {
-            href: {
-              _: (await lock.resource.getCanonicalUrl(baseUrl)).pathname,
-            },
-          },
-        });
-      }
-    }
-
-    if (!xml.activelock.length) {
-      return {};
-    }
-
-    return xml;
-  }
-
   getMethod(method: string): typeof Method {
     // No additional methods to handle.
     if (method === 'POST' || method === 'PATCH') {

diff --git a/src/FileSystemAdapter/Lock.ts b/src/FileSystemAdapter/Lock.ts
@@ -5,14 +5,14 @@ import User from './User.js';
 
 export default class Lock implements LockInterface {
   resource: Resource;
-  user: User;
   token: string = '';
   date: Date = new Date();
   timeout: number = 1000 * 60 * 60 * 24 * 2; // Default to two day timeout.
   scope: 'exclusive' | 'shared' = 'exclusive';
   depth: '0' | 'infinity' = '0';
   provisional: boolean = false;
   owner: any = {};
+  user: User;
 
   constructor({ resource, user }: { resource: Resource; user: User }) {
     this.resource = resource;

diff --git a/src/Interfaces/Adapter.d.ts b/src/Interfaces/Adapter.d.ts
@@ -151,11 +151,6 @@ export interface Adapter {
    */
   newCollection(url: URL, baseUrl: string): Promise<Resource>;
 
-  /**
-   * Format a list of locks into an object acceptable by xml2js.
-   */
-  formatLocks(locks: Lock[], baseUrl: URL): Promise<any>;
-
   /**
    * Get a handler class for an additional method.
    *

diff --git a/src/Interfaces/Lock.d.ts b/src/Interfaces/Lock.d.ts
@@ -1,6 +1,11 @@
+import { Resource } from '../index.js';
 import type { User } from './User.js';
 
 export interface Lock {
+  /**
+   * The lock-root resource of this lock.
+   */
+  resource: Resource;
   /**
    * A unique token representing this lock.
    */

diff --git a/src/Methods/LOCK.ts b/src/Methods/LOCK.ts
@@ -123,7 +123,7 @@ export class LOCK extends Method {
       const currentLocks = await this.getLocks(request, resource);
       const responseObj = {
         prop: {
-          lockdiscovery: await this.adapter.formatLocks(
+          lockdiscovery: await this.formatLocks(
             currentLocks.all,
             this.getRequestBaseUrl(request)
           ),
@@ -456,7 +456,7 @@ export class LOCK extends Method {
     const currentLocks = await this.getLocks(request, resource);
     const responseObj = {
       prop: {
-        lockdiscovery: await this.adapter.formatLocks(
+        lockdiscovery: await this.formatLocks(
           currentLocks.all,
           this.getRequestBaseUrl(request)
         ),

diff --git a/src/Methods/Method.ts b/src/Methods/Method.ts
@@ -962,4 +962,54 @@ export class Method {
     }
     return this.xmlBuilder.buildObject(obj);
   }
+
+  /**
+   * Format a list of locks into an object acceptable by xml2js.
+   */
+  async formatLocks(locks: Lock[], baseUrl: URL) {
+    const xml = { activelock: [] as any[] };
+
+    if (locks != null) {
+      for (let lock of locks) {
+        const secondsLeft =
+          lock.timeout === Infinity
+            ? Infinity
+            : (lock.date.getTime() + lock.timeout - new Date().getTime()) /
+              1000;
+
+        if (secondsLeft <= 0) {
+          continue;
+        }
+
+        xml.activelock.push({
+          locktype: {
+            write: {},
+          },
+          lockscope: {
+            [lock.scope]: {},
+          },
+          depth: {
+            _: `${lock.depth}`,
+          },
+          owner: lock.owner,
+          timeout:
+            secondsLeft === Infinity
+              ? { _: 'Infinite' }
+              : { _: `Second-${secondsLeft}` },
+          locktoken: { href: { _: lock.token } },
+          lockroot: {
+            href: {
+              _: (await lock.resource.getCanonicalUrl(baseUrl)).pathname,
+            },
+          },
+        });
+      }
+    }
+
+    if (!xml.activelock.length) {
+      return {};
+    }
+
+    return xml;
+  }
 }
diff --git a/src/Methods/PROPFIND.ts b/src/Methods/PROPFIND.ts
@@ -176,7 +176,7 @@ export class PROPFIND extends Method {
             (allprop || requestedProps.includes('lockdiscovery'))
           ) {
             const currentLocks = await this.getLocks(request, resource);
-            propObj.lockdiscovery = await this.adapter.formatLocks(
+            propObj.lockdiscovery = await this.formatLocks(
               currentLocks.all,
               this.getRequestBaseUrl(request)
             );