Install the ZMQ prebuilt binaries and verify ZMQ works on startup (#10551)

* Npm package

* Add ZMQ to the extension

* Fix functional failure

* Make verification happen at server launch

* Fix native dependencies. Make sure error sticks around

* Fix functional tests

* Fix linter

Author: rchiodo

build/webpack/common.js

@@ -35,7 +35,8 @@ exports.nodeModulesToExternalize = [
     '@koa/cors',
     'koa',
     'koa-compress',
-    'koa-logger'
+    'koa-logger',
+    'zeromq'
 ];
 exports.nodeModulesToReplacePaths = [...exports.nodeModulesToExternalize];
 function getDefaultPlugins(name) {

build/webpack/webpack.extension.config.js

@@ -2,6 +2,8 @@
 // Licensed under the MIT License.
 'use strict';
 
+const copyWebpackPlugin = require('copy-webpack-plugin');
+const removeFilesWebpackPlugin = require('remove-files-webpack-plugin');
 const path = require('path');
 const tsconfig_paths_webpack_plugin = require('tsconfig-paths-webpack-plugin');
 const constants = require('../constants');
@@ -76,7 +78,15 @@ const config = {
                     ]
                 }
             ]
-        })
+        }),
+        // ZMQ requires prebuilds to be in our node_modules directory. So recreate the ZMQ structure.
+        // However we don't webpack to manage this, so it was part of the excluded modules. Delete it from there
+        // so at runtime we pick up the original structure.
+        new removeFilesWebpackPlugin({ after: { include: ['./out/client/node_modules/zeromq.js'] } }),
+        new copyWebpackPlugin([{ from: './node_modules/zeromq/**/*.js' }]),
+        new copyWebpackPlugin([{ from: './node_modules/zeromq/**/*.node' }]),
+        new copyWebpackPlugin([{ from: './node_modules/zeromq/**/*.json' }]),
+        new copyWebpackPlugin([{ from: './node_modules/node-gyp-build/**/*' }])
     ],
     resolve: {
         alias: {

gulpfile.js

@@ -709,6 +709,7 @@ function hasNativeDependencies() {
         path.dirname(item.substring(item.indexOf('node_modules') + 'node_modules'.length)).split(path.sep)
     )
         .filter(item => item.length > 0)
+        .filter(item => !item.includes('zeromq')) // This is a known native. Allow this one for now
         .filter(
             item =>
                 jsonProperties.findIndex(flattenedDependency =>

news/3 Code Health/10483.md

@@ -0,0 +1 @@
+Add ZMQ library to extension