Introduce `quarkus.http.header` #21102

gastaldi · 2021-10-29T19:44:43Z

This allows to explicitly set fixed headers on HTTP responses

docs/src/main/asciidoc/http-reference.adoc

geoand · 2021-10-30T05:43:47Z

How is this expected to behave when there is an exception?

How about when then header has already been set by the application?

gastaldi · 2021-10-30T12:06:18Z

The idea here is to use it for fixed headers, specially those from https://wiki.owasp.org/index.php/OWASP_Secure_Headers_Project, which must be set regardless of the outcome.

Other cases should adopt a filter instead

geoand · 2021-10-30T12:10:40Z

But is that how this behaves?

Furthermore, have you tried it (and added tests) for all the various HTTP options (pure Vert.x, Reactive Routes, RESTEasy Classic and RESTEasy Reactive)?

Also, the expected usage and behavior should be very clearly documented

gastaldi · 2021-10-30T12:16:26Z

Furthermore, have you tried it (and added tests) for all the various HTTP options (pure Vert.x, Reactive Routes, RESTEasy Classic and RESTEasy Reactive)?

No, I assumed it would work since they all use vertx-http, but maybe it would be nice to have tests for them too

gastaldi · 2021-10-30T12:36:56Z

I think another common use case would be to add headers for a specific URL pattern.

I'll change it to a draft meanwhile

...nsions/vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/VertxHttpRecorder.java

gastaldi · 2021-10-31T23:44:03Z

Moving out of draft. I believe this should be enough to allow setting fixed headers in the application regardless on the requested URL.

I'll check about having tests for the other HTTP options as mentioned by @geoand in #21102 (comment) (probably in a separate PR)

stuartwdouglas · 2021-10-31T23:58:23Z

...nsions/vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/VertxHttpRecorder.java

