studio/flamenco
studio/flamenco
12
30
Fork 38
Code Issues 64 Pull Requests 5 Releases Wiki Activity

Manager: allow setup to finish without Blender #104306

Manually merged
Sybren A. Stüvel merged 34 commits from abelli/flamenco:issue100195 into main 2024-09-09 11:22:42 +02:00
Conversation 17 Commits 34 Files Changed 9 +8 -6
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 34d91a7797 - Show all commits

8
internal/manager/api_impl/meta.go
View File

@ -265,9 +265,11 @@ func (f *Flamenco) SaveSetupAssistantConfig(e echo.Context) error {
logger = logger.With().Interface("config", setupAssistantCfg).Logger() logger = logger.With().Interface("config", setupAssistantCfg).Logger()
if setupAssistantCfg.StorageLocation == "" || isConfigIncomplete := setupAssistantCfg.StorageLocation == "" ||
!setupAssistantCfg.BlenderExecutable.IsUsable || !setupAssistantCfg.BlenderExecutable.IsUsable ||
abelli marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2024-07-11 10:32:12 +02:00
Outdated
Review
Copy Link

The work cannot be done, and so this should be logged as an error, not a warning.

I usually log errors as a 'cause' field:

logger.Error().AnErr("cause", err).Msg("setup assistant: configuration is incomplete")

Alternatively, if you want to keep the error message as part of the log message, you could use .Msgf(...) instead:

logger.Error().Msgf("setup assistant: configuration is incomplete, %v", err)

%v is Go's generic "put the thing's value here", and should result in the value of err.Error().

The work cannot be done, and so this should be logged as an error, not a warning. I usually log errors as a 'cause' field: ```go logger.Error().AnErr("cause", err).Msg("setup assistant: configuration is incomplete") ``` Alternatively, if you want to keep the error message as part of the log message, you could use `.Msgf(...)` instead: ```go logger.Error().Msgf("setup assistant: configuration is incomplete, %v", err) ``` `%v` is Go's generic "put the thing's value here", and should result in the value of `err.Error()`.
setupAssistantCfg.BlenderExecutable.Path == "" { setupAssistantCfg.BlenderExecutable.Path == ""
abelli marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2024-07-11 10:32:44 +02:00
Outdated
Review
Copy Link

It's fine to include the actual error message in the response as well, so that the caller knows what's wrong without checking the Manager log.

It's fine to include the actual error message in the response as well, so that the caller knows what's wrong without checking the Manager log.
if isConfigIncomplete && setupAssistantCfg.BlenderExecutable.Source != "default" {
logger.Warn().Msg("setup assistant: configuration is incomplete, unable to accept") logger.Warn().Msg("setup assistant: configuration is incomplete, unable to accept")
return sendAPIError(e, http.StatusBadRequest, "configuration is incomplete") return sendAPIError(e, http.StatusBadRequest, "configuration is incomplete")
} }
@ -277,7 +279,7 @@ func (f *Flamenco) SaveSetupAssistantConfig(e echo.Context) error {
var executable string var executable string
switch setupAssistantCfg.BlenderExecutable.Source { switch setupAssistantCfg.BlenderExecutable.Source {
case api.BlenderPathSourceFileAssociation: case api.BlenderPathSourceFileAssociation, api.BlenderPathSourceDefault:
// The Worker will try to use the file association when the command is set // The Worker will try to use the file association when the command is set
// to the string "blender". // to the string "blender".
executable = "blender" executable = "blender"

6
web/app/src/views/SetupAssistantView.vue
View File

@ -355,11 +355,11 @@ export default {
}, },
blenderFromDefaultSource() { blenderFromDefaultSource() {
return { return {
input: 'blender', input: '',
path: 'blender', path: '',
source: 'default', source: 'default',
is_usable: true, is_usable: true,
cause: 'blender', cause: '',
}; };
}, },
setupConfirmIsClickable() { setupConfirmIsClickable() {