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

Jump to bottom

fix(compose): container locking #2722

Merged
merged 1 commit into from
Aug 12, 2024
Merged

fix(compose): container locking #2722

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
32 changes: 15 additions & 17 deletions modules/compose/compose_api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,8 @@ type dockerCompose struct {
// only one strategy can be added to a service, to use multiple use wait.ForAll(...)
waitStrategies map[string]wait.Strategy

// used to synchronise writes to the containers map
containersLock sync.RWMutex
// Used to synchronise writes to the containers.
containersLock sync.Mutex

// cache for containers that are part of the stack
// used in ServiceContainer(...) function to avoid calls to the Docker API
Expand Down Expand Up @@ -362,10 +362,6 @@ func (d *dockerCompose) Up(ctx context.Context, opts ...StackUpOption) error {
}()
}

d.containersLock.Lock()
defer d.containersLock.Unlock()
d.containers[srv.Name] = dc

return nil
})
}
Expand All @@ -391,11 +387,6 @@ func (d *dockerCompose) Up(ctx context.Context, opts ...StackUpOption) error {
return err
}

// cache all the containers on compose.up
d.containersLock.Lock()
defer d.containersLock.Unlock()
d.containers[svc] = target

return strategy.WaitUntilReady(errGrpCtx, target)
})
}
Expand Down Expand Up @@ -427,12 +418,20 @@ func (d *dockerCompose) WithOsEnv() ComposeStack {
return d
}

func (d *dockerCompose) lookupContainer(ctx context.Context, svcName string) (*testcontainers.DockerContainer, error) {
// cachedContainer returns the cached container for svcName or nil if it doesn't exist.
func (d *dockerCompose) cachedContainer(svcName string) *testcontainers.DockerContainer {
d.containersLock.Lock()
defer d.containersLock.Unlock()

if ctr, ok := d.containers[svcName]; ok {
return ctr, nil
return d.containers[svcName]
}

// lookupContainer is used to retrieve the container instance from the cache or the Docker API.
//
// Safe for concurrent calls.
func (d *dockerCompose) lookupContainer(ctx context.Context, svcName string) (*testcontainers.DockerContainer, error) {
if c := d.cachedContainer(svcName); c != nil {
return c, nil
}

containers, err := d.dockerClient.ContainerList(ctx, container.ListOptions{
Expand Down Expand Up @@ -466,15 +465,14 @@ func (d *dockerCompose) lookupContainer(ctx context.Context, svcName string) (*t

ctr.SetProvider(dockerProvider)

d.containersLock.Lock()
stevenh marked this conversation as resolved.
Show resolved Hide resolved
defer d.containersLock.Unlock()
d.containers[svcName] = ctr

return ctr, nil
}

func (d *dockerCompose) lookupNetworks(ctx context.Context) error {
d.containersLock.Lock()
defer d.containersLock.Unlock()

networks, err := d.dockerClient.NetworkList(ctx, dockernetwork.ListOptions{
Filters: filters.NewArgs(
filters.Arg("label", fmt.Sprintf("%s=%s", api.ProjectLabel, d.name)),
Expand Down