mirror of
https://github.com/docker/compose.git
synced 2025-04-08 17:05:13 +02:00
3b0742fd57
Adjust the debouncing logic so that it applies to all inbound file events, regardless of whether they match a sync or rebuild rule. When the batch is flushed out, if any event for the service is a rebuild event, then the service is rebuilt and all sync events for the batch are ignored. If _all_ events in the batch are sync events, then a sync is triggered, passing the entire batch at once. This provides a substantial performance win for the new `tar`-based implementation, as it can efficiently transfer the changes in bulk. Additionally, this helps with jitter, e.g. it's not uncommon for there to be double-writes in quick succession to a file, so even if there's not many files being modified at once, it can still prevent some unnecessary transfers. Signed-off-by: Milas Bowman <milas.bowman@docker.com>
43 lines
1.4 KiB
Go
43 lines
1.4 KiB
Go
/*
|
|
Copyright 2023 Docker Compose CLI authors
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package sync
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/compose-spec/compose-go/types"
|
|
)
|
|
|
|
// PathMapping contains the Compose service and modified host system path.
|
|
type PathMapping struct {
|
|
// HostPath that was created/modified/deleted outside the container.
|
|
//
|
|
// This is the path as seen from the user's perspective, e.g.
|
|
// - C:\Users\moby\Documents\hello-world\main.go (file on Windows)
|
|
// - /Users/moby/Documents/hello-world (directory on macOS)
|
|
HostPath string
|
|
// ContainerPath for the target file inside the container (only populated
|
|
// for sync events, not rebuild).
|
|
//
|
|
// This is the path as used in Docker CLI commands, e.g.
|
|
// - /workdir/main.go
|
|
// - /workdir/subdir
|
|
ContainerPath string
|
|
}
|
|
|
|
type Syncer interface {
|
|
Sync(ctx context.Context, service types.ServiceConfig, paths []PathMapping) error
|
|
}
|