appwrite/tests/e2e/Services/Sites/SitesConsoleClientTest.php

<?php

namespace Tests\E2E\Services\Sites;

use PHPUnit\Framework\Attributes\Group;
use Tests\E2E\Client;
use Tests\E2E\Scopes\ProjectCustom;
use Tests\E2E\Scopes\Scope;
use Tests\E2E\Scopes\SideConsole;
use Utopia\Console;
use Utopia\Database\Helpers\ID;

class SitesConsoleClientTest extends Scope
{
    use ProjectCustom;
    use SideConsole;
    use SitesBase;

    #[Group('screenshots')]
    public function testSiteScreenshot(): void
    {
        $siteId = $this->setupSite([
            'siteId' => ID::unique(),
            'name' => 'Themed site',
            'framework' => 'other',
            'adapter' => 'static',
            'buildRuntime' => 'static-1',
            'outputDirectory' => './',
            'buildCommand' => '',
            'installCommand' => '',
            'fallbackFile' => '',
        ]);

        $this->assertNotEmpty($siteId);

        $domain = $this->setupSiteDomain($siteId);

        $deploymentId = $this->setupDeployment($siteId, [
            'code' => $this->packageSite('static-themed'),
            'activate' => 'true'
        ]);

        $this->assertNotEmpty($deploymentId);

        $domain = $this->getSiteDomain($siteId);
        $this->assertNotEmpty($domain);

        $proxyClient = new Client();
        $proxyClient->setEndpoint('http://' . $domain);

        $response = $proxyClient->call(Client::METHOD_GET, '/');

        $this->assertEquals(200, $response['headers']['status-code']);
        $this->assertStringContainsString("Themed website", $response['body']);
        $this->assertStringContainsString("@media (prefers-color-scheme: dark)", $response['body']);

        $deployment = null;
        $site = null;
        $this->assertEventually(function () use ($siteId, $deploymentId, &$deployment, &$site) {
            $deployment = $this->getDeployment($siteId, $deploymentId);
            $this->assertEquals(200, $deployment['headers']['status-code']);
            $this->assertNotEmpty($deployment['body']['screenshotLight']);
            $this->assertNotEmpty($deployment['body']['screenshotDark']);

            $site = $this->getSite($siteId);
            $this->assertEquals(200, $site['headers']['status-code']);
            $this->assertEquals($deployment['body']['screenshotLight'], $site['body']['deploymentScreenshotLight']);
            $this->assertEquals($deployment['body']['screenshotDark'], $site['body']['deploymentScreenshotDark']);
        });

        $this->assertNotNull($site);
        $this->assertNotNull($deployment);

        $screenshotId = $deployment['body']['screenshotLight'];
        $file = $this->client->call(Client::METHOD_GET, "/storage/buckets/screenshots/files/$screenshotId/view?project=console", array_merge($this->getHeaders(), [
            'x-appwrite-mode' => 'default' // NOT ADMIN!
        ]));

        $this->assertEquals(200, $file['headers']['status-code']);
        $this->assertNotEmpty(200, $file['body']);
        $this->assertGreaterThan(1, $file['headers']['content-length']);
        $this->assertEquals('image/png', $file['headers']['content-type']);

        // Compare with reference screenshots
        $referencePath = \realpath(__DIR__ . '/../../../resources/sites/static-themed');
        $referenceScreenshotLight = $referencePath . '/screenshot-light.png';
        $this->assertFileExists($referenceScreenshotLight, 'Reference light screenshot not found');
        $this->assertSamePixels($referenceScreenshotLight, $file['body']);

        $screenshotId = $deployment['body']['screenshotDark'];
        $file = $this->client->call(Client::METHOD_GET, "/storage/buckets/screenshots/files/$screenshotId/view?project=console", array_merge($this->getHeaders(), [
            'x-appwrite-mode' => 'default' // NOT ADMIN!
        ]));

        $this->assertEquals(200, $file['headers']['status-code']);
        $this->assertNotEmpty(200, $file['body']);
        $this->assertGreaterThan(1, $file['headers']['content-length']);
        $this->assertEquals('image/png', $file['headers']['content-type']);

        $referenceScreenshotDark = $referencePath . '/screenshot-dark.png';
        $this->assertFileExists($referenceScreenshotDark, 'Reference dark screenshot not found');
        $this->assertSamePixels($referenceScreenshotDark, $file['body']);

        $screenshotId = $deployment['body']['screenshotLight'];
        $file = $this->client->call(Client::METHOD_GET, "/storage/buckets/screenshots/files/$screenshotId/view?project=console");
        $this->assertEquals(404, $file['headers']['status-code']);

        $screenshotId = $deployment['body']['screenshotDark'];
        $file = $this->client->call(Client::METHOD_GET, "/storage/buckets/screenshots/files/$screenshotId/view?project=console");
        $this->assertEquals(404, $file['headers']['status-code']);

        // Verify previews
        $screenshotId = $deployment['body']['screenshotLight'];
        $file = $this->client->call(Client::METHOD_GET, "/storage/buckets/screenshots/files/$screenshotId/preview?project=console", array_merge($this->getHeaders(), [
            'x-appwrite-mode' => 'default' // NOT ADMIN!
        ]));

        $this->assertEquals(200, $file['headers']['status-code']);
        $this->assertNotEmpty(200, $file['body']);
        $this->assertGreaterThan(1, $file['headers']['content-length']);
        $this->assertEquals('image/png', $file['headers']['content-type']);

        $screenshotHash = \md5($file['body']);
        $this->assertNotEmpty($screenshotHash);

        $screenshotId = $deployment['body']['screenshotDark'];
        $file = $this->client->call(Client::METHOD_GET, "/storage/buckets/screenshots/files/$screenshotId/preview?project=console", array_merge($this->getHeaders(), [
            'x-appwrite-mode' => 'default' // NOT ADMIN!
        ]));

        $this->assertEquals(200, $file['headers']['status-code']);
        $this->assertNotEmpty(200, $file['body']);
        $this->assertGreaterThan(1, $file['headers']['content-length']);
        $this->assertEquals('image/png', $file['headers']['content-type']);

        $screenshotDarkHash = \md5($file['body']);
        $this->assertNotEmpty($screenshotDarkHash);

        $this->assertNotEquals($screenshotDarkHash, $screenshotHash);

        $screenshotId = $deployment['body']['screenshotLight'];
        $file = $this->client->call(Client::METHOD_GET, "/storage/buckets/screenshots/files/$screenshotId/preview?project=console");
        $this->assertEquals(404, $file['headers']['status-code']);

        $screenshotId = $deployment['body']['screenshotDark'];
        $file = $this->client->call(Client::METHOD_GET, "/storage/buckets/screenshots/files/$screenshotId/preview?project=console");
        $this->assertEquals(404, $file['headers']['status-code']);

        $this->cleanupSite($siteId);
    }

