I implemented a straightforward cookie collection mechanism #66

hacan359 · 2024-10-21T16:02:16Z

In my project, I needed to work with cookies from requests in different parts of the application. I couldn't find a ready-made solution, so I created my own locally. It's a simple collection that is populated in middleware and can be used from anywhere in the code, along with a straightforward implementation of a provider for the collection.

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌
Fixed issues	comma-separated list of tickets # fixed by the PR, if any

…ws for project work from any place

vjik

Overall I like this PR.

Suggest move all new files to RequestCookies folder. One feature - one directory.

src/RequestCookieCollection.php

src/RequestCookieCollectionMiddleware.php

src/RequestCookieProviderInterface.php

src/RequestCookieCollection.php

…est-cookies-collection

… request-cookies-collection

codecov · 2024-10-25T15:08:14Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ceba1d0) to head (71b9b6b).
Report is 6 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff             @@
##              master       #66   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity       132       146   +14     
===========================================
  Files              5         9    +4     
  Lines            338       366   +28     
===========================================
+ Hits             338       366   +28

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

vjik · 2024-10-26T09:17:07Z

config/di-web.php

+    RequestCookiesProviderInterface::class => [
+        'class' => RequestCookiesProvider::class,
+    ],


Suggested change

RequestCookiesProviderInterface::class => [

'class' => RequestCookiesProvider::class,

],

RequestCookiesProviderInterface::class => RequestCookiesProvider::class,

vjik · 2024-10-26T09:18:07Z

src/RequestCookies/Exception/RequestCookieCollectionNotSetException.php

+
+declare(strict_types=1);
+
+namespace Yiisoft\Cookies\RequestCookies\Exception;


Suggested change

namespace Yiisoft\Cookies\RequestCookies\Exception;

namespace Yiisoft\Cookies\RequestCookies;

vjik · 2024-10-26T09:23:45Z

src/RequestCookies/Exception/RequestCookieCollectionNotSetException.php

+use Throwable;
+
+/**
+ * Thrown when Request cookie collect isn't set before.


Suggested change

* Thrown when Request cookie collect isn't set before.

* Thrown when request cookies isn't set before.

vjik · 2024-10-26T09:23:57Z

src/RequestCookies/Exception/RequestCookieCollectionNotSetException.php

+{
+    public function __construct(int $code = 0, ?Throwable $previous = null)
+    {
+        parent::__construct('Request cookie collect is not set.', $code, $previous);


Suggested change

parent::__construct('Request cookie collect is not set.', $code, $previous);

parent::__construct('Request cookies is not set.', $code, $previous);

vjik · 2024-10-26T09:25:08Z

src/RequestCookies/RequestCookies.php

+     *
+     * @see getValue()


Suggested change

*

* @see getValue()

vjik · 2024-10-26T09:26:29Z

src/RequestCookies/RequestCookiesProvider.php

+    /**
+     * @var RequestCookies|null The collection.
+     */
+    private ?RequestCookies $cookieCollection = null;


Suggested change

private ?RequestCookies $cookieCollection = null;

private ?RequestCookies $cookies = null;

vjik · 2024-10-26T09:26:43Z

src/RequestCookies/RequestCookiesProviderInterface.php

+     *
+     * @param RequestCookies $cookieCollection The collection to set.
+     */
+    public function set(RequestCookies $cookieCollection): void;


Suggested change

public function set(RequestCookies $cookieCollection): void;

public function set(RequestCookies $cookies): void;

vjik · 2024-10-26T09:36:27Z

src/RequestCookies/RequestCookiesCollectorMiddleware.php

+        $cookies = $this->collectCookies($request);
+        $this->cookieProvider->set(new RequestCookies($cookies));


Suggested change

$cookies = $this->collectCookies($request);

$this->cookieProvider->set(new RequestCookies($cookies));

$this->cookieProvider->set(new RequestCookies($request->getCookieParams()));

Seems, getCookieParams always contains array<string,string>, isn't he?

vjik · 2024-10-26T09:37:30Z

README.md

@@ -146,6 +146,46 @@ $cookie = (new \Yiisoft\Cookies\Cookie('cookieName'))
    ->withRawValue('ebaKUq90PhiHck_MR7st-E1SxhbYWiTsLo82mCTbNuAh7rgflx5LVsYfJJseyQCrODuVcJkTSYhm1WKte-l5lQ==')
 ```

+Work with cookie request collection from any place in you project. Add in config you app in middleware block


Suggested change

Work with cookie request collection from any place in you project. Add in config you app in middleware block

### Request cookies collection

You can work with cookie request collection from any place in you project. Add in config you app in middleware block

vjik · 2024-10-26T09:37:52Z

README.md

+    }
+}
+```
+```


Suggested change

```

