Apply suggestions from code review

Co-authored-by: Julien Veyssier <[email protected]>
Signed-off-by: janepie <[email protected]>

Author: janepie

apps/webhook_listeners/lib/BackgroundJobs/WebhookCall.php

@@ -97,7 +97,10 @@ protected function run($argument): void {
 	}
 
 	private function getTokens($webhookListener, $triggerUserId): array {
-		$tokens = [];
+		$tokens = [
+			'users' => [],
+			'functions' => [],
+		];
 		$tokenNeeded = $webhookListener->getTokenNeeded();
 		if (isset($tokenNeeded['users'])) {
 			foreach ($tokenNeeded['users'] as $userId) {

apps/webhook_listeners/lib/Controller/WebhooksController.php

@@ -113,7 +113,7 @@ public function show(int $id): DataResponse {
 	 * @param "none"|"header"|null $authMethod Authentication method to use
 	 * @param ?array<string,mixed> $authData Array of data for authentication
 	 * @param ?array<string,mixed> $tokenNeeded List of user ids for which to include auth tokens in the event.
-	 *                                          Has to fields: "users" lists uids of users for which tokens are needed, "functions" lists functions for which tokens can be included.
+	 *                                          Has two fields: "users" list of user uids for which tokens are needed, "functions" list of functions for which tokens can be included.
 	 *                                          Possible functions: "owner" for the user creating the webhook, "trigger" for the user triggering the webhook call
 	 *
 	 * @return DataResponse<Http::STATUS_OK, WebhookListenersWebhookInfo, array{}>
@@ -186,7 +186,7 @@ public function create(
 	 * @param "none"|"header"|null $authMethod Authentication method to use
 	 * @param ?array<string,mixed> $authData Array of data for authentication
 	 * @param ?array<string,mixed> $tokenNeeded List of user ids for which to include auth tokens in the event.
-	 *                                          Has to fields: "users" lists uids of users for which tokens are needed, "functions" lists functions for which tokens can be included.
+	 *                                          Has two fields: "users" list of user uids for which tokens are needed, "functions" list of functions for which tokens can be included.
 	 *                                          Possible functions: "owner" for the user creating the webhook, "trigger" for the user triggering the webhook call
 	 *
 	 * @return DataResponse<Http::STATUS_OK, WebhookListenersWebhookInfo, array{}>

apps/webhook_listeners/lib/Db/WebhookListener.php

@@ -169,15 +169,15 @@ public function getAppId(): ?string {
 	}
 
 
-	public function createTemporaryToken($userId) {
+	public function createTemporaryToken(string $userId): IToken {
 		$token = $this->generateRandomDeviceToken();
-		$name = 'Authentication for Webhook';
+		$name = 'Ephemeral webhook authentication';
 		$password = null;
 		$deviceToken = $this->tokenProvider->generateToken($token, $userId, $userId, $password, $name, IToken::PERMANENT_TOKEN);
 		return $token;
 	}
 
-	private function generateRandomDeviceToken() {
+	private function generateRandomDeviceToken(): string {
 		$groups = [];
 		for ($i = 0; $i < 5; $i++) {
 			$groups[] = $this->random->generate(5, ISecureRandom::CHAR_HUMAN_READABLE);