Merge pull request #10 from sauravhiremath/master

TCP sockets for connection

Author: rakshith-ravi

README.md

@@ -1,6 +1,6 @@
-# Gotham Node
+# Juno Node
 
-This is a library that provides you with helper methods for interfacing with the microservices framework, [gotham](https://github.com/bytesonus/gotham).
+This is a library that provides you with helper methods for interfacing with the microservices framework, [juno](https://github.com/bytesonus/juno).
 
 ## How to use:
 
@@ -13,10 +13,10 @@ For all other basic needs, you can get away without worrying about any of that.
 ### A piece of code is worth a thousand words
 
 ```js
-import GothamModule from "./src/gotham-node";
+import JunoModule from "juno-node";
 
 async function main() {
-    let module = GothamModule.default("./path/to/gotham.sock");
+    let module = JunoModule.default("./path/to/juno.sock");
     await module.initialize("module-name", "1.0.0");
     console.log("Initialized!");
 
@@ -29,4 +29,4 @@ async function main() {
 }
 
 main()
-```
+```

package-lock.json

@@ -1,15 +1,15 @@
 {
-	"name": "gotham-node",
+	"name": "juno-node",
 	"version": "0.0.0",
 	"description": "",
 	"keywords": [],
-	"main": "dist/gotham-node.umd.js",
-	"module": "dist/gotham-node.es5.js",
-	"typings": "dist/types/gotham-node.d.ts",
+	"main": "dist/juno-node.umd.js",
+	"module": "dist/juno-node.es5.js",
+	"typings": "dist/types/juno-node.d.ts",
 	"files": [
 		"dist"
 	],
-	"author": "thebongy <rishit.[email protected]>",
+	"author": "thebongy <rishit.[email protected]>",
 	"repository": {
 		"type": "git",
 		"url": ""
@@ -55,48 +55,48 @@
 		]
 	},
 	"devDependencies": {
-		"@commitlint/cli": "^7.1.2",
-		"@commitlint/config-conventional": "^7.1.2",
-		"@types/chai": "^4.2.7",
+		"@commitlint/cli": "^8.3.5",
+		"@commitlint/config-conventional": "^8.3.4",
+		"@types/chai": "^4.2.11",
 		"@types/chai-as-promised": "^7.1.2",
 		"@types/expect": "^24.3.0",
-		"@types/mocha": "^5.2.7",
-		"@types/node": "^10.11.0",
-		"@types/sinon": "^7.5.1",
-		"@types/sinon-chai": "^3.2.3",
+		"@types/mocha": "^7.0.2",
+		"@types/node": "^13.13.4",
+		"@types/sinon": "^9.0.0",
+		"@types/sinon-chai": "^3.2.4",
 		"chai": "^4.2.0",
 		"chai-as-promised": "^7.1.1",
 		"chai-exclude": "^2.0.2",
-		"colors": "^1.3.2",
-		"commitizen": "^3.0.0",
-		"coveralls": "^3.0.2",
-		"cross-env": "^5.2.0",
-		"cz-conventional-changelog": "^2.1.0",
-		"lint-staged": "^8.0.0",
+		"colors": "^1.4.0",
+		"commitizen": "^4.0.4",
+		"coveralls": "^3.1.0",
+		"cross-env": "^7.0.2",
+		"cz-conventional-changelog": "^3.1.0",
+		"lint-staged": "^10.1.7",
 		"lodash.camelcase": "^4.3.0",
-		"mocha": "^7.0.0",
-		"prettier": "^1.14.3",
+		"mocha": "^7.1.2",
+		"prettier": "^2.0.5",
 		"prompt": "^1.0.0",
-		"replace-in-file": "^3.4.2",
-		"rimraf": "^2.6.2",
-		"rollup": "^0.67.0",
-		"rollup-plugin-commonjs": "^9.1.8",
-		"rollup-plugin-json": "^3.1.0",
-		"rollup-plugin-node-resolve": "^3.4.0",
-		"rollup-plugin-sourcemaps": "^0.4.2",
-		"rollup-plugin-typescript2": "^0.18.0",
-		"semantic-release": "^15.9.16",
-		"shelljs": "^0.8.3",
-		"sinon": "^8.0.2",
-		"sinon-chai": "^3.4.0",
-		"travis-deploy-once": "^5.0.9",
-		"ts-mocha": "^6.0.0",
-		"ts-node": "^7.0.1",
-		"tslint": "^5.11.0",
-		"tslint-config-prettier": "^1.15.0",
-		"tslint-config-standard": "^8.0.1",
-		"typedoc": "^0.12.0",
-		"typescript": "^3.0.3"
+		"replace-in-file": "^6.0.0",
+		"rimraf": "^3.0.2",
+		"rollup": "^2.7.2",
+		"rollup-plugin-commonjs": "^10.1.0",
+		"rollup-plugin-json": "^4.0.0",
+		"rollup-plugin-node-resolve": "^5.2.0",
+		"rollup-plugin-sourcemaps": "^0.5.0",
+		"rollup-plugin-typescript2": "^0.27.0",
+		"semantic-release": "^17.0.7",
+		"shelljs": "^0.8.4",
+		"sinon": "^9.0.2",
+		"sinon-chai": "^3.5.0",
+		"travis-deploy-once": "^5.0.11",
+		"ts-mocha": "^7.0.0",
+		"ts-node": "^8.9.1",
+		"tslint": "^6.1.1",
+		"tslint-config-prettier": "^1.18.0",
+		"tslint-config-standard": "^9.0.0",
+		"typedoc": "^0.17.5",
+		"typescript": "^3.8.3"
 	},
 	"dependencies": {}
 }

package.json

@@ -7,7 +7,7 @@ import json from 'rollup-plugin-json'
 
 const pkg = require('./package.json')
 
-const libraryName = 'gotham-node'
+const libraryName = 'juno-node'
 
 export default {
   input: `src/${libraryName}.ts`,

rollup.config.ts

@@ -0,0 +1,43 @@
+import { Socket, createConnection } from 'net';
+import BaseConnection from './base-connection';
+
+export default class InetSocketConnection extends BaseConnection {
+	client?: Socket;
+	host: string;
+	port: number;
+
+	constructor(host: string, port: number) {
+		super();
+		this.host = host;
+		this.port = port;
+	}
+
+	setupConnection(): Promise<void> {
+		return new Promise(resolve => {
+			this.client = createConnection(this.port, this.host);
+			this.client.on('data', (data) => {
+				const dataLines = data.toString().split(/\r?\n/);
+				dataLines.map((data) => {
+					if (data) {
+						this.onData(Buffer.from(data))
+					}
+				});
+			});
+			this.client.on('connect', () => {
+				resolve();
+			});
+		});
+	}
+
+	async closeConnection() {
+		this.client?.destroy();
+	}
+
+	send(message: Buffer): Promise<void> {
+		return new Promise(resolve => {
+			this.client?.write(message, () => {
+				resolve();
+			});
+		});
+	}
+}

src/connection/inet-socket-connection.ts

@@ -1,8 +1,8 @@
-import * as net from 'net';
+import { Socket, createConnection } from 'net';
 import BaseConnection from './base-connection';
 
-export default class SocketConnection extends BaseConnection {
-	client?: net.Socket;
+export default class UnixSocketConnection extends BaseConnection {
+	client?: Socket;
 	sockPath: string;
 
 	constructor(sockPath: string) {
@@ -12,7 +12,7 @@ export default class SocketConnection extends BaseConnection {
 
 	setupConnection(): Promise<void> {
 		return new Promise(resolve => {
-			this.client = net.createConnection(this.sockPath);
+			this.client = createConnection(this.sockPath);
 			this.client.on('data', (data) => {
 				const dataLines = data.toString().split(/\r?\n/);
 				dataLines.map((data) => {

src/connection/unix-socket-connection.ts

@@ -1,3 +1,5 @@
+import { isIP } from 'net';
+import { promises as fsPromises } from 'fs';
 import { BaseProtocol } from './protocol/base-protocol';
 import BaseConnection from './connection/base-connection';
 import { JsonProtocol } from './protocol/json-protocol';
@@ -6,11 +8,12 @@ import {
 	FunctionCallRequest,
 	FunctionCallResponse,
 	TriggerHookRequest,
-	GothamMessage
+	JunoMessage
 } from './models/messages';
-import SocketConnection from './connection/unix-socket-connection';
+import UnixSocketConnection from './connection/unix-socket-connection';
+import InetSocketConnection from './connection/inet-socket-connection';
 
-export default class GothamModule {
+export default class JunoModule {
 
 	private protocol: BaseProtocol;
 	private moduleId?: string;
@@ -27,8 +30,38 @@ export default class GothamModule {
 		// this.connection.setOnDataListener(this.onDataHandler);
 	}
 
-	public static default(socketPath: string): GothamModule {
-		return new GothamModule(new SocketConnection(socketPath), new JsonProtocol());
+	public static async default(socketPath: string) {
+		const [ host, port ] = socketPath.split(':');
+
+		if (isIP(host) && !isNaN(Number(port))) {
+			return this.fromInetSocket(host, Number(port));
+		}
+		if ( (await fsPromises.lstat(socketPath)).isSocket() ) {
+			return this.fromUnixSocket(socketPath);
+		}
+
+		throw new Error('Invalid socket object. Only unix domain sockets and Inet sockets are allowed');
+
+	}
+
+	public static async fromUnixSocket(path: string) {
+		// Return Error if invoked from windows
+		if (process.platform == 'win32') {
+			throw new Error('Unix sockets are not supported on windows');
+		}
+		if ( (await fsPromises.lstat(path)).isSocket() ) {
+			return new JunoModule(new UnixSocketConnection(path), new JsonProtocol());
+		}
+
+		throw new Error('Invalid unix socket path');
+	}
+
+	public static async fromInetSocket(host: string, port: number) {
+		if (isIP(host) && !isNaN(Number(port))) {
+			return new JunoModule(new InetSocketConnection(host, port), new JsonProtocol());
+		}
+
+		throw new Error('Invalid Inet socket address. Use the format `{host}:{port}`')
 	}
 
 	public async initialize(
@@ -87,7 +120,7 @@ export default class GothamModule {
 		return this.connection.closeConnection();
 	}
 
-	private async sendRequest(request: GothamMessage) {
+	private async sendRequest(request: JunoMessage) {
 		if (request.type === RequestTypes.ModuleRegistration && this.registered) {
 			throw new Error('Module already registered');
 		}
@@ -179,7 +212,7 @@ export default class GothamModule {
 	private async executeHookTriggered(request: TriggerHookRequest) {
 		if (request.hook) {
 			// Hook triggered by another module.
-			if (request.hook === `gotham.activated`) {
+			if (request.hook === `juno.activated`) {
 				this.registered = true;
 				if (this.messagBuffer) {
 					this.connection.send(this.messagBuffer);

src/gotham-node.ts renamed to src/juno-node.ts

@@ -50,19 +50,19 @@ export interface DeclareFunctionResponse extends BaseMessage {
 	function: string;
 }
 
-export type GothamResponse =
+export type JunoResponse =
 	RegisterModuleResponse |
 	ListenHookResponse |
 	TriggerHookResponse |
 	DeclareFunctionResponse |
 	FunctionCallResponse;
-export type GothamRequest =
+export type JunoRequest =
 	RegisterModuleRequest |
 	DeclareFunctionRequest |
 	FunctionCallRequest |
 	RegisterHookRequest |
 	TriggerHookRequest;
-export type GothamMessage =
+export type JunoMessage =
 	RegisterModuleResponse |
 	ListenHookResponse |
 	TriggerHookResponse |

src/models/messages.ts

@@ -4,7 +4,7 @@ import {
 	DeclareFunctionRequest,
 	FunctionCallRequest,
 	RegisterModuleRequest,
-	GothamMessage
+	JunoMessage
 } from '../models/messages';
 import { RequestTypes } from '../utils/constants';
 
@@ -70,6 +70,6 @@ export abstract class BaseProtocol {
 		};
 	}
 
-	public abstract encode(req: GothamMessage): Buffer;
-	public abstract decode(data: Buffer): GothamMessage;
+	public abstract encode(req: JunoMessage): Buffer;
+	public abstract decode(data: Buffer): JunoMessage;
 }

src/protocol/base-protocol.ts

@@ -1,12 +1,12 @@
 import { BaseProtocol } from './base-protocol';
-import { GothamRequest, GothamResponse } from '../models/messages';
+import { JunoRequest, JunoResponse } from '../models/messages';
 
 export class JsonProtocol extends BaseProtocol {
-	public encode(req: GothamRequest): Buffer {
+	public encode(req: JunoRequest): Buffer {
 		return Buffer.from(JSON.stringify(req) + '\n');
 	}
 
-	public decode(data: Buffer): GothamResponse {
+	public decode(data: Buffer): JunoResponse {
 		return JSON.parse(data.toString());
 	}
 }