Skip to content

Change api signature to require etag #403

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
lukasdotcom merged 1 commit into from
Apr 14, 2026
Merged

Change api signature to require etag #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions lib/Controller/ApprovalController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,12 @@ public function getPendingNodes(?int $since = null): DataResponse {
* Approve a file
*
* @param int $fileId
* @param string $etag
* @param string|null $message
* @param string|null $etag
* @return DataResponse
*/
#[NoAdminRequired]
public function approve(int $fileId, ?string $message = '', ?string $etag = ''): DataResponse {
public function approve(int $fileId, string $etag, ?string $message = ''): DataResponse {
try {
if ($this->approvalService->approve($fileId, $this->userId, $message, $etag)) {
return new DataResponse([]);
Expand All @@ -98,12 +98,12 @@ public function approve(int $fileId, ?string $message = '', ?string $etag = ''):
* Reject a file
*
* @param int $fileId
* @param string $etag
* @param string|null $message
* @param string|null $etag
* @return DataResponse
*/
#[NoAdminRequired]
public function reject(int $fileId, ?string $message = '', ?string $etag = ''): DataResponse {
public function reject(int $fileId, string $etag, ?string $message = ''): DataResponse {
try {
if ($this->approvalService->reject($fileId, $this->userId, $message, $etag)) {
return new DataResponse([]);
Expand Down
12 changes: 6 additions & 6 deletions lib/Service/ApprovalService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,14 +353,14 @@ public function getApprovalState(int $fileId, ?string $userId, bool $userHasAcce
*
* @param int $fileId
* @param string|null $userId
* @param string $etag
* @param string $message
* @param string $etag optional etag of the file to check if it has changed since approval was requested
* @return bool success
* @throws OutdatedEtagException
*/
public function approve(int $fileId, ?string $userId, string $message = '', string $etag = ''): bool {
public function approve(int $fileId, ?string $userId, string $etag, string $message = ''): bool {
$fileState = $this->getApprovalState($fileId, $userId);
if ($etag !== '' && $etag !== $this->getEtag($fileId)) {
if ($etag !== $this->getEtag($fileId)) {
throw new OutdatedEtagException();
}
// if file has pending tag and user is authorized to approve it
Expand Down Expand Up @@ -396,14 +396,14 @@ public function approve(int $fileId, ?string $userId, string $message = '', stri
*
* @param int $fileId
* @param string|null $userId
* @param string $etag
* @param string $message
* @param string $etag optional etag of the file to check if it has changed since approval was requested
* @return bool success
* @throws OutdatedEtagException
*/
public function reject(int $fileId, ?string $userId, string $message = '', string $etag = ''): bool {
public function reject(int $fileId, ?string $userId, string $etag, string $message = ''): bool {
$fileState = $this->getApprovalState($fileId, $userId);
if ($etag !== '' && $etag !== $this->getEtag($fileId)) {
if ($etag !== $this->getEtag($fileId)) {
throw new OutdatedEtagException();
}
// if file has pending tag and user is authorized to approve it
Expand Down
12 changes: 4 additions & 8 deletions tests/unit/Service/ApprovalServiceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,10 @@
use OCP\IL10N;
use OCP\IUserManager;
use OCP\Notification\IManager as INotificationManager;

use OCP\Share\IManager as IShareManager;

use OCP\Share\IShare;

use OCP\SystemTag\ISystemTagManager;
use OCP\SystemTag\ISystemTagObjectMapper;

use Psr\Log\LoggerInterface;

class ApprovalServiceTest extends TestCase {
Expand Down Expand Up @@ -365,24 +361,24 @@ public function testApproval() {
// approve failures
// tag does not exist
$this->ruleService->saveRule($idRule3, $idTagPending3, -1, $idTagRejected3, $approvers, $requesters, $description, $unapproveWhenModified);
$result = $this->approvalService->approve($fileToReject->getId(), 'user1');
$result = $this->approvalService->approve($fileToReject->getId(), 'user1', $fileToReject->getEtag());
$this->assertFalse($result);
$this->ruleService->saveRule($idRule3, $idTagPending3, $idTagApproved3, $idTagRejected3, $approvers, $requesters, $description, $unapproveWhenModified);

// approve
$this->approvalService->approve($fileToApprove->getId(), 'user1');
$this->approvalService->approve($fileToApprove->getId(), 'user1', $fileToApprove->getEtag());
$stateForUser1 = $this->approvalService->getApprovalState($fileToApprove->getId(), 'user1');
$this->assertEquals(Application::STATE_APPROVED, $stateForUser1['state']);

// reject failures
// tag does not exist
$this->ruleService->saveRule($idRule3, $idTagPending3, $idTagApproved3, -1, $approvers, $requesters, $description, $unapproveWhenModified);
$result = $this->approvalService->reject($fileToReject->getId(), 'user1');
$result = $this->approvalService->reject($fileToReject->getId(), 'user1', $fileToReject->getEtag());
$this->assertFalse($result);
$this->ruleService->saveRule($idRule3, $idTagPending3, $idTagApproved3, $idTagRejected3, $approvers, $requesters, $description, $unapproveWhenModified);

// reject
$this->approvalService->reject($fileToReject->getId(), 'user1');
$this->approvalService->reject($fileToReject->getId(), 'user1', $fileToReject->getEtag());
$stateForUser1 = $this->approvalService->getApprovalState($fileToReject->getId(), 'user1');
$this->assertEquals(Application::STATE_REJECTED, $stateForUser1['state']);
}
Expand Down
Loading