@hubspot/ui-extensions-dev-server 0.2.0 → 0.3.0

package/tests/testDevServer.js

@@ -1,287 +0,0 @@
-const { spawn } = require('child_process');
-const fs = require('fs');
-const path = require('path');
-const assert = require('assert');
-const axios = require('axios');
-const WebSocket = require('ws');
-const {
-  VITE_DEFAULT_PORT,
-  WEBSOCKET_PORT,
-  WEBSOCKET_MESSAGE_VERSION,
-  EXTENSIONS_MESSAGE_VERSION,
-} = require('../constants');
-const { verifyFileContents, generateManifestOutputPair } = require('./utils');
-const { getUrlSafeFileName } = require('../utils');
-
-const preShutdownResults = {
-  buildTestPassed: false,
-  expressStaticTestPassed: false,
-  extensionsEndpointPassed: false,
-  webSocketTestPassed: false,
-};
-
-const postShutdownResults = {
-  websocketShutdownReceived: false,
-  expressServerShutdown: false,
-};
-
-const host = 'http://hslocal.net';
-
-let running = false;
-
-function resetResults() {
-  Object.keys(preShutdownResults).forEach(result => {
-    preShutdownResults[result] = false;
-  });
-  Object.keys(postShutdownResults).forEach(result => {
-    postShutdownResults[result] = false;
-  });
-}
-
-function testDevServer(logger, devServerProcess, specs) {
-  const devServerInterval = setInterval(runDevServer, 1000);
-  let runCount = 0;
-
-  function runDevServer() {
-    if (running === false && !devServerProcess) {
-      resetResults();
-      _testDevServer(logger, devServerProcess, specs[runCount]);
-      runCount += 1;
-    }
-    if (runCount === specs.length) {
-      clearInterval(devServerInterval);
-    }
-  }
-}
-
-function _testDevServer(logger, devServerProcess, spec) {
-  running = true;
-  const { entrypoint, expected } = spec;
-
-  const filename = getUrlSafeFileName(entrypoint);
-  const localExpectations = {
-    callback: `${host}:${VITE_DEFAULT_PORT}/${filename}`,
-    websocketUrl: `ws://localhost:${WEBSOCKET_PORT}`,
-    ...expected,
-  };
-
-  logger.warn(`\nDev Server Tests started - ${entrypoint} 🤞`);
-  // We need to use spawn here because it will put the process into the background,
-  // which is required because dev mode is a blocking process and we want to test that
-  // the express server and websocket server are starting properly
-  devServerProcess = spawn('hs-ui-extensions-dev-server', [
-    'dev',
-    '--extension',
-    entrypoint,
-  ]);
-
-  devServerProcess.stdout.on('data', buffer => {
-    const data = buffer.toString().toLowerCase();
-    console.debug('[Dev Server]:', data);
-    if (data.includes('built in')) {
-      testBuild(logger, entrypoint);
-    }
-    if (
-      data.includes('listening') &&
-      data.includes(`${host}:${VITE_DEFAULT_PORT}/extensions`)
-    ) {
-      setTimeout(() => {
-        testExpressServer(logger, localExpectations, filename);
-        testWebSocketServer(logger, localExpectations);
-      }, 1000);
-    }
-  });
-
-  // If the dev server writes to stderr, log the error and throw a new error
-  devServerProcess.stderr.on('data', buffer => {
-    const data = buffer.toString();
-    logger.error(data.toString());
-    throw new Error(data);
-  });
-
-  // When the process closes make sure we met all the success conditions
-  devServerProcess.on('close', () => {
-    if (metPreShutdownConditions()) {
-      logger.info(`- Dev Server pre-shutdown tests passed - ${entrypoint} 🚀`);
-      testPostShutdown(logger, filename);
-    } else {
-      console.log(preShutdownResults);
-      logger.error('Tests failed 😭');
-    }
-  });
-
-  const preShutdownInterval = setInterval(preShutdownCallback, 1000);
-  let preShutdownCheckCount = 0;
-  function preShutdownCallback() {
-    preShutdownCheckCount += 1;
-    if (metPreShutdownConditions() || preShutdownCheckCount === 5) {
-      clearInterval(preShutdownInterval);
-      devServerProcess.kill();
-    }
-  }
-}
-
-function metPreShutdownConditions() {
-  const {
-    buildTestPassed,
-    expressStaticTestPassed,
-    extensionsEndpointPassed,
-    webSocketTestPassed,
-  } = preShutdownResults;
-  return (
-    buildTestPassed &&
-    expressStaticTestPassed &&
-    extensionsEndpointPassed &&
-    webSocketTestPassed
-  );
-}
-
-function metPostShutdownConditions() {
-  const {
-    websocketShutdownReceived,
-    expressServerShutdown,
-  } = postShutdownResults;
-
-  return websocketShutdownReceived && expressServerShutdown;
-}
-
-// Test that the files were built in the proper location and spot
-// check the contents of the files.
-function testBuild(logger, entryPoint) {
-  // // Make sure the files are getting generated in the dist dir
-  const distDir = path.join(process.cwd(), 'dist');
-  const filesInOutputDir = fs.readdirSync(distDir);
-  const filename = path.parse(entryPoint).name;
-  assert.deepStrictEqual(
-    filesInOutputDir,
-    generateManifestOutputPair(entryPoint)
-  );
-  const fileContents = fs
-    .readFileSync(path.join(distDir, `${filename}.js`))
-    .toString();
-  verifyFileContents(`${filename}.js`, fileContents);
-
-  // Check for the inlined source map
-  assert(
-    fileContents.includes(
-      '//# sourceMappingURL=data:application/json;charset=utf-8;base64,'
-    )
-  );
-  logger.info('- Build succeeded 🚀');
-  preShutdownResults.buildTestPassed = true;
-}
-
-// Test that the express server is running on the expected port
-// and that it is serving the files as expected.
-function testExpressServer(logger, expected, filename) {
-  axios
-    .get(`${host}:${VITE_DEFAULT_PORT}/${filename}`)
-    .then(response => {
-      assert.strictEqual(response.status, 200, 'Bundle status code');
-      logger.info('- Express server connected and serving files 🚀');
-      preShutdownResults.expressStaticTestPassed = true;
-    })
-    .catch(logger.error);
-  axios
-    .get(`${host}:${VITE_DEFAULT_PORT}/extensions`)
-    .then(response => {
-      const { data, status } = response;
-      assert.strictEqual(status, 200, '/extensions status code');
-
-      // Top level response assertions
-      assert.strictEqual(data.websocket, expected.websocketUrl);
-      assert.strictEqual(data.version, EXTENSIONS_MESSAGE_VERSION);
-      assert(data.extensions);
-
-      // Extension level response assertions
-      assert.equal(data.extensions.length, 1, '/extensions body length');
-      const extension = data.extensions.pop();
-      assert(extension.manifest);
-      assert.strictEqual(
-        extension.appName,
-        expected.appName,
-        '/extensions appName'
-      );
-      assert.strictEqual(extension.title, expected.title, '/extensions title');
-      assert.strictEqual(
-        extension.callback,
-        expected.callback,
-        '/extensions callback'
-      );
-      logger.info('- Express serving extension data 🚀');
-      preShutdownResults.extensionsEndpointPassed = true;
-    })
-    .catch(logger.error);
-}
-
-// Test the the web socket server is running on the expected port and
-// that we are able to receive messages from it.
-function testWebSocketServer(logger, expected) {
-  const ws = new WebSocket(expected.websocketUrl);
-  ws.on('message', messageBuffer => {
-    const message = JSON.parse(messageBuffer.toString());
-    console.debug('[WebSocket Message]:', message);
-    // Vite sends { type: 'connected'} as a greeting on connect
-    if (message.type === 'connected') {
-      return;
-    }
-
-    assert(['start', 'shutdown'].includes(message.event), 'Message Event');
-    assert.strictEqual(message.appName, expected.appName, 'Message appName');
-    assert.strictEqual(message.title, expected.title, 'Message title');
-    assert.strictEqual(message.version, WEBSOCKET_MESSAGE_VERSION);
-    logger.info(
-      `- WebSocket server connected and sending '${message.event}' messages 🚀`
-    );
-    if (message.event === 'start') {
-      preShutdownResults.webSocketTestPassed = true;
-    } else if (message.event === 'shutdown') {
-      postShutdownResults.websocketShutdownReceived = true;
-    }
-  });
-}
-
-function testPostShutdown(logger, filename) {
-  testExpressHasShutdown(filename);
-
-  const shutdownInterval = setInterval(shutdownCallback, 1000);
-  let shutdownCheckCount = 0;
-  function shutdownCallback() {
-    shutdownCheckCount += 1;
-    if (metPostShutdownConditions()) {
-      clearInterval(shutdownInterval);
-      logger.info('- Dev Server post-shutdown tests passed 🚀');
-      logger.info('Dev Server tests passed 🚀');
-      running = false;
-    } else if (shutdownCheckCount === 5) {
-      clearInterval(shutdownInterval);
-      console.log(postShutdownResults);
-      logger.error('Tests failed 😭');
-    }
-  }
-}
-
-function testExpressHasShutdown(filename) {
-  axios
-    .get(`${host}:${VITE_DEFAULT_PORT}/${filename}`)
-    .then(response => {
-      console.debug(response);
-    })
-    .catch(err => {
-      assert.strictEqual(
-        err.syscall,
-        'connect',
-        'The connect call should fail'
-      );
-      assert.strictEqual(
-        err.code,
-        'ECONNREFUSED',
-        'Express should refuse connection post shutdown'
-      );
-      postShutdownResults.expressServerShutdown = true;
-    });
-}
-
-module.exports = {
-  testDevServer,
-};

