fix(jest): Fix watchmode on api tests

[dac09]

...by loading scenarios in the same context as jest.

This unfortunately is a compromise, because the work I did to improve the memory usage of our scenario tests gets a little nullified now.

What is the change?

One of the memory optimisations I did was to make sure scenarios are loaded and seeded outside the context/VM that the tests run in. This seemed to really help with memory usage, but unfortunately breaks tests in watch mode, with a cryptic DB/Prisma error (on Postgres):

    ConnectorError(ConnectorError { user_facing_error: None, kind: QueryError(Error { kind: Db, cause: Some(DbError { severity: "ERROR", parsed_severity: Some(Error), code: SqlState(EXX000), message: "cache lookup failed for type 226432", detail: None, hint: None, position: None, where_: Some("unnamed portal parameter $3"), schema: None, table: None, column: None, datatype: None, constraint: None, file: Some("lsyscache.c"), line: Some(2904), routine: Some("getTypeBinaryInputInfo") }) }) })

This PR now puts back the scenario loading and seeding back in the same context, while keeping some of the other minor optimisations, as well as the tests that don't use scenarios being fast.

What do I do if my api side tests run out of memory on CI?

One of the things we can suggest is to use Jest 28+'s sharding.

e.g.

yarn rw test api --no-watch --shard 1/3
yarn rw test api --no-watch --shard 2/3
yarn rw test api --no-watch --shard 3/3

(adjust the number of shards as needed. 50 or so test-suites per shard is a good number!)

This will allow tests to run to completion

[dthyresson]

@dac09 Do you think we should add a tip in https://redwoodjs.com/docs/testing#jest with:

What do I do if my api side tests run out of memory on CI?

One of the things we can suggest is to use Jest 28+'s sharding.

e.g.

yarn rw test api --no-watch --shard 1/3
yarn rw test api --no-watch --shard 2/3
yarn rw test api --no-watch --shard 3/3

(adjust the number of shards as needed. 50 or so test-suites per shard is a good number!)

This will allow tests to run to completion.

Or words to that effect?

[dac09]

Sure - I just don’t know if that’s the right place to put it. Because it’s most likely something you see in CI.

[virtuoushub]

fwiw - I am seeing odd test errors that may or may not be related to this PR:

...
FAIL api api/src/services/comments/comments.test.js
  comments
    ✕ returns all comments for a single post from the database (5 ms)
    ✕ creates a new comment (6 ms)
    ✕ allows admins and moderators to delete a comment (4 ms)
    ✕ does not allow a non-moderator to delete a comment (4 ms)
    ✕ does not allow a logged out user to delete a comment (5 ms)

  ● comments › returns all comments for a single post from the database

    TypeError: Cannot redefine property: __RESOLVED_TMP_DIR__
        at Function.defineProperty (<anonymous>)

      at Object.get (node_modules/jest-environment-node/build/index.js:100:20)
      at Object.<anonymous> (node_modules/temp-write/node_modules/temp-dir/index.js:7:12)
      at Object.<anonymous> (node_modules/temp-write/index.js:8:17)
      at Object.<anonymous> (node_modules/@prisma/internals/dist/engine-commands/queryEngineCommons.js:44:33)
      at Object.<anonymous> (node_modules/@prisma/internals/dist/engine-commands/getConfig.js:43:33)
      at Object.<anonymous> (node_modules/@prisma/internals/dist/engine-commands/index.js:29:24)
      at Object.<anonymous> (node_modules/@prisma/internals/dist/index.js:120:25)
      at configureTeardown (node_modules/@redwoodjs/testing/config/jest/api/jest.setup.js:35:23)
      at Object.<anonymous> (node_modules/@redwoodjs/testing/config/jest/api/jest.setup.js:225:11)

  ● comments › returns all comments for a single post from the database

    TypeError: Cannot redefine property: __RESOLVED_TMP_DIR__
        at Function.defineProperty (<anonymous>)

      at Object.get (node_modules/jest-environment-node/build/index.js:100:20)
      at Object.<anonymous> (node_modules/temp-write/node_modules/temp-dir/index.js:7:12)
      at Object.<anonymous> (node_modules/temp-write/index.js:8:17)
      at Object.<anonymous> (node_modules/@prisma/internals/dist/engine-commands/queryEngineCommons.js:44:33)
      at Object.<anonymous> (node_modules/@prisma/internals/dist/engine-commands/getConfig.js:43:33)
      at Object.<anonymous> (node_modules/@prisma/internals/dist/engine-commands/index.js:29:24)
      at Object.<anonymous> (node_modules/@prisma/internals/dist/index.js:120:25)
      at getQuoteStyle (node_modules/@redwoodjs/testing/config/jest/api/jest.setup.js:60:42)
      at teardown (node_modules/@redwoodjs/testing/config/jest/api/jest.setup.js:139:28)
      at Object.<anonymous> (node_modules/@redwoodjs/testing/config/jest/api/jest.setup.js:237:11)
...

• chore(redwood): don't fail test teardown errors example-storybook#194

[virtuoushub]

fwiw, I think I can get around the errors I am seeing using try/catch (plz ignore formatting diffs due to ;):

redwoodjs/example-storybook#196