mirror of
https://github.com/coder/coder.git
synced 2025-07-03 16:13:58 +00:00
27bc60d1b9
Closes https://github.com/coder/internal/issues/510 <details> <summary> Refactoring Summary </summary> ### 1) `CalculateActions` Function #### Issues Before Refactoring: - Large function (~150 lines), making it difficult to read and maintain. - The control flow is hard to follow due to complex conditional logic. - The `ReconciliationActions` struct was partially initialized early, then mutated in multiple places, making the flow error-prone. Original source:fe60b569ad/coderd/prebuilds/state.go (L13-L167)#### Improvements After Refactoring: - Simplified and broken down into smaller, focused helper methods. - The flow of the function is now more linear and easier to understand. - Struct initialization is cleaner, avoiding partial and incremental mutations. Refactored function:eeb0407d78/coderd/prebuilds/state.go (L67-L84)--- ### 2) `ReconciliationActions` Struct #### Issues Before Refactoring: - The struct mixed both actionable decisions and diagnostic state, which blurred its purpose. - It was unclear which fields were necessary for reconciliation logic, and which were purely for logging/observability. #### Improvements After Refactoring: - Split into two clear, purpose-specific structs: - **`ReconciliationActions`** — defines the intended reconciliation action. - **`ReconciliationState`** — captures runtime state and metadata, primarily for logging and diagnostics. Original struct:fe60b569ad/coderd/prebuilds/reconcile.go (L29-L41)</details> --------- Signed-off-by: Danny Kopping <dannykopping@gmail.com> Co-authored-by: Sas Swart <sas.swart.cdk@gmail.com> Co-authored-by: Danny Kopping <dannykopping@gmail.com> Co-authored-by: Dean Sheather <dean@deansheather.com> Co-authored-by: Spike Curtis <spike@coder.com> Co-authored-by: Danny Kopping <danny@coder.com>
27 lines
824 B
Go
27 lines
824 B
Go
package prebuilds
|
|
|
|
import (
|
|
"crypto/rand"
|
|
"encoding/base32"
|
|
"fmt"
|
|
"strings"
|
|
)
|
|
|
|
// GenerateName generates a 20-byte prebuild name which should safe to use without truncation in most situations.
|
|
// UUIDs may be too long for a resource name in cloud providers (since this ID will be used in the prebuild's name).
|
|
//
|
|
// We're generating a 9-byte suffix (72 bits of entropy):
|
|
// 1 - e^(-1e9^2 / (2 * 2^72)) = ~0.01% likelihood of collision in 1 billion IDs.
|
|
// See https://en.wikipedia.org/wiki/Birthday_attack.
|
|
func GenerateName() (string, error) {
|
|
b := make([]byte, 9)
|
|
|
|
_, err := rand.Read(b)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
// Encode the bytes to Base32 (A-Z2-7), strip any '=' padding
|
|
return fmt.Sprintf("prebuild-%s", strings.ToLower(base32.StdEncoding.WithPadding(base32.NoPadding).EncodeToString(b))), nil
|
|
}
|