router.ts tests

.github/workflows/linux.yml

@@ -47,11 +47,16 @@ jobs:
 
       - uses: actions/setup-node@v2
         with:
-          node-version: '12.x'
+          node-version: '14.x'
 
-      - run: yarn install
+      - name: Install JavaScript Dependencies
+        run: yarn install
 
-      - run: yarn build
+      - name: Build Frontend
+        run: yarn build
+
+      - name: Run the tests
+        run: yarn test -- --coverage
 
       - name: Install ${{ matrix.version }}
         uses: actions-rs/toolchain@v1

.gitignore

@@ -10,3 +10,4 @@ node_modules/
 ./templates/**/*.js
 /static-assets/bundle/*
 src/cache_buster_data.json
+coverage

jest.config.ts

@@ -0,0 +1,192 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/en/configuration.html
+ */
+
+export default {
+  // 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 and instances between 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: 'coverage',
+
+  // 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,
+
+  // 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: ['templates/'],
+
+  // 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-jsdom",
+
+  // 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:7000',
+
+  // 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,
+  transform: {
+    '^.+\\.(ts|tsx)$': 'ts-jest',
+  },
+
+  // 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,
+};

package.json

@@ -4,15 +4,25 @@
   "version": "1.0.0",
   "scripts": {
     "build": "webpack --mode production",
-    "start": "webpack-dev-server --mode development --progress --color"
+    "start": "webpack-dev-server --mode development --progress --color",
+    "test": "jest"
   },
   "devDependencies": {
+    "@types/jest": "^26.0.23",
+    "@types/jsdom": "^16.2.10",
+    "@types/node": "^15.0.2",
+    "@types/sinon": "^10.0.0",
     "css-loader": "^5.2.4",
     "css-minimizer-webpack-plugin": "^2.0.0",
     "dart-sass": "^1.25.0",
+    "jest": "^26.6.3",
+    "jsdom": "^16.5.3",
     "mini-css-extract-plugin": "^1.6.0",
     "sass-loader": "^11.0.1",
+    "sinon": "^10.0.0",
+    "ts-jest": "^26.5.6",
     "ts-loader": "^8.0.0",
+    "ts-node": "^9.1.1",
     "typescript": "^4.1.0",
     "webpack": "^5.0.0",
     "webpack-cli": "^4.6.0",

templates/router.test.ts

@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2021  Aravinth Manivannan <realaravinth@batsense.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import {Router} from './router';
+
+'use strict';
+
+const result = {
+  result: '',
+};
+
+const panelResult = 'hello from panel';
+const panelRoute = '/panel';
+const panel = () => (result.result = panelResult);
+
+const settingsRoute = '/settings';
+const settingsResult = 'hello from settings';
+const settings = () => (result.result = settingsResult);
+
+const router = new Router();
+router.register(panelRoute, panel);
+router.register(settingsRoute, settings);
+
+test('checks if Router works', () => {
+  window.history.pushState({}, 'Settings', settingsRoute);
+  router.route();
+  expect(result.result).toBe(settingsResult);
+  window.history.pushState({}, 'Panel', panelRoute);
+  router.route();
+  expect(result.result).toBe(panelResult);
+});

templates/router.ts

@@ -17,19 +17,19 @@
 
 /** Removes trailing slashed from URI */
 const normalizeUri = (uri: string) => {
-  if (!uri) {
-    throw new Error('uri is empty');
-  }
+  if (typeof uri == 'string') {
+    if (uri.trim().length == 0) {
+      throw new Error('uri is empty');
+    }
 
-  if (typeof uri !== 'string') {
-    throw new TypeError('URI must be a string');
+    let uriLength = uri.length;
+    if (uri[uriLength - 1] == '/') {
+      uri = uri.slice(0, uriLength - 1);
+    }
+    return uri;
+  } else {
+    throw new TypeError(`${typeof uri} ${uri}`);
   }
-
-  let uriLength = uri.length;
-  if (uri[uriLength - 1] == '/') {
-    uri = uri.slice(0, uriLength - 1);
-  }
-  return uri;
 };
 
 /** URI<-> Fn mapping type */
@@ -38,9 +38,9 @@ type routeTuple = {
   fn: () => void;
 };
 
-/** 
+/**
  * Router that selectively executes fucntions
- * based on window.location.pathname 
+ * based on window.location.pathname
  * */
 export class Router {
   routes: Array<routeTuple>;
@@ -48,15 +48,15 @@ export class Router {
     this.routes = [];
   }
 
-  /** 
-   * registers a route-function pair with Router 
+  /**
+   * registers a route-function pair with Router
    * @param {string} uri - route to be registered
    * @param {function} fn: - function to be registered when window.locatin.path
    * matches uri
    * */
   register(uri: string, fn: () => void) {
     // typechecks
-    if (!uri) {
+    if (uri.trim().length == 0) {
       throw new Error('uri is empty');
     }
 
@@ -90,12 +90,11 @@ export class Router {
    * matches window.pathname.location
    * */
   route() {
+    const path = normalizeUri(window.location.pathname);
+
     this.routes.forEach(route => {
-      // normalize for trailing slash
       const pattern = new RegExp(`^${route.uri}$`);
-      const path = normalizeUri(window.location.pathname);
       if (path.match(pattern)) {
-        //return route.fn.call();
         return route.fn();
       }
     });