Fix comments

coder · kylecarbs · Sep 25, 2023 · Sep 3, 2023 · Sep 5, 2023 · Sep 5, 2023
commit 40bcd9d54fe669d4f3e593030794b34fa7c33e8b
diff --git a/agent/agentscripts/agentscripts.go b/agent/agentscripts/agentscripts.go
@@ -8,6 +8,7 @@ import (
 	"os/exec"
 	"path/filepath"
 	"sync"
+	"sync/atomic"
 	"time"
 
 	"github.com/robfig/cron/v3"
@@ -55,14 +56,20 @@ type Runner struct {
 	closeMutex   sync.Mutex
 	ctx          context.Context
 	cron         *cron.Cron
+	initialized  atomic.Bool
 	scripts      []codersdk.WorkspaceAgentScript
 }
 
 // Init initializes the runner with the provided scripts.
 // It also schedules any scripts that have a schedule.
 // This function must be called before Execute.
 func (r *Runner) Init(scripts []codersdk.WorkspaceAgentScript) error {
+	if r.initialized.Load() {
+		return xerrors.New("init: already initialized")
+	}
+	r.initialized.Store(true)
 	r.scripts = scripts
+	r.Logger.Info(r.ctx, "initializing agent scripts", slog.F("script_count", len(scripts)), slog.F("log_dir", r.LogDir))
 
 	for _, script := range scripts {
 		if script.Cron == "" {
@@ -165,9 +172,9 @@ func (r *Runner) run(script codersdk.WorkspaceAgentScript) error {
 		}
 	}()
 
-	infoW := agentsdk.StartupLogsWriter(ctx, send, script.LogSourceID, codersdk.LogLevelInfo)
+	infoW := agentsdk.LogsWriter(ctx, send, script.LogSourceID, codersdk.LogLevelInfo)
 	defer infoW.Close()
-	errW := agentsdk.StartupLogsWriter(ctx, send, script.LogSourceID, codersdk.LogLevelError)
+	errW := agentsdk.LogsWriter(ctx, send, script.LogSourceID, codersdk.LogLevelError)
 	defer errW.Close()
 	cmd.Stdout = io.MultiWriter(fileWriter, infoW)
 	cmd.Stderr = io.MultiWriter(fileWriter, errW)

diff --git a/codersdk/agentsdk/logs.go b/codersdk/agentsdk/logs.go
@@ -73,15 +73,15 @@ func (w *startupLogsWriter) Close() error {
 	return nil
 }
 
-// StartupLogsWriter returns an io.WriteCloser that sends logs via the
+// LogsWriter returns an io.WriteCloser that sends logs via the
 // provided sender. The sender is expected to be non-blocking. Calling
 // Close flushes any remaining partially written log lines but is
-// otherwise no-op. If the context passed to StartupLogsWriter is
+// otherwise no-op. If the context passed to LogsWriter is
 // canceled, any remaining logs will be discarded.
 //
 // Neither Write nor Close is safe for concurrent use and must be used
 // by a single goroutine.
-func StartupLogsWriter(ctx context.Context, sender func(ctx context.Context, log ...Log) error, source uuid.UUID, level codersdk.LogLevel) io.WriteCloser {
+func LogsWriter(ctx context.Context, sender func(ctx context.Context, log ...Log) error, source uuid.UUID, level codersdk.LogLevel) io.WriteCloser {
 	return &startupLogsWriter{
 		ctx:    ctx,
 		send:   sender,

diff --git a/codersdk/agentsdk/logs_test.go b/codersdk/agentsdk/logs_test.go
@@ -184,7 +184,7 @@ func TestStartupLogsWriter_Write(t *testing.T) {
 				got = append(got, log...)
 				return nil
 			}
-			w := agentsdk.StartupLogsWriter(tt.ctx, send, uuid.New(), tt.level)
+			w := agentsdk.LogsWriter(tt.ctx, send, uuid.New(), tt.level)
 			for _, s := range tt.writes {
 				_, err := w.Write([]byte(s))
 				if err != nil {