Skip to content

Handle redirect on error when saving permissions or related items #1296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
didoda merged 2 commits into from
Aug 6, 2025
Merged

Handle redirect on error when saving permissions or related items #1296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fc16eb
feat: handleError on saving permissions or related
didoda Aug 6, 2025
ecdc51c
tests: handle error
didoda Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 34 additions & 19 deletions src/Controller/ModulesController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,15 +326,23 @@ public function save(): void
$response = $this->apiClient->getObject($id, $this->objectType);
}
if (!$skipSavePermissions) {
$this->savePermissions(
(array)$response,
$schema,
$permissions
);
try {
$this->savePermissions(
(array)$response,
$schema,
$permissions
);
} catch (BEditaClientException $error) {
$this->handleError($error);
}
}
$id = (string)Hash::get($response, 'data.id');
if (!$skipSaveRelated) {
$this->Modules->saveRelated($id, $this->objectType, $relatedData);
try {
$this->Modules->saveRelated($id, $this->objectType, $relatedData);
} catch (BEditaClientException $error) {
$this->handleError($error);
}
}
$options = [
'id' => Hash::get($response, 'data.id'),
Expand All @@ -344,11 +352,7 @@ public function save(): void
$event = new Event('Controller.afterSave', $this, $options);
$this->getEventManager()->dispatch($event);
} catch (BEditaClientException $error) {
$message = new Message($error);
$this->log($message->get(), LogLevel::ERROR);
$this->Flash->error($message->get(), ['params' => $error]);
$this->set(['error' => $message->get()]);
$this->setSerialize(['error']);
$this->handleError($error);

return;
}
Expand All @@ -362,6 +366,23 @@ public function save(): void
$this->setSerialize(array_keys($response));
}

/**
* Handle exception error: log, flash and set.
*
* @param \BEdita\SDK\BEditaClientException $exception The exception
* @return void
*/
protected function handleError(BEditaClientException $exception): void
{
$message = new Message($exception);
$this->log($message->get(), LogLevel::ERROR);
$this->Flash->error($message->get(), ['params' => $exception]);
$error = $this->viewBuilder()->getVar('error') ?? [];
$error = is_array($error) ? array_merge($error, [$message->get()]) : [$error, $message->get()];
$this->set(['error' => $error]);
$this->setSerialize(['error']);
}

/**
* Clone single object.
*
Expand Down Expand Up @@ -459,10 +480,7 @@ public function related($id, string $relation): void
$response = $this->apiClient->getRelated($id, $this->objectType, $relation, $query);
$response = $this->ApiFormatter->embedIncluded((array)$response);
} catch (BEditaClientException $error) {
$this->log($error->getMessage(), LogLevel::ERROR);

$this->set(compact('error'));
$this->setSerialize(['error']);
$this->handleError($error);

return;
}
Expand All @@ -488,10 +506,7 @@ public function resources($id, string $type): void
try {
$response = $this->apiClient->get($type, $query);
} catch (BEditaClientException $error) {
$this->log($error, LogLevel::ERROR);

$this->set(compact('error'));
$this->setSerialize(['error']);
$this->handleError($error);

return;
}
Expand Down
60 changes: 59 additions & 1 deletion tests/TestCase/Controller/ModulesControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1315,7 +1315,7 @@ public function testSavePermissions(): void
],
'post' => [
'id' => 123456789,
'permissions' => ['1','2','3'],
'permissions' => ['1', '2', '3'],
],
'params' => [
'object_type' => 'folders',
Expand Down Expand Up @@ -1546,4 +1546,62 @@ public function save(string $type, array $data, ?array $headers = null): ?array
static::assertTrue($apiClient->getSave(), 'ApiClient save method should be called when no post data is provided');
static::assertFalse($apiClient->getLoad(), 'ApiClient load method should not be called to load object');
}

/**
* Test errors when saving permissions and related data
*
* @return void
* @covers ::save()
* @covers ::handleError()
*/
public function testSaveErrorPermissionsAndRelatedData(): void
{
$this->setupController();
$config = [
'environment' => [
'REQUEST_METHOD' => 'POST',
],
'post' => [
'title' => 'Test Dummy',
'_api' => [['method' => 'addRelated', 'type' => 'dummies', 'relatedIds' => [['id' => 1, 'type' => 'dummies'], ['id' => 2, 'type' => 'dummies']]]],
'permissions' => ['1', '2', '3'],
],
'params' => [
'object_type' => 'documents',
],
];
$request = new ServerRequest($config);
$this->controller = new class ($request) extends ModulesControllerSample
{
public function savePermissions(array $response, array $schema, array $newPermissions): bool
{
throw new BEditaClientException('save permission debug error');
}
};
$registry = $this->controller->components();
$component = new class ($registry) extends ModulesComponent
{
public function skipSavePermissions(string $id, array $requestPermissions, array $schema): bool
{
return false; // do not skip save permissions
}

public function skipSaveRelated(string $id, array &$relatedData): bool
{
return false; // do not skip save related
}

public function saveRelated(string $id, string $type, array $relatedData): void
{
throw new BEditaClientException('save related debug error');
}
};
$this->controller->Modules = $component;
$this->controller->save();
$actual = $this->controller->viewBuilder()->getVar('error');
static::assertIsArray($actual);
static::assertCount(2, $actual);
static::assertStringContainsString('save permission debug error', $actual[0]);
static::assertStringContainsString('save related debug error', $actual[1]);
}
}
Loading