codeceptjs / codeceptjs/CodeceptJS

`I.waitForFile` (FileSystem helper) fails if directory does not exist (yet)

Open
#5,420 1 comment 0 reactions 0 assignees View on GitHub
stale
Dominant language
JavaScript
Stars
4.2k
Forks
757
Avg merge
2d 9h
Merged PRs (30d)
16

Description

`I.waitForFile` sometimes fails and throws weird exceptions if the directory containing the expected file does not exist yet.

Example (all output goes to `${codecept_dir}/output/`):
```js
I.handleDownloads('downloads/example.txt');
I.click('button.download');
I.amInPath('output/downloads');
I.waitForFile('example.txt', 5);
```

If the directory `${codecept_dir}/output/downloads` does not exist yet (it will be created by the browser download at some point in time), the function `I.waitForFile` will throw an exception `ReferenceError: Cannot access 'watcher' before initialization` and the test will fail.

Root cause is in the function [`isFileExists`](https://github.com/codeceptjs/CodeceptJS/blob/3.x/lib/helper/FileSystem.js#L202-L227) of the `FileSystem` helper. The line `const watcher = fs.watch(dir, (eventType, filename) => {...` will throw if `dir` does not exist yet. This exception remains unhandled. Later, the timer for the 5sec timeout detection will try to close the uninitialized `watcher`, leading to the `ReferenceError`.

I will try to create a PR.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.