feat(v2.1.1): add typescript compilation to husky; add createQueryStr…

…ingParamsObjectFromString()

.husky/pre-commit

@@ -1,6 +1,7 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
+npx tsc
 npm run build
 npm run test
 npm run docs:madge

package.json

@@ -1,7 +1,7 @@
 {
   "name": "gitmetrix",
   "description": "Helps you find your team-level engineering metrics",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "author": "Mikael Vesavuori",
   "license": "MIT",
   "keywords": [
@@ -24,7 +24,7 @@
   "scripts": {
     "start": "npx sls offline --reloadHandler",
     "test": "npm run test:licenses && npm run test:types && npm run test:unit",
-    "test:types": "npx type-coverage --at-least 98 --strict --ignore-files \"tests/**/*.ts\" --ignore-files \"*.ts\" --ignore-files \"src/application/errors/*.ts\" --ignore-files \"testdata/*.ts\"",
+    "test:types": "npx type-coverage --at-least 97.5 --strict --ignore-files \"tests/**/*.ts\" --ignore-files \"*.ts\" --ignore-files \"src/application/errors/*.ts\" --ignore-files \"testdata/*.ts\"",
     "test:licenses": "npx license-compliance --direct --allow 'MIT;ISC;0BSD;BSD-2-Clause;BSD-3-Clause;Apache-2.0;Unlicense;CC0-1.0'",
     "test:unit": "npx c8 -reporter=lcov ava",
     "test:createdata": "npx ts-node tests/createTestData.ts",

src/application/createQueryStringParamsObjectFromString.ts

@@ -0,0 +1,17 @@
+/**
+ * @description Create a conventional object of query string parameters
+ * from an HTTP API's `event` object that only has query string parameters
+ * in the shape of a "raw" string.
+ */
+export function createQueryStringParamsObjectFromString(event: Record<string, any>) {
+  const queryStringParameters: Record<string, any> = {};
+
+  const parts = event?.rawQueryString?.split('&');
+  if (parts && parts.length > 0)
+    parts.forEach((part: string) => {
+      const [key, value] = part.split('=');
+      queryStringParameters[key] = value.replace('%2F', '/');
+    });
+
+  return queryStringParameters;
+}

src/infrastructure/adapters/web/GetMetrics.ts

@@ -5,7 +5,9 @@ import { EventInput } from '../../../interfaces/Lambda';
 
 import { getMetrics } from '../../../usecases/getMetrics';
 
+import { createQueryStringParamsObjectFromString } from '../../../application/createQueryStringParamsObjectFromString';
 import { getRequestDTO } from '../../../application/getRequestDTO';
+
 import { getRepo } from '../../frameworks/getRepo';
 import { end } from '../../frameworks/end';
 
@@ -24,7 +26,8 @@ export async function handler(event: EventInput, context: Record<string, any>) {
   });
 
   try {
-    const input = getRequestDTO(event.queryStringParameters || {});
+    const queryStringParameters = createQueryStringParamsObjectFromString(event);
+    const input = getRequestDTO(queryStringParameters);
     const repository = getRepo(process.env.NODE_ENV === 'test');
     const metrics = await getMetrics(repository, input);
     return end(200, metrics);

tests/unit/application/createQueryStringParamsObjectFromString.test.ts

@@ -0,0 +1,25 @@
+import test from 'ava';
+
+import { createQueryStringParamsObjectFromString } from '../../../src/application/createQueryStringParamsObjectFromString';
+
+/**
+ * POSITIVE TESTS
+ */
+
+test.serial('It should return a clean object from a query parameter string', (t) => {
+  const expected = { repo: 'SOMEORG/SOMEREPO', from: '20230220', to: '20230225' };
+
+  const result = createQueryStringParamsObjectFromString({
+    rawQueryString: 'repo=SOMEORG/SOMEREPO&from=20230220&to=20230225'
+  });
+
+  t.deepEqual(result, expected);
+});
+
+test.serial('It should return an empty object for an unknown input', (t) => {
+  const expected = {};
+
+  const result = createQueryStringParamsObjectFromString({});
+
+  t.deepEqual(result, expected);
+});