Skip to content

Commit e63e711

Browse files
committed
docs(error-warning-details): update missing errors to have description
1 parent e9dd68f commit e63e711

File tree

1 file changed

+80
-11
lines changed

1 file changed

+80
-11
lines changed

docs/guides/error-warning-details.md

Lines changed: 80 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,47 +43,116 @@ This Error gets thrown when this package runs on an unsupported architecture by
4343

4444
## UnknownPlatformError
4545

46-
*extend documentation*
46+
Example: `Unknown Platform: "${platform}"`
47+
48+
Details:
49+
The Platform `${platform}` is not supported, only supported platform currently are:
50+
51+
- `osx`
52+
- `win32` / `windows`
53+
- `linux`
4754

4855
## WaitForPrimaryTimeoutError
4956

50-
*extend documentation*
57+
Example: `Timed out after ${timeout}ms while waiting for a Primary (where: "${where}")`
58+
59+
Details:
60+
Waiting for a Primary has timedout, this originates from 4 common issues:
61+
62+
- Starting instances failed
63+
- A even number of instances started and are unable to elect a Primary
64+
- Internal Problem
65+
- Target System is too slow to start the number of instances
66+
67+
Default Timeout: `1000 * 30` (30 seconds)
5168

5269
## EnsureInstanceError
5370

54-
*extend documentation*
71+
Example:
72+
73+
- `${baseMesasge} state was "running" but "instanceInfo" was undefined!`
74+
- `${baseMesasge} "instanceInfo" was undefined after running "start"`
75+
76+
Details:
77+
78+
- First Error Message gets thrown when `ensureInstance` is called and the `state` is `running`, but somehow `instanceInfo` is `undefined`
79+
- Second Error Message gets thrown when `ensureInstance` is called and after `start` was called by `ensureInstance` and `instanceInfo` is still `undefined`
80+
81+
In any case this Error gets thrown, it means that some internal problem happened that was not handled with another Error, please report if your get this error and did not mock anything.
82+
83+
Also see [`InstanceInfoError`](#instanceinfoerror).
5584

5685
## NoSystemBinaryFoundError
5786

58-
*extend documentation*
87+
Example: `Config option "SYSTEM_BINARY" was provided with value "${binaryPath}", but no binary could be found!`
88+
89+
Details:
90+
Config Options [`SYSTEM_BINARY`](../api/config-options#system_binary) was set, but no binary could be found at the path `${binaryPath}`.
91+
Likely causes are:
92+
93+
- No Binary Exists at the specified path
94+
- The Binary is does not have the necessary permissions and is so ignored (required permissions are `fs.constants.X_OK` (`--x`))
95+
96+
Also see:
97+
98+
- [`InsufficientPermissionsError`](#insufficientpermissionserror)
99+
- [`BinaryNotFoundError`](#binarynotfounderror)
59100

60101
## Md5CheckFailedError
61102

62-
*extend documentation*
103+
Example: `MD5 check failed! Binary MD5 is "${binarymd5}", Checkfile MD5 is "${checkfilemd5}"`
104+
105+
Details:
106+
Download MD5 check was enabled ([`MD5_CHECK`](../api/config-options#md5_check)) but failed, listing the local file md5 as `${binarymd5}` and the downloaded md5 as `${checkfilemd5}`
63107

64108
## StartBinaryFailedError
65109

66-
*extend documentation*
110+
Example: `Starting the Binary Failed (PID is undefined)! Binary: "${binary}"`
111+
112+
Details:
113+
Trying to start the binary `${binary}` as a childprocess somehow failed by having property `pid` being `undefined`.
114+
115+
Enable [Debug Mode](./enable-debug-mode) for more information.
67116

68117
## InstanceInfoError
69118

70-
*extend documentation*
119+
Example: `"instanceInfo" was undefined when expected to be defined! (where: "${where}")`
120+
121+
Details:
122+
`instanceInfo` was `undefined` when it was expected to have been defined previously. Please Report if this error gets thrown.
123+
124+
Enable [Debug Mode](./enable-debug-mode) for more information.
71125

72126
## KeyFileMissingError
73127

74-
*extend documentation*
128+
Example: `"keyfileLocation" was undefined when expected!`
129+
130+
Details:
131+
Option `keyfileLocation` was `undefined` when it was needed. This Options is required when starting a `MongoInstance` and option `replSet` and `auth` are set.
75132

76133
## AuthNotObjectError
77134

78-
*extend documentation*
135+
Example: `"auth" was not a object when it was expected!`
136+
137+
Details:
138+
Property `auth` was expect to be of type `object` (transform happens in the setter for `replSetOpts`). Please Report if this error gets thrown.
79139

80140
## InsufficientPermissionsError
81141

82-
*extend documentation*
142+
Example: `File "${path}" does not have the required Permissions, required Permissions: "--x"`
143+
144+
Details:
145+
Binary Check was conducted and found that the specified file `${path}` exists, but does not have the required permissions, required permissions are `fs.constants.X_OK` (`--x`).
83146

84147
## BinaryNotFoundError
85148

86-
*extend documentation*
149+
Example: `No Binary at path "${path}" was found! (ENOENT)`
150+
151+
Details:
152+
Binary Check was conducted and found that the specified file `${path}` did not exist (`ENOENT`), this may be a result of:
153+
154+
- The Binary Download failed without throwing another Error
155+
- The Path generation had a problem
87156

88157
## AssertionFallbackError
89158

0 commit comments

Comments
 (0)