Add a piped component that watches app configs #2772
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| load("@io_bazel_rules_go//go:def.bzl", "go_library") | ||
|
|
||
| go_library( | ||
| name = "go_default_library", | ||
| srcs = ["appconfigreporter.go"], | ||
| importpath = "github.com/pipe-cd/pipe/pkg/app/piped/appconfigreporter", | ||
| visibility = ["//visibility:public"], | ||
| deps = [ | ||
| "//pkg/app/api/service/pipedservice:go_default_library", | ||
| "//pkg/cache:go_default_library", | ||
| "//pkg/cache/memorycache:go_default_library", | ||
| "//pkg/config:go_default_library", | ||
| "//pkg/git:go_default_library", | ||
| "//pkg/model:go_default_library", | ||
| "@org_golang_google_grpc//:go_default_library", | ||
| "@org_uber_go_zap//:go_default_library", | ||
| ], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,279 @@ | ||
| // Copyright 2021 The PipeCD 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 appconfigreporter | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "go.uber.org/zap" | ||
| "google.golang.org/grpc" | ||
|
|
||
| "github.com/pipe-cd/pipe/pkg/app/api/service/pipedservice" | ||
| "github.com/pipe-cd/pipe/pkg/config" | ||
| "github.com/pipe-cd/pipe/pkg/git" | ||
| "github.com/pipe-cd/pipe/pkg/model" | ||
| ) | ||
|
|
||
| type apiClient interface { | ||
| UpdateApplicationConfigurations(ctx context.Context, in *pipedservice.UpdateApplicationConfigurationsRequest, opts ...grpc.CallOption) (*pipedservice.UpdateApplicationConfigurationsResponse, error) | ||
| ReportUnregisteredApplicationConfigurations(ctx context.Context, in *pipedservice.ReportUnregisteredApplicationConfigurationsRequest, opts ...grpc.CallOption) (*pipedservice.ReportUnregisteredApplicationConfigurationsResponse, error) | ||
| } | ||
|
|
||
| type gitClient interface { | ||
| Clone(ctx context.Context, repoID, remote, branch, destination string) (git.Repo, error) | ||
| } | ||
|
|
||
| type applicationLister interface { | ||
| List() []*model.Application | ||
| } | ||
|
|
||
| type Reporter struct { | ||
| apiClient apiClient | ||
| gitClient gitClient | ||
| applicationLister applicationLister | ||
| config *config.PipedSpec | ||
| gitRepos map[string]git.Repo | ||
| gracePeriod time.Duration | ||
| // Cache for the last scanned commit for each repository. | ||
| // Not goroutine safe. | ||
| lastScannedCommits map[string]string | ||
| logger *zap.Logger | ||
| } | ||
|
|
||
| func NewReporter( | ||
| apiClient apiClient, | ||
| gitClient gitClient, | ||
| appLister applicationLister, | ||
| cfg *config.PipedSpec, | ||
| gracePeriod time.Duration, | ||
| logger *zap.Logger, | ||
| ) *Reporter { | ||
| return &Reporter{ | ||
| apiClient: apiClient, | ||
| gitClient: gitClient, | ||
| applicationLister: appLister, | ||
| config: cfg, | ||
| gracePeriod: gracePeriod, | ||
| lastScannedCommits: make(map[string]string), | ||
| logger: logger.Named("app-config-reporter"), | ||
| } | ||
| } | ||
|
|
||
| func (r *Reporter) Run(ctx context.Context) error { | ||
| r.logger.Info("start running app-config-reporter") | ||
|
|
||
| // Pre-clone to cache the registered git repositories. | ||
| r.gitRepos = make(map[string]git.Repo, len(r.config.Repositories)) | ||
| for _, repoCfg := range r.config.Repositories { | ||
| repo, err := r.gitClient.Clone(ctx, repoCfg.RepoID, repoCfg.Remote, repoCfg.Branch, "") | ||
| if err != nil { | ||
| r.logger.Error("failed to clone repository", | ||
| zap.String("repo-id", repoCfg.RepoID), | ||
| zap.Error(err), | ||
| ) | ||
| return err | ||
| } | ||
| r.gitRepos[repoCfg.RepoID] = repo | ||
| } | ||
|
|
||
| // FIXME: Think about sync interval of app config reporter | ||
| ticker := time.NewTicker(r.config.SyncInterval.Duration()) | ||
| defer ticker.Stop() | ||
|
|
||
| for { | ||
| select { | ||
| case <-ticker.C: | ||
| if err := r.scanAppConfigs(ctx); err != nil { | ||
| r.logger.Error("failed to check application configurations defined in Git", zap.Error(err)) | ||
| } | ||
| case <-ctx.Done(): | ||
| r.logger.Info("app-config-reporter has been stopped") | ||
| return nil | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // scanAppConfigs checks and reports two types of applications. | ||
| // One is applications registered in Control-plane already, and another is ones that aren't registered yet. | ||
| func (r *Reporter) scanAppConfigs(ctx context.Context) error { | ||
| if len(r.gitRepos) == 0 { | ||
| r.logger.Info("no repositories were configured for this piped") | ||
| return nil | ||
| } | ||
|
|
||
| // Make all repos up-to-date. | ||
| for repoID, repo := range r.gitRepos { | ||
| if err := repo.Pull(ctx, repo.GetClonedBranch()); err != nil { | ||
| r.logger.Error("failed to update repo to latest", | ||
| zap.String("repo-id", repoID), | ||
| zap.Error(err), | ||
| ) | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // Create a map to determine from GitPath if the application is registered. | ||
| registeredAppPaths := make(map[string]struct{}) | ||
| for _, app := range r.applicationLister.List() { | ||
| id := model.BuildGitPathID(app.GitPath.Repo.Id, app.GitPath.Path, app.GitPath.ConfigFilename) | ||
| registeredAppPaths[id] = struct{}{} | ||
| } | ||
|
|
||
| if err := r.updateUnregisteredApps(ctx, registeredAppPaths); err != nil { | ||
| return fmt.Errorf("failed to update unregistered applications: %w", err) | ||
| } | ||
| if err := r.updateRegisteredApps(ctx, registeredAppPaths); err != nil { | ||
| return fmt.Errorf("failed to update registered applications: %w", err) | ||
| } | ||
|
Member
There was a problem hiding this comment. Registered applications are more important than unregistered ones so let's change the order of updating. |
||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // updateUnregisteredApps sends all unregistered application configurations to the control-plane. | ||
| func (r *Reporter) updateUnregisteredApps(ctx context.Context, registeredAppPaths map[string]struct{}) error { | ||
| apps := make([]*model.ApplicationInfo, 0) | ||
| for repoID, repo := range r.gitRepos { | ||
| err := filepath.Walk(repo.GetPath(), func(path string, info os.FileInfo, err error) error { | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if info.IsDir() { | ||
| return nil | ||
| } | ||
| appInfo, skip := r.readApplicationInfo(repoID, repo.GetPath(), filepath.Base(path), registeredAppPaths, false) | ||
| if skip { | ||
| return nil | ||
| } | ||
| apps = append(apps, appInfo) | ||
| return nil | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to inspect files under %s: %w", repo.GetPath(), err) | ||
| } | ||
|
Member
There was a problem hiding this comment. nit: Add a log message that could help for debugging by our users.
Member
Author
There was a problem hiding this comment. Nice. It is definite that currently it's quite hard to see what's going on. |
||
| } | ||
| if len(apps) == 0 { | ||
| return nil | ||
|
Member
There was a problem hiding this comment. Do you think that we should send this empty list to the control plane to delete the cache?
Member
There was a problem hiding this comment. Or we can have a simple mark in this Reporter to avoid sending continuous this kind of request.
Member
Author
There was a problem hiding this comment. To avoid sending meaningless requests simply, I applied this way. Cache in Control-plane gets periodically removed, so I thought it's fine. But it's worth considering. |
||
| } | ||
|
|
||
| _, err := r.apiClient.ReportUnregisteredApplicationConfigurations( | ||
| ctx, | ||
| &pipedservice.ReportUnregisteredApplicationConfigurationsRequest{ | ||
| Applications: apps, | ||
| }, | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to put the latest unregistered application configurations: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
|
Member
There was a problem hiding this comment. Separating the |
||
|
|
||
| // updateRegisteredApps sends application configurations that have changed since the last time to the control-plane. | ||
| func (r *Reporter) updateRegisteredApps(ctx context.Context, registeredAppPaths map[string]struct{}) (err error) { | ||
| apps := make([]*model.ApplicationInfo, 0) | ||
| for repoID, repo := range r.gitRepos { | ||
| var headCommit git.Commit | ||
| headCommit, err = repo.GetLatestCommit(ctx) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get the latest commit of %s: %w", repoID, err) | ||
| } | ||
| lastScannedCommit, ok := r.lastScannedCommits[repoID] | ||
| if ok && headCommit.Hash == lastScannedCommit { | ||
| continue | ||
| } | ||
|
|
||
| var files []string | ||
| files, err = repo.ChangedFiles(ctx, lastScannedCommit, headCommit.Hash) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get files those were touched between two commits: %w", err) | ||
| } | ||
| if len(files) == 0 { | ||
| // The case where all changes have been fully reverted. | ||
| continue | ||
| } | ||
| for _, filename := range files { | ||
| appInfo, skip := r.readApplicationInfo(repoID, repo.GetPath(), filename, registeredAppPaths, true) | ||
| if skip { | ||
| continue | ||
| } | ||
| apps = append(apps, appInfo) | ||
| } | ||
|
|
||
| id := repoID | ||
| defer func() { | ||
| if err == nil { | ||
| r.lastScannedCommits[id] = headCommit.Hash | ||
| } | ||
| }() | ||
|
Member
There was a problem hiding this comment. I think to be simple we should avoid
Member
Author
There was a problem hiding this comment. Cool. It will reduce the amount of code. |
||
| } | ||
| if len(apps) == 0 { | ||
| return | ||
| } | ||
|
|
||
| _, err = r.apiClient.UpdateApplicationConfigurations( | ||
| ctx, | ||
| &pipedservice.UpdateApplicationConfigurationsRequest{ | ||
| Applications: apps, | ||
| }, | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to update application configurations: %w", err) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| func (r *Reporter) readApplicationInfo(repoID, path, cfgFilename string, registeredAppPaths map[string]struct{}, wantRegistered bool) (appInfo *model.ApplicationInfo, skip bool) { | ||
|
Member
There was a problem hiding this comment. To be simple, |
||
| if !strings.HasSuffix(cfgFilename, model.DefaultDeploymentConfigFileExtension) { | ||
| return nil, true | ||
| } | ||
| gitPathID := model.BuildGitPathID(repoID, path, cfgFilename) | ||
| if _, registered := registeredAppPaths[gitPathID]; registered != wantRegistered { | ||
| return nil, true | ||
| } | ||
|
|
||
| cfgFilePath := filepath.Join(path, cfgFilename) | ||
| cfg, err := config.LoadFromYAML(cfgFilePath) | ||
| if err != nil { | ||
| r.logger.Error("failed to load configuration file", | ||
| zap.String("repo-id", repoID), | ||
| zap.String("config-file-path", cfgFilePath), | ||
| zap.Error(err), | ||
| ) | ||
| return nil, true | ||
| } | ||
|
|
||
| spec, ok := cfg.GetGenericDeployment() | ||
| if !ok { | ||
| r.logger.Error(fmt.Sprintf("unsupported application kind: %s", cfg.Kind), | ||
| zap.String("repo-id", repoID), | ||
| zap.String("config-file-path", cfgFilePath), | ||
| ) | ||
| return nil, true | ||
| } | ||
|
|
||
| return &model.ApplicationInfo{ | ||
| Name: spec.Name, | ||
| // TODO: Convert Kind string into dedicated type | ||
| //Kind: cfg.Kind, | ||
| EnvId: spec.EnvID, | ||
| Path: path, | ||
| ConfigFilename: cfgFilename, | ||
| Labels: spec.Labels, | ||
| }, false | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.