Flaky Tests Hub

Description

This is a space dedicated to tracking known flaky tests and systematically resolving them.

[!NOTE]

1. Pick one, create issue if it doesn't exist and reference here via related issue
2. After your issue's related PR has been merged and related issue is closed on a good note. click the checkmark!

Flaky Tests

• [skipped] "synchronously create a placeholder before generating the docs"
  Reason[1]: Promise functions start resolving as soon as they've been called. await doesn't tell a promise to start resolving but rather blocks execution only in the scope of its async function.
  Reason[2]: A placeholder is supposed to be generated quickly before the promise is resolved. Here, we're trying to test in between the time the placeholder is generator and when the promise with the actual data is resolved. Since there's no good mechanism to test in-between promise call and resolution, it makes this test very flaky. Hence, an error is thrown when the placeholder doesn't exist but we try doing JSON.parse(readFileSync(path, 'utf8'));
  https://github.com/OpenFn/kit/blob/7554a34c009eb722c9e38ead837096e3e249db31/packages/cli/test/docgen/handler.test.ts#L137-L157
  Related Issue: no issue created

• "allow a job to complete after receiving a sigterm"
  Reason: workerProcess.kill('SIGTERM') doesn't kill a process exactly after it has been called. It's async and may take some time to actually kill the process. Hence at times, the job gets processed before, other times not depending on computer resource available.
  https://github.com/OpenFn/kit/blob/535da76adb5ad8b64f095a05804816cdb2da5d84/integration-tests/worker/test/server.test.ts#L98-L145
  SKIPPED

• There's something failing intermittently in integration tests Log
  I think it's this?

integration-tests/worker test: [worker] ✘ 29bbf427-4414-47d4-9901-b5f79aa092cc failed to send run:complete event. This run will be lost!
integration-tests/worker test: [worker] ✘ Unexpected keys: timestamp

Start by reviewing the linked sections of packages/cli/test/docgen/handler.test.ts and integration-tests/worker/test/server.test.ts, then inspect the CircleCI log for the intermittent worker failure. Confirm which entries remain actionable and reproduce the relevant flaky test; done means the selected flake is resolved or documented and the hub is updated after its related issue and PR are complete.