drsybren/Flamenco
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Shaman: log a warning on platforms that don't reliably support symlinks

Browse Source 
Windows 10 Home does not support symlinks, and Shaman will cause errors
unless running as admin (which is not recommended for security reasons).
Now Flamenco Manager will log a warning when Shaman is enabled on this
platform.
This commit is contained in:
Sybren A. Stüvel 2023-10-15 14:37:15 +02:00
parent d60af809be
commit 40f76efec9
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
pkg/shaman/server.go
View File

@ -25,6 +25,7 @@ package shaman
import (
"context"
"io"
"runtime"
"sync"
"github.com/rs/zerolog/log"
@ -34,6 +35,7 @@ import (
"projects.blender.org/studio/flamenco/pkg/shaman/fileserver"
"projects.blender.org/studio/flamenco/pkg/shaman/filestore"
"projects.blender.org/studio/flamenco/pkg/shaman/jwtauth"
"projects.blender.org/studio/flamenco/pkg/sysinfo"
)
var ErrDoesNotExist = checkout.ErrDoesNotExist
@ -58,6 +60,8 @@ func NewServer(conf config.Config, auther jwtauth.Authenticator) *Server {
return nil
}
checkPlatformSymlinkSupport()
if conf.StoragePath == "" {
log.Error().Interface("config", conf).Msg("shaman: no checkout path configured, unable to start")
return nil
@ -81,6 +85,33 @@ func NewServer(conf config.Config, auther jwtauth.Authenticator) *Server {
return shamanServer
}
func checkPlatformSymlinkSupport() {
canSymlink, err := sysinfo.CanSymlink()
switch {
case err != nil:
log.Warn().AnErr("cause", err).
Msg("unable to determine whether this platform can use symlinks. " +
"Please report a bug about this: https://flamenco.blender.org/development/get-involved/")
return
case canSymlink:
return
}
osDetail, err := sysinfo.Description()
if err != nil {
log.Warn().AnErr("cause", err).
Msg("unable to find details of your operating system. " +
"Please report a bug about this: https://flamenco.blender.org/development/get-involved/")
return
}
log.Warn().
Str("os", runtime.GOOS).
Str("arch", runtime.GOARCH).
Str("osDetail", osDetail).
Msg("this platform does not reliably support symbolic links; using the Shaman system is not recommended")
}
// Go starts goroutines for background operations.
// After Go() has been called, use Close() to stop those goroutines.
func (s *Server) Go() {