Add message processor and specs

jest.config.mjs

@@ -0,0 +1,198 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+/** @type {import('jest').Config} */
+const config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  transform: {},
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

main.js

@@ -0,0 +1,36 @@
+import { Message } from "./message.js";
+
+/**
+* @typedef {Object} MessageLike
+* @property {string} action - every string valid for JS function name.
+* @property {Object} data - The user's last name.
+*/
+
+/**
+ * @param {string|MessageLike} message - Message itself of JSON representation of Message
+ */
+function processMessage(messageLike = {}) {
+  const message = new Message(messageLike);
+
+  if(!message.isValid()) {
+    console.error("Got mallformed message:", message);
+    return;
+  };
+
+  if (this.actions[message.action]) {
+    this.actions[message.action](message.data);
+  } else {
+    this.fallbackAction(message);
+  }
+};
+
+const messageProcessor = {
+  // Use Map instead?
+  actions: {},
+  processMessage,
+  fallbackAction: function(x) {
+    console.log("No actions for message:", x)
+  }
+}
+
+export { messageProcessor };

main.spec.js

@@ -0,0 +1,38 @@
+import { messageProcessor } from "./main.js";
+import { jest } from '@jest/globals'
+
+test('should fire error message about mallformed message', () => {
+  console.error = jest.fn();
+  var message = {};
+  var errorMessage = "Got mallformed message:";
+  var errorParams = { action: undefined, data: undefined };
+
+  messageProcessor.processMessage(message);
+  expect(console.error).toHaveBeenCalledWith(errorMessage, errorParams);
+});
+
+test('should fire log message if no action presents', () => {
+  console.log = jest.fn();
+  var message = { action: "do something" };
+  var errorMessage = "No actions for message:";
+  var errorParams = { action: "do something", data: undefined };
+
+  messageProcessor.processMessage(message);
+  expect(console.log).toHaveBeenCalledWith(errorMessage, errorParams);
+});
+
+test('should call action', () => {
+  var result = 0;
+  var message = {
+    action: "do something"
+  };
+
+  messageProcessor.actions = {
+    "do something": function() {
+      result = 1;
+    }
+  };
+
+  messageProcessor.processMessage(message);
+  expect(result).toBe(1);
+});

message.js

@@ -0,0 +1,41 @@
+const parseMessageFromString = (message) => {
+  try {
+    return JSON.parse(message);
+  } catch {
+    return {};
+  }
+}
+
+/**
+* @typedef {Object} MessageLike
+* @property {string} action - every string valid for JS function name.
+* @property {Object} data - The user's last name.
+*/
+
+/**
+ * @param {string|MessageLike} data - Message itself of JSON representation of Message
+ */
+function Message(data = {}) {
+  switch(Object.prototype.toString.call(data)) {
+  case "[object String]":
+    const parsedMessage = parseMessageFromString(x);
+
+    this.action = parsedMessage?.action;
+    this.data = parsedMessage?.data;
+
+    break;
+  case "[object Object]":
+    this.action = data?.action;
+    this.data = data?.data;
+
+    break;
+  }
+}
+
+Message.prototype.isValid = function() {
+  return (
+    this?.action !== undefined
+  );
+}
+
+export { Message }

package.json

@@ -0,0 +1,19 @@
+{
+  "name": "message-processor",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "Tiny utility library for rpc-style message communication",
+  "main": "main.js",
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitea.bjornmossa.net/Radioiceberg/message-processor"
+  },
+  "author": "Radioiceberg team",
+  "license": "GPL-3.0-or-later",
+  "devDependencies": {
+    "jest": "^29.7.0"
+  }
+}