vjik

Add line to changelog

xepozz · 2024-10-26T12:37:58Z

src/RequestCookies/RequestCookiesCollectorMiddleware.php

+            if (!is_string($name) || !is_string($value)) {
+                continue;
+            }
+            $collection[$name] = $value;


How can I access expires, domain and other parameters later?

xepozz · 2024-10-26T12:38:50Z

src/RequestCookies/RequestCookiesProviderInterface.php

+    /**
+     * Get the current request cookie collection.
+     *
+     * @throws RequestCookieCollectionNotSetException


I'd return an empty collection instead

xepozz · 2024-10-26T12:40:01Z

src/RequestCookies/RequestCookiesProviderInterface.php

+/**
+ * Provides a way to set the current cookie collection and then get it when needed.
+ */
+interface RequestCookiesProviderInterface


CookiesProvider sounds better than RequestCookiesProvider

xepozz · 2024-10-26T12:42:33Z

src/RequestCookies/RequestCookiesProvider.php

+     */
+    private ?RequestCookies $cookieCollection = null;
+
+    public function set(RequestCookies $cookieCollection): void


I'd have an empty collection in this class and merge two collections instead.
Moreover it can be used in two ways:
The first is as you did
The second is the similar that error-handler has: set parameters in the app and add them back to request in a post-middleware later. Wdyt?

vjik · 2024-10-26T16:32:04Z

Closed in favor yiisoft/request-provider#11

hcan359 and others added 2 commits October 21, 2024 18:57

I implemented a straightforward cookie collection mechanism that allo…

8f3fbee

…ws for project work from any place

Merge branch 'master' into request-cookies-collection

b1bebe6

vjik requested changes Oct 25, 2024

View reviewed changes

hcan359 added 2 commits October 25, 2024 18:04

Merge branch 'master' of https://github.com/yiisoft/cookies into requ…

2bef751

…est-cookies-collection

Merge remote-tracking branch 'origin/request-cookies-collection' into…

0a92769

… request-cookies-collection

hcan359 added 7 commits October 25, 2024 18:46

Transfer feature in new folder RequestCookies

3c47fb1

add definition

2b670f6

composer dev php 8.0 support

9a9ccc6

composer dev php 7.4 support

f4205c0

100% coverage new file

8eb1f9b

code style =)

adb94ea

code style =)

71b9b6b

vjik requested changes Oct 26, 2024

View reviewed changes

vjik reviewed Oct 26, 2024

View reviewed changes

vjik added the status:code review The pull request needs review. label Oct 26, 2024

vjik requested a review from a team October 26, 2024 09:39

xepozz requested changes Oct 26, 2024

View reviewed changes

vjik closed this Oct 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

I implemented a straightforward cookie collection mechanism #66

I implemented a straightforward cookie collection mechanism #66

hacan359 commented Oct 21, 2024

vjik left a comment

codecov bot commented Oct 25, 2024 •

edited

Loading

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik Oct 26, 2024

vjik left a comment

xepozz Oct 26, 2024

xepozz Oct 26, 2024

xepozz Oct 26, 2024

xepozz Oct 26, 2024

vjik commented Oct 26, 2024


		declare(strict_types=1);

		namespace Yiisoft\Cookies\RequestCookies\Exception;

	* Thrown when Request cookie collect isn't set before.
	* Thrown when request cookies isn't set before.

	parent::__construct('Request cookie collect is not set.', $code, $previous);
	parent::__construct('Request cookies is not set.', $code, $previous);

	private ?RequestCookies $cookieCollection = null;
	private ?RequestCookies $cookies = null;

	public function set(RequestCookies $cookieCollection): void;
	public function set(RequestCookies $cookies): void;

		$cookies = $this->collectCookies($request);
		$this->cookieProvider->set(new RequestCookies($cookies));

-Work with cookie request collection from any place in you project. Add in config you app in middleware block
+### Request cookies collection
+You can work with cookie request collection from any place in you project. Add in config you app in middleware block

I implemented a straightforward cookie collection mechanism #66

I implemented a straightforward cookie collection mechanism #66

Conversation

hacan359 commented Oct 21, 2024

vjik left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 25, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vjik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vjik commented Oct 26, 2024

codecov bot commented Oct 25, 2024 •

edited

Loading