带有 Jest 的打字稿 - “ReferenceError：未定义 beforeAll”

Posted 2023-03-30

【中文标题】带有 Jest 的打字稿 - “ReferenceError：未定义 beforeAll”

【英文标题】：Typescript with Jest - "ReferenceError: beforeAll is not defined"

【发布时间】：2021-05-09 09:10:46

【问题描述】：

所以我有一个正在使用的项目：

打字稿 类型ORM Type-graphql 开玩笑

在我开始编写测试之前，它一直运行良好。测试文件位于每个实体文件夹中。例如：

  Student
  |- Student.ts
  |- Student.test.ts
  |- StudentService.ts

当我运行 Jest 来执行我的测试时，一切都很好并且按预期工作。但是，如果我运行nodemon --exec ts-node src/index.ts，我会收到第一个与 Jest 相关的函数的错误，无论是 beforeAll()、afterAll()、describe()...

我的 tsconfig.json 是：

  "compilerOptions": 
    "target": "es6",
    "module": "commonjs",
    "lib": ["dom", "es6", "es2017", "esnext.asynciterable"],
    "sourceMap": true,
    "outDir": "./dist",
    "moduleResolution": "node",

    "types": ["jest", "node"],

    "removeComments": true,
    "noImplicitAny": true,
    "strictNullChecks": true,
    "strictFunctionTypes": true,
    "noImplicitThis": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true,
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true
  ,
  "include": ["**/*.ts"],
  "exclude": ["node_modules", "**/*.test.ts", "**/*.spec.ts"]

我的 jest.config.js 是：

module.exports = 
  preset: "ts-jest",
  testEnvironment: "node",
  roots: ["./src"],
  testMatch: [
    "**/__tests__/**/*.+(ts|tsx|js)",
    "**/?(*.)+(spec|test).+(ts|tsx|js)",
  ],
  transform: 
    "^.+\\.(ts|tsx)$": "ts-jest",
  ,
;

据我所知，typescript 正在尝试编译我的测试文件，即使它们被设置为在 tsconfig 中排除。

更多可能有用的信息： 我有 jest、ts-jest 和 @types/jest 作为开发依赖项。 我只有一个 tsconfig.json 文件和一个 jest.config.js

知道如何解决这个问题吗？

更新 1

我忘记发布其中一个测试文件，虽然我不认为它与问题有关或者是我的问题的原因......

import  createTestConnection  from "../../test/createTestConnection";
import  graphqlCall  from "../../test/graphqlCall";
import  Connection  from "typeorm";

let conn: Connection;

beforeAll(async () => 
  console.log("Test started");

  conn = await createTestConnection(true);
);

afterAll(() => 
  conn.close();
);

const addStudentWithoutGuardian = `
  mutation addStudentWithoutGuardian($studentInput: StudentInput!) 
  addStudent(studentInput: $studentInput) 
    id
  

`;

describe("Student", () => 
  it("create only with basic information", async () => 
    console.log(
      await graphqlCall(
        source: addStudentWithoutGuardian,
        variableValues: 
          studentInput: 
            firstName: "Harry",
            lastName: "Smith",
            dateOfBirth: "1997-01-30",
            pronoun: 0,
            gender: 0,
            phone: "1231231234",
            email: "[e-mail]",
            addressLine1: "123 Avenue",
            city: "Toronto",
            state: "Ontario",
            postalCode: "X1X1X1",
            gradeLevel: "grade level",
          ,
        ,
      )
    );
  );
);

更新 2

错误堆栈

$ nodemon --exec ts-node src/index.ts
[nodemon] 2.0.7
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: ts,json      
[nodemon] starting `ts-node src/index.ts`   
(node:11716) UnhandledPromiseRejectionWarning: ReferenceError: beforeAll is not defined
    at Object.<anonymous> (G:\Documents\repos\tms\server\src\model\Student\Student.test.ts:7:1)
    at Module._compile (internal/modules/cjs/loader.js:1063:30)
    at Module.m._compile (G:\Documents\repos\tms\server\node_modules\ts-node\src\index.ts:1056:23)
    at Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
    at Object.require.extensions.<computed> [as .ts] (G:\Documents\repos\tms\server\node_modules\ts-node\src\index.ts:1059:12)
    at Module.load (internal/modules/cjs/loader.js:928:32)
    at Function.Module._load (internal/modules/cjs/loader.js:769:14)
    at Module.require (internal/modules/cjs/loader.js:952:19)
    at require (internal/modules/cjs/helpers.js:88:18)
    at G:\Documents\repos\tms\server\src\util\DirectoryExportedClassesLoader.ts:41:22
(Use `node --trace-warnings ...` to show where the warning was created)
(node:11716) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:11716) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
[nodemon] clean exit - waiting for changes before restart

更新 3

我的 index.ts

import "reflect-metadata";
import  createConnection  from "typeorm";
import express from "express";
import  ApolloServer  from "apollo-server-express";
import cors from "cors";
import  createSchema  from "./utils/createSchema";

