[STUD-490] add cluster api support

.circleci/cluster.properties

@@ -0,0 +1,2 @@
+pack.enabled=true
+pack.zookeeper.address=zoo1:2181

.circleci/docker-compose.yml

@@ -0,0 +1,44 @@
+version: '2'
+services:
+  stardog1:
+    command: ["--port", "5821", "--home", "/var/opt/stardog"]
+    depends_on:
+    - zoo1
+    environment:
+      STARDOG_SERVER_JAVA_ARGS: -Xms2g -Xmx2g -XX:MaxDirectMemorySize=1g
+      THIS_HOST: stardog1
+      THIS_PORT: 5821
+      ZK_HOST_PORT: zoo1:2181
+    image: stardog/stardog:latest
+    ports:
+    - 5821:5821
+    restart: always
+    privileged: true
+    volumes:
+    - ../stardog-license-key.bin:/var/opt/stardog/stardog-license-key.bin
+    - ./cluster.properties:/var/opt/stardog/stardog.properties
+  stardog2:
+    command: ["--port", "5822", "--home", "/var/opt/stardog"]
+    depends_on:
+    - zoo1
+    environment:
+      STARDOG_SERVER_JAVA_ARGS: -Xms2g -Xmx2g -XX:MaxDirectMemorySize=1g
+      THIS_HOST: stardog2
+      THIS_PORT: 5822
+      ZK_HOST_PORT: zoo1:2181
+    image: stardog/stardog:latest
+    ports:
+    - 5822:5822
+    restart: always
+    privileged: true
+    volumes:
+    - ../stardog-license-key.bin:/var/opt/stardog/stardog-license-key.bin
+    - ./cluster.properties:/var/opt/stardog/stardog.properties
+  zoo1:
+    environment:
+      ZOO_MY_ID: 1
+      ZOO_SERVERS: server.1=zoo1:2888:3888
+    image: zookeeper:3.4.14
+    ports:
+    - 2181
+    restart: always

.gitignore

@@ -5,4 +5,4 @@ node_modules/
 dist/**
 .vscode/
 .rpt2_cache/
-
+stardog-license-key.bin

README.md

@@ -53,6 +53,18 @@ In order to contribute changes, all test cases must pass. With the Stardog serve
 npm test
 ```
 
+To test the cluster commands you will need to first start a Stardog cluster then run the cluster suite. The easiest way to do this is to run docker-compose to start a cluster:
+
+```bash
+docker-compose -f .circleci/docker-compose.yml up
+```
+
+Then run the cluster test suite in `test/cluster`:
+
+```bash
+npm run test:cluster
+```
+
 ### Contributing
 
 Fork, clone and develop, write or amend tests, and then open a PR. All PRs go against "master". This project uses [prettier](https://github.com/prettier/prettier) on file commit, so don't worry about style as it'll just get rewritten when you commit your changes.
@@ -2095,3 +2107,24 @@ Expects the following parameters:
 
 Returns [`Promise<HTTP.Body>`](#body)
 
+## <a name="cluster">cluster</a>
+
+#### <a name="shutdown">`cluster.info(conn)`</a>
+
+Retrieves basic information about a Stardog cluster. 
+
+Expects the following parameters:
+
+- conn ([`Connection`](#connection))
+
+Returns [`Promise<HTTP.Body>`](#body)
+
+#### <a name="status">`cluster.status(conn)`</a>
+
+Retrieves detailed status information about a Stardog cluster.
+
+Expects the following parameters:
+
+- conn ([`Connection`](#connection))
+
+Returns [`Promise<HTTP.Body>`](#body)

lib/cluster.js

@@ -0,0 +1,23 @@
+const { fetch } = require('./fetch');
+const { httpBody } = require('./response-transforms');
+
+const info = conn => {
+  const headers = conn.headers();
+  headers.set('Accept', 'application/json');
+  return fetch(conn.request('admin', 'cluster'), {
+    headers,
+  }).then(httpBody);
+};
+
+const status = conn => {
+  const headers = conn.headers();
+  headers.set('Accept', 'application/json');
+  return fetch(conn.request('admin', 'cluster', 'status'), {
+    headers,
+  }).then(httpBody);
+};
+
+module.exports = {
+  info,
+  status,
+};

lib/index.d.ts

@@ -1340,6 +1340,23 @@ declare namespace Stardog {
          */
         function getAll(conn: Connection, params?: object): Promise<HTTP.Body>
     }
+
+    /** Stardog HTTP cluster actions. */
+    export namespace cluster {
+        /** 
+         * Retrieves basic information about a Stardog cluster.
+         * 
+         * @param {Connection} conn the Stardog server connection
+         */
+        function info(conn: Connection): Promise<HTTP.Body>;
+
+        /** 
+         * Retrieves detailed status information about a Stardog cluster. 
+         * 
+         * @param {Connection} conn the Stardog server connection
+         */
+        function status(conn: Connection): Promise<HTTP.Body>;
+    }
 }
 
 // No idea why I need this, but this is what removes the extra level of nesting

