Skip to content

Refactored bundle tool initialization #1349

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 5, 2021
Merged

Refactored bundle tool initialization #1349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 2 additions & 8 deletions commands/bundled_tools_ctags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
semver "go.bug.st/relaxed-semver"
)

func loadBuiltinCtagsMetadata(pm *packagemanager.PackageManager) {
func getBuiltinCtagsTool(pm *packagemanager.PackageManager) *cores.ToolRelease {
builtinPackage := pm.Packages.GetOrCreatePackage("builtin")
ctagsTool := builtinPackage.GetOrCreateTool("ctags")
ctagsRel := ctagsTool.GetOrCreateRelease(semver.ParseRelaxed("5.8-arduino11"))
Expand Down Expand Up @@ -88,11 +88,5 @@ func loadBuiltinCtagsMetadata(pm *packagemanager.PackageManager) {
},
},
}
}

var ctagsVersion = semver.ParseRelaxed("5.8-arduino11")

func getBuiltinCtagsTool(pm *packagemanager.PackageManager) (*cores.ToolRelease, error) {
loadBuiltinCtagsMetadata(pm)
return pm.Package("builtin").Tool("ctags").Release(ctagsVersion).Get()
return ctagsRel
}
15 changes: 4 additions & 11 deletions commands/bundled_tools_serial_discovery.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,7 @@ func ListBoards(pm *packagemanager.PackageManager) ([]*discovery.Port, error) {
defer listBoardMutex.Unlock()

// get the bundled tool
t, err := getBuiltinSerialDiscoveryTool(pm)
if err != nil {
return nil, err
}
t := getBuiltinSerialDiscoveryTool(pm)

// determine if it's installed
if !t.IsInstalled() {
Expand Down Expand Up @@ -146,11 +143,7 @@ func ListBoards(pm *packagemanager.PackageManager) ([]*discovery.Port, error) {

// WatchListBoards returns a channel that receives events from the bundled discovery tool
func WatchListBoards(pm *packagemanager.PackageManager) (<-chan *discovery.Event, error) {
t, err := getBuiltinSerialDiscoveryTool(pm)
if err != nil {
return nil, err
}

t := getBuiltinSerialDiscoveryTool(pm)
if !t.IsInstalled() {
return nil, fmt.Errorf("missing serial-discovery tool")
}
Expand All @@ -175,10 +168,10 @@ func WatchListBoards(pm *packagemanager.PackageManager) (<-chan *discovery.Event
return disc.EventChannel(10), nil
}

func getBuiltinSerialDiscoveryTool(pm *packagemanager.PackageManager) (*cores.ToolRelease, error) {
func getBuiltinSerialDiscoveryTool(pm *packagemanager.PackageManager) *cores.ToolRelease {
builtinPackage := pm.Packages.GetOrCreatePackage("builtin")
serialDiscoveryTool := builtinPackage.GetOrCreateTool("serial-discovery")
serialDiscoveryToolRel := serialDiscoveryTool.GetOrCreateRelease(serialDiscoveryVersion)
serialDiscoveryToolRel.Flavors = serialDiscoveryFlavors
return pm.Package("builtin").Tool("serial-discovery").Release(serialDiscoveryVersion).Get()
return serialDiscoveryToolRel
}
29 changes: 5 additions & 24 deletions commands/instances.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,8 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) *sta
// If this is not done the information of the uninstall core is kept in memory,
// even if it should not.
instance.PackageManager.Clear()
ctagsTool := getBuiltinCtagsTool(instance.PackageManager)
serialDiscoveryTool := getBuiltinSerialDiscoveryTool(instance.PackageManager)

// Load Platforms
urls := []string{globals.DefaultIndexURL}
Expand Down Expand Up @@ -254,48 +256,27 @@ func Init(req *rpc.InitRequest, responseCallback func(r *rpc.InitResponse)) *sta
}

// Install tools if necessary
toolHasBeenInstalled := false
ctagsTool, err := getBuiltinCtagsTool(instance.PackageManager)
ctagsHasBeenInstalled, err := instance.installToolIfMissing(ctagsTool, downloadCallback, taskCallback)
if err != nil {
s := status.Newf(codes.Internal, err.Error())
responseCallback(&rpc.InitResponse{
Message: &rpc.InitResponse_Error{
Error: s.Proto(),
},
})
} else {
toolHasBeenInstalled, err = instance.installToolIfMissing(ctagsTool, downloadCallback, taskCallback)
if err != nil {
s := status.Newf(codes.Internal, err.Error())
responseCallback(&rpc.InitResponse{
Message: &rpc.InitResponse_Error{
Error: s.Proto(),
},
})
}
}

serialDiscoveryTool, _ := getBuiltinSerialDiscoveryTool(instance.PackageManager)
serialHasBeenInstalled, err := instance.installToolIfMissing(serialDiscoveryTool, downloadCallback, taskCallback)
if err != nil {
s := status.Newf(codes.Internal, err.Error())
responseCallback(&rpc.InitResponse{
Message: &rpc.InitResponse_Error{
Error: s.Proto(),
},
})
} else {
toolHasBeenInstalled, err = instance.installToolIfMissing(serialDiscoveryTool, downloadCallback, taskCallback)
if err != nil {
s := status.Newf(codes.Internal, err.Error())
responseCallback(&rpc.InitResponse{
Message: &rpc.InitResponse_Error{
Error: s.Proto(),
},
})
}
}

if toolHasBeenInstalled {
if ctagsHasBeenInstalled || serialHasBeenInstalled {
// We installed at least one new tool after loading hardware
// so we must reload again otherwise we would never found them.
for _, err := range instance.PackageManager.LoadHardware() {
Expand Down