- Notifications
You must be signed in to change notification settings - Fork23
feat: add scheduling configuration for prebuilds#408
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
19 commits Select commitHold shift + click to select a range
d61894d feat: add autoscaling configuration for prebuilds
evgeniy-scherbina7853727 fix: improve schedule validation
evgeniy-scherbina17b2adb fix: allow DOM and Month fields
evgeniy-scherbina6403bc7 docs: improve documentation for timezone field
evgeniy-scherbina7bbe0d8 docs: make gen
evgeniy-scherbina5b0b1f9 Update provider/workspace_preset.go
evgeniy-scherbina4bd2f81 docs: improve doc comments
evgeniy-scherbinad19bea1 fix: tests
evgeniy-scherbina99680b0 refactor: rename autoscaling to scheduling
evgeniy-scherbina30979f0 docs: make gen
evgeniy-scherbina68bcb2f refactor: minor refactor after renaming
evgeniy-scherbinaddd8b4c Update provider/helpers/schedule_validation.go
evgeniy-scherbina1ae3fc7 Update provider/helpers/schedule_validation.go
evgeniy-scherbina201cd1d refactor: improve docs
evgeniy-scherbina604cb1e refactor: improve docs
evgeniy-scherbina9437525 test: improve test coverage
evgeniy-scherbina59bc618 test: improve test coverage
evgeniy-scherbinad040b81 refactor: check for a specific error in tests
evgeniy-scherbina79def30 refactor: check for a specific error in tests
evgeniy-scherbinaFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
20 changes: 20 additions & 0 deletionsdocs/data-sources/workspace_preset.md
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
17 changes: 11 additions & 6 deletionsintegration/integration_test.go
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
16 changes: 16 additions & 0 deletionsintegration/test-data-source/main.tf
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
187 changes: 187 additions & 0 deletionsprovider/helpers/schedule_validation.go
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,187 @@ | ||
| package helpers | ||
| import ( | ||
| "strconv" | ||
| "strings" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
| // ValidateSchedules checks if any schedules overlap | ||
| func ValidateSchedules(schedules []string) error { | ||
| for i := 0; i < len(schedules); i++ { | ||
| for j := i + 1; j < len(schedules); j++ { | ||
| overlap, err := SchedulesOverlap(schedules[i], schedules[j]) | ||
| if err != nil { | ||
| return xerrors.Errorf("invalid schedule: %w", err) | ||
| } | ||
| if overlap { | ||
| return xerrors.Errorf("schedules overlap: %s and %s", | ||
| schedules[i], schedules[j]) | ||
Comment on lines +19 to +20 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This error message could be more helpful. We know which aspect of the schedules overlap, so let's help template authors out by telling them. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. It means everything (minutes, hours and days) overlap. | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
| // SchedulesOverlap checks if two schedules overlap by checking | ||
| // all cron fields separately | ||
| func SchedulesOverlap(schedule1, schedule2 string) (bool, error) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This is excellent work@evgeniy-scherbina! I really like how clean the code is, how complete the code-coverage, and how clear the intentions are. | ||
| // Get cron fields | ||
| fields1 := strings.Fields(schedule1) | ||
| fields2 := strings.Fields(schedule2) | ||
| if len(fields1) != 5 { | ||
| return false, xerrors.Errorf("schedule %q has %d fields, expected 5 fields (minute hour day-of-month month day-of-week)", schedule1, len(fields1)) | ||
| } | ||
| if len(fields2) != 5 { | ||
| return false, xerrors.Errorf("schedule %q has %d fields, expected 5 fields (minute hour day-of-month month day-of-week)", schedule2, len(fields2)) | ||
| } | ||
evgeniy-scherbina marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // Check if months overlap | ||
| monthsOverlap, err := MonthsOverlap(fields1[3], fields2[3]) | ||
| if err != nil { | ||
| return false, xerrors.Errorf("invalid month range: %w", err) | ||
| } | ||
| if !monthsOverlap { | ||
| return false, nil | ||
| } | ||
| // Check if days overlap (DOM OR DOW) | ||
| daysOverlap, err := DaysOverlap(fields1[2], fields1[4], fields2[2], fields2[4]) | ||
| if err != nil { | ||
| return false, xerrors.Errorf("invalid day range: %w", err) | ||
| } | ||
| if !daysOverlap { | ||
| return false, nil | ||
| } | ||
| // Check if hours overlap | ||
| hoursOverlap, err := HoursOverlap(fields1[1], fields2[1]) | ||
| if err != nil { | ||
| return false, xerrors.Errorf("invalid hour range: %w", err) | ||
| } | ||
| return hoursOverlap, nil | ||
| } | ||
| // MonthsOverlap checks if two month ranges overlap | ||
| func MonthsOverlap(months1, months2 string) (bool, error) { | ||
| return CheckOverlap(months1, months2, 12) | ||
| } | ||
| // HoursOverlap checks if two hour ranges overlap | ||
| func HoursOverlap(hours1, hours2 string) (bool, error) { | ||
| return CheckOverlap(hours1, hours2, 23) | ||
| } | ||
| // DomOverlap checks if two day-of-month ranges overlap | ||
| func DomOverlap(dom1, dom2 string) (bool, error) { | ||
| return CheckOverlap(dom1, dom2, 31) | ||
| } | ||
| // DowOverlap checks if two day-of-week ranges overlap | ||
| func DowOverlap(dow1, dow2 string) (bool, error) { | ||
| return CheckOverlap(dow1, dow2, 6) | ||
| } | ||
| // DaysOverlap checks if two day ranges overlap, considering both DOM and DOW. | ||
| // Returns true if both DOM and DOW overlap, or if one is * and the other overlaps. | ||
| func DaysOverlap(dom1, dow1, dom2, dow2 string) (bool, error) { | ||
| // If either DOM is *, we only need to check DOW overlap | ||
| if dom1 == "*" || dom2 == "*" { | ||
| return DowOverlap(dow1, dow2) | ||
| } | ||
| // If either DOW is *, we only need to check DOM overlap | ||
| if dow1 == "*" || dow2 == "*" { | ||
| return DomOverlap(dom1, dom2) | ||
| } | ||
evgeniy-scherbina marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // If both DOM and DOW are specified, we need to check both | ||
| // because the schedule runs when either matches | ||
| domOverlap, err := DomOverlap(dom1, dom2) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| dowOverlap, err := DowOverlap(dow1, dow2) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| // If either DOM or DOW overlaps, the schedules overlap | ||
| return domOverlap || dowOverlap, nil | ||
| } | ||
| // CheckOverlap is a function to check if two ranges overlap | ||
| func CheckOverlap(range1, range2 string, maxValue int) (bool, error) { | ||
| set1, err := ParseRange(range1, maxValue) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| set2, err := ParseRange(range2, maxValue) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| for value := range set1 { | ||
| if set2[value] { | ||
| return true, nil | ||
| } | ||
| } | ||
| return false, nil | ||
| } | ||
| // ParseRange converts a cron range to a set of integers | ||
| // maxValue is the maximum allowed value (e.g., 23 for hours, 6 for DOW, 12 for months, 31 for DOM) | ||
| func ParseRange(input string, maxValue int) (map[int]bool, error) { | ||
| result := make(map[int]bool) | ||
| // Handle "*" case | ||
| if input == "*" { | ||
| for i := 0; i <= maxValue; i++ { | ||
| result[i] = true | ||
| } | ||
| return result, nil | ||
| } | ||
| // Parse ranges like "1-3,5,7-9" | ||
| parts := strings.Split(input, ",") | ||
| for _, part := range parts { | ||
| if strings.Contains(part, "-") { | ||
| // Handle range like "1-3" | ||
| rangeParts := strings.Split(part, "-") | ||
| start, err := strconv.Atoi(rangeParts[0]) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("invalid start value in range: %w", err) | ||
| } | ||
| end, err := strconv.Atoi(rangeParts[1]) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("invalid end value in range: %w", err) | ||
| } | ||
| // Validate range | ||
| if start < 0 || end > maxValue || start > end { | ||
| return nil, xerrors.Errorf("invalid range %d-%d: values must be between 0 and %d", start, end, maxValue) | ||
| } | ||
| for i := start; i <= end; i++ { | ||
| result[i] = true | ||
| } | ||
| } else { | ||
| // Handle single value | ||
| value, err := strconv.Atoi(part) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("invalid value: %w", err) | ||
| } | ||
| // Validate value | ||
| if value < 0 || value > maxValue { | ||
| return nil, xerrors.Errorf("invalid value %d: must be between 0 and %d", value, maxValue) | ||
| } | ||
| result[value] = true | ||
| } | ||
| } | ||
| return result, nil | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.