如何在typescript中使用sinon存根表示中间件？

Question

我正在尝试使用typescript、mocha、sinon和chai http为我的express路由器编写一个集成测试。这个路由器使用我编写的自定义中间件，它检查头中的JWT。

理想情况下，我想存根我的authMiddleware，这样我就可以控制它的行为，而不必为每个测试用例提供有效/无效的JWT。

当我尝试在测试中存根AuthMiddleware时，我意识到Expressapp使用AuthMiddleware的实际实现，而不是模拟的实现。

在模拟authMiddleware之后，我尝试使用typescript的动态导入导入应用程序，但也没有成功。

AUTHMiddleware.ts

import { Request, Response, NextFunction } from 'express';

export default class AuthMiddleware {
    
    verifyToken(req: Request, res: Response, next: NextFunction) :void {
        console.log('Actual implemetation of verifyToken is called!');
        
        // verify token
        
        next();
    }
}

主题路由器。ts

import express from'express';
import AuthMiddleware from '../middleware/authMiddleware';
import * as subjectController from '../controller/subjectController';

const router = express.Router();
const authMiddleware = new AuthMiddleware();

router.post('/', authMiddleware.verifyToken, subjectController.createSubject);

export default router;

应用程序。ts

import express from 'express';
import subjectRoute from './route/subjectRoute';

// Initilize express app
const app = express();

app.set("port", 3000);

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));

// Routers
app.use('/user', userRoute);
app.use('/subject', subjectRoute);

export default app;

受试者测试。ts

import app from '../../src/app';
import AuthMiddleware from '../../../src/middleware/AuthMiddleware';

describe('Subject', () => {

    let app;
    
    beforeEach(async () => {
        sinon.stub(AuthMiddleware.prototype, 'verifyToken').callsFake((req: Request, res: Response, next: NextFunction): void => {
            console.log('Fake verifyToken is called!');
             
            // THIS IS NEVER CALLED IN TESTS...

        });
        app = (await import('../../../src/app')).default;
    });

    it('should throw 403 when jwt is missing in header', (done) => {
        request(app)
            .post(/subject)
            .end((err, res) => {
                expect(res).has.status(403);
                done();
            });
    });
});

当我运行上述测试时，我看到没有调用mockauthMiddleware<测试中的代码>应用程序使用authMiddleware对象的实际实现。

有没有办法存根Express中间件并将其显式传递给应用程序？




Answer 1

我刚刚解释了此响应中发生的情况，但只给出了解决方法。

经过一些思考，我相信克服这个问题的最佳方法是从您的模块中删除全局状态并将整个初始化代码捕获到显式调用的函数（或类，如果您愿意）中，这样您就可以为每个测试创建您的服务器。也就是说，将您的架构更改为：

// router.ts
export function createRouter() {
    /// ...
    router.post('/', authMiddleware.verifyToken, subjectController.createSubject);
    return router;
}

// app.ts
import { createRouter} from "./router.js"
export function createApp() {
   ///same code as currently, but in function
   app.use('/subject', createRouter());
}

现在，您可以在每个设置回调中创建新的“应用程序”：

// test.ts
beforeEach(async () => {
    sinon.stub(AuthMiddleware.prototype, 'verifyToken').callsFake((req: Request, res: Response, next: NextFunction): void => {
        ...
    });
    app = (await import('../../../src/app')).createApp(); // note that we create new app for each test, so you're not polutting global state of app
});

这种方法有许多优点，其中包括：

• 您可以为不同的测试模拟不同的函数；
• 您正在有效地从代码中删除“隐式单例”，这些代码的存在是您问题的根本原因。