<?php

declare(strict_types=1);

namespace Drupal\Tests\workspaces\Kernel;

use ColinODell\PsrTestLogger\TestLogger;
use Drupal\Component\Datetime\Time;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormState;
use Drupal\Core\Hook\Attribute\Hook;
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\KernelTests\KernelTestBase;
use Drupal\Tests\node\Traits\NodeCreationTrait;
use Drupal\Tests\user\Traits\UserCreationTrait;
use Drupal\node\NodeInterface;
use Drupal\workspaces\Entity\Workspace;
use Drupal\workspaces\WorkspaceOperationFactory;
use Drupal\workspaces\WorkspacePublisher;
use Drupal\workspaces\WorkspacePublisherInterface;
use Drupal\workspaces_ui\Form\WorkspacePublishForm;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
use Psr\Log\LoggerInterface;

/**
 * Tests workspace publishing.
 */
#[CoversClass(WorkspacePublisher::class)]
#[Group('workspaces')]
#[RunTestsInSeparateProcesses]
class WorkspacePublisherTest extends KernelTestBase {

  use NodeCreationTrait;
  use UserCreationTrait;
  use WorkspaceTestTrait;

  /**
   * The entity type manager.
   */
  protected EntityTypeManagerInterface $entityTypeManager;

  /**
   * The class to throw during node presave, or empty string to skip.
   */
  protected string $throwOnNodePresaveClass = '';

  /**
   * The number of times node_presave has fired since arming.
   */
  protected int $nodePresaveCount = 0;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'node',
    'user',
    'workspaces',
    'workspaces_ui',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();

    $this->entityTypeManager = \Drupal::entityTypeManager();

    $this->installEntitySchema('node');
    $this->installEntitySchema('user');
    $this->installEntitySchema('workspace');

