Method Resolve

pkg/workflow/engine_definition.go:227–273

Resolve returns a ResolvedEngineTarget for the given engine ID and config. Resolution order: 1. Exact match in the catalog by ID 2. Prefix match in the underlying EngineRegistry (backward compat, e.g. "codex-experimental") 3. Returns a formatted validation error when no match is found

(id string, config *EngineConfig)

//  2. Prefix match in the underlying EngineRegistry (backward compat, e.g. "codex-experimental")
//  3. Returns a formatted validation error when no match is found
func (c *EngineCatalog) Resolve(id string, config *EngineConfig) (*ResolvedEngineTarget, error) {
	engineCatalogLog.Printf("Resolving engine: %s", id)

	// Exact catalog lookup
	if def, ok := c.definitions[id]; ok {
		engineCatalogLog.Printf("Exact catalog match found for engine: %s (runtimeID=%s)", id, def.RuntimeID)
		runtime, err := c.registry.GetEngine(def.RuntimeID)
		if err != nil {
			return nil, fmt.Errorf("engine %q definition references unknown runtime %q: %w", id, def.RuntimeID, err)
		}
		return &ResolvedEngineTarget{Definition: def, Config: config, Runtime: runtime}, nil
	}

	// Fall back to runtime-ID prefix lookup for backward compat (e.g. "codex-experimental")
	runtime, err := c.registry.GetEngineByPrefix(id)
	if err == nil {
		engineCatalogLog.Printf("Engine %q resolved via runtime-ID prefix fallback to %q", id, runtime.GetID())
		def := &EngineDefinition{
			ID:          id,
			DisplayName: runtime.GetDisplayName(),
			Description: runtime.GetDescription(),
			RuntimeID:   runtime.GetID(),
		}
		return &ResolvedEngineTarget{Definition: def, Config: config, Runtime: runtime}, nil
	}

	// Engine not found — produce a helpful validation error matching the existing format
	engineCatalogLog.Printf("Engine not found: %s", id)
	validEngines := c.registry.GetSupportedEngines()
	suggestions := parser.FindClosestMatches(id, validEngines, 1)
	enginesStr := strings.Join(validEngines, ", ")

	errMsg := fmt.Sprintf("invalid engine: %s. Valid engines are: %s.\n\nExample:\nengine: copilot\n\nSee: %s",
		id,
		enginesStr,
		constants.DocsEnginesURL)

	if len(suggestions) > 0 {
		errMsg = fmt.Sprintf("invalid engine: %s. Valid engines are: %s.\n\nDid you mean: %s?\n\nExample:\nengine: copilot\n\nSee: %s",
			id,
			enginesStr,
			suggestions[0],
			constants.DocsEnginesURL)
	}

	return nil, errors.New(errMsg)
}