[VET-5756] feat: add support for fetching endpoint log archive (#313)

* feat: add support for fetching endpoint log archive

* doc: add comment for server logs method

* fix: use jest eslint env

* refactor: reorder assertions

* doc: add server.logs documentation

Author: jakehamilton

README.md

@@ -268,6 +268,16 @@ Expects the following parameters:
 
 Returns [`Promise<HTTP.Body>`](#body)
 
+#### <a name="logs">`server.logs(conn)`</a>
+
+Retrieves a zip file containing log information for an endpoint.
+
+Expects the following parameters:
+
+- conn ([`Connection`](#connection))
+
+Returns [`Promise<Response>`](#response)
+
 ## <a name="db">db</a>
 
 #### <a name="create">`db.create(conn, database, databaseOptions, options, params)`</a>

lib/index.d.ts

@@ -130,6 +130,11 @@ declare namespace Stardog {
          * properties, but you can specify `names` to return specific ones.
          */
         function properties(conn: Connection, names?: string[]): Promise<HTTP.Body>;
+
+        /**
+         * Retrieves a zip file containing log information for an endpoint.
+         */
+        function logs(conn: Connection): Promise<Response>;
     }
 
     /** Stardog database actions. */

lib/server.js

@@ -42,8 +42,18 @@ const properties = (conn, names = []) => {
   ).then(httpBody);
 };
 
+const logs = conn => {
+  const headers = conn.headers();
+  const response = fetch(conn.request('admin', 'logs'), {
+    headers,
+  });
+
+  return response;
+};
+
 module.exports = {
   shutdown,
   status,
   properties,
+  logs,
 };

test/serverLogs.spec.js

@@ -0,0 +1,22 @@
+/* eslint-env jest */
+
+const { server } = require('../lib');
+const { ConnectionFactory } = require('./setup-database');
+
+describe('server.logs()', () => {
+  let conn;
+
+  beforeEach(() => {
+    conn = ConnectionFactory();
+  });
+
+  it('should retrieve a JS response object containing the logs zip file', () =>
+    server.logs(conn).then(response => {
+      expect(response.status).toBe(200);
+
+      return response.arrayBuffer().then(buffer => {
+        expect(buffer).toBeTruthy();
+        expect(buffer.byteLength).toBeGreaterThan(0);
+      });
+    }));
+});