nextcloud/server

Allow to get CookieJar in IClientService

Open

#14,447 opened on Feb 28, 2019

View on GitHub
 (4 comments) (0 reactions) (0 assignees)PHP (4,865 forks)batch import
1. to developenhancementgood first issueperformance 🚀technical debt

Repository metrics

Stars
 (34,953 stars)
PR merge metrics
 (Avg merge 20d) (627 merged PRs in 30d)

Description

With IClientService you can get a wrapped GuzzleClient. However you have no way to keep the cookies with our API.

The following would work:

		$cookieJar = new \GuzzleHttp\Cookie\CookieJar();

		$client = $this->clientService->newClient();
		$response = $client->post(
			'.../login', [
				'body' => [
					'name' => $name,
					'password' => $password,
				],
				'cookies' => $cookieJar,
			]
		);

		$response = $client->get(
			'.../authed-api', [
				'cookies' => $cookieJar,
			]
		);

I think we should add a newCookieJar() method to the clientService, to hide the Guzzle CookieJar. I just don't know what to do with the interface, Should we add a dummy around it like with the client? and forward all calls to the internal?

cc @MorrisJobke @rullzer agreed and okay for 16?

Contributor guide

Research direction
Examine the IClientService interface and its implementation to understand how GuzzleClient is wrapped. Then implement a newCookieJar() method that returns a CookieJar or a wrapper, following the existing pattern for hiding the Guzzle implementation.
Tech stack
php
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PHP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70