mirror of
https://github.com/appwrite/appwrite.git
synced 2026-11-18 20:36:03 +00:00
fix(migrations): finalize exports without a user (#12490)
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
1 parent
fea06addb5
commit
6212284150
3 files changed
+701
-36
No files matched your search
@@ -338,7 +338,7 @@ class Migrations extends Action
|
||||
$this->deviceForFiles,
|
||||
$migration->getAttribute('resourceId'),
|
||||
$options['bucketId'],
|
||||
$options['filename'],
|
||||
$migration->getId(),
|
||||
$options['columns'],
|
||||
$options['delimiter'],
|
||||
$options['enclosure'],
|
||||
@@ -349,7 +349,7 @@ class Migrations extends Action
|
||||
$this->deviceForFiles,
|
||||
$migration->getAttribute('resourceId'),
|
||||
$options['bucketId'] ?? 'default',
|
||||
$options['filename'],
|
||||
$migration->getId(),
|
||||
$options['columns'] ?? [],
|
||||
),
|
||||
default => throw new Exception(Exception::MIGRATION_DESTINATION_TYPE_INVALID),
|
||||
@@ -590,6 +590,11 @@ class Migrations extends Action
|
||||
return;
|
||||
}
|
||||
|
||||
$destinationType = $migration->getAttribute('destination');
|
||||
if ($destinationType === DestinationCSV::getName() || $destinationType === DestinationJSON::getName()) {
|
||||
$this->handleDataExportComplete($project, $migration, $publisherForMails, $queueForRealtime, $platform, $authorization);
|
||||
}
|
||||
|
||||
$migration->setAttribute('status', 'completed');
|
||||
$migration->setAttribute('stage', 'finished');
|
||||
} catch (\Throwable $th) {
|
||||
@@ -629,7 +634,7 @@ class Migrations extends Action
|
||||
$extras['sourceEndpoint'] = $credentials['endpoint'] ?? '';
|
||||
}
|
||||
|
||||
call_user_func($this->logError, $th, 'appwrite-worker', 'appwrite-queue-' . self::getName(), $extras);
|
||||
$this->reportError($th, $migration, $extras);
|
||||
}
|
||||
} finally {
|
||||
try {
|
||||
@@ -693,10 +698,6 @@ class Migrations extends Action
|
||||
$destination?->success();
|
||||
$source?->success();
|
||||
}
|
||||
$destination_type = $migration->getAttribute('destination');
|
||||
if ($destination_type === DestinationCSV::getName() || $destination_type === DestinationJSON::getName()) {
|
||||
$this->handleDataExportComplete($project, $migration, $publisherForMails, $queueForRealtime, $platform, $authorization);
|
||||
}
|
||||
} finally {
|
||||
$source?->cleanup();
|
||||
$destination?->cleanup();
|
||||
@@ -739,14 +740,7 @@ class Migrations extends Action
|
||||
$options = $migration->getAttribute('options', []);
|
||||
$bucketId = 'default'; // Always use platform default bucket
|
||||
$filename = $options['filename'] ?? 'export_' . \time();
|
||||
$userInternalId = $options['userInternalId'] ?? '';
|
||||
$user = $this->dbForPlatform->findOne('users', [
|
||||
Query::equal('$sequence', [$userInternalId])
|
||||
]);
|
||||
|
||||
if ($user->isEmpty()) {
|
||||
throw new \Exception('User ' . $userInternalId . ' not found');
|
||||
}
|
||||
$user = $this->resolveExportUser($migration);
|
||||
|
||||
$bucket = $this->dbForPlatform->getDocument('buckets', $bucketId);
|
||||
if ($bucket->isEmpty()) {
|
||||
@@ -754,7 +748,7 @@ class Migrations extends Action
|
||||
}
|
||||
|
||||
$extension = $migration->getAttribute('destination') === DestinationJSON::getName() ? '.json' : '.csv';
|
||||
$path = $this->deviceForFiles->getPath($bucketId . '/' . $this->sanitizeFilename($filename) . $extension);
|
||||
$path = $this->deviceForFiles->getPath($bucketId . '/' . $migration->getId() . $extension);
|
||||
$size = $this->deviceForFiles->getFileSize($path);
|
||||
$mime = $this->deviceForFiles->getFileMimeType($path);
|
||||
$hash = $this->deviceForFiles->getFileHash($path);
|
||||
@@ -778,7 +772,8 @@ class Migrations extends Action
|
||||
$migration->setAttribute('errors', $errors);
|
||||
$migration = $this->updateMigrationDocument($migration, $project, $queueForRealtime);
|
||||
|
||||
$this->sendExportEmail(
|
||||
$this->notifyExport(
|
||||
migration: $migration,
|
||||
success: false,
|
||||
project: $project,
|
||||
user: $user,
|
||||
@@ -793,11 +788,14 @@ class Migrations extends Action
|
||||
}
|
||||
}
|
||||
|
||||
$permissions = [];
|
||||
if (!$user->isEmpty()) {
|
||||
$permissions[] = Permission::read(Role::user($user->getId()));
|
||||
}
|
||||
|
||||
$this->dbForPlatform->createDocument('bucket_' . $bucket->getSequence(), new Document([
|
||||
'$id' => $fileId,
|
||||
'$permissions' => [
|
||||
Permission::read(Role::user($user->getId())),
|
||||
],
|
||||
'$permissions' => $permissions,
|
||||
'bucketId' => $bucket->getId(),
|
||||
'bucketInternalId' => $bucket->getSequence(),
|
||||
'name' => $filename,
|
||||
@@ -841,7 +839,8 @@ class Migrations extends Action
|
||||
$migration->setAttribute('options', $options);
|
||||
$this->updateMigrationDocument($migration, $project, $queueForRealtime);
|
||||
|
||||
$this->sendExportEmail(
|
||||
$this->notifyExport(
|
||||
migration: $migration,
|
||||
success: true,
|
||||
project: $project,
|
||||
user: $user,
|
||||
@@ -853,6 +852,95 @@ class Migrations extends Action
|
||||
);
|
||||
}
|
||||
|
||||
protected function resolveExportUser(Document $migration): Document
|
||||
{
|
||||
$userInternalId = $migration->getAttribute('options', [])['userInternalId'] ?? null;
|
||||
if (\is_string($userInternalId) && \ctype_digit($userInternalId)) {
|
||||
$userInternalId = (int) $userInternalId;
|
||||
}
|
||||
|
||||
if ($userInternalId === null || $userInternalId === '') {
|
||||
Console::warning('Finalizing export without a user permission for migration ' . $migration->getId() . ': no initiating user.');
|
||||
return new Document([]);
|
||||
}
|
||||
|
||||
$valid = \is_string($userInternalId) || (\is_int($userInternalId) && $userInternalId > 0);
|
||||
if (!$valid) {
|
||||
$error = new \UnexpectedValueException('Invalid initiating user sequence for export migration.');
|
||||
Console::error($error->getMessage() . ' Migration: ' . $migration->getId());
|
||||
$this->reportError($error, $migration);
|
||||
return new Document([]);
|
||||
}
|
||||
|
||||
$user = $this->dbForPlatform->findOne('users', [
|
||||
Query::equal('$sequence', [$userInternalId])
|
||||
]);
|
||||
|
||||
if ($user->isEmpty()) {
|
||||
$error = new \RuntimeException('Initiating user not found for export migration.');
|
||||
Console::error($error->getMessage() . ' Migration: ' . $migration->getId());
|
||||
$this->reportError($error, $migration);
|
||||
}
|
||||
|
||||
return $user;
|
||||
}
|
||||
|
||||
protected function notifyExport(
|
||||
Document $migration,
|
||||
bool $success,
|
||||
Document $project,
|
||||
Document $user,
|
||||
array $options,
|
||||
MailPublisher $publisherForMails,
|
||||
array $platform,
|
||||
string $exportType = 'CSV',
|
||||
string $downloadUrl = '',
|
||||
float $sizeMB = 0.0,
|
||||
): void {
|
||||
try {
|
||||
$this->sendExportEmail(
|
||||
success: $success,
|
||||
project: $project,
|
||||
user: $user,
|
||||
options: $options,
|
||||
publisherForMails: $publisherForMails,
|
||||
platform: $platform,
|
||||
exportType: $exportType,
|
||||
downloadUrl: $downloadUrl,
|
||||
sizeMB: $sizeMB,
|
||||
);
|
||||
} catch (\Throwable $error) {
|
||||
Console::error('Failed to send the export notification for migration ' . $migration->getId() . ': ' . $error->getMessage());
|
||||
$this->reportError($error, $migration);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $extras
|
||||
*/
|
||||
protected function reportError(\Throwable $error, Document $migration, array $extras = []): void
|
||||
{
|
||||
if (!\is_callable($this->logError)) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
($this->logError)(
|
||||
$error,
|
||||
'appwrite-worker',
|
||||
'appwrite-queue-' . self::getName(),
|
||||
[
|
||||
'migrationId' => $migration->getId(),
|
||||
'source' => $migration->getAttribute('source', ''),
|
||||
'destination' => $migration->getAttribute('destination', ''),
|
||||
...$extras,
|
||||
]
|
||||
);
|
||||
} catch (\Throwable $loggingError) {
|
||||
Console::error('Failed to report the migration error: ' . $loggingError->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Send CSV export notification email
|
||||
*
|
||||
@@ -959,21 +1047,6 @@ class Migrations extends Action
|
||||
Console::info("CSV export {$emailType} notification email sent to " . $user->getAttribute('email'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitize a filename to make it filesystem-safe
|
||||
*
|
||||
* @param string $filename
|
||||
* @return string
|
||||
*/
|
||||
protected function sanitizeFilename(string $filename): string
|
||||
{
|
||||
// Replace problematic characters with underscores
|
||||
$sanitized = \preg_replace('/[:\/<>"|*?]/', '_', $filename);
|
||||
$sanitized = \preg_replace('/[^\x20-\x7E]/', '_', $sanitized);
|
||||
$sanitized = \trim($sanitized);
|
||||
return empty($sanitized) ? 'export' : $sanitized;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitize migration errors, removing sensitive information like stack traces
|
||||
*
|
||||
|
||||
@@ -3564,6 +3564,19 @@ trait MigrationsBase
|
||||
$this->assertEquals($response['body']['max'], 65);
|
||||
$this->assertEquals($response['body']['required'], true);
|
||||
|
||||
$this->assertEventually(function () use ($databaseId, $tableId) {
|
||||
foreach (['name', 'age'] as $column) {
|
||||
$response = $this->client->call(Client::METHOD_GET, '/tablesdb/' . $databaseId . '/tables/' . $tableId . '/columns/' . $column, [
|
||||
'content-type' => 'application/json',
|
||||
'x-appwrite-project' => $this->getProject()['$id'],
|
||||
'x-appwrite-key' => $this->getProject()['apiKey'],
|
||||
]);
|
||||
|
||||
$this->assertEquals(200, $response['headers']['status-code']);
|
||||
$this->assertEquals('available', $response['body']['status']);
|
||||
}
|
||||
}, 5_000, 500);
|
||||
|
||||
// make a bucket, upload a file to it!
|
||||
$bucketOne = $this->client->call(Client::METHOD_POST, '/storage/buckets', [
|
||||
'content-type' => 'application/json',
|
||||
@@ -6705,6 +6718,19 @@ trait MigrationsBase
|
||||
$this->assertEquals($response['body']['max'], 65);
|
||||
$this->assertEquals($response['body']['required'], true);
|
||||
|
||||
$this->assertEventually(function () use ($databaseId, $tableId) {
|
||||
foreach (['name', 'age'] as $column) {
|
||||
$response = $this->client->call(Client::METHOD_GET, '/tablesdb/' . $databaseId . '/tables/' . $tableId . '/columns/' . $column, [
|
||||
'content-type' => 'application/json',
|
||||
'x-appwrite-project' => $this->getProject()['$id'],
|
||||
'x-appwrite-key' => $this->getProject()['apiKey'],
|
||||
]);
|
||||
|
||||
$this->assertEquals(200, $response['headers']['status-code']);
|
||||
$this->assertEquals('available', $response['body']['status']);
|
||||
}
|
||||
}, 5_000, 500);
|
||||
|
||||
// make a bucket, upload a file to it!
|
||||
$bucketOne = $this->client->call(Client::METHOD_POST, '/storage/buckets', [
|
||||
'content-type' => 'application/json',
|
||||
|
||||
@@ -0,0 +1,566 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Tests\Unit\Migration;
|
||||
|
||||
use Appwrite\Event\Publisher\Mail as MailPublisher;
|
||||
use Appwrite\Event\Publisher\Usage as UsagePublisher;
|
||||
use Appwrite\Event\Realtime;
|
||||
use Appwrite\Platform\Workers\Migrations;
|
||||
use Appwrite\Usage\Context;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Utopia\Database\Database;
|
||||
use Utopia\Database\Document;
|
||||
use Utopia\Database\Query;
|
||||
use Utopia\Database\Validator\Authorization;
|
||||
use Utopia\Migration\Destination;
|
||||
use Utopia\Migration\Destinations\CSV as DestinationCSV;
|
||||
use Utopia\Migration\Destinations\JSON as DestinationJSON;
|
||||
use Utopia\Migration\Source;
|
||||
use Utopia\Storage\Device;
|
||||
|
||||
final class MigrationsWorkerExportTest extends TestCase
|
||||
{
|
||||
public function testExportDestinationsWriteToMigrationScopedArtifactNames(): void
|
||||
{
|
||||
$worker = new class () extends Migrations {
|
||||
public function destination(Device $deviceForFiles, Document $migration): Destination
|
||||
{
|
||||
$this->deviceForFiles = $deviceForFiles;
|
||||
return $this->processDestination($migration);
|
||||
}
|
||||
};
|
||||
$deviceForFiles = $this->createStub(Device::class);
|
||||
$cases = [
|
||||
[
|
||||
'destination' => DestinationCSV::getName(),
|
||||
'options' => [
|
||||
'bucketId' => 'default',
|
||||
'columns' => [],
|
||||
'delimiter' => ',',
|
||||
'enclosure' => '"',
|
||||
'escape' => '"',
|
||||
'filename' => 'same/name',
|
||||
'header' => true,
|
||||
],
|
||||
],
|
||||
[
|
||||
'destination' => DestinationJSON::getName(),
|
||||
'options' => [
|
||||
'bucketId' => 'default',
|
||||
'columns' => [],
|
||||
'filename' => 'same:name',
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
foreach ($cases as $case) {
|
||||
$destination = $worker->destination($deviceForFiles, new Document([
|
||||
'$id' => 'migration-id',
|
||||
'credentials' => [],
|
||||
'destination' => $case['destination'],
|
||||
'options' => $case['options'],
|
||||
'resourceId' => 'database',
|
||||
]));
|
||||
$property = new \ReflectionProperty($destination, 'outputFile');
|
||||
|
||||
$this->assertSame('migration-id', $property->getValue($destination));
|
||||
|
||||
$destination->cleanUp();
|
||||
}
|
||||
}
|
||||
|
||||
public function testExportCompletionFinalizesWithoutInitiatingUser(): void
|
||||
{
|
||||
$file = null;
|
||||
$dbForPlatform = $this->createMock(Database::class);
|
||||
$dbForPlatform->expects($this->never())->method('findOne');
|
||||
$dbForPlatform
|
||||
->expects($this->once())
|
||||
->method('getDocument')
|
||||
->with('buckets', 'default')
|
||||
->willReturn(new Document([
|
||||
'$id' => 'default',
|
||||
'$sequence' => 1,
|
||||
]));
|
||||
$dbForPlatform
|
||||
->expects($this->once())
|
||||
->method('createDocument')
|
||||
->with(
|
||||
'bucket_1',
|
||||
$this->callback(function (Document $document) use (&$file): bool {
|
||||
$file = $document;
|
||||
return true;
|
||||
})
|
||||
)
|
||||
->willReturnArgument(1);
|
||||
|
||||
$deviceForFiles = $this->createMock(Device::class);
|
||||
$deviceForFiles
|
||||
->expects($this->once())
|
||||
->method('getPath')
|
||||
->with('default/migration-without-user.json')
|
||||
->willReturn('/tmp/migration-without-user.json');
|
||||
$deviceForFiles->expects($this->once())->method('getFileSize')->with('/tmp/migration-without-user.json')->willReturn(256);
|
||||
$deviceForFiles->expects($this->once())->method('getFileMimeType')->with('/tmp/migration-without-user.json')->willReturn('application/json');
|
||||
$deviceForFiles->expects($this->once())->method('getFileHash')->with('/tmp/migration-without-user.json')->willReturn('signature');
|
||||
|
||||
$worker = new class () extends Migrations {
|
||||
public function complete(
|
||||
Database $dbForPlatform,
|
||||
Device $deviceForFiles,
|
||||
Document $migration,
|
||||
MailPublisher $publisherForMails,
|
||||
Realtime $queueForRealtime,
|
||||
Authorization $authorization,
|
||||
): void {
|
||||
$this->dbForPlatform = $dbForPlatform;
|
||||
$this->deviceForFiles = $deviceForFiles;
|
||||
$this->plan = [];
|
||||
$this->handleDataExportComplete(
|
||||
new Document(['$id' => 'project-id']),
|
||||
$migration,
|
||||
$publisherForMails,
|
||||
$queueForRealtime,
|
||||
[],
|
||||
$authorization,
|
||||
);
|
||||
}
|
||||
|
||||
protected function updateMigrationDocument(Document $migration, Document $project, Realtime $queueForRealtime): Document
|
||||
{
|
||||
return $migration;
|
||||
}
|
||||
};
|
||||
|
||||
$migration = new Document([
|
||||
'$id' => 'migration-without-user',
|
||||
'destination' => DestinationJSON::getName(),
|
||||
'options' => [
|
||||
'filename' => 'export',
|
||||
'notify' => false,
|
||||
'userInternalId' => '',
|
||||
],
|
||||
]);
|
||||
|
||||
$previousKey = \getenv('_APP_OPENSSL_KEY_V1');
|
||||
$previousDomain = \getenv('_APP_DOMAIN');
|
||||
\putenv('_APP_OPENSSL_KEY_V1=test-key');
|
||||
\putenv('_APP_DOMAIN=example.test');
|
||||
|
||||
try {
|
||||
$worker->complete(
|
||||
$dbForPlatform,
|
||||
$deviceForFiles,
|
||||
$migration,
|
||||
$this->createStub(MailPublisher::class),
|
||||
$this->createStub(Realtime::class),
|
||||
$this->createStub(Authorization::class),
|
||||
);
|
||||
} finally {
|
||||
$this->restoreEnvironment('_APP_OPENSSL_KEY_V1', $previousKey);
|
||||
$this->restoreEnvironment('_APP_DOMAIN', $previousDomain);
|
||||
}
|
||||
|
||||
$this->assertInstanceOf(Document::class, $file);
|
||||
$this->assertSame([], $file->getPermissions());
|
||||
$this->assertStringContainsString(
|
||||
'/v1/storage/buckets/default/files/',
|
||||
(string) $migration->getAttribute('options')['downloadUrl']
|
||||
);
|
||||
}
|
||||
|
||||
public function testExportCompletionKeepsDisplayNamesButUsesUniquePhysicalPaths(): void
|
||||
{
|
||||
$cases = [
|
||||
['id' => 'same-name-one', 'name' => 'report'],
|
||||
['id' => 'same-name-two', 'name' => 'report'],
|
||||
['id' => 'sanitized-name-one', 'name' => 'sales/2026'],
|
||||
['id' => 'sanitized-name-two', 'name' => 'sales:2026'],
|
||||
];
|
||||
$files = [];
|
||||
$dbForPlatform = $this->createMock(Database::class);
|
||||
$dbForPlatform->expects($this->never())->method('findOne');
|
||||
$dbForPlatform
|
||||
->expects($this->exactly(\count($cases)))
|
||||
->method('getDocument')
|
||||
->with('buckets', 'default')
|
||||
->willReturn(new Document([
|
||||
'$id' => 'default',
|
||||
'$sequence' => 1,
|
||||
]));
|
||||
$dbForPlatform
|
||||
->expects($this->exactly(\count($cases)))
|
||||
->method('createDocument')
|
||||
->with(
|
||||
'bucket_1',
|
||||
$this->callback(function (Document $document) use (&$files): bool {
|
||||
$files[] = $document;
|
||||
return true;
|
||||
})
|
||||
)
|
||||
->willReturnArgument(1);
|
||||
|
||||
$deviceForFiles = $this->createMock(Device::class);
|
||||
$deviceForFiles
|
||||
->expects($this->exactly(\count($cases)))
|
||||
->method('getPath')
|
||||
->willReturnCallback(static fn (string $path): string => '/tmp/' . \basename($path));
|
||||
$deviceForFiles
|
||||
->expects($this->exactly(\count($cases)))
|
||||
->method('getFileSize')
|
||||
->willReturn(256);
|
||||
$deviceForFiles
|
||||
->expects($this->exactly(\count($cases)))
|
||||
->method('getFileMimeType')
|
||||
->willReturn('application/json');
|
||||
$deviceForFiles
|
||||
->expects($this->exactly(\count($cases)))
|
||||
->method('getFileHash')
|
||||
->willReturnCallback(static fn (string $path): string => 'signature:' . $path);
|
||||
|
||||
$worker = new class () extends Migrations {
|
||||
public function complete(
|
||||
Database $dbForPlatform,
|
||||
Device $deviceForFiles,
|
||||
Document $migration,
|
||||
MailPublisher $publisherForMails,
|
||||
Realtime $queueForRealtime,
|
||||
Authorization $authorization,
|
||||
): void {
|
||||
$this->dbForPlatform = $dbForPlatform;
|
||||
$this->deviceForFiles = $deviceForFiles;
|
||||
$this->plan = [];
|
||||
$this->handleDataExportComplete(
|
||||
new Document(['$id' => 'project-id']),
|
||||
$migration,
|
||||
$publisherForMails,
|
||||
$queueForRealtime,
|
||||
[],
|
||||
$authorization,
|
||||
);
|
||||
}
|
||||
|
||||
protected function updateMigrationDocument(Document $migration, Document $project, Realtime $queueForRealtime): Document
|
||||
{
|
||||
return $migration;
|
||||
}
|
||||
};
|
||||
|
||||
$previousKey = \getenv('_APP_OPENSSL_KEY_V1');
|
||||
$previousDomain = \getenv('_APP_DOMAIN');
|
||||
\putenv('_APP_OPENSSL_KEY_V1=test-key');
|
||||
\putenv('_APP_DOMAIN=example.test');
|
||||
|
||||
try {
|
||||
foreach ($cases as $case) {
|
||||
$migration = new Document([
|
||||
'$id' => $case['id'],
|
||||
'destination' => DestinationJSON::getName(),
|
||||
'options' => [
|
||||
'filename' => $case['name'],
|
||||
'notify' => false,
|
||||
'userInternalId' => '',
|
||||
],
|
||||
]);
|
||||
$worker->complete(
|
||||
$dbForPlatform,
|
||||
$deviceForFiles,
|
||||
$migration,
|
||||
$this->createStub(MailPublisher::class),
|
||||
$this->createStub(Realtime::class),
|
||||
$this->createStub(Authorization::class),
|
||||
);
|
||||
|
||||
$file = $files[\array_key_last($files)];
|
||||
$this->assertSame($case['name'], $file->getAttribute('name'));
|
||||
$this->assertSame('/tmp/' . $case['id'] . '.json', $file->getAttribute('path'));
|
||||
$this->assertSame('signature:/tmp/' . $case['id'] . '.json', $file->getAttribute('signature'));
|
||||
$this->assertStringContainsString(
|
||||
'/v1/storage/buckets/default/files/' . $file->getId() . '/push',
|
||||
(string) $migration->getAttribute('options')['downloadUrl']
|
||||
);
|
||||
}
|
||||
} finally {
|
||||
$this->restoreEnvironment('_APP_OPENSSL_KEY_V1', $previousKey);
|
||||
$this->restoreEnvironment('_APP_DOMAIN', $previousDomain);
|
||||
}
|
||||
|
||||
$this->assertCount(\count($cases), \array_unique(\array_map(
|
||||
static fn (Document $file): string => (string) $file->getAttribute('path'),
|
||||
$files,
|
||||
)));
|
||||
}
|
||||
|
||||
public function testExportCompletionNormalizesNumericStringUserInternalId(): void
|
||||
{
|
||||
$user = new Document([
|
||||
'$id' => 'user-id',
|
||||
'$sequence' => 42,
|
||||
]);
|
||||
$dbForPlatform = $this->createMock(Database::class);
|
||||
$dbForPlatform
|
||||
->expects($this->once())
|
||||
->method('findOne')
|
||||
->with(
|
||||
'users',
|
||||
$this->callback(function (array $queries): bool {
|
||||
$this->assertCount(1, $queries);
|
||||
$this->assertInstanceOf(Query::class, $queries[0]);
|
||||
$this->assertSame([42], $queries[0]->getValues());
|
||||
|
||||
return true;
|
||||
})
|
||||
)
|
||||
->willReturn($user);
|
||||
|
||||
$worker = new class () extends Migrations {
|
||||
public function resolve(Database $dbForPlatform, Document $migration): Document
|
||||
{
|
||||
$this->dbForPlatform = $dbForPlatform;
|
||||
return $this->resolveExportUser($migration);
|
||||
}
|
||||
};
|
||||
|
||||
$resolved = $worker->resolve($dbForPlatform, new Document([
|
||||
'$id' => 'migration-with-string-user',
|
||||
'options' => ['userInternalId' => '42'],
|
||||
]));
|
||||
|
||||
$this->assertSame('user-id', $resolved->getId());
|
||||
}
|
||||
|
||||
public function testExportCompletionPreservesMongoStringUserInternalId(): void
|
||||
{
|
||||
$sequence = '019f70db-a902-7127-96fe-f24d908cea2c';
|
||||
$user = new Document([
|
||||
'$id' => 'user-id',
|
||||
'$sequence' => $sequence,
|
||||
]);
|
||||
$dbForPlatform = $this->createMock(Database::class);
|
||||
$dbForPlatform
|
||||
->expects($this->once())
|
||||
->method('findOne')
|
||||
->with(
|
||||
'users',
|
||||
$this->callback(function (array $queries) use ($sequence): bool {
|
||||
$this->assertCount(1, $queries);
|
||||
$this->assertInstanceOf(Query::class, $queries[0]);
|
||||
$this->assertSame([$sequence], $queries[0]->getValues());
|
||||
|
||||
return true;
|
||||
})
|
||||
)
|
||||
->willReturn($user);
|
||||
|
||||
$worker = new class () extends Migrations {
|
||||
public function resolve(Database $dbForPlatform, Document $migration): Document
|
||||
{
|
||||
$this->dbForPlatform = $dbForPlatform;
|
||||
return $this->resolveExportUser($migration);
|
||||
}
|
||||
};
|
||||
|
||||
$resolved = $worker->resolve($dbForPlatform, new Document([
|
||||
'$id' => 'migration-with-mongo-user',
|
||||
'options' => ['userInternalId' => $sequence],
|
||||
]));
|
||||
|
||||
$this->assertSame('user-id', $resolved->getId());
|
||||
}
|
||||
|
||||
public function testExportUserLookupFailurePropagates(): void
|
||||
{
|
||||
$dbForPlatform = $this->createStub(Database::class);
|
||||
$dbForPlatform
|
||||
->method('findOne')
|
||||
->willThrowException(new \RuntimeException('Database unavailable'));
|
||||
|
||||
$worker = new class () extends Migrations {
|
||||
public function resolve(Database $dbForPlatform, Document $migration): Document
|
||||
{
|
||||
$this->dbForPlatform = $dbForPlatform;
|
||||
return $this->resolveExportUser($migration);
|
||||
}
|
||||
};
|
||||
|
||||
$this->expectException(\RuntimeException::class);
|
||||
$this->expectExceptionMessage('Database unavailable');
|
||||
|
||||
$worker->resolve($dbForPlatform, new Document([
|
||||
'$id' => 'migration-with-user',
|
||||
'options' => ['userInternalId' => 42],
|
||||
]));
|
||||
}
|
||||
|
||||
public function testNotificationAndLoggerFailuresDoNotEscape(): void
|
||||
{
|
||||
$reported = 0;
|
||||
$worker = new class () extends Migrations {
|
||||
public function notify(Document $migration, MailPublisher $publisherForMails, callable $logError): void
|
||||
{
|
||||
$this->logError = $logError;
|
||||
$this->notifyExport(
|
||||
migration: $migration,
|
||||
success: true,
|
||||
project: new Document([]),
|
||||
user: new Document([]),
|
||||
options: ['notify' => true],
|
||||
publisherForMails: $publisherForMails,
|
||||
platform: [],
|
||||
);
|
||||
}
|
||||
|
||||
protected function sendExportEmail(
|
||||
bool $success,
|
||||
Document $project,
|
||||
Document $user,
|
||||
array $options,
|
||||
MailPublisher $publisherForMails,
|
||||
array $platform,
|
||||
string $exportType = 'CSV',
|
||||
string $downloadUrl = '',
|
||||
float $sizeMB = 0.0,
|
||||
): void {
|
||||
throw new \RuntimeException('Mail unavailable');
|
||||
}
|
||||
};
|
||||
|
||||
$worker->notify(
|
||||
new Document([
|
||||
'$id' => 'migration-id',
|
||||
'source' => 'Appwrite',
|
||||
'destination' => DestinationJSON::getName(),
|
||||
]),
|
||||
$this->createStub(MailPublisher::class),
|
||||
function () use (&$reported): void {
|
||||
$reported++;
|
||||
throw new \RuntimeException('Logger unavailable');
|
||||
}
|
||||
);
|
||||
|
||||
$this->assertSame(1, $reported);
|
||||
}
|
||||
|
||||
public function testArtifactFinalizationFailureMarksMigrationFailed(): void
|
||||
{
|
||||
$source = $this->createStub(Source::class);
|
||||
$source->method('getErrors')->willReturn([]);
|
||||
$destination = $this->createStub(Destination::class);
|
||||
$destination->method('getErrors')->willReturn([]);
|
||||
|
||||
$worker = new class ($source, $destination) extends Migrations {
|
||||
/** @var array<string> */
|
||||
public array $statuses = [];
|
||||
|
||||
public function __construct(private Source $source, private Destination $destination)
|
||||
{
|
||||
}
|
||||
|
||||
public function process(
|
||||
Document $migration,
|
||||
Realtime $queueForRealtime,
|
||||
MailPublisher $publisherForMails,
|
||||
Context $usage,
|
||||
UsagePublisher $publisherForUsage,
|
||||
Authorization $authorization,
|
||||
): void {
|
||||
$this->project = new Document([
|
||||
'$id' => 'project-id',
|
||||
'$sequence' => 1,
|
||||
]);
|
||||
$this->logError = static function (): void {
|
||||
};
|
||||
|
||||
$this->processMigration(
|
||||
$migration,
|
||||
$queueForRealtime,
|
||||
$publisherForMails,
|
||||
$usage,
|
||||
$publisherForUsage,
|
||||
[],
|
||||
$authorization,
|
||||
);
|
||||
}
|
||||
|
||||
protected function processSource(Document $migration): Source
|
||||
{
|
||||
return $this->source;
|
||||
}
|
||||
|
||||
protected function processDestination(Document $migration): Destination
|
||||
{
|
||||
return $this->destination;
|
||||
}
|
||||
|
||||
protected function handleDataExportComplete(
|
||||
Document $project,
|
||||
Document $migration,
|
||||
MailPublisher $publisherForMails,
|
||||
Realtime $queueForRealtime,
|
||||
array $platform,
|
||||
Authorization $authorization,
|
||||
): void {
|
||||
throw new \RuntimeException('Artifact unavailable');
|
||||
}
|
||||
|
||||
protected function generateAPIKey(Document $project): string
|
||||
{
|
||||
return 'api-key';
|
||||
}
|
||||
|
||||
protected function updateMigrationDocument(Document $migration, Document $project, Realtime $queueForRealtime): Document
|
||||
{
|
||||
$this->statuses[] = (string) $migration->getAttribute('status');
|
||||
return $migration;
|
||||
}
|
||||
};
|
||||
|
||||
$migration = new Document([
|
||||
'$id' => 'migration-id',
|
||||
'$sequence' => 1,
|
||||
'credentials' => [],
|
||||
'destination' => DestinationJSON::getName(),
|
||||
'resourceId' => '',
|
||||
'resourceType' => '',
|
||||
'resources' => [],
|
||||
'source' => 'Test',
|
||||
]);
|
||||
|
||||
$previousHost = \getenv('_APP_MIGRATION_HOST');
|
||||
\putenv('_APP_MIGRATION_HOST=example.test');
|
||||
|
||||
try {
|
||||
$worker->process(
|
||||
$migration,
|
||||
$this->createStub(Realtime::class),
|
||||
$this->createStub(MailPublisher::class),
|
||||
$this->createStub(Context::class),
|
||||
$this->createStub(UsagePublisher::class),
|
||||
$this->createStub(Authorization::class),
|
||||
);
|
||||
} finally {
|
||||
$this->restoreEnvironment('_APP_MIGRATION_HOST', $previousHost);
|
||||
}
|
||||
|
||||
$this->assertSame('failed', $migration->getAttribute('status'));
|
||||
$this->assertSame('finished', $migration->getAttribute('stage'));
|
||||
$this->assertNotContains('completed', $worker->statuses);
|
||||
$this->assertSame('failed', $worker->statuses[array_key_last($worker->statuses)]);
|
||||
$this->assertNotEmpty($migration->getAttribute('errors'));
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|false $value
|
||||
*/
|
||||
private function restoreEnvironment(string $name, string|false $value): void
|
||||
{
|
||||
if ($value === false) {
|
||||
\putenv($name);
|
||||
return;
|
||||
}
|
||||
|
||||
\putenv($name . '=' . $value);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user