(async () => 
  const app = express();

  app.use(
    cors(
      origin: ["http://localhost:3000"],
      credentials: true,
    )
  );

  await createConnection();

  const apolloServer = new ApolloServer(
    schema: await createSchema(),
    context: ( req, res ) => ( req, res ),
  );

  apolloServer.applyMiddleware( app, cors: false );

  app.listen(4000, () => 
    console.log("Express server started");
  );
)();

更新 4

我的依赖项和开发依赖项

"dependencies": 
    "apollo-server-express": "^2.19.2",
    "class-validator": "^0.13.1",
    "cors": "^2.8.5",
    "dotenv": "^8.2.0",
    "express": "^4.17.1",
    "faker": "^5.2.0",
    "graphql": "^15.4.0",
    "pg": "^8.5.1",
    "reflect-metadata": "^0.1.13",
    "type-graphql": "^1.1.1",
    "typeorm": "^0.2.30",
    "typeorm-seeding": "^1.6.1"
  ,
  "devDependencies": 
    "@types/express": "^4.17.11",
    "@types/faker": "^5.1.6",
    "@types/jest": "^26.0.20",
    "@types/node": "^14.14.21",
    "jest": "^26.6.3",
    "nodemon": "^2.0.7",
    "ts-jest": "^26.5.0",
    "ts-node": "^9.1.1",
    "typescript": "^4.1.3"
  ,

【问题讨论】：

提供更多错误详细信息，例如错误堆栈跟踪。

刚刚添加了错误堆栈跟踪@hoangdv。谢谢。

看起来index.ts文件导入了.test.ts文件。

最初，这就是我的想法，或者我可能不小心将它导入到其他地方，但我已经对任何意外导入进行了三次检查，一切似乎都很好。 @hoangdv

另外，如果我简单地删除文件，项目就会再次开始运行。我想如果我将 student.test.ts 导入其他地方我会收到一些错误，因为该文件不再存在......

【参考方案1】：

对于任何试图获得 globalSetup 以在 Jest 中工作并获得 ReferenceError: beforeAll is not defined - 我会为你节省几个小时用头撞桌子的时间：

定义您的安装文件 - jest.setup.ts 使用 setupFilesAfterEnv 属性。即setupFilesAfterEnv: ['./jest.setup.ts']

Jest 全局变量在setupFiles 或globalSetup 中不可用

【讨论】：

这行得通，但是，我收到一条错误消息Your test suite must contain at least one test.

@yesyouken 将测试添加到您的空测试文件中。

问题是这个空测试在所有测试之前运行。不是特别有效。

【参考方案2】：

所以我只是想通了......这真的很傻......

ormconfig.json 有一个扫描所有实体的路径，如下所示：

"entities": ["src/model/**/*.ts"],

我不得不改成：

"entities": ["src/model/**/!(*.test.ts)"],

这就是为什么我的一些测试文件被加载，然后抛出与未找到 Jest 函数相关的错误的原因。

我在搜索以类似 tsconfig.json 的方式排除某些文件的方法后找到了这个解决方案，但是，TypeORM 没有排除参数，因此必须像上面那样完成。

Github issue with the suggestion

感谢大家的帮助。

【讨论】：

我曾想过为什么beforeAll 在你的代码中运行））miss something 关于它，但我不确定

【参考方案3】：

检查package.json 是否具有所有依赖项：

  "name": "ts_test",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT",
  "devDependencies": 
    "jest": "^26.6.3",
    "ts-jest": "^26.5.0",
    "ts-node": "^9.1.1",
    "typescript": "^4.1.3"
  

我和你一起运行配置：yarn jest 它有效。

 PASS  src/sum.test.ts
  ✓ adds 1 + 2 to equal 3 (4 ms)

  console.log
    Test started

      at src/sum.test.ts:4:11

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        4.023 s
Ran all test suites.
Done in 5.06s.

sum.test.ts

import sum from './sum';

beforeAll(async () => 
  console.log("Test started");
);

test('adds 1 + 2 to equal 3', () => 
  expect(sum(1, 2)).toBe(3);
);

sum.ts

function sum(x:number, y:number):number 
  return x + y;


export default sum

使用 nodemon 运行

yarn nodemon --exec ts-node src/sum.ts
yarn run v1.22.4
$ /home/.../ts_test/node_modules/.bin/nodemon --exec ts-node src/sum.ts
[nodemon] 2.0.7
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: ts,json
[nodemon] starting `ts-node src/sum.ts`
[nodemon] clean exit - waiting for changes before restart

【讨论】：

嘿，所以我的问题不是运行 jest，jest 运行得非常好，但是当我尝试使用 nodemon --exec ts-node src/index.ts 运行项目时，我得到所有与 jest 相关的函数的错误，例如“beforeAll” 、“毕竟”、“描述”或以先到者为准。我还在问题中添加了我的依赖项和 devDependencies。

它认为它也有效，我将输出附加到答案

如果你想把你的项目的一部分与这个错误放到 github 上，因为我可能会错过一些东西