Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve installed.json handling in v2/tools #983

Merged
merged 5 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions tools/download.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import (

"github.com/arduino/arduino-create-agent/gen/tools"
"github.com/arduino/arduino-create-agent/utilities"
"github.com/arduino/arduino-create-agent/v2/pkgs"
)

// Download will parse the index at the indexURL for the tool to download.
Expand All @@ -45,8 +44,8 @@ import (
// if it already exists.
func (t *Tools) Download(pack, name, version, behaviour string) error {

tool := pkgs.New(t.index, t.directory.String(), behaviour)
_, err := tool.Install(context.Background(), &tools.ToolPayload{Name: name, Version: version, Packager: pack})
t.tools.SetBehaviour(behaviour)
_, err := t.tools.Install(context.Background(), &tools.ToolPayload{Name: name, Version: version, Packager: pack})
if err != nil {
return err
}
Expand Down
3 changes: 3 additions & 0 deletions tools/tools.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"sync"

"github.com/arduino/arduino-create-agent/index"
"github.com/arduino/arduino-create-agent/v2/pkgs"
"github.com/arduino/go-paths-helper"
"github.com/xrash/smetrics"
)
Expand All @@ -47,6 +48,7 @@ type Tools struct {
logger func(msg string)
installed map[string]string
mutex sync.RWMutex
tools *pkgs.Tools
}

// New will return a Tool object, allowing the caller to execute operations on it.
Expand All @@ -60,6 +62,7 @@ func New(directory *paths.Path, index *index.Resource, logger func(msg string))
logger: logger,
installed: map[string]string{},
mutex: sync.RWMutex{},
tools: pkgs.New(index, directory.String(), "replace"),
}
_ = t.readMap()
return t
Expand Down
76 changes: 36 additions & 40 deletions v2/pkgs/tools.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (
"path/filepath"
"runtime"
"strings"
"sync"

"github.com/arduino/arduino-create-agent/gen/tools"
"github.com/arduino/arduino-create-agent/index"
Expand Down Expand Up @@ -60,17 +61,23 @@ type Tools struct {
index *index.Resource
folder string
behaviour string
installed map[string]string
mutex sync.RWMutex
}

// New will return a Tool object, allowing the caller to execute operations on it.
// The New function will accept an index as parameter (used to download the indexes)
// and a folder used to download the indexes
func New(index *index.Resource, folder, behaviour string) *Tools {
return &Tools{
t := &Tools{
index: index,
folder: folder,
behaviour: behaviour,
installed: map[string]string{},
mutex: sync.RWMutex{},
}
t.readInstalled()
return t
}

// Installedhead is here only because it was required by the front-end.
Expand Down Expand Up @@ -181,13 +188,10 @@ func (t *Tools) Install(ctx context.Context, payload *tools.ToolPayload) (*tools
key := correctTool.Name + "-" + correctTool.Version
// Check if it already exists
if t.behaviour == "keep" && pathExists(t.folder) {
location, ok, err := checkInstalled(t.folder, key)
if err != nil {
return nil, err
}
location, ok := t.installed[key]
if ok && pathExists(location) {
// overwrite the default tool with this one
err := writeInstalled(t.folder, path)
err := t.writeInstalled(path)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -245,7 +249,7 @@ func (t *Tools) install(ctx context.Context, path, url, checksum string) (*tools
}

// Write installed.json for retrocompatibility with v1
err = writeInstalled(t.folder, path)
err = t.writeInstalled(path)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -285,61 +289,53 @@ func rename(base string) extract.Renamer {
}
}

func readInstalled(installedFile string) (map[string]string, error) {
func (t *Tools) readInstalled() error {
t.mutex.RLock()
defer t.mutex.RUnlock()
// read installed.json
installed := map[string]string{}
data, err := os.ReadFile(installedFile)
if err == nil {
err = json.Unmarshal(data, &installed)
if err != nil {
return nil, err
}
}
return installed, nil
}

func checkInstalled(folder, key string) (string, bool, error) {
installedFile, err := utilities.SafeJoin(folder, "installed.json")
if err != nil {
return "", false, err
}
installed, err := readInstalled(installedFile)
if err != nil {
return "", false, err
}
location, ok := installed[key]
return location, ok, err
}

func writeInstalled(folder, path string) error {
// read installed.json
installedFile, err := utilities.SafeJoin(folder, "installed.json")
installedFile, err := utilities.SafeJoin(t.folder, "installed.json")
if err != nil {
return err
}
installed, err := readInstalled(installedFile)
data, err := os.ReadFile(installedFile)
if err != nil {
return err
}
return json.Unmarshal(data, &t.installed)
}

func (t *Tools) writeInstalled(path string) error {
t.mutex.Lock()
defer t.mutex.Unlock()

parts := strings.Split(path, string(filepath.Separator))
tool := parts[len(parts)-2]
toolWithVersion := fmt.Sprint(tool, "-", parts[len(parts)-1])
toolFile, err := utilities.SafeJoin(folder, path)
toolFile, err := utilities.SafeJoin(t.folder, path)
if err != nil {
return err
}
installed[tool] = toolFile
installed[toolWithVersion] = toolFile
t.installed[tool] = toolFile
t.installed[toolWithVersion] = toolFile

data, err := json.Marshal(installed)
data, err := json.Marshal(t.installed)
if err != nil {
return err
}

installedFile, err := utilities.SafeJoin(t.folder, "installed.json")
if err != nil {
return err
}

return os.WriteFile(installedFile, data, 0644)
}

// SetBehaviour sets the download behaviour to either keep or replace
func (t *Tools) SetBehaviour(behaviour string) {
t.behaviour = behaviour
}

func pathExists(path string) bool {
_, err := os.Stat(path)
if err == nil {
Expand Down