Some refactoring, add unit testing, add pre-commit quality hooks

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx prettier --write .
+npm test

.prettierignore

@@ -0,0 +1,6 @@
+.husky
+coverage
+README.md
+jest.config.js
+package-lock.json
+package.json

.prettierrc.json

@@ -0,0 +1 @@
+{}

__tests__/mouse.js

@@ -0,0 +1,14 @@
+const { getInvocationFromMessage } = require("../functions/mouse.protected.js");
+
+const message = "Weather inreachlink.com/BSM3UMY  - Keesha Boles";
+
+test("invocation is all lowercase", () => {
+  const invocation = getInvocationFromMessage(message);
+  expect(invocation).toBe(invocation.toLowerCase());
+});
+
+test("invocation doesn't have any name/signature", () => {
+  const invocation = getInvocationFromMessage(message);
+  const messageWithoutInvocation = message.replace(invocation, "");
+  expect(messageWithoutInvocation).toMatch(/ {1,3}- [\w ]+/);
+});

__tests__/utils.js

@@ -0,0 +1,15 @@
+const { getInReachSlug } = require("../functions/utils.private.js");
+
+const invocationWithSlug = "weather inreachlink.com/bsm3umy";
+
+test("slug is all uppercase", () => {
+  const slug = getInReachSlug(invocationWithSlug);
+  expect(slug).not.toBeNull();
+  expect(slug).toBe(slug.toUpperCase());
+});
+
+test("slug is seven characters", () => {
+  const slug = getInReachSlug(invocationWithSlug);
+  expect(slug).not.toBeNull();
+  expect(slug.length).toBe(7);
+});

functions/mouse.protected.js

@@ -1,6 +1,6 @@
 const Twilio = require("twilio");
 
-exports.handler = async function (context, event, callback) {
+const handler = async function (context, event, callback) {
   // Need to use this syntax to `require` these `private`
   // handler/helper functions
   const handleWeatherInvocation = require(Runtime.getFunctions()["weather"]
@@ -14,47 +14,42 @@ exports.handler = async function (context, event, callback) {
   // needs to be sent
   const twiml = new Twilio.twiml.MessagingResponse();
 
-  const incomingMessage = event.Body;
-  if (typeof incomingMessage === "undefined") {
+  const rawMessage = event.Body;
+  if (typeof rawMessage === "undefined") {
     twiml.message(
       "Error: No message found, make sure one is sent in the HTTP request"
     );
     return callback(null, twiml);
   }
 
-  // All InReach messages include ` - ${user's name}` at the end,
-  // so strip that off
-  let invocation = incomingMessage.split(/ {1,3}- /)[0].trim();
-  let inReachSlug = null;
-
-  // The user may have location sharing turned on, in which case
-  // there will also be an ` inreachlink.com/#######` before the
-  // `  - ${user's name}`
-  if (incomingMessage.includes("inreachlink.com")) {
-    inReachSlug = incomingMessage.match(/inreachlink\.com\/([A-Z|\d]{7})/)[1];
-    invocation = invocation.replace(inReachSlug, "").trim();
-  }
-  invocation = invocation.toLowerCase();
+  const invocation = getInvocationFromMessage(message);
 
   if (invocation.includes("weather")) {
-    if (inReachSlug === null) {
-      twiml.message(
-        "Error: You must include your InReach location link in your text message"
-      );
-      return callback(null, twiml);
-    }
-
-    const daysMatch = invocation.match(/\d+/);
-    const days = Array.isArray(daysMatch) ? daysMatch[0] : 2;
-    return await handleWeatherInvocation(inReachSlug, days, callback);
+    return await handleWeatherInvocation(invocation, callback);
   } else if (invocation.includes("closures")) {
     return await handleClosuresInvocation(invocation, callback);
   } else if (invocation.includes("wikipedia")) {
     return await handleWikipediaInvocation(invocation, callback);
   } else {
     twiml.message(
-      "Error: Your text must include which information you want; available options: `weather`, `closures`, `wikipedia`"
+      "Error: Your text must include which information you want; options are: `weather`, `closures`, `wikipedia`"
     );
     return callback(null, twiml);
   }
 };
+
+const getInvocationFromMessage = (message) => {
+  // All InReach messages include ` - ${user's name}` at the end,
+  // so strip that off
+  const invocation = message
+    .split(/ {1,3}- /)[0]
+    .trim()
+    .toLowerCase();
+
+  return invocation;
+};
+
+module.exports = {
+  handler,
+  getInvocationFromMessage,
+};

functions/utils.private.js

@@ -94,9 +94,23 @@ const splitMessage = (message) => {
   return messages;
 };
 
+const getInReachSlug = (message) => {
+  // The user may have location sharing turned on, in which case
+  // there will be an ` inreachlink.com/#######` before the
+  // `  - ${user's name}`
+  let inReachSlug = null;
+  if (message.includes("inreachlink.com")) {
+    inReachSlug = message.match(/inreachlink\.com\/([A-z|\d]{7})/)[1];
+    message = message.replace(inReachSlug, "");
+    inReachSlug = inReachSlug.toUpperCase();
+  }
+  return inReachSlug;
+};
+
 const convertUrlToGoogleCacheUrl = (url) =>
   `http://webcache.googleusercontent.com/search?q=cache:${url}&strip=1&vwsrc=0`;
 
 module.exports = {
   convertUrlToGoogleCacheUrl,
+  getInReachSlug,
 };

functions/weather.private.js

@@ -1,4 +1,5 @@
 const axios = require("axios").default;
+const { getInReachSlug } = require(Runtime.getFunctions()["utils"].path);
 
 const inReachSlugToWeatherUrl = async (inReachSlug) => {
   const url = `http://inreachlink.com/${inReachSlug}`;
@@ -32,7 +33,7 @@ const buildIntroMessage = (weatherData, days) => {
   }
   // Keep consistency with the weather summaries, which all end
   // in a period
-  message = message + '.'
+  message = message + ".";
 
   return message;
 };
@@ -131,9 +132,20 @@ const buildWeatherMessages = (weatherData, days) => {
   });
 };
 
-const handleWeatherInvocation = async (inReachSlug, days, callback) => {
+const handleWeatherInvocation = async (invocation, callback) => {
   const twiml = new Twilio.twiml.MessagingResponse();
 
+  const inReachSlug = getInReachSlug(invocation);
+  if (!inReachSlug) {
+    twiml.message(
+      "Error: You must include your InReach location link in your text message"
+    );
+    return callback(null, twiml);
+  }
+
+  const daysMatch = invocation.match(/\d+/);
+  const days = Array.isArray(daysMatch) ? daysMatch[0] : 2;
+
   const weatherUrl = await inReachSlugToWeatherUrl(inReachSlug);
   if (weatherUrl === null) {
     twiml.message(

jest.config.js

@@ -0,0 +1,188 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // Respect "browser" field in package.json when resolving modules
+  // browser: false,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/zr/_r7bpkm5065b4tx5vv5sq6jc0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // 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/"
+  // ],
+
+  // 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,
+
+  // 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",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "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 between 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 between 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: [],
+
+  // 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: "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: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // 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,
+};