rouggy
660653ce14
The data folder is created and stays empty, the process keeps running, and no window appears. Nothing returns, so nothing is logged: WebView2 never hands control back, and a hang has no error to report. So the ABSENCE of progress is reported. If OnStartup has not been reached twelve seconds after wails.Run, that is written to the startup log and shown in a message box naming the two causes — a missing WebView2 runtime and an antivirus blocking msedgewebview2.exe — because 'OpsLog is not responding' otherwise sends people to reinstall OpsLog, which is the one thing that cannot help: the part that has not started is not ours.
112 lines
4.0 KiB
Go
112 lines
4.0 KiB
Go
package main
|
|
|
|
// The first breadcrumbs, written before anything else can fail.
|
|
//
|
|
// OpsLog keeps its log in the data folder, which lives beside the executable —
|
|
// so every fault that happens BEFORE that folder exists is invisible. Reported
|
|
// from a Windows 10 machine: "the process appears, no data folder is created,
|
|
// nothing starts", with no file anywhere to say why. There was nothing to read
|
|
// because the only place we write to had not been created yet.
|
|
//
|
|
// This writes to %LOCALAPPDATA%\OpsLog\startup.log instead: a folder Windows
|
|
// guarantees is writable for the user, whatever OpsLog itself was installed
|
|
// into. It records the handful of milestones between the process starting and
|
|
// the window appearing, and nothing else — it is not a second log, it is the
|
|
// answer to "it does not start".
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"sync/atomic"
|
|
"time"
|
|
)
|
|
|
|
// bootLogPath is the file, or "" when even LOCALAPPDATA is unavailable.
|
|
func bootLogPath() string {
|
|
dir := os.Getenv("LOCALAPPDATA")
|
|
if strings.TrimSpace(dir) == "" {
|
|
dir = os.TempDir()
|
|
}
|
|
if dir == "" {
|
|
return ""
|
|
}
|
|
dir = filepath.Join(dir, "OpsLog")
|
|
if err := os.MkdirAll(dir, 0o755); err != nil {
|
|
return ""
|
|
}
|
|
return filepath.Join(dir, "startup.log")
|
|
}
|
|
|
|
// bootLog appends one line. Never fails loudly: it exists to explain a failure,
|
|
// so it must not become one.
|
|
func bootLog(format string, args ...any) {
|
|
p := bootLogPath()
|
|
if p == "" {
|
|
return
|
|
}
|
|
f, err := os.OpenFile(p, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o644)
|
|
if err != nil {
|
|
return
|
|
}
|
|
defer f.Close()
|
|
// Trimmed when it gets long. A startup log that grows for two years is a
|
|
// file nobody opens, and the interesting launch is always the last one.
|
|
if fi, err := f.Stat(); err == nil && fi.Size() > 256*1024 {
|
|
f.Close()
|
|
_ = os.Remove(p)
|
|
f, err = os.OpenFile(p, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o644)
|
|
if err != nil {
|
|
return
|
|
}
|
|
defer f.Close()
|
|
}
|
|
fmt.Fprintf(f, "%s %s\n", time.Now().Format("2006-01-02 15:04:05.000"), fmt.Sprintf(format, args...))
|
|
}
|
|
|
|
// bootLogLaunch records what was launched and from where.
|
|
func bootLogLaunch() {
|
|
exe, _ := os.Executable()
|
|
bootLog("launch: %s %v", exe, os.Args[1:])
|
|
}
|
|
|
|
// checkDataDirWritable makes sure the folder OpsLog keeps everything in can
|
|
// actually be created and written to, and says exactly what failed if not.
|
|
//
|
|
// The data folder sits beside the executable, which is fine on a stick or in a
|
|
// home directory and refused outright under Program Files — where Windows
|
|
// silently denies the write to anything not elevated. That refusal used to end
|
|
// the launch with no window and no message.
|
|
func checkDataDirWritable() error {
|
|
dir, err := userDataDir()
|
|
if err != nil {
|
|
return fmt.Errorf("cannot work out where to keep the data: %w", err)
|
|
}
|
|
if err := os.MkdirAll(dir, 0o755); err != nil {
|
|
return fmt.Errorf("cannot create the data folder %s: %w", dir, err)
|
|
}
|
|
probe := filepath.Join(dir, ".writetest")
|
|
if err := os.WriteFile(probe, []byte("ok"), 0o644); err != nil {
|
|
return fmt.Errorf("the data folder %s cannot be written to: %w", dir, err)
|
|
}
|
|
_ = os.Remove(probe)
|
|
bootLog("data dir ok: %s", dir)
|
|
return nil
|
|
}
|
|
|
|
// startupReached flips as soon as OnStartup runs — the first moment OpsLog's
|
|
// own code is executing inside the window's lifecycle.
|
|
var startupReached atomic.Bool
|
|
|
|
// startupStuckMessage is what an operator sees when the window never starts.
|
|
//
|
|
// It names the two causes and what to do about each, because "OpsLog is not
|
|
// responding" sends people to reinstall OpsLog, which is the one thing that
|
|
// cannot help: the part that has not started is not ours.
|
|
const startupStuckMessage = "OpsLog started but its window never opened.\n\n" +
|
|
"This is the WebView2 runtime failing to start, and it is almost always one of two things:\n\n" +
|
|
"• The Microsoft Edge WebView2 Runtime is missing — install it from Microsoft, then start OpsLog again.\n" +
|
|
"• An antivirus is blocking msedgewebview2.exe — add OpsLog's folder to its exceptions.\n\n" +
|
|
"The details are in the OpsLog folder under LOCALAPPDATA (startup.log)."
|