amp/test/InternalProducerTest.php

<?php

namespace Amp\Test;

use Amp\Deferred;
use Amp\Failure;
use Amp\Internal\Producer;
use Amp\PHPUnit\AsyncTestCase;
use Amp\PHPUnit\TestException;
use Amp\Promise;
use Amp\Success;
use function React\Promise\resolve;

class InternalProducerTest extends AsyncTestCase
{
    private Producer $producer;

    public function setUp(): void
    {
        parent::setUp();

        $this->producer = new Producer;
    }

    public function testEmit(): \Generator
    {
        $value = 1;

        $promise = $this->producer->emit($value);

        $this->assertTrue(yield $this->producer->advance());
        $this->assertSame($value, $this->producer->getCurrent());

        $this->assertInstanceOf(Promise::class, $promise);
    }

    /**
     * @depends testEmit
     */
    public function testEmitSuccessfulPromise(): \Generator
    {
        $value = 1;
        $promise = new Success($value);

        $promise = $this->producer->emit($promise);

        $this->assertTrue(yield $this->producer->advance());
        $this->assertSame($value, $this->producer->getCurrent());

        $this->assertInstanceOf(Promise::class, $promise);
    }

    /**
     * @depends testEmit
     */
    public function testEmitFailedPromise(): \Generator
    {
        $exception = new TestException;
        $promise = new Failure($exception);

        $promise = $this->producer->emit($promise);

        try {
            $this->assertTrue(yield $this->producer->advance());
            $this->fail("The exception used to fail the iterator should be thrown from advance()");
        } catch (TestException $reason) {
            $this->assertSame($reason, $exception);
        }

        $this->assertInstanceOf(Promise::class, $promise);
    }

    /**
     * @depends testEmit
     */
    public function testEmitPendingPromise(): \Generator
    {
        $value = 1;
        $deferred = new Deferred;

        $this->producer->emit($deferred->promise());

        $deferred->resolve($value);

        $this->assertTrue(yield $this->producer->advance());
        $this->assertSame($value, $this->producer->getCurrent());
    }

    /**
     * @depends testEmit
     */
    public function testEmitSuccessfulReactPromise(): \Generator
    {
        $value = 1;
        $promise = resolve($value);

        $this->producer->emit($promise);

        $this->assertTrue(yield $this->producer->advance());
        $this->assertSame($value, $this->producer->getCurrent());
    }

    /**
     * @depends testEmit
     */
    public function testEmitPendingPromiseThenNonPromise(): \Generator
    {
        $deferred = new Deferred;

        $this->producer->emit($deferred->promise());

        $this->producer->emit(2);

        $this->assertTrue(yield $this->producer->advance());
        $this->assertSame(2, $this->producer->getCurrent());

        $deferred->resolve(1);

        $this->assertTrue(yield $this->producer->advance());
        $this->assertSame(1, $this->producer->getCurrent());
    }

    /**
     * @depends testEmit
     */
    public function testEmitAfterComplete(): void
    {
        $this->expectException(\Error::class);
        $this->expectExceptionMessage("Iterators cannot emit values after calling complete");

        $this->producer->complete();
        $this->producer->emit(1);
    }

    public function testGetCurrentAfterComplete(): void
    {
        $this->expectException(\Error::class);
        $this->expectExceptionMessage("The iterator has completed");

        $this->producer->complete();
        $this->producer->getCurrent();
    }

    /**
     * @depends testEmit
     */
    public function testEmitPendingPromiseThenComplete(): \Generator
    {
        $this->expectException(\Error::class);
        $this->expectExceptionMessage("The iterator was completed before the promise result could be emitted");

        $deferred = new Deferred;

        $promise = $this->producer->emit($deferred->promise());

        $this->producer->complete();
        $deferred->resolve();

        yield $promise;
    }

    /**
     * @depends testEmit
     */
    public function testEmitPendingPromiseThenFail(): \Generator
    {
        $this->expectException(\Error::class);
        $this->expectExceptionMessage("The iterator was completed before the promise result could be emitted");

        $deferred = new Deferred;

        $promise = $this->producer->emit($deferred->promise());

        $this->producer->complete();
        $deferred->fail(new \Exception);

        yield $promise;
    }

    public function testDoubleAdvance(): void
    {
        $this->expectException(\Error::class);
        $this->expectExceptionMessage("The prior promise returned must resolve before invoking this method again");

        $this->producer->advance();
        $this->producer->advance();
    }

    public function testGetCurrentBeforeAdvance(): void
    {
        $this->expectException(\Error::class);
        $this->expectExceptionMessage("Promise returned from advance() must resolve before calling this method");

        $this->producer->getCurrent();
    }

    public function testDoubleComplete(): void
    {
        $this->expectException(\Error::class);
        $this->expectExceptionMessage("Iterator has already been completed");

        $this->producer->complete();
        $this->producer->complete();
    }
}