Skip to content

refactor: use coder/slog + minor go style changes #107

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jun 2, 2025
Merged

refactor: use coder/slog + minor go style changes #107

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2c20ae5
log -> coder/slog change
cstyan May 16, 2025
b1d22f2
minor style cleanup of readmefiles.go
cstyan May 16, 2025
6b4093c
minor style changes in main.go
cstyan May 16, 2025
097b8a2
minor style changes in errors.go
cstyan May 16, 2025
ed629c1
minor contributors.go style changes
cstyan May 16, 2025
85743cd
minor style changes in corderresources.go
cstyan May 16, 2025
6e8fc77
minor style changes in repostructure.go
cstyan May 16, 2025
4fc0a54
address review feedback from Michael
cstyan May 16, 2025
8ab9fe9
some more minor changes
cstyan May 22, 2025
11e4da3
these regex should be equivalent, but using backticks we can avoid ha…
cstyan May 22, 2025
333d962
make each phase type string explicitly an instance the validationPhas…
cstyan May 22, 2025
94f0cb0
Merge branch 'main' into callum-registry-go-style
cstyan May 29, 2025
9fd7eb4
give validation phases more obvious name prefixes
cstyan May 29, 2025
673df61
back out some non-idiomatic one lining but add helper functions to ma…
cstyan May 29, 2025
518d860
two final fixes
cstyan May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 46 additions & 50 deletions cmd/readmevalidation/coderresources.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ package main

