feat: add initial plot/base/server implementation

kgryte · kgryte · commit 927a38f2da65 · 2025-08-16T04:07:28.000-07:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/plot/base/server/lib/connections_store.js b/lib/node_modules/@stdlib/plot/base/server/lib/connections_store.js
@@ -0,0 +1,34 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The Stdlib Authors.
+*
+* 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
+*
+*    http://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.
+*/
+
+'use strict';
+
+/**
+* Returns a new connections store.
+*
+* @private
+* @returns {Object} store
+*/
+function create() {
+	return {};
+}
+
+
+// EXPORTS //
+
+module.exports = create;
diff --git a/lib/node_modules/@stdlib/plot/base/server/lib/index.js b/lib/node_modules/@stdlib/plot/base/server/lib/index.js
@@ -0,0 +1,50 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* 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
+*
+*    http://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.
+*/
+
+'use strict';
+
+/**
+* Plot server.
+*
+* @module @stdlib/plot/base/server
+*
+* @example
+* var createServer = require( '@stdlib/plot/base/server' );
+*
+* function router( req, res ) {
+*     res.end();
+* }
+*
+* function onReady( error, server ) {
+*     if ( error ) {
+*         throw error
+*     }
+*     server.close();
+* }
+*
+* createServer( router, onReady );
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;
diff --git a/lib/node_modules/@stdlib/plot/base/server/lib/keys/localhost_cert.pem b/lib/node_modules/@stdlib/plot/base/server/lib/keys/localhost_cert.pem
@@ -0,0 +1,19 @@
+-----BEGIN CERTIFICATE-----
+MIIDGjCCAgKgAwIBAgIUY77Qg5UIMpE7/e3T9lfhA51jfdcwDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTI1MDgxNjA4NTU1MVoXDTI1MDkx
+NTA4NTU1MVowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF
+AAOCAQ8AMIIBCgKCAQEAolomYjGUgoRTbfkVZqcifglvr9d5K7mc280pbM5Zhbob
+SVCc/BU52V8W7z18qq1jfaMwBbLKiIV5M8w50uGeE/mc51D2QohFQqWVby0fhJ57
+WW7w+Bn/bex1IG9mqtwfUxwgMCnyncWf8/0N9TY51EApOnmjZUil4u56dDUxb903
+UYt2evse7DmzHJBsNVdo14cf0ea91w5KMligts+UkyseBVeodKmWV5tea5tAif+Q
+q3E2CFK+QkYhBm0JowdsbJfCNQv5dKrZwjtHR/YbFfWsuG8YJR36bEZcPEAqgcBu
+RIlBBHSJlCwnWxhU8/U1A4yAhy7R4E4uabH2hCz5nQIDAQABo2QwYjAdBgNVHQ4E
+FgQUfFkcV4D8H6oBGZgBED/1Oe9cOm0wHwYDVR0jBBgwFoAUfFkcV4D8H6oBGZgB
+ED/1Oe9cOm0wDwYDVR0TAQH/BAUwAwEB/zAPBgNVHREECDAGhwR/AAABMA0GCSqG
+SIb3DQEBCwUAA4IBAQByJA+NEziDO1JGSyzfzuog51khl0YGeA9i1wWuoiYe6VbJ
+12BbFhb01bw+8kFQznWoJyNXh+yMP1/5FkbYjhWLEXoQsmetH2kxmug9kOZR/59C
+EA7sNYNdLb8t6w7VfqfkMuC0dYskB0nRfawCIr+F9x3mM4A7z8O0DlvvbJtn7bq2
+gKANwfZOSnv5bJeNwd35LYXMyAHZey0HZA3Q/bblt4kbjBB5PRoTHorX5FGzub8k
+ZM9XTixGfueivEc8tahTI+s8ncBBhMir+c8tCxfb/KEahextPkO6Y6pPJjZuqFGz
+4vprylLQvT3zqX5VFQ/D+LWm0ySgprWxVbk8WnHy
+-----END CERTIFICATE-----
diff --git a/lib/node_modules/@stdlib/plot/base/server/lib/keys/localhost_privkey.pem b/lib/node_modules/@stdlib/plot/base/server/lib/keys/localhost_privkey.pem
@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCiWiZiMZSChFNt
++RVmpyJ+CW+v13kruZzbzSlszlmFuhtJUJz8FTnZXxbvPXyqrWN9ozAFssqIhXkz
+zDnS4Z4T+ZznUPZCiEVCpZVvLR+EnntZbvD4Gf9t7HUgb2aq3B9THCAwKfKdxZ/z
+/Q31NjnUQCk6eaNlSKXi7np0NTFv3TdRi3Z6+x7sObMckGw1V2jXhx/R5r3XDkoy
+WKC2z5STKx4FV6h0qZZXm15rm0CJ/5CrcTYIUr5CRiEGbQmjB2xsl8I1C/l0qtnC
+O0dH9hsV9ay4bxglHfpsRlw8QCqBwG5EiUEEdImULCdbGFTz9TUDjICHLtHgTi5p
+sfaELPmdAgMBAAECggEAMMYFfv1nILixOboZWFAAuD2MfJauk9i8y3m8pq/tTBPn
+i6R4rPCRgwCiqrfdoobZe06RqDyYxN/YVBvYCUb3jwevv/xeJwm6SPXmyVIUhGp6
+IxmFsftZdcQSQe7FuLHNhVHPR7jqZsSOs6WD0nV6dQ3bdPJDCLQFBgJf7lZmpjSk
+B1RO5SITejFYZzhA88btRhN/Mo1Aq9tNRX5wSbgdsp9vGpnMhLSnh49lzNgMrlCt
+5cRbFIp8nGNhEtdL602Iu3l/cnROsDkUpZ67Y4hCaD+ZLZzZiY6XcwLBkK/66yFJ
++Av3nMKNImFhmaBmFF9PP3uIThLCDU6uLB2nbOTS7wKBgQDUdnq1QIvP2brhzqZl
+Miw/Uhn3vAI5afTj/t2L5fq8PlXqc0eEPePO/gDdzJz4sivn8nvOseATEy1rvVeb
+bkBxgznIHVJz4BPJ1usALSUNXDoYo8g5kjLym0xRbFfji9+y4oBOFN2dqeuePHSn
+zTihYvb7YnXKGDqlbD+1j6x+6wKBgQDDnu5SO6n2N1B2XtQSBm1jzGWoNi9er1jt
+hwTq1B2lrviVuDa0kwXuGD9RTutUQyHBgzJIjjpTqmmY55YHSjtlzh4Jv5IipNb4
+orWI4zWdqCCTkHfJDlLCDMxyq6Lf+P1Abu2C9+INK3xJ92QrXqRy7bzCCGizARox
+Ur675lUXlwKBgE7k8Av+O+yi3VKceg155BRfWGU1212Wiule6sXYUJM2UpEM3bGt
+ibqDd67lHCT9hHBNCsxmIN70cBlh5fZBqox8PiihOszsmGyK8hjOqsObS7d6mg9G
+ysRsBpr1sG0+s4KpuRtFhEXXozbPHEJzYmQLa8tNdI/nD1/+Imo5P8ShAoGAMZT/
+7OHog1qjz0zbzbHJWik9fvQ073fcP2Agk/CtjwgZQ8GMRBqbvyxwKAirxxC45pZ9
+UTyTdg9UcogIU9Kx2Wzz2h6vSI6lWiHLh2Wnek1Z7G0Kn3A886hQzaPJRaGTdxhm
+pPJ1XkcuWoUU45U6c1Lkq/17pBtcazIA3BlWagMCgYBNaRXg01jVdAOM2Lfd2dgr
+UKuucsQ2ZcfNqCPLoN0uq3W7zPrAl0dCLLssoMzXfvCTL9DDuurU9EHwzBm/84BG
+cXKodXA+rC5axoj/BC4R0MkerjGuFxr0rh2o8yc6aTEer5Cvs4xkP2dAMgfXuc8B
+3anarHhn0p3D/1YJppG3XQ==
+-----END PRIVATE KEY-----
diff --git a/lib/node_modules/@stdlib/plot/base/server/lib/main.js b/lib/node_modules/@stdlib/plot/base/server/lib/main.js
@@ -0,0 +1,186 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* 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
+*
+*    http://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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var resolve = require( 'path' ).resolve;
+var logger = require( 'debug' );
+var isFunction = require( '@stdlib/assert/is-function' );
+var objectKeys = require( '@stdlib/utils/keys' );
+var readFileSync = require( '@stdlib/fs/read-file' ).sync;
+var serverFactory = require( '@stdlib/net/http2-secure-server' );
+var format = require( '@stdlib/string/format' );
+var createStore = require( './connections_store.js' );
+var serverOpts = require( './opts.js' );
+
+
+// VARIABLES //
+
+var debug = logger( 'plot-server' );
+var KEYS_DIR = resolve( __dirname, 'keys' );
+
+
+// MAIN //
+
+/**
+* Creates a plot server.
+*
+* @param {Function} router - request handler
+* @param {Callback} clbk - callback to invoke upon creating a server
+* @throws {TypeError} first argument must be a function
+* @throws {TypeError} second argument must be a function
+* @throws {Error} error encountered when starting server
+*
+* @example
+* function router( req, res ) {
+*     res.end();
+* }
+*
+* function onReady( error, server ) {
+*     if ( error ) {
+*         throw error
+*     }
+*     server.close();
+* }
+*
+* createServer( router, onReady );
+*/
+function createServer( router, clbk ) {
+	var connections;
+	var server;
+	var sopts;
+	var boot;
+
+	if ( !isFunction( router ) ) {
+		throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', router ) );
+	}
+	if ( !isFunction( clbk ) ) {
+		throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', clbk ) );
+	}
+	// Extract server options:
+	sopts = serverOpts( {} );
+
+	// Set require server options for SSL:
+	sopts = {
+		'cert': readFileSync( resolve( KEYS_DIR, 'localhost_cert.pem' ) ),
+		'key': readFileSync( resolve( KEYS_DIR, 'localhost_privkey.pem' ) ),
+		'allowHTTP1': true
+	};
+
+	// Create a function to boot a server...
+	boot = serverFactory( sopts, requestListener );
+
+	debug( 'Starting server...' );
+	boot( onServer );
+
+	// Initialize a connections store:
+	connections = createStore();
+
+	/**
+	* Callback invoked upon creating a server.
+	*
+	* @private
+	* @param {(Error|null)} error - error object
+	* @param {Server} _server - server instance
+	* @throws {Error} error encountered when starting server
+	*/
+	function onServer( error, _server ) {
+		if ( error ) {
+			throw error;
+		}
+		debug( 'Server started.' );
+		server = _server;
+
+		// Track connections so that we can perform clean-up upon closing the server of any persistent TCP connections which are still hanging around:
+		server.on( 'connection', onConnection );
+
+		server.once( 'close', onClose );
+		clbk( null, server );
+	}
+
+	/**
+	* Callback invoked upon receiving a socket connection.
+	*
+	* @private
+	* @param {Socket} socket - socket connection
+	*/
+	function onConnection( socket ) {
+		var key = socket.remoteAddress + ':' + socket.remotePort;
+
+		debug( 'Received a socket connection: %s.', key );
+		connections[ key ] = socket;
+		socket.on( 'close', onClose );
+
+		/**
+		* Callback invoked once a socket connection closes.
+		*
+		* @private
+		*/
+		function onClose() {
+			debug( 'Socket connection closed: %s.', key );
+			delete connections[ key ];
+		}
+	}
+
+	/**
+	* Callback invoked upon receiving an HTTP request.
+	*
+	* @private
+	* @param {IncomingMessage} request - HTTP request object
+	* @param {ServerResponse} response - HTTP response object
+	* @returns {void}
+	*/
+	function requestListener( request, response ) {
+		debug( 'Received a request for %s', request.url );
+		router( request, response );
+	}
+
+	/**
+	* Callback invoked once a server closes.
+	*
+	* @private
+	*/
+	function onClose() {
+		debug( 'Server closed.' );
+		setTimeout( destroyConnections, 5000 );
+	}
+
+	/**
+	* Destroys all connections.
+	*
+	* @private
+	*/
+	function destroyConnections() {
+		var keys;
+		var i;
+
+		debug( 'Destroying all connections...' );
+		keys = objectKeys( connections );
+		for ( i = 0; i < keys.length; i++ ) {
+			debug( 'Destroying connection %s...', keys[i] );
+			connections[ keys[i] ].destroy();
+		}
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = createServer;
diff --git a/lib/node_modules/@stdlib/plot/base/server/lib/opts.js b/lib/node_modules/@stdlib/plot/base/server/lib/opts.js
@@ -0,0 +1,67 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* 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
+*
+*    http://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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+
+
+// MAIN //
+
+/**
+* Extracts server options from input function options.
+*
+* @private
+* @param {Options} options - function options
+* @param {NonNegativeInteger} [options.port] - server port
+* @param {NonNegativeInteger} [options.maxport] - max server port
+* @param {string} [options.hostname] - server hostname
+* @param {string} [options.address] - server address
+* @returns {Options} server options
+*
+* @example
+* var options = {
+*     'port': 7331,
+*     'address': '127.0.0.1'
+* };
+* var out = opts( options );
+* // returns {'port': 7331, 'address': '127.0.0.1'}
+*/
+function opts( options ) {
+	var out = {};
+	if ( hasOwnProp( options, 'port' ) ) {
+		out.port = options.port;
+	}
+	if ( hasOwnProp( options, 'maxport' ) ) {
+		out.maxport = options.maxport;
+	}
+	if ( hasOwnProp( options, 'hostname' ) ) {
+		out.hostname = options.hostname;
+	}
+	if ( hasOwnProp( options, 'address' ) ) {
+		out.address = options.address;
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = opts;
diff --git a/lib/node_modules/@stdlib/plot/base/server/package.json b/lib/node_modules/@stdlib/plot/base/server/package.json
