AppSignal shows a scary-looking error on Windows

[unflxw]

AppSignal should print an error message when on Windows, warning the user that AppSignal is not running -- but it should not look like it crashed. The error seen here about the install report, while not really a crash in itself, could be mistaken for one.

The error is also shown when AppSignal is not active -- in that case, loading the extension is not necessary, so we shouldn't show any error if active is set to false.

[appsignal][ERROR] Unable to fetch install report: Error: ENOENT: no such file or directory, open 'C:\[REDACTED]\node_modules\@appsignal\nodejs\ext\install.report'
at Object.openSync (node:fs:590:3)
at Object.readFileSync (node:fs:458:35)
at fetchInstalledArch (C:\[REDACTED]\node_modules\@appsignal\nodejs\dist\extension_wrapper.js:8:40)
at Object.<anonymous> (C:\[REDACTED]\node_modules\@appsignal\nodejs\dist\extension_wrapper.js:22:42)
at Module._compile (node:internal/modules/cjs/loader:1165:14)
at Object.Module._extensions..js (node:internal/modules/cjs/loader:1219:10)
at Module.load (node:internal/modules/cjs/loader:1043:32)
at Function.Module._load (node:internal/modules/cjs/loader:878:12)
at Module.require (node:internal/modules/cjs/loader:1067:19)
at require (node:internal/modules/cjs/helpers:103:18) {
errno: -4058,
syscall: 'open',
code: 'ENOENT',
path: 'C:\\[REDACTED]\\node_modules\\@appsignal\\nodejs\\ext\\install.report'
}
[appsignal][ERROR] The AppSignal extension was installed for architecture 'unknown-unknown', but the current architecture is 'x64-win32'. Please reinstall the AppSignal package on the host the app is started.

Intercom conversation: https://app.intercom.com/a/inbox/yzor8gyw/inbox/admin/5246522/conversation/16410700272393#part_id=comment-16410700272393-21909540524

[backlog-helper]

✔️ All good!

New issue guide | Backlog management | Rules | Feedback

[shairyar]

https://app.intercom.com/a/inbox/yzor8gyw/inbox/admin/4356044/conversation/16410700286195 (private link)

[Tobivaria]

So does AppSignal not work with windows npm and workspaces?
This is what I get

[appsignal][ERROR] Unable to fetch install report: Error: ENOENT: no such file or directory, open 'C:\mypersonalpath\node_modules\@appsignal\nodejs\ext\install.report'
    at Object.readFileSync (node:fs:442:20)
    at fetchInstalledArch (C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\extension_wrapper.js:8:40)
    at Object.logLoadingErrors (C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\extension_wrapper.js:44:54)
    at Extension.logLoadingErrors (C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\extension.js:57:39)
    at new Client (C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\client.js:141:28)
    at Object.<anonymous> (C:\mypersonalpath\apps\backend\appsignal.cjs:15:19)
    at Module._compile (node:internal/modules/cjs/loader:1730:14)
    at node:internal/modules/cjs/loader:1895:10
    at Object.require.extensions.<computed> [as .js] (C:\mypersonalpath\node_modules\ts-node\src\index.ts:1608:43)
    at Module.load (node:internal/modules/cjs/loader:1465:32) {
  errno: -4058,
  code: 'ENOENT',
  syscall: 'open',
  path: 'C:\\mypersonalpath\\node_modules\\@appsignal\\nodejs\\ext\\install.report'
}
[appsignal][ERROR] AppSignal failed to load the extension. Please run the diagnose tool and email us at support@appsignal.com: https://docs.appsignal.com/nodejs/3.x/command-line/diagnose.html
 Error: Cannot find module '../build/Release/extension.node'
Require stack:
- C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\extension_wrapper.js
- C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\extension.js  
- C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\client.js     
- C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\index.js      
- C:\mypersonalpath\apps\backend\appsignal.cjs
- internal/preload
    at Function.<anonymous> (node:internal/modules/cjs/loader:1401:15)      
    at Function.Module._resolveFilename.sharedData.moduleResolveFilenameHook.installedValue [as _resolveFilename] (C:\mypersonalpath\node_modules\@cspotcode\source-map-support\source-map-support.js:811:30)
    at defaultResolveImpl (node:internal/modules/cjs/loader:1057:19)        
    at resolveForCJSWithHooks (node:internal/modules/cjs/loader:1062:22)    
    at Function._load (node:internal/modules/cjs/loader:1211:37)
    at TracingChannel.traceSync (node:diagnostics_channel:322:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:235:24)
    at Module.require (node:internal/modules/cjs/loader:1487:12)
    at require (node:internal/modules/helpers:135:16)
    at Object.<anonymous> (C:\mypersonalpath\node_modules\@appsignal\nodejs\dist\extension_wrapper.js:18:11) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    'C:\\mypersonalpath\\node_modules\\@appsignal\\nodejs\\dist\\extension_wrapper.js',
    'C:\\mypersonalpath\\node_modules\\@appsignal\\nodejs\\dist\\extension.js',
    'C:\\mypersonalpath\\node_modules\\@appsignal\\nodejs\\dist\\client.js',
    'C:\\mypersonalpath\\node_modules\\@appsignal\\nodejs\\dist\\index.js',
    'C:\\mypersonalpath\\apps\\backend\\appsignal.cjs',
    'internal/preload'
  ]
}
AppSignal not starting: extension failed to load

The diagnose tool also just dies

🔭 Checking for @appsignal/nodejs...
✅ Found it! (at C:\\mypersonalpath)
Something went wrong when executing the diagnose report:
Error: spawnSync C:\\mypersonalpath/node_modules/@appsignal/nodejs/bin/diagnose ENOENT
    at Object.spawnSync (node:internal/child_process:1120:20)
    at spawnSync (node:child_process:868:24)

[tombruijn]

Hi @Tobivaria, are you running the package on Windows directly? If so, it won't work as we don't support Windows. But if you use WSL (Windows Subsystem for Linux) you may have more luck getting it running.