-
-
Notifications
You must be signed in to change notification settings - Fork 4k
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.
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
feat: webhooks_listeners app: send direct requests to ExApps using AppAPI #46477
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,7 @@ | |
|
||
/** | ||
* @method void setUserId(string $userId) | ||
* @method ?string getAppId() | ||
* @method string getUserId() | ||
* @method string getHttpMethod() | ||
* @method string getUri() | ||
|
@@ -139,4 +140,8 @@ public function jsonSerialize(): array { | |
) | ||
); | ||
} | ||
|
||
public function getAppId(): ?string { | ||
return $this->appId; | ||
} | ||
Comment on lines
+143
to
+146
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You do not need to add the method, it’s a DB entity there is a magic method for this already. |
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,92 @@ | ||
<?php | ||
|
||
namespace OCA\AppAPI\Service; | ||
|
||
use OCP\IRequest; | ||
|
||
class AppAPIService { | ||
/** | ||
* @param IRequest $request | ||
* @param bool $isDav | ||
* | ||
* @return bool | ||
*/ | ||
public function validateExAppRequestToNC(IRequest $request, bool $isDav = false): bool {} | ||
namespace OCA\AppAPI\Service { | ||
use OCP\IRequest; | ||
|
||
class AppAPIService { | ||
/** | ||
* @param IRequest $request | ||
* @param bool $isDav | ||
* | ||
* @return bool | ||
*/ | ||
public function validateExAppRequestToNC(IRequest $request, bool $isDav = false): bool {} | ||
} | ||
} | ||
|
||
namespace OCA\AppAPI { | ||
|
||
use OCP\IRequest; | ||
use OCP\Http\Client\IPromise; | ||
use OCP\Http\Client\IResponse; | ||
|
||
class PublicFunctions { | ||
|
||
public function __construct( | ||
private readonly ExAppService $exAppService, | ||
private readonly AppAPIService $service, | ||
) { | ||
} | ||
|
||
/** | ||
* Request to ExApp with AppAPI auth headers | ||
*/ | ||
public function exAppRequest( | ||
string $appId, | ||
string $route, | ||
?string $userId = null, | ||
string $method = 'POST', | ||
array $params = [], | ||
array $options = [], | ||
?IRequest $request = null, | ||
): array|IResponse { | ||
$exApp = $this->exAppService->getExApp($appId); | ||
if ($exApp === null) { | ||
return ['error' => sprintf('ExApp `%s` not found', $appId)]; | ||
} | ||
return $this->service->requestToExApp($exApp, $route, $userId, $method, $params, $options, $request); | ||
} | ||
|
||
/** | ||
* Async request to ExApp with AppAPI auth headers | ||
* | ||
* @throws \Exception if ExApp not found | ||
*/ | ||
public function asyncExAppRequest( | ||
string $appId, | ||
string $route, | ||
?string $userId = null, | ||
string $method = 'POST', | ||
array $params = [], | ||
array $options = [], | ||
?IRequest $request = null, | ||
): IPromise { | ||
$exApp = $this->exAppService->getExApp($appId); | ||
if ($exApp === null) { | ||
throw new \Exception(sprintf('ExApp `%s` not found', $appId)); | ||
} | ||
return $this->service->requestToExAppAsync($exApp, $route, $userId, $method, $params, $options, $request); | ||
} | ||
|
||
/** | ||
* Get basic ExApp info by appid | ||
* | ||
* @param string $appId | ||
* | ||
* @return array|null ExApp info (appid, version, name, enabled) or null if no ExApp found | ||
*/ | ||
public function getExApp(string $appId): ?array { | ||
$exApp = $this->exAppService->getExApp($appId); | ||
if ($exApp !== null) { | ||
$info = $exApp->jsonSerialize(); | ||
return [ | ||
'appid' => $info['appid'], | ||
'version' => $info['version'], | ||
'name' => $info['name'], | ||
'enabled' => $info['enabled'], | ||
]; | ||
} | ||
return null; | ||
} | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check notice
Code scanning / Psalm
PossiblyInvalidMethodCall Note