    $this->installSchema('node', ['node_access']);
    $this->installSchema('workspaces', ['workspace_association', 'workspace_association_revision']);
  }

  /**
   * {@inheritdoc}
   */
  public function register(ContainerBuilder $container): void {
    parent::register($container);

    $container->getDefinition('datetime.time')
      ->setClass(TestTime::class);
  }

  /**
   * Tests that publishing a workspace updates the changed time of its entities.
   */
  public function testPublishingChangedTime(): void {
    // Create an entity in Live.
    $entity = $this->createNode(['status' => TRUE]);

    $initial_request_time = \Drupal::time()->getRequestTime();
    $this->assertEquals($initial_request_time, $entity->getChangedTime());

    // Create a new workspace, activate it, and make some changes to the entity.
    $workspace = Workspace::create(['id' => 'test_changed', 'label' => 'Test changed']);
    $workspace->save();
    $this->switchToWorkspace('test_changed');

    // Simulate passing time.
    TestTime::$offset = 1;

    $entity = $this->entityTypeManager->getStorage('node')->loadUnchanged($entity->id());
    $entity->title = $this->randomString();
    $entity->save();

    $this->assertEquals($initial_request_time + 1, $entity->getChangedTime());

    // Publish the workspace and check that the changed time has been updated.
    TestTime::$offset = 2;
    $workspace->publish();

    $entity = $this->entityTypeManager->getStorage('node')->loadUnchanged($entity->id());
    $this->assertEquals($initial_request_time + 2, $entity->getChangedTime());
  }

  /**
   * Tests that a throwable during publish is logged and rolls back the save.
   */
  #[DataProvider('providerPublishThrowableRollback')]
  public function testPublishThrowableRollback(string $thrown): void {
    $logger = new TestLogger();
    $this->container->get(LoggerChannelFactoryInterface::class)
      ->get('workspaces')
      ->addLogger($logger);

    // Create two nodes in Live and capture their default revision IDs.
    $node_1 = $this->createNode(['title' => 'node_1 live']);
    $node_2 = $this->createNode(['title' => 'node_2 live']);
    $node_1_live_vid = $node_1->getRevisionId();
    $node_2_live_vid = $node_2->getRevisionId();

    // Create a workspace and add a workspace-specific revision for each node.
    $workspace = Workspace::create(['id' => 'stage', 'label' => 'Stage']);
    $workspace->save();
    $this->switchToWorkspace('stage');

    $storage = $this->entityTypeManager->getStorage('node');
    foreach ([$node_1, $node_2] as $node) {
      $edited = $storage->loadUnchanged($node->id());
      $edited->title = 'workspace edit';
      $edited->save();
    }

    // Throw on the second presave inside the publisher's save loop, so the
    // first node's save has already happened inside the open transaction. The
    // data provider covers both \Exception and \Error subclasses; the
    // publisher's catch block must handle any \Throwable.
    $this->throwOnNodePresaveClass = $thrown;

    try {
      $workspace->publish();
    }
    catch (\Throwable) {
    }

    // Rollback proof: the first node's in-flight save was undone.
    $this->switchToLive();
    $this->assertSame($node_1_live_vid, $storage->loadUnchanged($node_1->id())->getRevisionId());
    $this->assertSame($node_2_live_vid, $storage->loadUnchanged($node_2->id())->getRevisionId());

    // The publisher logged the throwable on its channel.
    $this->assertTrue($logger->hasRecordThatPasses(
      static fn (array $record): bool => ($record['context']['@message'] ?? '') === 'Simulated node presave failure.',
      RfcLogLevel::ERROR,
    ));
  }

  /**
   * Implements hook_ENTITY_TYPE_presave() for the 'node' entity type.
   *
   * @see ::testPublishThrowableRollback()
   */
  #[Hook('node_presave')]
  public function nodePresave(NodeInterface $node): void {
    if (!$this->throwOnNodePresaveClass) {
      return;
    }
    $this->nodePresaveCount++;
    if ($this->nodePresaveCount >= 2) {
      throw new $this->throwOnNodePresaveClass('Simulated node presave failure.');
    }
  }

  /**
   * Data provider for ::testPublishThrowableRollback().
   */
  public static function providerPublishThrowableRollback(): array {
    return [
      'exception' => [\RuntimeException::class],
      'error' => [\Error::class],
    ];
  }

  /**
   * Tests submit form with exception.
   *
   * @legacy-covers \Drupal\workspaces\Form\WorkspacePublishForm::submitForm
   */
  public function testSubmitFormWithException(): void {
    /** @var \Drupal\Core\Messenger\MessengerInterface $messenger */
    $messenger = \Drupal::service('messenger');

    $workspaceOperationFactory = $this->createMock(WorkspaceOperationFactory::class);
    $entityTypeManager = $this->createMock(EntityTypeManagerInterface::class);
    $logger = $this->createMock(LoggerInterface::class);
    /** @var \Drupal\Core\Logger\LoggerChannelFactoryInterface $loggerFactory */
    $loggerFactory = \Drupal::service('logger.factory');
    $loggerFactory->addLogger($logger);

    $workspace = $this->createMock(Workspace::class);
    $workspacePublisher = $this->createMock(WorkspacePublisherInterface::class);

    $workspace
      ->expects($this->any())
      ->method('label');

    $workspace
      ->expects($this->once())
      ->method('publish')
      ->willThrowException(new \Exception('Unexpected error'));

    $workspaceOperationFactory
      ->expects($this->once())
      ->method('getPublisher')
      ->willReturn($workspacePublisher);

    $workspacePublisher
      ->expects($this->once())
      ->method('getTargetLabel');

    $publishForm = new WorkspacePublishForm(
      $workspaceOperationFactory,
      $entityTypeManager
    );

    $form = [];
    $formState = new FormState();

    $publishForm->buildForm($form, $formState, $workspace);

    $logger
      ->expects($this->once())
      ->method('log')
      ->with(RfcLogLevel::ERROR, 'Unexpected error');

    $publishForm->submitForm($form, $formState);

    $messages = $messenger->messagesByType(MessengerInterface::TYPE_ERROR);
    $this->assertCount(1, $messages);
    $this->assertEquals('Publication failed. All errors have been logged.', $messages[0]);
  }

}

/**
 * A test-only implementation of the time service.
 */
class TestTime extends Time {

  /**
   * An offset to add to the request time.
   */
  public static int $offset = 0;

  /**
   * {@inheritdoc}
   */
  public function getRequestTime() {
    return parent::getRequestTime() + static::$offset;
  }

}