Merge pull request #863 from BitGo/DX-634

feat: add optional name param to httpRequest

Author: bitgopatmcl

packages/io-ts-http/src/combinators.ts

@@ -1,4 +1,4 @@
-import { pipe } from 'fp-ts/pipeable';
+import { pipe } from 'fp-ts/function';
 import * as E from 'fp-ts/Either';
 import * as R from 'fp-ts/Record';
 import * as t from 'io-ts';
@@ -101,12 +101,12 @@ export const flattened = <Props extends NestedProps>(
     const innerProps = props[key];
     flatProps = { ...flatProps, ...innerProps };
   }
-  const flatCodec = t.exact(optionalized(flatProps));
+  const flatCodec = t.exact(optionalized(flatProps), name);
 
   const nestedProps = R.map((innerProps: t.Props) => t.exact(optionalized(innerProps)))(
     props,
   );
-  const nestedCodec = t.strict(nestedProps);
+  const nestedCodec = t.strict(nestedProps, name);
 
   return new t.Type(
     name,

packages/io-ts-http/src/httpRequest.ts

@@ -52,8 +52,8 @@ type EmitPropsErrors<P extends HttpRequestCombinatorProps> = {
 
 export function httpRequest<
   Props extends HttpRequestCombinatorProps & EmitPropsErrors<Props>,
->(props: Props) {
-  return flattened('httpRequest', {
+>(props: Props, name?: string) {
+  return flattened(name ?? 'httpRequest', {
     query: {},
     params: {},
     ...(props as Omit<Props, 'query' | 'params'>),

packages/io-ts-http/test/httpRequest.test.ts

@@ -1,10 +1,11 @@
 import { describe, it } from 'node:test';
 import { strict as assert } from 'node:assert';
-
+import * as PathReporter from 'io-ts/lib/PathReporter';
 import * as NEA from 'fp-ts/NonEmptyArray';
 import * as t from 'io-ts';
 import { nonEmptyArray, JsonFromString, NumberFromString } from 'io-ts-types';
-import { assertRight } from './utils';
+
+import { assertLeft, assertRight } from './utils';
 
 import { optional } from '../src/combinators';
 import * as h from '../src/httpRequest';
@@ -138,4 +139,38 @@ describe('httpRequest', () => {
     // tslint:disable-next-line: no-unused-expression
     void _codec;
   });
+
+  it('Displays error with codec name on decode', () => {
+    const request = h.httpRequest(
+      {
+        params: {},
+        query: {
+          foo: t.string,
+        },
+        body: {
+          bar: t.number,
+        },
+      },
+      'TestRequestWithCodecName',
+    );
+
+    const test = {
+      params: {},
+      query: {
+        foo: 'hello',
+      },
+      body: {
+        bar: 'world',
+      },
+    };
+
+    const errors = assertLeft(request.decode(test));
+    const validationErrors = PathReporter.failure(errors);
+    const validationMessage = validationErrors.join('\n');
+
+    assert(
+      validationMessage.includes('TestRequestWithCodecName'),
+      'Expected error to include codec name',
+    );
+  });
 });

packages/io-ts-http/test/utils.ts

@@ -7,6 +7,11 @@ export const assertRight = E.getOrElseW(() => {
   throw new Error('Failed to decode object');
 });
 
+export const assertLeft = <T>(e: E.Either<t.Errors, T>) => {
+  assert(E.isLeft(e), 'Expected a failure, got a success');
+  return e.left;
+};
+
 export const assertEncodes = (codec: t.Mixed, test: unknown, expected = test) => {
   const encoded = codec.encode(test);
   assert.deepEqual(encoded, expected);