@openziti/ziti-sdk-nodejs 0.6.0 → 0.9.0

package/.github/workflows/build.yml

@@ -31,12 +31,21 @@ jobs:
       matrix:
         config:
           # - { name: "Win", os: windows-latest, cc: "cl",    cxx: "cl" }
-          - { name: "Lnx", os: ubuntu-18.04,   cc: "gcc",   cxx: "g++" }
-          - { name: "Mac", os: macos-latest,   cc: "clang", cxx: "clang++" }
-        node: [ '12', '13', '14' ]
-        architecture:
-          - arm64
-          - x64
+          - { os: ubuntu-18.04,   cc: "gcc",   cxx: "g++", node: '12' }
+          - { os: ubuntu-18.04,   cc: "gcc",   cxx: "g++", node: '13' }
+          - { os: ubuntu-18.04,   cc: "gcc",   cxx: "g++", node: '14' }
+          - { os: ubuntu-18.04,   cc: "gcc",   cxx: "g++", node: '15' }
+          - { os: ubuntu-18.04,   cc: "gcc",   cxx: "g++", node: '16' }
+          - { os: ubuntu-18.04,   cc: "gcc",   cxx: "g++", node: '17' }
+          - { os: ubuntu-20.04,   cc: "gcc",   cxx: "g++", node: '18' }
+          - { os: macos-latest,   cc: "clang", cxx: "clang++", node: '12' }
+          - { os: macos-latest,   cc: "clang", cxx: "clang++", node: '13' }
+          - { os: macos-latest,   cc: "clang", cxx: "clang++", node: '14' }
+          - { os: macos-latest,   cc: "clang", cxx: "clang++", node: '15' }
+          - { os: macos-latest,   cc: "clang", cxx: "clang++", node: '16' }
+          - { os: macos-latest,   cc: "clang", cxx: "clang++", node: '17' }
+          - { os: macos-latest,   cc: "clang", cxx: "clang++", node: '18' }
+        architecture: [x64, arm64]
       fail-fast: false
 
     steps:
@@ -58,7 +67,7 @@ jobs:
     - name: Node Version
       uses: actions/setup-node@v2
       with:
-        node-version: ${{ matrix.node }}
+        node-version: ${{ matrix.config.node }}
     
     - name: Extract branch name
       shell: bash
@@ -76,7 +85,7 @@ jobs:
 
     - name: Install Ninja (Linux)
       run: sudo apt-get install -y ninja-build
-      if: matrix.config.os == 'ubuntu-18.04'
+      if: matrix.config.os == 'ubuntu-18.04' || matrix.config.os == 'ubuntu-20.04'
 
     - name: Install Ninja (Mac)
       run: brew install ninja
@@ -111,7 +120,7 @@ jobs:
         cd ${{ runner.workspace }}/${{ github.event.repository.name }}/deps/ziti-sdk-c/build
         cmake -G Ninja -DUSE_OPENSSL=on -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_C_COMPILER=${{ matrix.config.cc }} -DCMAKE_CXX_COMPILER=${{ matrix.config.cxx }} ..
       if: |
-        matrix.config.os == 'ubuntu-18.04'
+        matrix.config.os == 'ubuntu-18.04' || matrix.config.os == 'ubuntu-20.04'
 
     - name: Build (embedded) C-SDK Phase-I ( Mac)
       run: |
@@ -146,7 +155,8 @@ jobs:
         cd ${{ runner.workspace }}/${{ github.event.repository.name }}/deps/ziti-sdk-c/build
         cmake --build . --target all
       if: |
-        matrix.config.os == 'ubuntu-18.04' ||
+        matrix.config.os == 'ubuntu-18.04' || 
+        matrix.config.os == 'ubuntu-20.04' ||
         matrix.config.os == 'macOS-latest'
 
     # - name: Build (embedded) C-SDK Phase-II (Windows)
@@ -169,6 +179,7 @@ jobs:
         BUILD_DATE: ${{ steps.date.outputs.date }}
       if: |
         matrix.config.os == 'ubuntu-18.04' ||