package/tests/utils.js

@@ -1,76 +0,0 @@
-const path = require('path');
-const { MANIFEST_FILE } = require('../constants');
-const { getUrlSafeFileName } = require('../utils');
-const assert = require('assert');
-const { loadConfig } = require('../config');
-
-function generateManifestOutputPair(entrypoint) {
-  const fileName = path.parse(entrypoint).name;
-  return [`${fileName}-${MANIFEST_FILE}`, getUrlSafeFileName(entrypoint)];
-}
-
-function verifyFileContents(file, contents) {
-  if (file.endsWith(MANIFEST_FILE)) {
-    const manifest = JSON.parse(contents);
-    assert(manifest.entry);
-    assert(manifest.modules);
-    assert(manifest.modules.internal);
-    manifest.modules.internal.forEach(mod => {
-      assert(mod.module);
-      assert(mod.renderedExports);
-    });
-    assert(manifest.modules.external);
-    manifest.modules.external.forEach(mod => {
-      assert(mod.module);
-      assert(mod.renderedExports);
-    });
-    assert(manifest.package);
-    assert(manifest.package.packages);
-  } else {
-    const stringsToSpotCheck = [
-      '.createRemoteReactComponent',
-      '.createElement',
-      'hubspot.extend',
-      'React',
-      'RemoteUI',
-    ];
-    stringsToSpotCheck.forEach(stringToCheck => {
-      assert(
-        contents.includes(stringToCheck),
-        `File ${file} contents should contain: "${stringToCheck}"`
-      );
-    });
-  }
-}
-
-function generateSpec() {
-  const config = loadConfig();
-  const entrypoints = Object.keys(config);
-  if (entrypoints.length === 0) {
-    throw new Error(
-      'Unable to determine testable entrypoints from config files'
-    );
-  }
-
-  const dev = entrypoints.map(entrypoint => {
-    const { data } = config[entrypoint];
-    return {
-      entrypoint,
-      expected: {
-        ...data,
-      },
-    };
-  });
-  return {
-    build: {
-      entrypoints,
-    },
-    dev,
-  };
-}
-
-module.exports = {
-  generateManifestOutputPair,
-  verifyFileContents,
-  generateSpec,
-};

package/utils.js

@@ -1,10 +0,0 @@
-const path = require('path');
-
-function getUrlSafeFileName(filePath) {
-  const { name } = path.parse(filePath);
-  return encodeURIComponent(`${name}.js`);
-}
-
-module.exports = {
-  getUrlSafeFileName,
-};