Merge pull request #75 from bioinformatics-ua/imp/service-hostname_6

Extend API with service hostname support (v6.x)

Author: Enet4

src/service.ts

@@ -29,6 +29,11 @@ export interface ServiceConfiguration {
   autostart?: boolean,
   /** the TCP port that the service should listen to */
   port?: number,
+  /** the hostname that the service should bind to
+   *
+   * _Note:_ Available since Dicoogle 3.5.0
+   */
+  hostname?: string,
 }
 
 /** Full status of the DICOM service. */
@@ -39,6 +44,11 @@ export interface ServiceStatus {
   autostart: boolean,
   /** the TCP port that the service listens to */
   port: number,
+  /** the hostname that the service is bound to
+   *
+   * _Note:_ Available since Dicoogle 3.5.0
+   */
+  hostname?: string,
 }
 
 /** A DICOM service change outcome object,
@@ -52,15 +62,15 @@ export interface ServiceChangeOutcome extends ServiceConfiguration {
 }
 
 export interface RemoteStorage {
-  /// {string} aetitle
+  /** called AE title of the remote DICOM node */
   aetitle: string,
-  /// {string} ip
+  /** IP address or hostname of the remote DICOM node */
   ip: string,
-  /// {number} port
+  /** TCP port to the remote DICOM node */
   port: number,
-  /// {?string} description
+  /** Free text description of the DICOM node */
   description?: string,
-  /// {?boolean} public
+  /** Whether the DICOM node is public */
   public?: boolean,
 }
 
@@ -95,9 +105,9 @@ class BaseService {
    * @param callback the callback function
    */
   configure(config: ServiceConfiguration, callback?: (error: Error | null, outcome: ServiceChangeOutcome | undefined) => void): Promise<ServiceChangeOutcome> {
-    const {running, autostart, port} = config;
+    const {running, autostart, port, hostname} = config;
     return andCall(this._socket.post(this._endpoint)
-      .query({running, autostart, port})
+      .query({running, autostart, hostname, port})
       .then((resp) => resp.body), callback);
   }
 

test/base-promise.test.ts

@@ -392,13 +392,15 @@ describe('Dicoogle Client, Promise API (under Node.js)', function() {
         it("should give no error", async function() {
           await dicoogle.queryRetrieve.configure({
             autostart: true,
+            hostname: '127.1',
             port: 7777
           });
         });
         it("and {autostart, port} changes", async function() {
           const data = await dicoogle.queryRetrieve.getStatus();
           assert.strictEqual(data.autostart, true);
           assert.strictEqual(data.port, 7777);
+          assert.strictEqual(data.hostname, '127.1');
         });
     });
 

test/mock/service-mock.ts

@@ -185,7 +185,8 @@ export default function createDicoogleMock(port = 8080): ReturnType<typeof dicoo
         const QR = {
             isRunning: true,
             autostart: false,
-            port: 1045
+            port: 1045,
+            hostname: undefined
         };
         let TaskClosed = false;
         let TaskStopped = false;
@@ -505,18 +506,27 @@ export default function createDicoogleMock(port = 8080): ReturnType<typeof dicoo
                 error: "Incomplete configurations"
             })
             .post('/management/dicom/query')
-            .query({
-                autostart: true,
-                port: 7777
-            })
+            .query((query) => !!(query.autostart || query.port || query.hostname))
             .reply(200, function() {
-                QR.autostart = true;
-                QR.port = 7777;
-                return {
+                // pass whatever is in the query parameters
+                const {query} = URL.parse(this.req.path, true);
+                const out: {[key: string]: string | boolean | number} = {
                     success: true,
-                    autostart: true,
-                    port: 7777
                 };
+
+                if (query.autostart) {
+                    QR.autostart = query.autostart == 'true';
+                    out.autostart = QR.autostart;
+                }
+                if (query.port) {
+                    QR.port = +query.port;
+                    out.port = QR.port;
+                }
+                if (query.hostname) {
+                    QR.hostname = query.hostname ? query.hostname : undefined;
+                    out.hostname = QR.hostname;
+                }
+                return out;
             })