generated from TBD54566975/tbd-project-template
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add ftl dev command to watch and deploy (#630)
- Loading branch information
1 parent
a6398c0
commit c41408b
Showing
7 changed files
with
295 additions
and
32 deletions.
There are no files selected for viewing
This file contains 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 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 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 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,259 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "context" | ||
| "io/fs" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/alecthomas/errors" | ||
| "github.com/bmatcuk/doublestar/v4" | ||
|
|
||
| "github.com/TBD54566975/ftl/backend/common/log" | ||
| "github.com/TBD54566975/ftl/backend/common/moduleconfig" | ||
| "github.com/TBD54566975/ftl/protos/xyz/block/ftl/v1/ftlv1connect" | ||
| ) | ||
|
|
||
| type moduleFolderInfo struct { | ||
| NumFiles int | ||
| LastModTime time.Time | ||
| } | ||
|
|
||
| type devCmd struct { | ||
| BaseDir string `arg:"" help:"Directory to watch for FTL modules" type:"existingdir" default:"."` | ||
| Watch time.Duration `help:"Watch template directory at this frequency and regenerate on change." default:"500ms"` | ||
| modules map[string]moduleFolderInfo | ||
| client ftlv1connect.ControllerServiceClient | ||
| } | ||
|
|
||
| func (d *devCmd) Run(ctx context.Context, client ftlv1connect.ControllerServiceClient) error { | ||
| logger := log.FromContext(ctx) | ||
| logger.Infof("Watching %s for FTL modules", d.BaseDir) | ||
|
|
||
| d.modules = make(map[string]moduleFolderInfo) | ||
| d.client = client | ||
|
|
||
| lastScanTime := time.Now() | ||
| for { | ||
| iterationStartTime := time.Now() | ||
|
|
||
| tomls, err := d.getTomls() | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
|
|
||
| d.addOrRemoveModules(tomls) | ||
|
|
||
| for dir := range d.modules { | ||
| currentModule := d.modules[dir] | ||
| err := d.updateFileInfo(dir) | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
|
|
||
| if currentModule.NumFiles != d.modules[dir].NumFiles || d.modules[dir].LastModTime.After(lastScanTime) { | ||
| deploy := deployCmd{ | ||
| Replicas: 1, | ||
| ModuleDir: dir, | ||
| } | ||
| err = deploy.Run(ctx, client) | ||
| if err != nil { | ||
| logger.Errorf(err, "Error deploying module %s. Will retry", dir) | ||
| delete(d.modules, dir) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| lastScanTime = iterationStartTime | ||
| select { | ||
| case <-time.After(d.Watch): | ||
| case <-ctx.Done(): | ||
| return nil | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (d *devCmd) getTomls() ([]string, error) { | ||
| baseDir := d.BaseDir | ||
| ignores := loadGitIgnore(os.DirFS(baseDir), ".") | ||
| tomls := []string{} | ||
|
|
||
| err := walkDir(baseDir, ignores, func(srcPath string, d fs.DirEntry) error { | ||
| if filepath.Base(srcPath) == "ftl.toml" { | ||
| tomls = append(tomls, srcPath) | ||
| return errSkip // Return errSkip to stop recursion in this branch | ||
| } | ||
| return nil | ||
| }) | ||
| if err != nil { | ||
| return nil, errors.WithStack(err) | ||
| } | ||
|
|
||
| return tomls, nil | ||
| } | ||
|
|
||
| func (d *devCmd) addOrRemoveModules(tomls []string) { | ||
| for _, toml := range tomls { | ||
| dir := filepath.Dir(toml) | ||
| if _, ok := d.modules[dir]; !ok { | ||
| d.modules[dir] = moduleFolderInfo{ | ||
| LastModTime: time.Now(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| for dir := range d.modules { | ||
| found := false | ||
| for _, toml := range tomls { | ||
| if filepath.Dir(toml) == dir { | ||
| found = true | ||
| break | ||
| } | ||
| } | ||
| if !found { | ||
| delete(d.modules, dir) // Remove deleted module from d.modules | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (d *devCmd) updateFileInfo(dir string) error { | ||
| config, err := moduleconfig.LoadConfig(dir) | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
|
|
||
| ignores := loadGitIgnore(os.DirFS(dir), ".") | ||
| d.modules[dir] = moduleFolderInfo{} | ||
|
|
||
| err = walkDir(dir, ignores, func(srcPath string, entry fs.DirEntry) error { | ||
| for _, pattern := range config.Watch { | ||
| relativePath, err := filepath.Rel(dir, srcPath) | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
|
|
||
| match, err := doublestar.PathMatch(pattern, relativePath) | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
|
|
||
| if match && !entry.IsDir() { | ||
| fileInfo, err := entry.Info() | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
|
|
||
| module := d.modules[dir] | ||
| module.NumFiles++ | ||
| if fileInfo.ModTime().After(module.LastModTime) { | ||
| module.LastModTime = fileInfo.ModTime() | ||
| } | ||
| d.modules[dir] = module | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| }) | ||
|
|
||
| return err | ||
| } | ||
|
|
||
| // errSkip is returned by walkDir to skip a file or directory. | ||
| var errSkip = errors.New("skip directory") | ||
|
|
||
| // Depth-first walk of dir executing fn after each entry. | ||
| func walkDir(dir string, ignores []string, fn func(path string, d fs.DirEntry) error) error { | ||
| dirInfo, err := os.Stat(dir) | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
| if err = fn(dir, fs.FileInfoToDirEntry(dirInfo)); err != nil { | ||
| if errors.Is(err, errSkip) { | ||
| return nil | ||
| } | ||
| return errors.WithStack(err) | ||
| } | ||
| entries, err := os.ReadDir(dir) | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
|
|
||
| var dirs []os.DirEntry | ||
|
|
||
| // Process files first, then recurse into directories. | ||
| for _, entry := range entries { | ||
| fullPath := filepath.Join(dir, entry.Name()) | ||
|
|
||
| // Check if the path matches any ignore pattern | ||
| shouldIgnore := false | ||
| for _, pattern := range ignores { | ||
| match, err := doublestar.PathMatch(pattern, fullPath) | ||
| if err != nil { | ||
| return errors.WithStack(err) | ||
| } | ||
| if match { | ||
| shouldIgnore = true | ||
| break | ||
| } | ||
| } | ||
|
|
||
| if shouldIgnore { | ||
| continue // Skip this entry | ||
| } | ||
|
|
||
| if entry.IsDir() { | ||
| dirs = append(dirs, entry) | ||
| } else { | ||
| if err = fn(fullPath, entry); err != nil { | ||
| if errors.Is(err, errSkip) { | ||
| // If errSkip is found in a file, skip the remaining files in this directory | ||
| return nil | ||
| } | ||
| return errors.WithStack(err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Then, recurse into subdirectories | ||
| for _, dirEntry := range dirs { | ||
| dirPath := filepath.Join(dir, dirEntry.Name()) | ||
| ignores = append(ignores, loadGitIgnore(os.DirFS(dirPath), ".")...) | ||
| if err := walkDir(dirPath, ignores, fn); err != nil { | ||
| if errors.Is(err, errSkip) { | ||
| return errSkip // Propagate errSkip upwards to stop this branch of recursion | ||
| } | ||
| return errors.WithStack(err) | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func loadGitIgnore(root fs.FS, dir string) []string { | ||
| ignore := []string{ | ||
| "**/.*", | ||
| "**/.*/**", | ||
| } | ||
| r, err := root.Open(path.Join(dir, ".gitignore")) | ||
| if err != nil { | ||
| return nil | ||
| } | ||
| lr := bufio.NewScanner(r) | ||
| for lr.Scan() { | ||
| line := lr.Text() | ||
| line = strings.TrimSpace(line) | ||
| if line == "" || line[0] == '#' || line[0] == '!' { // We don't support negation. | ||
| continue | ||
| } | ||
| if strings.HasSuffix(line, "/") { | ||
| line = path.Join("**", line, "**/*") | ||
| } else if !strings.ContainsRune(line, '/') { | ||
| line = path.Join("**", line) | ||
| } | ||
| ignore = append(ignore, line) | ||
| } | ||
| return ignore | ||
| } |
This file contains 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 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.