Skip to content
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

[RELEASE-V8] Add new fields #33

Merged
merged 11 commits into from
May 23, 2024
Merged

[RELEASE-V8] Add new fields #33

merged 11 commits into from
May 23, 2024

Conversation

StevenRenaux
Copy link
Collaborator

@StevenRenaux StevenRenaux commented Apr 14, 2024

Add new form fields failOnHttpStatusCodes
Add new form fields skipNetworkIdleEvent
Add new form fields cookies

@StevenRenaux StevenRenaux requested review from Neirda24 and Jean-Beru and removed request for Neirda24 April 14, 2024 14:50
*
* @see https://gotenberg.dev/docs/routes#cookies-chromium
*/
public function addCookies(array $cookies): static
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addCookie or just cookie ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As addExtraHttpHeader you can add cookies in addition to the ones in the configuration file if needed.

And if not use cookies only.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can have a look about the doc where I explain that 😉 Let me know what you think
https://github.com/sensiolabs/GotenbergBundle/pull/33/files#diff-dbcb3d682e3e3080ba4b0f0195b7215457be7782b74898ccbefed9a74ba3be26R267

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So addCookies could be named addCookie since we only add one.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the method if the user wants to add several to those already loaded from their configuration file.
WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is confusing. On other classes we have singulars on add methods. I don't see why this one needs to be different. But maybe I'm just missing something.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about addExtraHttpHeaders when I created that one.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know and I can rename it ;)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we name them addCookies and addExtraHttpHeaders, they should accept a list. If we name them without a "s" (addCookie and addExtraHttpHeader), they should accept a single value.

PS: I don't have a strong opinion on choosing one of these two solutions

docs/customization.rst Show resolved Hide resolved
docs/customization.rst Show resolved Hide resolved
*/
public function addCookies(array $cookies): static
{
$this->formFields['cookies'][] = $cookies;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should ensure cookies is already a [] with $this->formFields['cookies'] ??= [] before

src/Builder/AbstractPdfBuilder.php Outdated Show resolved Hide resolved
src/DependencyInjection/Configuration.php Outdated Show resolved Hide resolved
…v8-add-new-fields

# Conflicts:
#	docs/configuration.rst
#	docs/customization.rst
#	src/Builder/AbstractChromiumPdfBuilder.php
#	src/DependencyInjection/Configuration.php
#	tests/Builder/HtmlPdfBuilderTest.php
#	tests/DependencyInjection/ConfigurationTest.php
#	tests/DependencyInjection/SensiolabsGotenbergExtensionTest.php
Copy link
Contributor

@Neirda24 Neirda24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about instead of passing by an associative array we type with the cookie object from symfony directly?

@Jean-Beru
Copy link
Contributor

What about instead of passing by an associative array we type with the cookie object from symfony directly?

IMO, we should avoid a new dependency with HttpFoundation just for this option.

@StevenRenaux
Copy link
Collaborator Author

Add setCookie method as talked with @Neirda24

docs/customization.rst Outdated Show resolved Hide resolved
docs/configuration.rst Outdated Show resolved Hide resolved
src/DependencyInjection/Configuration.php Outdated Show resolved Hide resolved
src/DependencyInjection/Configuration.php Outdated Show resolved Hide resolved
src/DependencyInjection/Configuration.php Outdated Show resolved Hide resolved
@Neirda24 Neirda24 merged commit df93c4a into sensiolabs:main May 23, 2024
@Jean-Beru Jean-Beru added this to the v8.0.0 milestone May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants