Use default HTTP(S) port when none specified

lutovich · lutovich · commit 293c23af9308 · 2018-02-19T16:14:55.000+01:00
For driver created with either `http` or `https` url.
diff --git a/src/v1/index.js b/src/v1/index.js
@@ -179,7 +179,7 @@ const USER_AGENT = "neo4j-javascript/" + VERSION;
  */
 function driver(url, authToken, config = {}) {
   assertString(url, 'Bolt URL');
-  const parsedUrl = urlUtil.parseBoltUrl(url);
+  const parsedUrl = urlUtil.parseDatabaseUrl(url);
   if (parsedUrl.scheme === 'bolt+routing') {
     return new RoutingDriver(parsedUrl.hostAndPort, parsedUrl.query, USER_AGENT, authToken, config);
   } else if (parsedUrl.scheme === 'bolt') {
diff --git a/src/v1/internal/ch-config.js b/src/v1/internal/ch-config.js
@@ -22,8 +22,6 @@ import {SERVICE_UNAVAILABLE} from '../error';
 
 const DEFAULT_CONNECTION_TIMEOUT_MILLIS = 5000; // 5 seconds by default
 
-export const DEFAULT_PORT = 7687;
-
 export default class ChannelConfig {
 
   /**
diff --git a/src/v1/internal/connector.js b/src/v1/internal/connector.js
@@ -586,7 +586,7 @@ class ConnectionState {
  */
 function connect(url, config = {}, connectionErrorCode = null) {
   const Ch = config.channel || Channel;
-  const parsedUrl = urlUtil.parseBoltUrl(url);
+  const parsedUrl = urlUtil.parseDatabaseUrl(url);
   const channelConfig = new ChannelConfig(parsedUrl, config, connectionErrorCode);
   return new Connection(new Ch(channelConfig), parsedUrl.hostAndPort, config.disableLosslessIntegers);
 }
diff --git a/src/v1/internal/host-name-resolvers.js b/src/v1/internal/host-name-resolvers.js
@@ -41,7 +41,7 @@ export class DnsHostNameResolver extends HostNameResolver {
   }
 
   resolve(seedRouter) {
-    const parsedAddress = urlUtil.parseBoltUrl(seedRouter);
+    const parsedAddress = urlUtil.parseDatabaseUrl(seedRouter);
 
     return new Promise((resolve) => {
       this._dns.lookup(parsedAddress.host, {all: true}, (error, addresses) => {
diff --git a/src/v1/internal/http/http-data-converter.js b/src/v1/internal/http/http-data-converter.js
@@ -71,10 +71,7 @@ export default class HttpDataConverter {
    * @return {object[][]} raw records from the response.
    */
   extractRawRecords(response) {
-
     const result = extractResult(response);
-
-
     if (result) {
       const data = result.data;
       if (data) {
@@ -153,8 +150,6 @@ function extractResult(response) {
 }
 
 function extractRawRecord(data) {
-
-
   const row = data.row;
 
   const nodesById = indexNodesById(data);
@@ -208,8 +203,6 @@ function indexRelationshipsById(data) {
 }
 
 function extractRawRecordElement(index, data, nodesById, relationshipsById) {
-
-
   const element = data.row ? data.row[index] : null;
   const elementMetadata = data.meta ? data.meta[index] : null;
 
diff --git a/src/v1/internal/url-util.js b/src/v1/internal/url-util.js
@@ -19,7 +19,10 @@
 
 import ParsedUrl from 'url-parse';
 import {assertString} from './util';
-import {DEFAULT_PORT} from './ch-config';
+
+const DEFAULT_BOLT_PORT = 7687;
+const DEFAULT_HTTP_PORT = 7474;
+const DEFAULT_HTTPS_PORT = 7473;
 
 class Url {
 
@@ -39,8 +42,8 @@ class Url {
     this.host = host;
 
     /**
-     * Nonnull number representing port. Default port {@link DEFAULT_PORT} value is used if given URL string
-     * does not contain port. Example: 7687, 12000, etc.
+     * Nonnull number representing port. Default port for the given scheme is used if given URL string
+     * does not contain port. Example: 7687 for bolt, 7474 for HTTP and 7473 for HTTPS.
      * @type {number}
      */
     this.port = port;
@@ -62,7 +65,7 @@ class Url {
   }
 }
 
-function parseBoltUrl(url) {
+function parseDatabaseUrl(url) {
   assertString(url, 'URL');
 
   const sanitized = sanitizeUrl(url);
@@ -71,7 +74,7 @@ function parseBoltUrl(url) {
   const scheme = sanitized.schemeMissing ? null : extractScheme(parsedUrl.protocol);
   const rawHost = extractHost(parsedUrl.hostname); // has square brackets for IPv6
   const host = unescapeIPv6Address(rawHost); // no square brackets for IPv6
-  const port = extractPort(parsedUrl.port);
+  const port = extractPort(parsedUrl.port, scheme);
   const hostAndPort = `${rawHost}:${port}`;
   const query = parsedUrl.query;
 
@@ -107,9 +110,9 @@ function extractHost(host, url) {
   return host.trim();
 }
 
-function extractPort(portString) {
+function extractPort(portString, scheme) {
   const port = parseInt(portString, 10);
-  return (port === 0 || port) ? port : DEFAULT_PORT;
+  return (port === 0 || port) ? port : defaultPortForScheme(scheme);
 }
 
 function extractQuery(queryString, url) {
@@ -188,8 +191,19 @@ function formatIPv6Address(address, port) {
   return `${escapedAddress}:${port}`;
 }
 
+function defaultPortForScheme(scheme) {
+  if (scheme === 'http') {
+    return DEFAULT_HTTP_PORT;
+  } else if (scheme === 'https') {
+    return DEFAULT_HTTPS_PORT;
+  } else {
+    return DEFAULT_BOLT_PORT;
+  }
+}
+
 export default {
-  parseBoltUrl: parseBoltUrl,
+  parseDatabaseUrl: parseDatabaseUrl,
+  defaultPortForScheme: defaultPortForScheme,
   formatIPv4Address: formatIPv4Address,
   formatIPv6Address: formatIPv6Address
 };
diff --git a/test/internal/ch-config.test.js b/test/internal/ch-config.test.js
@@ -25,7 +25,7 @@ import {SERVICE_UNAVAILABLE} from '../../src/v1/error';
 describe('ChannelConfig', () => {
 
   it('should respect given Url', () => {
-    const url = urlUtil.parseBoltUrl('bolt://neo4j.com:4242');
+    const url = urlUtil.parseDatabaseUrl('bolt://neo4j.com:4242');
 
     const config = new ChannelConfig(url, {}, '');
 
diff --git a/test/internal/ch-websocket.test.js b/test/internal/ch-websocket.test.js
@@ -75,7 +75,7 @@ describe('WebSocketChannel', () => {
         };
       };
 
-      const url = urlUtil.parseBoltUrl('bolt://localhost:7687');
+      const url = urlUtil.parseDatabaseUrl('bolt://localhost:7687');
       const driverConfig = {connectionTimeout: 4242};
       const channelConfig = new ChannelConfig(url, driverConfig, SERVICE_UNAVAILABLE);
 
@@ -112,7 +112,7 @@ describe('WebSocketChannel', () => {
       };
     };
 
-    const url = urlUtil.parseBoltUrl(boltAddress);
+    const url = urlUtil.parseDatabaseUrl(boltAddress);
     // disable connection timeout, so that WebSocketChannel does not set any timeouts
     const driverConfig = {connectionTimeout: 0};
     const channelConfig = new ChannelConfig(url, driverConfig, SERVICE_UNAVAILABLE);
diff --git a/test/internal/host-name-resolvers.test.js b/test/internal/host-name-resolvers.test.js
@@ -72,7 +72,7 @@ describe('DnsHostNameResolver', () => {
 
         addresses.forEach(address => {
           expectToBeDefined(address);
-          const parsedUrl = urlUtil.parseBoltUrl(address);
+          const parsedUrl = urlUtil.parseDatabaseUrl(address);
           expect(parsedUrl.scheme).toBeNull();
           expectToBeDefined(parsedUrl.host);
           expect(parsedUrl.port).toEqual(7687); // default port should be appended
@@ -91,7 +91,7 @@ describe('DnsHostNameResolver', () => {
 
         addresses.forEach(address => {
           expectToBeDefined(address);
-          const parsedUrl = urlUtil.parseBoltUrl(address);
+          const parsedUrl = urlUtil.parseDatabaseUrl(address);
           expect(parsedUrl.scheme).toBeNull();
           expectToBeDefined(parsedUrl.host);
           expect(parsedUrl.port).toEqual(7474);
diff --git a/test/internal/http-driver.test.js b/test/internal/http-driver.test.js
@@ -225,6 +225,21 @@ describe('http driver', () => {
     });
   });
 
+  it('should use default HTTP port', done => {
+    if (testUtils.isServer()) {
+      done();
+      return;
+    }
+
+    const driver = neo4j.driver('http://localhost', sharedNeo4j.authToken);
+    const session = driver.session();
+    session.run('RETURN 4242').then(result => {
+      expect(result.records[0].get(0)).toEqual(4242);
+      expect(result.summary.server.address).toEqual('localhost:7474');
+      done();
+    });
+  });
+
   function testSendAndReceiveWithReturnQuery(values, done) {
     const query = 'RETURN $value';
 
diff --git a/test/internal/url-util.test.js b/test/internal/url-util.test.js
@@ -18,7 +18,6 @@
  */
 
 import urlUtil from '../../src/v1/internal/url-util';
-import {DEFAULT_PORT} from '../../src/v1/internal/ch-config';
 
 describe('url-util', () => {
 
@@ -716,6 +715,14 @@ describe('url-util', () => {
     expect(() => urlUtil.formatIPv6Address('1afc:0:a33:85a3::ff2f]', 4000)).toThrow();
   });
 
+  it('should use default ports when no port specified', () => {
+    expect(parse('bolt://localhost').port).toEqual(urlUtil.defaultPortForScheme('bolt'));
+    expect(parse('bolt+routing://localhost').port).toEqual(urlUtil.defaultPortForScheme('bolt'));
+
+    expect(parse('http://localhost').port).toEqual(urlUtil.defaultPortForScheme('http'));
+    expect(parse('https://localhost').port).toEqual(urlUtil.defaultPortForScheme('https'));
+  });
+
   function verifyUrl(urlString, expectedUrl) {
     const url = parse(urlString);
 
@@ -732,7 +739,7 @@ describe('url-util', () => {
     if (expectedUrl.port) {
       expect(url.port).toEqual(expectedUrl.port);
     } else {
-      expect(url.port).toEqual(DEFAULT_PORT);
+      expect(url.port).toEqual(urlUtil.defaultPortForScheme(expectedUrl.scheme));
     }
 
     verifyHostAndPort(url, expectedUrl);
@@ -745,7 +752,7 @@ describe('url-util', () => {
   }
 
   function verifyHostAndPort(url, expectedUrl) {
-    const port = expectedUrl.port === 0 || expectedUrl.port ? expectedUrl.port : DEFAULT_PORT;
+    const port = expectedUrl.port === 0 || expectedUrl.port ? expectedUrl.port : urlUtil.defaultPortForScheme(expectedUrl.scheme);
 
     if (expectedUrl.ipv6) {
       expect(url.hostAndPort).toEqual(`[${expectedUrl.host}]:${port}`);
@@ -755,7 +762,7 @@ describe('url-util', () => {
   }
 
   function parse(url) {
-    return urlUtil.parseBoltUrl(url);
+    return urlUtil.parseDatabaseUrl(url);
   }
 
 });

Original file line number	Diff line number	Diff line change
`@@ -586,7 +586,7 @@ class ConnectionState {`
`586`	`586`	`*/`
`587`	`587`	`function connect(url, config = {}, connectionErrorCode = null) {`
`588`	`588`	`const Ch = config.channel \|\| Channel;`
`589`		`- const parsedUrl = urlUtil.parseBoltUrl(url);`
	`589`	`+ const parsedUrl = urlUtil.parseDatabaseUrl(url);`
`590`	`590`	`const channelConfig = new ChannelConfig(parsedUrl, config, connectionErrorCode);`
`591`	`591`	`return new Connection(new Ch(channelConfig), parsedUrl.hostAndPort, config.disableLosslessIntegers);`
`592`	`592`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ export class DnsHostNameResolver extends HostNameResolver {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`resolve(seedRouter) {`
`44`		`- const parsedAddress = urlUtil.parseBoltUrl(seedRouter);`
	`44`	`+ const parsedAddress = urlUtil.parseDatabaseUrl(seedRouter);`
`45`	`45`
`46`	`46`	`return new Promise((resolve) => {`
`47`	`47`	`this._dns.lookup(parsedAddress.host, {all: true}, (error, addresses) => {`