    public function testSiteDeploymentRetentionWithMaintenance(): void
    {
        $siteId = $this->setupSite([
            'siteId' => ID::unique(),
            'name' => 'Test retention site',
            'framework' => 'other',
            'deploymentRetention' => 180,
            'buildRuntime' => 'node-22',
        ]);
        $this->assertNotEmpty($siteId);

        $deploymentIdInactive = $this->setupDeployment($siteId, [
            'code' => $this->packageSite('static'),
            'activate' => true
        ]);
        $this->assertNotEmpty($deploymentIdInactive);

        $deploymentIdInactiveOld = $this->setupDeployment($siteId, [
            'code' => $this->packageSite('static'),
            'activate' => true
        ]);
        $this->assertNotEmpty($deploymentIdInactiveOld);

        $deploymentIdActive = $this->setupDeployment($siteId, [
            'code' => $this->packageSite('static'),
            'activate' => true
        ]);
        $this->assertNotEmpty($deploymentIdActive);

        $stdout = '';
        $stderr = '';
        $code = Console::execute("docker exec appwrite task-time-travel --projectId={$this->getProject()['$id']} --resourceType=deployment --resourceId={$deploymentIdInactiveOld} --createdAt=2020-01-01T00:00:00Z", '', $stdout, $stderr);
        $this->assertSame(0, $code, "Time-travel command failed with code $code: $stderr ($stdout)");

        $stdout = '';
        $stderr = '';
        $code = Console::execute("docker exec appwrite maintenance --type=trigger", '', $stdout, $stderr);
        $this->assertSame(0, $code, "Maintenance command failed with code $code: $stderr ($stdout)");

        $this->assertEventually(function () use ($siteId) {
            $response = $this->listDeployments($siteId);
            $this->assertSame(200, $response['headers']['status-code']);
            $this->assertSame(2, $response['body']['total']);
        });

        $this->cleanupSite($siteId);
    }
}