import (
"bufio"
"context"
"errors"
"fmt"
"log"
"net/url"
"os"
"path"
Expand All @@ -15,7 +15,14 @@ import (
"gopkg.in/yaml.v3"
)

var supportedResourceTypes = []string{"modules", "templates"}
var (
supportedResourceTypes = []string{"modules", "templates"}

// TODO: This is a holdover from the validation logic used by the Coder Modules repo. It gives us some assurance, but
// realistically, we probably want to parse any Terraform code snippets, and make some deeper guarantees about how it's
// structured. Just validating whether it *can* be parsed as Terraform would be a big improvement.
terraformVersionRe = regexp.MustCompile(`^\s*\bversion\s+=`)
)

type coderResourceFrontmatter struct {
Description string `yaml:"description"`
Expand All @@ -25,9 +32,8 @@ type coderResourceFrontmatter struct {
Tags []string `yaml:"tags"`
}

// coderResourceReadme represents a README describing a Terraform resource used
// to help create Coder workspaces. As of 2025-04-15, this encapsulates both
// Coder Modules and Coder Templates
// coderResourceReadme represents a README describing a Terraform resource used to help create Coder workspaces.
// As of 2025-04-15, this encapsulates both Coder Modules and Coder Templates.
type coderResourceReadme struct {
resourceType string
filePath string
Expand All @@ -50,35 +56,33 @@ func validateCoderResourceDescription(description string) error {
}

func validateCoderResourceIconURL(iconURL string) []error {
problems := []error{}

if iconURL == "" {
problems = append(problems, errors.New("icon URL cannot be empty"))
return problems
return []error{errors.New("icon URL cannot be empty")}
}

errs := []error{}

isAbsoluteURL := !strings.HasPrefix(iconURL, ".") && !strings.HasPrefix(iconURL, "/")
if isAbsoluteURL {
if _, err := url.ParseRequestURI(iconURL); err != nil {
problems = append(problems, errors.New("absolute icon URL is not correctly formatted"))
errs = append(errs, errors.New("absolute icon URL is not correctly formatted"))
}
if strings.Contains(iconURL, "?") {
problems = append(problems, errors.New("icon URLs cannot contain query parameters"))
errs = append(errs, errors.New("icon URLs cannot contain query parameters"))
}
return problems
return errs
}

// Would normally be skittish about having relative paths like this, but it
// should be safe because we have guarantees about the structure of the
// repo, and where this logic will run
// Would normally be skittish about having relative paths like this, but it should be safe because we have guarantees
// about the structure of the repo, and where this logic will run.
isPermittedRelativeURL := strings.HasPrefix(iconURL, "./") ||
strings.HasPrefix(iconURL, "/") ||
strings.HasPrefix(iconURL, "../../../../.icons")
if !isPermittedRelativeURL {
problems = append(problems, fmt.Errorf("relative icon URL %q must either be scoped to that module's directory, or the top-level /.icons directory (this can usually be done by starting the path with \"../../../.icons\")", iconURL))
errs = append(errs, fmt.Errorf("relative icon URL %q must either be scoped to that module's directory, or the top-level /.icons directory (this can usually be done by starting the path with \"../../../.icons\")", iconURL))
}

return problems
return errs
}

func validateCoderResourceTags(tags []string) error {
Expand All @@ -89,9 +93,8 @@ func validateCoderResourceTags(tags []string) error {
return nil
}

// All of these tags are used for the module/template filter controls in the
// Registry site. Need to make sure they can all be placed in the browser
// URL without issue
// All of these tags are used for the module/template filter controls in the Registry site. Need to make sure they
// can all be placed in the browser URL without issue.
invalidTags := []string{}
for _, t := range tags {
if t != url.QueryEscape(t) {
Expand All @@ -105,16 +108,11 @@ func validateCoderResourceTags(tags []string) error {
return nil
}

// Todo: This is a holdover from the validation logic used by the Coder Modules
// repo. It gives us some assurance, but realistically, we probably want to
// parse any Terraform code snippets, and make some deeper guarantees about how
// it's structured. Just validating whether it *can* be parsed as Terraform
// would be a big improvement.
var terraformVersionRe = regexp.MustCompile("^\\s*\\bversion\\s+=")

func validateCoderResourceReadmeBody(body string) []error {
trimmed := strings.TrimSpace(body)
var errs []error

trimmed := strings.TrimSpace(body)
// TODO: this may cause unexpected behaviour since the errors slice may have a 0 length. Add a test.
errs = append(errs, validateReadmeBody(trimmed)...)

foundParagraph := false
Expand All @@ -124,15 +122,15 @@ func validateCoderResourceReadmeBody(body string) []error {
lineNum := 0
isInsideCodeBlock := false
isInsideTerraform := false
nextLine := ""

lineScanner := bufio.NewScanner(strings.NewReader(trimmed))
for lineScanner.Scan() {
lineNum++
nextLine := lineScanner.Text()
nextLine = lineScanner.Text()
Copy link
Contributor

@buenos-nachos buenos-nachos May 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand the point of this change, since nextLine isn't ever used outside the loop. I'm not a fan of scope pollution, and try to keep scoping as aggressively small as possible, even in the same function

  1. Is this mostly a memory optimization?
  2. I feel like I see code all the time in Go that looks just like what we used to have. Especially with range loops. Does the below example have the same problems as the old approach, where we're declaring new block-scoped variables on the stack once per iteration?
for i, value := range exampleSlice {
  // Stuff
}

Is there an optimization that range loops have that doesn't exist with other loops?

Copy link
Contributor Author

@cstyan cstyan May 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this is just an optimization to reduce memory allocations. Very minor in this case since I doubt this loop has a lot of iterations, but without this a new string for nextLine is allocated for each iteration of the loop.

The Go compiler already does an optimization itself for for thing := range anotherThing to do the same optimization, assigning to the same var for each iteration rather than allocating a new one every time.

Copy link
Contributor

@buenos-nachos buenos-nachos May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that actually true nowadays? I know it used to be, but they changed the range behavior to isolate variables for each declaration in Go 1.22:
https://go.dev/blog/loopvar-preview

Is Go doing escape analysis for the variable to see if it needs to be kept around for closures, and only reusing the declaration if it knows that the variable doesn't need to be long-lived? JS enforces scoped behavior for every loop that uses let and const, but I imagine it can't do those optimizations natively because it's a JIT language

Copy link
Contributor Author

@cstyan cstyan May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is Go doing escape analysis for the variable to see if it needs to be kept around for closures, and only reusing the declaration if it knows that the variable doesn't need to be long-lived?

I believe so, yes. It essentially looks for internal function calls or go routine calls that pass in the declared variable.

If I understand correctly the optimization will still be applied if it can detect that the variable is only used within the scope of that loop. If we wanted to, we can write a simple benchmark to explore this.


// Code assumes that invalid headers would've already been handled by
// the base validation function, so we don't need to check deeper if the
// first line isn't an h1
// Code assumes that invalid headers would've already been handled by the base validation function, so we don't
// need to check deeper if the first line isn't an h1.
if lineNum == 1 {
if !strings.HasPrefix(nextLine, "# ") {
break
Expand All @@ -159,15 +157,13 @@ func validateCoderResourceReadmeBody(body string) []error {
continue
}

// Code assumes that we can treat this case as the end of the "h1
// section" and don't need to process any further lines
// Code assumes that we can treat this case as the end of the "h1 section" and don't need to process any further lines.
if lineNum > 1 && strings.HasPrefix(nextLine, "#") {
break
}

// Code assumes that if we've reached this point, the only other options
// are: (1) empty spaces, (2) paragraphs, (3) HTML, and (4) asset
// references made via [] syntax
// Code assumes that if we've reached this point, the only other options are:
// (1) empty spaces, (2) paragraphs, (3) HTML, and (4) asset references made via [] syntax.
trimmedLine := strings.TrimSpace(nextLine)
isParagraph := trimmedLine != "" && !strings.HasPrefix(trimmedLine, "![") && !strings.HasPrefix(trimmedLine, "<")
foundParagraph = foundParagraph || isParagraph
Expand Down Expand Up @@ -250,29 +246,29 @@ func parseCoderResourceReadmeFiles(resourceType string, rms []readme) (map[strin
}
if len(yamlParsingErrs) != 0 {
return nil, validationPhaseError{
phase: validationPhaseReadmeParsing,
phase: readmeParsing,
errors: yamlParsingErrs,
}
}

yamlValidationErrors := []error{}
for _, readme := range resources {
errors := validateCoderResourceReadme(readme)
if len(errors) > 0 {
yamlValidationErrors = append(yamlValidationErrors, errors...)
errs := validateCoderResourceReadme(readme)
if len(errs) > 0 {
yamlValidationErrors = append(yamlValidationErrors, errs...)
}
}
if len(yamlValidationErrors) != 0 {
return nil, validationPhaseError{
phase: validationPhaseReadmeParsing,
phase: readmeParsing,
errors: yamlValidationErrors,
}
}

return resources, nil
}

// Todo: Need to beef up this function by grabbing each image/video URL from
// TODO: Need to beef up this function by grabbing each image/video URL from
// the body's AST
func validateCoderResourceRelativeUrls(resources map[string]coderResourceReadme) error {
return nil
Expand All @@ -286,13 +282,14 @@ func aggregateCoderResourceReadmeFiles(resourceType string) ([]readme, error) {

var allReadmeFiles []readme
var errs []error
var resourceDirs []os.DirEntry
for _, rf := range registryFiles {
if !rf.IsDir() {
continue
}

resourceRootPath := path.Join(rootRegistryPath, rf.Name(), resourceType)
resourceDirs, err := os.ReadDir(resourceRootPath)
resourceDirs, err = os.ReadDir(resourceRootPath)
if err != nil {
if !errors.Is(err, os.ErrNotExist) {
errs = append(errs, err)
Expand Down Expand Up @@ -321,7 +318,7 @@ func aggregateCoderResourceReadmeFiles(resourceType string) ([]readme, error) {

if len(errs) != 0 {
return nil, validationPhaseError{
phase: validationPhaseFileLoad,
phase: fileLoad,
errors: errs,
}
}
Expand All @@ -338,17 +335,16 @@ func validateAllCoderResourceFilesOfType(resourceType string) error {
return err
}

log.Printf("Processing %d README files\n", len(allReadmeFiles))
logger.Info(context.Background(), "Processing README files", "num_files", len(allReadmeFiles))
resources, err := parseCoderResourceReadmeFiles(resourceType, allReadmeFiles)
if err != nil {
return err
}
log.Printf("Processed %d README files as valid Coder resources with type %q", len(resources), resourceType)
logger.Info(context.Background(), "Processed README files as valid Coder resources", "num_files", len(resources), "type", resourceType)

err = validateCoderResourceRelativeUrls(resources)
if err != nil {
if err = validateCoderResourceRelativeUrls(resources); err != nil {
return err
}
log.Printf("All relative URLs for %s READMEs are valid\n", resourceType)
logger.Info(context.Background(), "All relative URLs for READMEs are valid", "type", resourceType)
return nil
}
Loading