secretsource: some improvement to comments for extension authors

Author: mstoykov

secretsource/extension.go

@@ -7,7 +7,11 @@ import (
 	"go.k6.io/k6/lib/fsext"
 )
 
-// Constructor returns an instance of an output extension module.
+// Constructor returns an instance of a secret source extension module.
+// This should return an instance of [Source] given the parameters.
+// The Secret Source should not log its secrets and any returned secret will be cached and redacted
+// by the [Manager]. No additional work needs to be done by the Secret source apart from retrieving
+// the secret.
 type Constructor func(Params) (Source, error)
 
 // Params contains all possible constructor parameters an output may need.

secretsource/hook.go

@@ -65,5 +65,5 @@ func recursiveReplace(v any, replacer *strings.Replacer) any {
 		return v
 	}
 	return fmt.Sprintf("Had a logrus.fields value with type %T, "+
-		"please report that this is unsupported and will be redacted in all logs in case it containing secrets", v)
+		"please report that this is unsupported and will be redacted in all logs in case it contains secrets", v)
 }

secretsource/interface.go

@@ -4,5 +4,8 @@ package secretsource
 type Source interface {
 	// Human readable description to be printed on the cli
 	Description() string
+	// Get retrives the value for a given key and returns it.
+	// Logging the value before it is returned is going to lead to it being leaked.
+	// The error might lead to an exception visible to users.
 	Get(key string) (value string, err error)
 }