Refactor session generation

Author: mattwellss

lib/Controller/ScrobblerController.php

@@ -44,22 +44,28 @@ public function __construct(string $appName,
 	 * @PublicPage
 	 * @NoCSRFRequired
 	 * @NoSameSiteCookieRequired
-	 * @throws \TypeError when $userId is null
 	 */
-	public function handleToken(string $token) : ?StandaloneTemplateResponse {
-		$sessionResponse = $this->scrobblerService->generateSession($token, $this->userId);
-		$success = $sessionResponse === 'ok';
-		return new StandaloneTemplateResponse($this->appName, 'scrobble-getsession-result', [
-			'lang' => $this->l10n->getLanguageCode(),
-			'success' => $success,
-			'headline' => $this->l10n->t($success ? 'All set!' : 'Failed to authenticate.'),
-			'getsession_response' => $sessionResponse,
-			'instructions' => $this->l10n->t(
-				$success ?
-					'You are now ready to scrobble.' :
-					'Authentication failure. Please review the error message and try again.'
-			)
-		], 'base');
+	public function handleToken(string $token) : StandaloneTemplateResponse {
+		try {
+			$this->scrobblerService->generateSession($token, $this->userId);
+			$success = true;
+			$headline = 'All Set!';
+			$getSessionResponse = '';
+			$instructions = 'You are now ready to scrobble.';
+		} catch (\Throwable $t) {
+			$success = false;
+			$headline = 'Failed to authenticate.';
+			$getSessionResponse = $t->getMessage();
+			$instructions = 'Authentication failure. Please review the error message and try again.';
+		} finally {
+			return new StandaloneTemplateResponse($this->appName, 'scrobble-getsession-result', [
+				'lang' => $this->l10n->getLanguageCode(),
+				'success' => $success,
+				'headline' => $this->l10n->t($headline),
+				'getsession_response' => $getSessionResponse,
+				'instructions' => $this->l10n->t($instructions)
+			], 'base');
+		}
 	}
 
 	/**

lib/Service/ScrobblerService.php

@@ -57,7 +57,10 @@ public function __construct(
 		$this->appName = $appName;
 	}
 
-	public function generateSession(string $token, string $userId): string {
+	/**
+	 * @throws \Throwable when unable to generate or save a session
+	 */
+	public function generateSession(string $token, string $userId) : void {
 		$scrobbleService = $this->getApiService();
 		$ch = $this->makeCurlHandle($scrobbleService);
 		$params = $this->generateBaseMethodParams('auth.getSession');
@@ -69,7 +72,7 @@ public function generateSession(string $token, string $userId): string {
 
 		$status = (string)$xml['status'];
 		if ($status !== 'ok') {
-			return \sprintf('Error %d: %s', (int)$xml->error['code'], (string)$xml->error);
+			throw new \Exception((string)$xml->error, (int)$xml->error['code']);
 		}
 
 		try {
@@ -79,10 +82,9 @@ public function generateSession(string $token, string $userId): string {
 			);
 			$this->config->setUserValue($userId, $this->appName, 'scrobbleSessionKey', $encryptedKey);
 		} catch (\Throwable $e) {
-			$this->logger->error("Unable to save session key");
-			return $e->getMessage();
+			$this->logger->error('Unable to save session key ' . $e->getMessage());
+			throw $e;
 		}
-		return 'ok';
 	}
 
 	public function getApiKey() : ?string {
@@ -211,13 +213,14 @@ private function generateBaseMethodParams(string $method) : array {
 	}
 
 	/**
-	 * @return false|resource in PHP8+ false|\CurlHandle
+	 * @return resource in PHP8+ \CurlHandle
+	 * @throws \RuntimeException when unable to initialize a cURL handle
 	 */
 	private function makeCurlHandle(string $scrobblerServiceIdentifier) {
 		$endpoint = self::SCROBBLE_SERVICES[$scrobblerServiceIdentifier]['endpoint'];
 		$ch = \curl_init($endpoint);
 		if (!$ch) {
-			return false;
+			throw new \RuntimeException('Unable to initialize a cURL handle');
 		}
 		\curl_setopt($ch, \CURLOPT_CONNECTTIMEOUT, 10);
 		\curl_setopt($ch, \CURLOPT_POST, true);