fp-ts 和 jest：Option 和 Either 的人体工程学测试？

Question

我正在使用fp-ts，并使用 Jest 编写单元测试。在许多情况下，我正在测试可为空的结果，通常用Option 或Either 表示（通常是数组finds）。如果结果为 none（以 Option 为例），并且知道这个结果是 some 继续下去，那么最符合人体工程学的方法是什么？

以下是我目前如何解决问题的示例：

function someFunc(input: string): Option.Option<string> {
  return Option.some(input);
}

describe(`Some suite`, () => {
  it(`should do something with a "some" result`, () => {
    const result = someFunc('abcd');

    // This is a fail case, here I'm expecting result to be Some
    if(Option.isNone(result)) {
      expect(Option.isSome(result)).toEqual(true);
      return;
    }

    expect(result.value).toEqual('abcd');
  });
});

但是必须写一个提前返回的 if 不太符合人体工程学。

我也可以写一个as 断言：

  // ...
  it(`should do something with a "some" result`, () => {
    const result = someFunc('abcd') as Option.Some<string>;

    expect(result.value).toEqual('abcd');
  });
  // ...

但缺点是我必须重写some 的类型。在许多情况下，编写它很繁重，需要编写和导出接口仅用于测试目的（这也不符合人体工程学）。

有没有办法简化这种测试？

编辑：这是一个更接近真实情况的测试用例：

interface SomeComplexType {
  id: string,
  inputAsArray: string[],
  input: string;
}

function someFunc(input: string): Option.Option<SomeComplexType> {
  return Option.some({
    id: '5',
    inputAsArray: input.split(''),
    input,
  });
}

describe(`Some suite`, () => {
  it(`should do something with a "some" result`, () => {
    const result = someFunc('abcd');

    // This is the un-ergonomic step
    if(Option.isNone(result)) {
      expect(Option.isSome(result)).toEqual(true);
      return;
    }

    // Ideally, I would only need this:
    expect(Option.isSome(result)).toEqual(true);
    // Since nothing will be ran after it if the result is not "some"
    // But I can imagine it's unlikely that TS could figure that out from Jest expects

    // Since I now have the value's actual type, I can do a lot with it
    // I don't have to check it for nullability, and I don't have to write its type
    const myValue = result.value;

    expect(myValue.inputAsArray).toEqual(expect.arrayContaining(['a', 'b', 'c', 'd']));

    const someOtherThing = getTheOtherThing(myValue.id);

    expect(someOtherThing).toMatchObject({
      another: 'thing',
    });
  });
});

Answer 1

你可以像这样写一个不安全的转换fromSome：

function fromSome<T>(input: Option.Option<T>): T {
  if (Option.isNone(input)) {
    throw new Error();
  }
  return input.value;
}

然后在测试中使用它

  it(`should do something with a "some" result`, () => {
    const result = someFunc('abcd');
    const myValue = fromSome(result);
    // do something with myValue
  });

Answer 2

toNullable 或 toUndefined 怎么样？给定Option<string>，toNullable 返回string | null。

import { toNullable, toUndefined } from "fp-ts/lib/Option";

it(`should do something with a "some" result`, () => {
  expect(toNullable(someFunc("abcd"))).toEqual("abcd");
});

---

expect(Option.isSome(result)).toEqual(true) 的问题是，类型守卫isSome 不能用于缩小expect 外部代码路径中的result（参见here 控制流分析的工作原理）。

您可以使用更精简的assertion functions 并将它们与fp-ts 类型保护结合起来，例如：

import { isSome, Option } from "fp-ts/lib/Option"

function assert<T>(guard: (o: any) => o is T, o: any): asserts o is T {
  if (!guard(o)) throw new Error() // or add param for custom error
}

it(`a test`, () => {
  const result: Option<string> = {...}
  assert(isSome, result)
  // result is narrowed to type "Some" here
  expect(result.value).toEqual('abcd');
});

我不知道是否有一种使用类型保护签名来增强 Jest expect 函数类型本身的好方法，但我怀疑它是否简化了您的案例，而不是简单的断言或以上解决方案。

Answer 3

这个问题在这一点上有点老了，并且有一个可以接受的答案，但是有几个非常好的库可以让测试 fp-ts Either 和 Option 非常愉快。它们都工作得很好，我真的无法决定我更喜欢哪个。

• https://github.com/relmify/jest-fp-ts
• https://github.com/svdo/fp-ts-jest-matchers

它们允许你写这样的东西：

test('some test', () => {
  expect(E.left({ code: 'invalid' })).toSubsetEqualLeft({ code: 'invalid' })
})