+        matrix.config.os == 'ubuntu-20.04' ||
         matrix.config.os == 'macOS-latest'
 
     - name: Build NodeJS-SDK (Windows)
@@ -198,7 +209,7 @@ jobs:
         ./node_modules/.bin/node-pre-gyp package unpublish publish
         sleep 5
       if: |
-        steps.extract_branch.outputs.branch == 'main' && matrix.config.os == 'ubuntu-18.04' && matrix.node != '14'
+        steps.extract_branch.outputs.branch == 'main' && matrix.config.os == 'ubuntu-18.04' && matrix.config.node != '14'
 
     - name: Install Binary
       run: |
@@ -217,4 +228,4 @@ jobs:
         token: ${{ secrets.NPM_TOKEN }}
         access: public
       if: |
-        matrix.config.os == 'ubuntu-18.04' && matrix.node == '14' && steps.extract_branch.outputs.branch == 'main'
+        matrix.config.os == 'ubuntu-18.04' && matrix.config.node == '14' && matrix.architecture == 'x64' && steps.extract_branch.outputs.branch == 'main'

package/README.md

@@ -25,7 +25,7 @@
 ---
 [![Build Status](https://github.com/openziti/ziti-sdk-nodejs/workflows/Build/badge.svg?branch=main)]()
 [![Issues](https://img.shields.io/github/issues-raw/openziti/ziti-sdk-nodejs)]()
-[![npm version](https://badge.fury.io/js/@openziti%2Fziti-sdk-nodejs.svg)](https://badge.fury.io/js/@openziti%2Fziti-sdk-nodejs)
+[![npm version](https://badge.fury.io/js/@openziti%2Fziti-sdk-nodejs.svg)](https://badge.fury.io/js/@openziti%2Fziti-sdk-nodejs.svg)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![LOC](https://img.shields.io/tokei/lines/github/openziti/ziti-sdk-nodejs)]()
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=rounded)](CONTRIBUTING.md)
@@ -38,9 +38,16 @@
 
 # Supported platforms
 
-The `ziti-sdk-nodejs` module works with Node.js v11.x, v12.x, v13.x, v14.x
+The `@openziti/ziti-sdk-nodejs` module works with the following Node.js versions:
+- v12.x
+- v13.x
+- v14.x
+- v15.x
+- v16.x
+- v17.x
+- v18.x
 
-Binaries for most Node versions and platforms are provided by default via [node-pre-gyp](https://github.com/mapbox/node-pre-gyp).
+Binaries for most Node versions and platforms are provided by default via [@mapbox/node-pre-gyp](https://github.com/mapbox/node-pre-gyp).
 
 # Installing
 
@@ -48,13 +55,21 @@ Binaries for most Node versions and platforms are provided by default via [node-
 npm i @openziti/ziti-sdk-nodejs
 ```
 
+Special note on previous package:
+
+On June 7, 2020 @openziti/ziti-sdk-nodejs@0.6.0 was released. Older, unscoped versions that are not part of the @openziti org are deprecated and only @openziti/ziti-sdk-nodejs will see updates going forward. To upgrade to the new package do:
+
+``` js
+npm uninstall ziti-sdk-nodejs --save
+npm install @openziti/ziti-sdk-nodejs --save
+```
 
 # Usage
 
 **Note:** the module must be [installed](#installing) before use.
 
 ``` js
-var ziti = require('ziti-sdk-nodejs');
+var ziti = require('@openziti/ziti-sdk-nodejs');
 
 const ziti_init = async (identity) => {
     return new Promise((resolve) => {

package/binding.gyp

@@ -8,19 +8,18 @@
     # node v0.6.x doesn't give us its build variables,
     # but on Unix it was only possible to use the system OpenSSL library,
     # so default the variable to "true", v0.8.x node and up will overwrite it.
-    'node_shared_openssl%': 'true'
+    'node_shared_openssl%': 'true',
 
 	},
 
   "targets": [
     {
       'defines': [
-        'BUILD_DATE=<@(BUILD_DATE)',
-        'ZITI_BRANCH=<@(ZITI_BRANCH)',
-        'ZITI_COMMIT=<@(ZITI_COMMIT)',
-        'ZITI_VERSION=<@(ZITI_VERSION)',
-        'ZITI_OS=<@(ZITI_OS)',
-        'ZITI_ARCH=<@(ZITI_ARCH)',
+        'BUILD_DATE=<!(echo <!(date))',
+        'ZITI_BRANCH=<!(git branch --show-current)',
+        'ZITI_COMMIT=<!(git rev-parse --short HEAD)',
+        'ZITI_VERSION=<!(jq -r .version package.json)',
+        'ZITI_ARCH=<!(arch)',
       ],
 
       "target_name": "<(module_name)",
@@ -37,6 +36,7 @@
         "./src/Ziti_https_request_data.c",
         "./src/Ziti_https_request_end.c",
         "./src/ziti_init.c",
+        "./src/ziti_listen.c",
         "./src/ziti_service_available.c",
         "./src/ziti_shutdown.c",
         "./src/ziti_write.c",
@@ -106,17 +106,19 @@
             "GCC_ENABLE_PASCAL_STRINGS": "NO",        # No -mpascal-strings
             "GCC_THREADSAFE_STATICS": "NO",           # -fno-threadsafe-statics
             "PREBINDING": "NO",                       # No -Wl,-prebind
-            "MACOSX_DEPLOYMENT_TARGET": "10.15",      # -mmacosx-version-min=10.14
+            "MACOSX_DEPLOYMENT_TARGET": "12",         # -mmacosx-version-min=10.14
             "USE_HEADERMAP": "NO",
             "OTHER_CFLAGS": [
               "-fno-strict-aliasing",
               "-g",
               "-fno-pie",
-              "-DSOURCE_PATH_SIZE=3"
+              "-DSOURCE_PATH_SIZE=3",
+              "-DZITI_OS=macos",
+              "-DCXXFLAGS=-mmacosx-version-min=11",
             ],
             "OTHER_LDFLAGS": [
               "-g",
-              "-mmacosx-version-min=10.15",
+              "-mmacosx-version-min=11",
             ],
             "WARNING_CFLAGS": [
               "-Wall",

package/lib/close.js

@@ -0,0 +1,29 @@
+/*
+Copyright Netfoundry, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+
+/**
+ * close()   
+ * 
+ * @param {*} conn 
+ */
+const close = ( conn,  ) => {
+
+  ziti.ziti_close( conn );
+
+};
+
+exports.close = close;

package/lib/express-listener.js

@@ -0,0 +1,253 @@
+/*
+Copyright Netfoundry, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+const zitiListen = require('./listen').listen;
+const EventEmitter = require('events');
+const { ZitiSocket } = require('./ziti-socket');
+
+
+const normalizedArgsSymbol = Symbol('normalizedArgs');
+
+
+var _serversIndex = 1;
+var _servers = new Map();
+
+/**
+ * on_listen()   
+ * 
+ * @param {*} status 
+ */
+Server.prototype.on_listen = ( status ) => {
+
+};
+  
+/**
+ * on_listen_client()   
+ * 
+ * @param {*} obj 
+ */
+ Server.prototype.on_listen_client = ( obj ) => {
+  
+};
+  
+/**
+ * on_client_write()   
+ * 
+ * @param {*} obj 
+ */
+ Server.prototype.on_client_write = ( obj ) => {
+    
+};
+
+/**
+ * on_listen_client_connect()   
+ * 
+ * @param {*} obj 
+ */
+ Server.prototype.on_listen_client_connect = ( obj ) => {
+  
+    let self = _servers.get(obj.js_arb_data);
+
+    const socket = new ZitiSocket({ client: obj.client });
+
+    self._socket = socket;
+        
+    self.emit('connection', socket);
+};
+
+/**
+ * on_listen_client_data()   
+ * 
+ * @param {*} obj 
+ */
+ Server.prototype.on_listen_client_data = ( obj ) => {
+    
+    let self    = _servers.get(obj.js_arb_data);
+    let socket  = self._socket;
+
+    socket.captureData(obj.app_data);
+};
+  
+
+/**
+ * 
+ * @param {*} args 
+ * @returns 
+ */
+function normalizeArgs(args) {
+    let arr;
+  
+    if (args.length === 0) {
+      arr = [{}, null];
+      arr[normalizedArgsSymbol] = true;
+      return arr;
+    }
+  
+    const arg0 = args[0];
+    let options = {};
+    if (typeof arg0 === 'object' && arg0 !== null) {
+      // (options[...][, cb])
+      options = arg0;
+    } else {
+      // ([port][, host][...][, cb])
+      options.port = arg0;
+      if (args.length > 1 && typeof args[1] === 'string') {
+        options.host = args[1];
+      }
+    }
+  
+    const cb = args[args.length - 1];
+    if (typeof cb !== 'function')
+      arr = [options, null];
+    else
+      arr = [options, cb];
+  
+    arr[normalizedArgsSymbol] = true;
+    return arr;
+}
+  
+function Server(serviceName, options, connectionListener) {
+
+    if (!(this instanceof Server))
+      return new Server(options, connectionListener);
+  
+    EventEmitter.call(this);
+  
+    if (typeof options === 'function') {
+      connectionListener = options;
+      options = {};
+      this.on('connection', connectionListener);
+    } else if (options == null || typeof options === 'object') {
+      options = { ...options };
+  
+      if (typeof connectionListener === 'function') {
+        this.on('connection', connectionListener);
+      }
+    } else {
+      throw new ERR_INVALID_ARG_TYPE('options', 'Object', options);
+    }
+    if (typeof options.keepAliveInitialDelay !== 'undefined') {
+      validateNumber(
+        options.keepAliveInitialDelay, 'options.keepAliveInitialDelay'
+      );
+  
+      if (options.keepAliveInitialDelay < 0) {
+        options.keepAliveInitialDelay = 0;
+      }
+    }
+
+    this._serviceName = serviceName;
+
+    this._connections = 0;
+  
+    // this[async_id_symbol] = -1;
+    this._handle = null;
+    this._usingWorkers = false;
+    this._workers = [];
+    this._unref = false;
+  
+    this.allowHalfOpen = options.allowHalfOpen || false;
+    this.pauseOnConnect = !!options.pauseOnConnect;
+    this.noDelay = Boolean(options.noDelay);
+    this.keepAlive = Boolean(options.keepAlive);
+    this.keepAliveInitialDelay = ~~(options.keepAliveInitialDelay / 1000);
+}
+Object.setPrototypeOf(Server.prototype, EventEmitter.prototype);
+Object.setPrototypeOf(Server, EventEmitter);
+  
+
+Server.prototype.listen = function( serviceName, ...args ) {
+
+    let normalized = normalizeArgs(args);
+    normalized = normalizeArgs(normalized[0]);
+
+    // let options = normalized[0];             // we currently ignore options (a.k.a. `port`)
+    let cb = normalized[1];
+    if (cb === null) { cb = this.on_listen; }   // Use our on_listen cb is necessary, else use cb from teh calling app
+
+    let index = _serversIndex++;
+    _servers.set(index, this);
+
+    zitiListen( serviceName, index, cb, this.on_listen_client, this.on_listen_client_connect, this.on_listen_client_data );
+};
+
+Server.prototype.address = function() {
+    if (this._handle && this._handle.getsockname) {
+      const out = {};
+      const err = this._handle.getsockname(out);
+      if (err) {
+        throw errnoException(err, 'address');
+      }
+      return out;
+    } else if (this._pipeName) {
+      return this._pipeName;
+    }
+    return null;
+};
+  
+Server.prototype.close = function(cb) {
+    if (typeof cb === 'function') {
+      if (!this._handle) {
+        this.once('close', function close() {
+          cb(new ERR_SERVER_NOT_RUNNING());
+        });
+      } else {
+        this.once('close', cb);
+      }
+    }
+  
+    if (this._handle) {
+      this._handle.close();
+      this._handle = null;
+    }
+  
+    if (this._usingWorkers) {
+      let left = this._workers.length;
+      const onWorkerClose = () => {
+        if (--left !== 0) return;
+  
+        this._connections = 0;
+        this._emitCloseIfDrained();
+      };
+  
+      // Increment connections to be sure that, even if all sockets will be closed
+      // during polling of workers, `close` event will be emitted only once.
+      this._connections++;
+  
+      // Poll workers
+      for (let n = 0; n < this._workers.length; n++)
+        this._workers[n].close(onWorkerClose);
+    } else {
+      this._emitCloseIfDrained();
+    }
+  
+    return this;
+};
+  
+Object.defineProperty(Server.prototype, 'listening', {
+    __proto__: null,
+    get: function() {
+      return !!this._handle;
+    },
+    configurable: true,
+    enumerable: true
+});
+  
+
+module.exports = {
+    Server,
+};
+  

package/lib/express.js

@@ -0,0 +1,58 @@
+/*
+Copyright Netfoundry, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+const expressListener = require('./express-listener');
+const { Server } = require('_http_server'); // from NodeJS internals
+
+
+
+/**
+ * express()   
+ * 
+ * @param {*} express 
+ * @param {*} serviceName 
+ */
+const express = ( express, serviceName ) => {
+
+  var wrappedExpressApp = express();
+
+  /**
+   * Listen for connections.
+   *
+   * A node `http.Server` is returned, with this
+   * application (which is a `Function`) as its
+   * callback. 
+   *
+   * @return {http.Server}
+   * @public
+   */  
+  wrappedExpressApp.listen = function() {
+
+    Object.setPrototypeOf(Server.prototype, expressListener.Server.prototype);
+    Object.setPrototypeOf(Server, expressListener.Server);
+    var server = new Server(this);
+
+    expressListener.Server.call( server, serviceName, { } );
+
+    return server.listen(serviceName, arguments);
+
+  };
+
+  return wrappedExpressApp;
+
+};
+
+exports.express = express;

package/lib/index.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2019-2020 Netfoundry, Inc.
+Copyright Netfoundry, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/lib/init.js

@@ -0,0 +1,39 @@
+/*
+Copyright Netfoundry, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+
+/**
+ * init()   
+ * 
+ * @param {*} identityPath 
+ * @returns 
+ */
+const init = ( identityPath ) => {
+
+  return new Promise((resolve, reject) => {
+
+      let rc = ziti.ziti_init( identityPath, ( result ) => {
+          return resolve( result );
+      });
+
+      if (rc < 0) {
+        return reject(`ziti.init() failed with return code ${rc}`);
+      }
+      
+  });
+};
+
+exports.init = init;

package/lib/listen.js

@@ -0,0 +1,30 @@
+/*
+Copyright Netfoundry, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+
+/**
+ * listen()   
+ * 
+ * @param {*} identityPath 
+ * @returns 
+ */
+const listen = ( serviceName, js_arb_data, on_listen, on_listen_client, on_client_connect, on_client_data ) => {
+
+  ziti.ziti_listen( serviceName, js_arb_data, on_listen, on_listen_client, on_client_connect, on_client_data );
+
+};
+
+exports.listen = listen;

package/lib/write.js

@@ -0,0 +1,48 @@
+/*
+Copyright Netfoundry, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+
+/**
+ * on_write()   
+ * 
+ */
+const on_write = ( status ) => {
+
+};
+
+
+/**
+ * write()   
+ * 
+ * @param {*} conn 
+ * @param {*} buf 
+ * @param {*} on_write callback 
+ */
+const write = ( conn, buf, on_write_cb ) => {
+
+  let cb;
+
+  if (typeof on_write_cb === 'undefined') {
+    cb = on_write;
+  } else {
+    cb = on_write_cb;
+  }
+
+  ziti.ziti_write( conn, buf, cb );
+
+};
+
+exports.write = write;