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.

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

fix(updater): Do Update in place for windows service #605

Merged
merged 2 commits into from
Aug 3, 2022
Merged

fix(updater): Do Update in place for windows service #605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2867273
do Update in place for windows service
BinaryFissionGames Aug 1, 2022
45e0614
add a few comments
BinaryFissionGames Aug 1, 2022
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
107 changes: 28 additions & 79 deletions updater/internal/service/service_windows.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ package service
import (
"encoding/json"
"fmt"
"log"
"os"
"path/filepath"
"strings"
"time"

"go.uber.org/zap"
"golang.org/x/sys/windows/svc"
Expand All @@ -34,10 +32,8 @@ import (
)

const (
defaultProductName = "observIQ Distro for OpenTelemetry Collector"
defaultServiceName = "observiq-otel-collector"
uninstallServicePollInterval = 50 * time.Millisecond
serviceNotExistErrStr = "The specified service does not exist as an installed service."
defaultProductName = "observIQ Distro for OpenTelemetry Collector"
defaultServiceName = "observiq-otel-collector"
)

// Option is an extra option for creating a Service
Expand Down Expand Up @@ -120,8 +116,7 @@ func (w windowsService) Stop() error {
return nil
}

// Installs the service
func (w windowsService) install() error {
func (w windowsService) Update() error {
// parse the service definition from disk
wsc, err := readWindowsServiceConfig(w.newServiceFilePath)
if err != nil {
Expand All @@ -131,12 +126,6 @@ func (w windowsService) install() error {
// expand the arguments to be properly formatted (expand [INSTALLDIR], clean '"' to be '"')
expandArguments(wsc, w.installDir)

// Split the arguments; Arguments are "shell-like", in that they may contain spaces, and can be quoted to indicate that.
splitArgs, err := shellquote.Split(wsc.Service.Arguments)
if err != nil {
return fmt.Errorf("failed to parse arguments in service config: %w", err)
}

// Get the start type
startType, delayed, err := winapiStartType(wsc.Service.Start)
if err != nil {
Expand All @@ -149,81 +138,41 @@ func (w windowsService) install() error {
}
defer m.Disconnect()

// Create the service using the service manager.
s, err := m.CreateService(w.serviceName,
filepath.Join(w.installDir, wsc.Path),
mgr.Config{
Description: wsc.Service.Description,
DisplayName: wsc.Service.DisplayName,
StartType: startType,
DelayedAutoStart: delayed,
},
splitArgs...,
)
if err != nil {
return fmt.Errorf("failed to create service: %w", err)
}
defer s.Close()

return nil
}

// Uninstalls the service
func (w windowsService) uninstall() error {
m, err := mgr.Connect()
if err != nil {
return fmt.Errorf("failed to connect to service manager: %w", err)
}
defer m.Disconnect()

// Get the installed service handle
s, err := m.OpenService(w.serviceName)
if err != nil {
return fmt.Errorf("failed to open service: %w", err)
}

// Note on deleting services in windows:
// Deleting the service is not immediate. If there are open handles to the service (e.g. you have services.msc open)
// then the service deletion will be delayed, perhaps indefinitely. However, we want this logic to be synchronous, so
// we will try to wait for the service to actually be deleted.
if err = s.Delete(); err != nil {
sCloseErr := s.Close()
if sCloseErr != nil {
log.Default().Printf("Failed to close service: %s\n", err)
defer func() {
if err := s.Close(); err != nil {
w.logger.Error("failed to close service after update", zap.Error(err))
}
return fmt.Errorf("failed to delete service: %w", err)
}
}()

if err := s.Close(); err != nil {
return fmt.Errorf("failed to close service: %w", err)
// Get the current config; We will use the current config as the basis
// for the new config.
newConf, err := s.Config()
if err != nil {
return fmt.Errorf("failed to get current service configuration: %w", err)
}

// Wait for the service to actually be deleted:
for {
s, err := m.OpenService(w.serviceName)
if err != nil {
if err.Error() == serviceNotExistErrStr {
// This is expected when the service is uninstalled.
break
}
return fmt.Errorf("got unexpected error when waiting for service deletion: %w", err)
}
// Get the full path the the collector
fullCollectorPath := filepath.Join(w.installDir, wsc.Path)
// binary path is the path to the EXE, then the space separated list of arguments.
// we quote the collector path, in case it contains spaces.
binaryPathName := fmt.Sprintf("\"%s\" %s", fullCollectorPath, wsc.Service.Arguments)

if err := s.Close(); err != nil {
return fmt.Errorf("failed to close service: %w", err)
}
// rest with the handle closed to let the service manager remove the service
time.Sleep(uninstallServicePollInterval)
}
return nil
}
// Fill in the new config values
newConf.BinaryPathName = binaryPathName
newConf.Description = wsc.Service.Description
newConf.DisplayName = wsc.Service.DisplayName
newConf.StartType = startType
newConf.DelayedAutoStart = delayed

func (w windowsService) Update() error {
if err := w.uninstall(); err != nil {
return fmt.Errorf("failed to uninstall old service: %w", err)
}

if err := w.install(); err != nil {
return fmt.Errorf("failed to install new service: %w", err)
// Update the service in-place
err = s.UpdateConfig(newConf)
if err != nil {
return fmt.Errorf("failed to updater service: %w", err)
}

return nil
Expand Down
Loading