lib/index.js

@@ -6,6 +6,7 @@ const Stardog = {
   query: require('./query'),
   user: require('./user'),
   server: require('./server'),
+  cluster: require('./cluster'),
   virtualGraphs: require('./virtualGraphs'),
   storedFunctions: require('./storedFunctions'),
 };

package.json

@@ -115,6 +115,7 @@
     "build": "node scripts/build",
     "docs": "node scripts/docs",
     "test": "eslint '{lib,test}/**/*.js' --fix && jest test/*.spec.js --verbose -i",
+    "test:cluster": "jest test/cluster/*.spec.js --verbose -i",
     "precommit": "lint-staged",
     "format": "prettier '{lib,test}/**/*.js' --single-quote --trailing-comma es5 --write",
     "version": "mdchangelog --remote stardog-union/stardog.js --no-prologue --order-milestones semver --order-issues closed_at --overwrite --no-orphan-issues && npm run docs && git add README.md CHANGELOG.md",

test/cluster/clusterInfo.spec.js

@@ -0,0 +1,38 @@
+/* eslint-env jest */
+
+const { cluster } = require('../../lib');
+const { ConnectionFactory } = require('../setup-database');
+
+describe('cluster.info()', () => {
+  const coordinatorPort = 5821;
+  const participantPort = 5822;
+  const expectedNodeCount = 2;
+
+  it('should retrieve a JS object containing cluster information', () => {
+    const coordinatorConnection = ConnectionFactory(coordinatorPort);
+
+    return cluster.info(coordinatorConnection).then(res => {
+      const { nodes } = res.body;
+      const coordinator = nodes.find(node => node.includes(coordinatorPort));
+      const participant = nodes.find(node => node.includes(participantPort));
+
+      expect(nodes).toHaveLength(expectedNodeCount);
+      expect(coordinator).not.toBeUndefined();
+      expect(participant).not.toBeUndefined();
+    });
+  });
+
+  it('should respond correctly from both nodes', () => {
+    const participantConnection = ConnectionFactory(participantPort);
+
+    return cluster.info(participantConnection).then(res => {
+      const { nodes } = res.body;
+      const coordinator = nodes.find(node => node.includes(coordinatorPort));
+      const participant = nodes.find(node => node.includes(participantPort));
+
+      expect(nodes).toHaveLength(expectedNodeCount);
+      expect(coordinator).not.toBeUndefined();
+      expect(participant).not.toBeUndefined();
+    });
+  });
+});

test/cluster/clusterStatus.spec.js

@@ -0,0 +1,54 @@
+/* eslint-env jest */
+
+const { cluster } = require('../../lib');
+const { ConnectionFactory } = require('../setup-database');
+
+describe('cluster.status()', () => {
+  const coordinatorPort = 5821;
+  const participantPort = 5822;
+  const expectedNodeCount = 2;
+
+  it('should retrieve a JS object containing cluster status', () => {
+    const coordinatorConnection = ConnectionFactory(coordinatorPort);
+
+    return cluster.status(coordinatorConnection).then(res => {
+      const { nodes } = res.body;
+      const coordinator = nodes.find(node =>
+        node.address.includes(coordinatorPort)
+      );
+      const participant = nodes.find(node =>
+        node.address.includes(participantPort)
+      );
+
+      expect(nodes).toHaveLength(expectedNodeCount);
+      expect(coordinator).not.toBeUndefined();
+      expect(coordinator.metadata).not.toBeUndefined();
+      expect(coordinator.type).toEqual('FULL');
+      expect(participant).not.toBeUndefined();
+      expect(participant.metadata).not.toBeUndefined();
+      expect(participant.type).toEqual('FULL');
+    });
+  });
+
+  it('should respond correctly from both nodes', () => {
+    const participantConnection = ConnectionFactory(participantPort);
+
+    return cluster.status(participantConnection).then(res => {
+      const { nodes } = res.body;
+      const coordinator = nodes.find(node =>
+        node.address.includes(coordinatorPort)
+      );
+      const participant = nodes.find(node =>
+        node.address.includes(participantPort)
+      );
+
+      expect(nodes).toHaveLength(expectedNodeCount);
+      expect(coordinator).not.toBeUndefined();
+      expect(coordinator.metadata).not.toBeUndefined();
+      expect(coordinator.type).toEqual('FULL');
+      expect(participant).not.toBeUndefined();
+      expect(participant.metadata).not.toBeUndefined();
+      expect(participant.type).toEqual('FULL');
+    });
+  });
+});

test/setup-database.js

@@ -88,10 +88,9 @@ exports.generateRandomString = () =>
     charset: 'alphabetic',
   });
 
-exports.ConnectionFactory = () =>
+exports.ConnectionFactory = (port = 5820) =>
   new Connection({
     username: 'admin',
     password: 'admin',
-    endpoint: 'http://localhost:5820',
-    // endpoint: 'http://localhost:61941',
+    endpoint: `http://localhost:${port}`,
   });