+            httpRouteRouter.route().order(Integer.MIN_VALUE).handler(new Handler<RoutingContext>() {
+                @Override
+                public void handle(RoutingContext event) {
+                    event.response().headers().addAll(headers);


Technically the application could clear this map, which is not uncommon in the case of errors (e.g. if you are sending an error response you might clear this to make sure nothing is left over from the failed response).

I don't know how much this matters.

Well, the primary goal of this feature is to set HTTP Headers in the response without having to write additional code. I think in the use case you described this would be still valid.

At least, the application can check the headers and decide if they need to be removed or not (even is most of the time, we just call clear).

quarkus-bot · 2021-11-01T03:49:21Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `ebb18f0`

Status	Name	Step	Failures	Logs	Raw logs
✖	Native Tests - Windows - hibernate-validator	`Build`	Failures	Logs	Raw logs

Failures

⚙️ Native Tests - Windows - hibernate-validator #

- Failing: integration-tests/hibernate-validator

📦 integration-tests/hibernate-validator

✖ Failed to execute goal io.quarkus:quarkus-maven-plugin:999-SNAPSHOT:build (default) on project quarkus-integration-test-hibernate-validator: Failed to build quarkus application

...nsions/vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/HttpConfiguration.java

cescoffier · 2021-11-01T09:06:32Z

...nsions/vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/VertxHttpRecorder.java

+            httpRouteRouter.route().order(Integer.MIN_VALUE).handler(new Handler<RoutingContext>() {
+                @Override
+                public void handle(RoutingContext event) {
+                    event.response().headers().addAll(headers);


At least, the application can check the headers and decide if they need to be removed or not (even is most of the time, we just call clear).

gastaldi · 2021-11-02T00:47:47Z

Do you guys think that we should support paths in this PR or this can be achieved in a separate PR?

eg.

quarkus.http.header.Pragma.value=no-cache
quarkus.http.header.Pragma.path="/foo/bar"

Would apply the Pragma header only when /foo/baris requested

gastaldi · 2021-11-02T00:55:56Z

I think I'll implement support for path and method(s) in the Header configuration in this PR, this would make it more flexible IMHO

...nsions/vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/VertxHttpRecorder.java

This allows to explicitly set fixed headers on HTTP responses Support path and method for the header Signed-off-by: George Gastaldi <[email protected]>

quarkus-bot · 2021-11-03T02:47:40Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `5934870`

Status	Name	Step	Failures	Logs	Raw logs
✔️	JVM Tests - JDK 11
✖	JVM Tests - JDK 17	`Build`	Failures	Logs	Raw logs

Full information is available in the Build summary check run.

Failures

⚙️ JVM Tests - JDK 17 #

- Failing: integration-tests/vault-agroal

📦 integration-tests/vault-agroal

✖ io.quarkus.vault.AgroalVaultITCase. - More details - Source on GitHub

java.lang.RuntimeException: Error waiting for test resource future to finish.
	at io.quarkus.test.common.TestResourceManager.waitForAllFutures(TestResourceManager.java:151)
	at io.quarkus.test.common.TestResourceManager.start(TestResourceManager.java:136)

✖ io.quarkus.vault.AgroalVaultKv1ITCase. - More details - Source on GitHub

java.lang.RuntimeException: Error waiting for test resource future to finish.
	at io.quarkus.test.common.TestResourceManager.waitForAllFutures(TestResourceManager.java:151)
	at io.quarkus.test.common.TestResourceManager.start(TestResourceManager.java:136)

✖ io.quarkus.vault.VaultKv1ITCase. - More details - Source on GitHub

java.lang.RuntimeException: Error waiting for test resource future to finish.
	at io.quarkus.test.common.TestResourceManager.waitForAllFutures(TestResourceManager.java:151)
	at io.quarkus.test.common.TestResourceManager.start(TestResourceManager.java:136)

quarkus-bot · 2021-11-03T06:56:30Z

Failing Jobs - Building `5934870`

Status	Name	Step	Failures	Logs	Raw logs
✖	Native Tests - Windows - hibernate-validator	`Build`	Failures	Logs	Raw logs

Failures

⚙️ Native Tests - Windows - hibernate-validator #

- Failing: integration-tests/hibernate-validator

📦 integration-tests/hibernate-validator

✖ Failed to execute goal io.quarkus:quarkus-maven-plugin:999-SNAPSHOT:build (default) on project quarkus-integration-test-hibernate-validator: Failed to build quarkus application

quarkus-bot bot added area/documentation area/vertx labels Oct 29, 2021

gastaldi requested review from cescoffier, stuartwdouglas, geoand and gsmet October 29, 2021 19:45

gastaldi added triage/backport? and removed triage/backport? labels Oct 29, 2021

gastaldi changed the title ~~Introduce quarkus.http.headers~~ Introduce quarkus.http.headers Oct 29, 2021

This comment has been minimized.

Sign in to view

gastaldi force-pushed the http branch from 7995e9d to 6926b6d Compare October 29, 2021 20:08

sberyozkin reviewed Oct 29, 2021

View reviewed changes

docs/src/main/asciidoc/http-reference.adoc Outdated Show resolved Hide resolved

gastaldi force-pushed the http branch from 6926b6d to 1f33153 Compare October 29, 2021 21:37

gastaldi marked this pull request as draft October 30, 2021 12:37

stuartwdouglas requested changes Oct 31, 2021

View reviewed changes

...nsions/vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/VertxHttpRecorder.java Outdated Show resolved Hide resolved

gastaldi force-pushed the http branch from f1e5ab0 to ebb18f0 Compare October 31, 2021 23:41

gastaldi changed the title ~~Introduce quarkus.http.headers~~ Introduce quarkus.http.header Oct 31, 2021

gastaldi marked this pull request as ready for review October 31, 2021 23:44

stuartwdouglas reviewed Oct 31, 2021

View reviewed changes

cescoffier approved these changes Nov 1, 2021

View reviewed changes

stuartwdouglas approved these changes Nov 2, 2021

View reviewed changes

gastaldi added the release/noteworthy-feature label Nov 2, 2021

gastaldi marked this pull request as draft November 2, 2021 00:56

gastaldi force-pushed the http branch from ebb18f0 to 3933daf Compare November 2, 2021 01:47

gastaldi requested a review from stuartwdouglas November 2, 2021 01:47

gastaldi marked this pull request as ready for review November 2, 2021 01:48

This comment has been minimized.

Sign in to view

geoand approved these changes Nov 2, 2021

View reviewed changes

geoand reviewed Nov 2, 2021

View reviewed changes

...nsions/vertx-http/runtime/src/main/java/io/quarkus/vertx/http/runtime/VertxHttpRecorder.java Outdated Show resolved Hide resolved

gastaldi added 2 commits November 2, 2021 20:08

Introduce quarkus.http.header

6a3c923

This allows to explicitly set fixed headers on HTTP responses Support path and method for the header Signed-off-by: George Gastaldi <[email protected]>

Using StringBuilder instead of concatenating Strings

5934870

gastaldi force-pushed the http branch from 3933daf to 5934870 Compare November 2, 2021 23:08

gastaldi added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Nov 3, 2021

gastaldi merged commit 96025ee into quarkusio:main Nov 3, 2021

quarkus-bot bot added this to the 2.5 - main milestone Nov 3, 2021

quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Nov 3, 2021

gastaldi deleted the http branch November 3, 2021 09:37

gastaldi mentioned this pull request Nov 19, 2021

Add the possibillity to return custom http response headers based on application.properties #21570

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce `quarkus.http.header` #21102

Introduce `quarkus.http.header` #21102

gastaldi commented Oct 29, 2021

This comment has been minimized.

geoand commented Oct 30, 2021

gastaldi commented Oct 30, 2021

geoand commented Oct 30, 2021 •

edited

Loading

gastaldi commented Oct 30, 2021 •

edited

Loading

gastaldi commented Oct 30, 2021

gastaldi commented Oct 31, 2021 •

edited

Loading

stuartwdouglas Oct 31, 2021

gastaldi Nov 1, 2021

cescoffier Nov 1, 2021

quarkus-bot bot commented Nov 1, 2021 •

edited

Loading

Failing Jobs - Building `ebb18f0`

Failures

⚙️ Native Tests - Windows - hibernate-validator #

📦 integration-tests/hibernate-validator

cescoffier Nov 1, 2021

gastaldi commented Nov 2, 2021 •

edited

Loading

gastaldi commented Nov 2, 2021

This comment has been minimized.

quarkus-bot bot commented Nov 3, 2021 •

edited

Loading

Failing Jobs - Building `5934870`

Failures

⚙️ JVM Tests - JDK 17 #

📦 integration-tests/vault-agroal

quarkus-bot bot commented Nov 3, 2021

Introduce quarkus.http.header #21102

Introduce quarkus.http.header #21102

Conversation

gastaldi commented Oct 29, 2021

This comment has been minimized.

geoand commented Oct 30, 2021

gastaldi commented Oct 30, 2021

geoand commented Oct 30, 2021 • edited Loading

gastaldi commented Oct 30, 2021 • edited Loading

gastaldi commented Oct 30, 2021

gastaldi commented Oct 31, 2021 • edited Loading

stuartwdouglas Oct 31, 2021

Choose a reason for hiding this comment

gastaldi Nov 1, 2021

Choose a reason for hiding this comment

cescoffier Nov 1, 2021

Choose a reason for hiding this comment

quarkus-bot bot commented Nov 1, 2021 • edited Loading

Failing Jobs - Building ebb18f0

Failures

⚙️ Native Tests - Windows - hibernate-validator #

📦 integration-tests/hibernate-validator

cescoffier Nov 1, 2021

Choose a reason for hiding this comment

gastaldi commented Nov 2, 2021 • edited Loading

gastaldi commented Nov 2, 2021

This comment has been minimized.

quarkus-bot bot commented Nov 3, 2021 • edited Loading

Failing Jobs - Building 5934870

Failures

⚙️ JVM Tests - JDK 17 #

📦 integration-tests/vault-agroal

quarkus-bot bot commented Nov 3, 2021

Failing Jobs - Building 5934870

Failures

⚙️ Native Tests - Windows - hibernate-validator #

📦 integration-tests/hibernate-validator

Introduce `quarkus.http.header` #21102

Introduce `quarkus.http.header` #21102

geoand commented Oct 30, 2021 •

edited

Loading

gastaldi commented Oct 30, 2021 •

edited

Loading

gastaldi commented Oct 31, 2021 •

edited

Loading

quarkus-bot bot commented Nov 1, 2021 •

edited

Loading

Failing Jobs - Building `ebb18f0`

gastaldi commented Nov 2, 2021 •

edited

Loading

quarkus-bot bot commented Nov 3, 2021 •

edited

Loading

Failing Jobs - Building `5934870`

Failing Jobs - Building `5934870`