# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Sequential agent implementation."""

from __future__ import annotations

import logging
from typing import AsyncGenerator
from typing import ClassVar
from typing import Type

from typing_extensions import deprecated
from typing_extensions import override

from ..events.event import Event
from ..features import experimental
from ..features import FeatureName
from ..utils.context_utils import Aclosing
from .base_agent import BaseAgent
from .base_agent import BaseAgentState
from .base_agent_config import BaseAgentConfig
from .invocation_context import InvocationContext
from .llm_agent import LlmAgent
from .sequential_agent_config import SequentialAgentConfig

logger = logging.getLogger('google_adk.' + __name__)


@experimental(FeatureName.AGENT_STATE)
class SequentialAgentState(BaseAgentState):
  """State for SequentialAgent."""

  current_sub_agent: str = ''
  """The name of the current sub-agent to run."""


@deprecated(
    'SequentialAgent is deprecated in favor of Workflow and will be removed'
    ' in a future version. Workflow cannot yet be used as an LlmAgent'
    ' sub-agent.'
)
class SequentialAgent(BaseAgent):
  """A shell agent that runs its sub-agents in sequence.

  .. deprecated::
    SequentialAgent is deprecated in favor of Workflow and will be removed in
    a future version. Workflow cannot yet be used as an LlmAgent sub-agent.
  """

  config_type: ClassVar[Type[BaseAgentConfig]] = SequentialAgentConfig
  """The config type for this agent.

  DEPRECATED: This attribute is deprecated and will be removed in a future
  version, along with the AgentConfig YAML loader.
  """

  @override
  async def _run_async_impl(
      self, ctx: InvocationContext
  ) -> AsyncGenerator[Event, None]:
    if not self.sub_agents:
      return

    # Initialize or resume the execution state from the agent state.
    agent_state = self._load_agent_state(ctx, SequentialAgentState)
    start_index = self._get_start_index(agent_state)

    pause_invocation = False
    resuming_sub_agent = agent_state is not None
    for i in range(start_index, len(self.sub_agents)):
      sub_agent = self.sub_agents[i]
      if not resuming_sub_agent:
        # If we are resuming from the current event, it means the same event has
        # already been logged, so we should avoid yielding it again.
        if ctx.is_resumable:
          agent_state = SequentialAgentState(current_sub_agent=sub_agent.name)
          ctx.set_agent_state(self.name, agent_state=agent_state)
          yield self._create_agent_state_event(ctx)

      async with Aclosing(sub_agent.run_async(ctx)) as agen:
        async for event in agen:
          yield event
          if ctx.should_pause_invocation(event):
            pause_invocation = True

      # Skip the rest of the sub-agents if the invocation is paused.
      if pause_invocation:
        return

      # Reset the flag for the next sub-agent.
      resuming_sub_agent = False

    if ctx.is_resumable:
      ctx.set_agent_state(self.name, end_of_agent=True)
      yield self._create_agent_state_event(ctx)

  def _get_start_index(
      self,
      agent_state: SequentialAgentState | None,
  ) -> int:
    """Calculates the start index for the sub-agent loop."""
    if not agent_state:
      return 0

    if not agent_state.current_sub_agent:
      # This means the process was finished.
      return len(self.sub_agents)

    try:
      sub_agent_names = [sub_agent.name for sub_agent in self.sub_agents]
      return sub_agent_names.index(agent_state.current_sub_agent)
    except ValueError:
      # A sub-agent was removed so the agent name is not found.
      # For now, we restart from the beginning.
      logger.warning(
          'Sub-agent %s was removed so the agent name is not found. Restarting'
          ' from the beginning.',
          agent_state.current_sub_agent,
      )
      return 0

  @override
  async def _run_live_impl(
      self, ctx: InvocationContext
  ) -> AsyncGenerator[Event, None]:
    """Implementation for live SequentialAgent.

    Compared to the non-live case, live agents process a continuous stream of audio
    or video, so there is no way to tell if it's finished and should pass
    to the next agent or not. So we introduce a task_completed() function so the
    model can call this function to signal that it's finished the task and we
    can move on to the next agent.

    Args:
      ctx: The invocation context of the agent.
    """
    if not self.sub_agents:
      return

    # There is no way to know if it's using live during init phase so we have to init it here
    for sub_agent in self.sub_agents:
      # add tool
      def task_completed() -> str:
        """
        Signals that the agent has successfully completed the user's question
        or task.
        """
        return 'Task completion signaled.'

      if isinstance(sub_agent, LlmAgent):
        # Use function name to dedupe.
        if task_completed.__name__ not in sub_agent.tools:
          sub_agent.tools.append(task_completed)
          sub_agent.instruction += f"""If you finished the user's request
          according to its description, call the {task_completed.__name__} function
          to exit so the next agents can take over. When calling this function,
          do not generate any text other than the function call."""

    for sub_agent in self.sub_agents:
      async with Aclosing(sub_agent.run_live(ctx)) as agen:
        async for event in agen:
          yield event
