Mocking 带有 Jest 的 jsonwebtoken 模块

Question

我试着开玩笑地模拟 npm 模块 jsonwebtoken 的验证 function。 function 返回一个解码令牌，但我想通过这个 function 的自定义返回我的单元测试。

我明确要求在继续请求之前检查访问令牌的有效性。 但我想模拟令牌检查的时刻直接返回用户值。 并轻松通过这一步。 我把你关注的代码部分。

但是 typescript 向我发送此错误：属性 'mockReturnValue' 在类型 '{ (token: string, secretOrPublicKey: Secret, options?: VerifyOptions | undefined): string | object； (token: string, secretOrPublicKey: string | Buffer | { key: string | Buffer; passphrase: string; } | GetPublicKeyOrSecret, callback?: VerifyCallback | undefined): void; （令牌：字符串，secretOrPublicKey：字符串 |... ...'。

所以模拟不起作用，我不明白。 我按照 Jest.io 上的模拟 axios 步骤进行操作，但它似乎不适用于 jsonwebtoken。

每个人都知道问题是什么或如何开玩笑地模拟这个 jsonwebtoken 模块吗？

用户.test.ts

import jwt from 'jsonwebtoken'
    jest.mock('jwt')
    jwt.verify.mockReturnValue({
                    userId: String(member._id),
                    email: String(member.email),
                    permissionLevel: member.permissionLevel,
                    username: String(member.username),
                })

describe('### /GET users', () => {
            it('it should return 200 (Users List)', async (done) => {
                const res = await request(app).set('Authorization', 'Bearer').get('/users')
                expect(res.status).toBe(200)
            })
})

验证.ts

public isAccessTokenValid = (req: Request, res: Response, next: NextFunction): void => {
        if (req.cryptedAccessToken) {
            try {
                req.accessToken = jwt.verify(req.cryptedAccessToken, ACCESS_TOKEN_SECRET)
                next()
            } catch (err) {
                res.status(498).send({ error: err.message })
            }
        } else res.status(401).send({ error: 'cryptedAccessToken field not present in request' })
    }

最好的祝福

Answer 1

我花了一段时间，但我得到了这个工作，有一些教训。

1. jest.mock('jsonwebtoken')需要使用并且必须放在spec文件的顶部，就在import jwt from 'jsonwebtoken'

2. 这样做会模拟 jwt 的所有功能。 就我而言，我只想模拟验证。 这段代码解决了这个问题（替换上面的 (1)）。

    import jwt from 'jsonwebtoken; jest.mock('jsonwebtoken', () => ({ ...jest.requireActual('jsonwebtoken'), // import and retain the original functionalities verify: jest.fn().mockReturnValue({ foo: 'bar' }), // overwrite verify }));

3. 然后我可以通过以下三种方式之一模拟验证：

a) 将其保留为默认模拟（返回 foo bar）

b) 使用 mockReturnValue，但我需要指定我要替换的重载 (thx @Gabriel)

  const verify = jwt.verify as jest.MockedFunction<
    (
      token: string,
      secretOrPublicKey: jwt.Secret,
      options?: jwt.VerifyOptions,
    ) => Record<string, unknown> | string
  >;
  verify.mockReturnValue({ verified: 'true' });

c) 使用模拟实现

 const verify = jest.spyOn(jwt, 'verify');
 verify.mockImplementation(() => () => ({ verified: 'true' }));

所有这些令人讨厌的事情是，现在在规范文件中为所有描述/它模拟了验证。

Answer 2

那是因为 TypeScript “不知道”您已经模拟了该模块，因此您可以尝试对正确的类型进行类型转换

import jwt from 'jsonwebtoken'
const { verify } = jwt as jest.Mocked<typeof import('jsonwebtoken')>

verify.mockReturnValue({
  //...
})

或者

(jwt as jest.Mocked<typeof import('jsonwebtoken')>).verify.mockReturnValue({
  //...
})

Answer 3

当使用verify并同时返回解码的令牌时：

jest.mock('jsonwebtoken', () => ({
  verify: jest.fn((token, secretOrPublicKey, options, callback) => {
    return callback(null, {sub: 'user_id'});
  })
}));

Answer 4

按照 Jasmin 的回答，我一直在为每个测试寻找一个独特的模拟。 我的回调 function 只使用了三个 arguments，成功时它只检查 email 属性。 对于我想看到错误的测试，我将 null 替换为 {name: 'TokenExpiredError'} 这是我的回调 function 检查的属性。

令牌.test.js：

const jwt = require('jsonwebtoken')
...
describe('Group 1', () => {   
    it('Test 1', async () => {
        jest.spyOn(jwt, 'verify').mockImplementation(
            jest.fn((token, secretOrPublicKey, callback) => callback(null, {email: 'cool@dude.com'}))
        ); 
        ... 
        (endpoint request and expect statements)
    });

这是测试的代码：

令牌.js

...
const validateToken = (keycloakToken) => {
  const callback = (err, decoded) => {
    if (err === null && decoded.email) {
      console.log(`INFO: valid token - logged in as ${decoded.email}`);
      return decoded.email;
    } else if (err.name === "TokenExpiredError") {
      console.log("ERROR: expired token");
    } else if (err.name === "JsonWebTokenError") {
      console.log("ERROR: malformed token");
    }
  }
  return jwt.verify(keycloakToken, PUB_KEY, callback);
};