Updates comments to extension source files

Author: wbreza

cli/azd/pkg/extensions/file_source.go

@@ -8,6 +8,7 @@ import (
 	"github.com/azure/azure-dev/cli/azd/pkg/config"
 )
 
+// newFileSource creates a new file base registry source.
 func newFileSource(name string, path string) (Source, error) {
 	absolutePath, err := getAbsolutePath(path)
 	if err != nil {
@@ -22,6 +23,7 @@ func newFileSource(name string, path string) (Source, error) {
 	return newJsonSource(name, string(registryBytes))
 }
 
+// getAbsolutePath converts a relative path to an absolute path.
 func getAbsolutePath(filePath string) (string, error) {
 	// Check if the path is absolute
 	if filepath.IsAbs(filePath) {

cli/azd/pkg/extensions/json_source.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 )
 
+// newJsonSource creates a new JSON base registry source.
 func newJsonSource(name string, jsonRegistry string) (Source, error) {
 	var registry *Registry
 	err := json.Unmarshal([]byte(jsonRegistry), &registry)

cli/azd/pkg/extensions/manager.go

@@ -77,13 +77,6 @@ func (m *Manager) Initialize() error {
 		return err
 	}
 
-	// configDir, err := config.GetUserConfigDir()
-	// if err != nil {
-	// 	return fmt.Errorf("failed to get user config directory: %w", err)
-	// }
-
-	//registryCachePath := filepath.Join(configDir, registryCacheFilePath)
-	//m.registryCache = cache.NewFileCache(registryCachePath, registryCacheDuration, m.loadRegistry)
 	m.userConfig = userConfig
 
 	return nil

cli/azd/pkg/extensions/source.go

@@ -33,7 +33,7 @@ type registrySource struct {
 	registry *Registry
 }
 
-// NewJsonTemplateSource creates a new template source from a JSON string.
+// newRegistrySource creates a new registry source.
 func newRegistrySource(name string, registry *Registry) (Source, error) {
 	if err := validateRegistry(*registry); err != nil {
 		return nil, fmt.Errorf("failed to validate registry: %w", err)
@@ -49,6 +49,7 @@ func (ts *registrySource) Name() string {
 	return ts.name
 }
 
+// ListTemplates returns a list of templates from the extension source.
 func (s *registrySource) ListExtensions(ctx context.Context) ([]*ExtensionMetadata, error) {
 	for _, extension := range s.registry.Extensions {
 		extension.Source = s.name
@@ -57,23 +58,25 @@ func (s *registrySource) ListExtensions(ctx context.Context) ([]*ExtensionMetada
 	return s.registry.Extensions, nil
 }
 
-func (s *registrySource) GetExtension(ctx context.Context, name string) (*ExtensionMetadata, error) {
+// GetExtension returns an extension by id.
+func (s *registrySource) GetExtension(ctx context.Context, id string) (*ExtensionMetadata, error) {
 	allTemplates, err := s.ListExtensions(ctx)
 	if err != nil {
 		return nil, fmt.Errorf("failed listing templates: %w", err)
 	}
 
 	matchingIndex := slices.IndexFunc(allTemplates, func(extension *ExtensionMetadata) bool {
-		return strings.EqualFold(extension.Id, name)
+		return strings.EqualFold(extension.Id, id)
 	})
 
 	if matchingIndex == -1 {
-		return nil, fmt.Errorf("extension with name '%s' was not found, %w", name, ErrExtensionNotFound)
+		return nil, fmt.Errorf("extension with name '%s' was not found, %w", id, ErrExtensionNotFound)
 	}
 
 	return allTemplates[matchingIndex], nil
 }
 
+// validateRegistry validates the registry content and its signature
 func validateRegistry(registry Registry) error {
 	if registry.Signature == "" {
 		log.Println("Registry signature is empty, skipping signature verification")

cli/azd/pkg/extensions/source_manager.go

@@ -12,6 +12,7 @@ import (
 	"github.com/azure/azure-dev/cli/azd/pkg/ioc"
 )
 
+// SourceKind represents the type of extension source.
 type SourceKind string
 
 const (
@@ -28,12 +29,14 @@ var (
 	ErrSourceTypeInvalid = errors.New("invalid extension source type")
 )
 
+// SourceConfig represents the configuration for an extension source.
 type SourceConfig struct {
 	Name     string     `json:"name,omitempty"`
 	Type     SourceKind `json:"type,omitempty"`
 	Location string     `json:"location,omitempty"`
 }
 
+// SourceManager manages extension sources.
 type SourceManager struct {
 	serviceLocator ioc.ServiceLocator
 	configManager  config.UserConfigManager
@@ -52,6 +55,7 @@ func NewSourceManager(
 	}
 }
 
+// Get returns an extension source by name.
 func (sm *SourceManager) Get(ctx context.Context, name string) (*SourceConfig, error) {
 	sources, err := sm.List(ctx)
 	if err != nil {
@@ -68,6 +72,7 @@ func (sm *SourceManager) Get(ctx context.Context, name string) (*SourceConfig, e
 
 }
 
+// Add adds a new extension source.
 func (sm *SourceManager) Add(ctx context.Context, name string, source *SourceConfig) error {
 	newKey := normalizeKey(name)
 
@@ -85,6 +90,7 @@ func (sm *SourceManager) Add(ctx context.Context, name string, source *SourceCon
 	return sm.addInternal(source)
 }
 
+// Remove removes an extension source.
 func (sm *SourceManager) Remove(ctx context.Context, name string) error {
 	name = normalizeKey(name)
 
@@ -117,6 +123,7 @@ func (sm *SourceManager) Remove(ctx context.Context, name string) error {
 	return nil
 }
 
+// List returns a list of extension sources.
 func (sm *SourceManager) List(ctx context.Context) ([]*SourceConfig, error) {
 	config, err := sm.configManager.Load()
 	if err != nil {
@@ -184,6 +191,7 @@ func (sm *SourceManager) CreateSource(ctx context.Context, config *SourceConfig)
 	return source, nil
 }
 
+// addInternal adds a new extension source to the user configuration.
 func (sm *SourceManager) addInternal(source *SourceConfig) error {
 	config, err := sm.configManager.Load()
 	if err != nil {
@@ -204,6 +212,7 @@ func (sm *SourceManager) addInternal(source *SourceConfig) error {
 	return nil
 }
 
+// normalizeKey normalizes a key for use in the configuration.
 func normalizeKey(key string) string {
 	key = strings.ToLower(key)
 	key = strings.ReplaceAll(key, " ", "-")

cli/azd/pkg/extensions/url_source.go

@@ -10,6 +10,7 @@ import (
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
 )
 
+// newUrlSource creates a new URL extension source.
 func newUrlSource(ctx context.Context, name string, url string, transport policy.Transporter) (Source, error) {
 	pipeline := runtime.NewPipeline("azd-extensions", "1.0.0", runtime.PipelineOptions{}, &policy.ClientOptions{
 		Transport: transport,