Add /ok route as an express middleware #4432

erral · 2023-02-24T11:23:12Z

Fixes #4375 adding an Express middleware

This supersedes #4429

netlify · 2023-02-24T11:23:29Z

✅ Deploy Preview for volto ready!

Name	Link
🔨 Latest commit	`515af71`
🔍 Latest deploy log	https://app.netlify.com/sites/volto/deploys/64b52e091220d000083cfe99
😎 Deploy Preview	https://deploy-preview-4432--volto.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

cypress · 2023-02-24T11:34:34Z

Passing run #6383 ↗︎

0	523	20	0	0

Details:

Merge branch 'master' into ionlizarazu-ok-view
Project: Volto	Commit: `515af71333`
Status: Passed	Duration: 19:14 💡
Started: Jul 17, 2023 12:06 PM	Ended: Jul 17, 2023 12:25 PM

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

tiberiuichim

In Plone the ok view is namespaced by the @@ symbols, so there's no chance to overlap something else. Let's do something similar here. Maybe /_ok ?

Also, I don't think there's a need for a setting for this, if we solve the namespacing problem.

@plone/volto-team thoughts on this?

davisagli · 2023-02-25T16:58:48Z

How about something like .well-known/volto/ok (based on https://en.wikipedia.org/wiki/Well-known_URI)?

Whatever it is, it should be mentioned in the docs.

avoinea · 2023-03-10T09:45:05Z

In Plone the ok view is namespaced by the @@ symbols, so there's no chance to overlap something else. Let's do something similar here. Maybe /_ok ?

Also, I don't think there's a need for a setting for this, if we solve the namespacing problem.

@plone/volto-team thoughts on this?

Well, it also works with /ok in Plone Classic and we're doing all health-checks to this path /ok. Thus, I would stick to /ok. Or use the .well-known approach as @davisagli suggested.

erral · 2023-03-10T10:09:32Z

I would also keep using the /ok route

sneridagh · 2023-03-15T10:32:40Z

We need a consensus here. I'm ok with using both /ok and .well-known/volto/ok the reasoning behind both seems ok (no pun intended) for me. Everybody is ok? 😂

tiberiuichim · 2023-03-15T10:47:43Z

I'm +1 on adopting the industry standard.

erral · 2023-03-17T16:47:39Z

I don't see a ok URL under the well-known URLs right? I mean I don't mind using the .well-known approach, but right now there's no such standard for ok right?

We can start having the ok like we have in classic and evolve to whatever is stablished later on.

davisagli · 2023-03-17T21:23:04Z

I was the one who brought up the .well-known idea, but I don't see any big problem with /ok: it is unlikely to conflict with content, and if it does there is the setting. So I would go ahead with this the way it is. The one thing I am missing in the PR is documentation of the new setting.

stevepiercy · 2023-03-17T23:38:04Z

The one thing I am missing in the PR is documentation of the new setting.

Would that go here?

https://6.docs.plone.org/volto/configuration/settings-reference.html#server-specific-serverconfig

sneridagh · 2023-05-10T14:58:22Z

@erral @stevepiercy yes, good for me. Let's add some docs and merge.

erral · 2023-07-01T09:15:12Z

I have realized that I was missing the documentation part on this PR as requested by @stevepiercy 🤦 so I have added it 😉

stevepiercy

Thanks for the docs. Mostly MyST and English syntax and grammar.

docs/source/configuration/settings-reference.md

erral · 2023-07-02T08:02:27Z

Thanks for the docs. Mostly MyST and English syntax and grammar.

thank you as always!

stevepiercy

Looks good! https://deploy-preview-4432--volto.netlify.app/configuration/settings-reference.html#term-okRoute

stevepiercy · 2023-07-02T10:20:19Z

It is OK to ignore the failing docs job. He Who Shall Not Be Named has once again pulled more feathers from the bird site, now requiring authentication to view a user's twerks.

Co-authored-by: ionlizarazu <ilizarazu@codesyntax.com> Co-authored-by: Víctor Fernández de Alba <sneridagh@gmail.com> Co-authored-by: Alin Voinea <contact@avoinea.com>

Co-authored-by: Mikel Larreategi <mlarreategi@codesyntax.com> Co-authored-by: ionlizarazu <ilizarazu@codesyntax.com> Co-authored-by: Alin Voinea <contact@avoinea.com>

* master: (42 commits) make selectedView and className props available for Search block (#4997) Release @plone/volto-testing 4.0.0-alpha.0 Release 17.0.0-alpha.21 Upgrade to Cypress 12.17.1 (latest) (#4981) Image rendering (#3337) feat(Url.js): add getFieldURL helper function to get the url value of a field based on its structure (#4731) Handle @linkintegrity response with items but no breaches (#4832) Release 17.0.0-alpha.20 Use all the apiExpanders in use, so we perform a single request for getting all the required data. (#4946) Fix the condition deciding on listing pagination format so it takes into account container blocks as well (#4978) Release 17.0.0-alpha.19 Fix search block input clear button doesn't reset the search (#4837) Add /ok route as an express middleware (#4432) handles condition for yearly frequency in recurrence (#4604) Remove dangling out of place Guillotina Cypress tests (#4980) Update to latest plone.restapi and Plone 6.0.6 (#4979) Update browserlist (#4977) `Links and references` view via content menu [Add `Links to item` view] (#4787) Release 17.0.0-alpha.18 Toc responsive (#4912) ...

ionlizarazu and others added 3 commits February 23, 2023 18:49

/ok route response is ok

fd446b8

add cache-control headers, mimicing what Plone does

fa9e1b6

changelog

05da58e

erral requested review from tiberiuichim and avoinea February 24, 2023 11:24

tiberiuichim approved these changes Feb 24, 2023

View reviewed changes

Merge branch 'master' into ionlizarazu-ok-view

9f8976c

tiberiuichim requested changes Feb 25, 2023

View reviewed changes

sneridagh and others added 2 commits March 4, 2023 21:51

Merge branch 'master' into ionlizarazu-ok-view

b07613b

Merge branch 'master' into ionlizarazu-ok-view

ab37c07

avoinea mentioned this pull request Mar 9, 2023

Add OK route #4429

Closed

Merge branch 'master' into ionlizarazu-ok-view

1fa2a09

avoinea approved these changes Mar 10, 2023

View reviewed changes

erral added 6 commits July 1, 2023 11:05

document the settings

08a4b9d

whitespace

d7f61d5

change name

132148a

Merge branch 'master' into ionlizarazu-ok-view

1744d55

format

1951dbc

formatting

dbb8244

formatting

81f6285

stevepiercy requested changes Jul 1, 2023

View reviewed changes

polish docs

9809fb7

stevepiercy approved these changes Jul 2, 2023

View reviewed changes

erral added 3 commits July 11, 2023 11:51

Merge branch 'master' into ionlizarazu-ok-view

0533301

Merge branch 'master' into ionlizarazu-ok-view

45f60b1

Merge branch 'master' into ionlizarazu-ok-view

515af71

sneridagh approved these changes Jul 18, 2023

View reviewed changes

sneridagh merged commit 8ccab38 into master Jul 18, 2023
39 checks passed

sneridagh deleted the ionlizarazu-ok-view branch July 18, 2023 07:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add /ok route as an express middleware #4432

Add /ok route as an express middleware #4432

erral commented Feb 24, 2023

netlify bot commented Feb 24, 2023 •

edited

Loading

cypress bot commented Feb 24, 2023 •

edited

Loading

tiberiuichim left a comment

davisagli commented Feb 25, 2023

avoinea commented Mar 10, 2023

erral commented Mar 10, 2023

sneridagh commented Mar 15, 2023

tiberiuichim commented Mar 15, 2023

erral commented Mar 17, 2023 •

edited

Loading

davisagli commented Mar 17, 2023

stevepiercy commented Mar 17, 2023

sneridagh commented May 10, 2023 •

edited

Loading

erral commented Jul 1, 2023

stevepiercy left a comment

erral commented Jul 2, 2023

stevepiercy left a comment

stevepiercy commented Jul 2, 2023

Add /ok route as an express middleware #4432

Add /ok route as an express middleware #4432

Conversation

erral commented Feb 24, 2023

netlify bot commented Feb 24, 2023 • edited Loading

✅ Deploy Preview for volto ready!

cypress bot commented Feb 24, 2023 • edited Loading

Passing run #6383 ↗︎

tiberiuichim left a comment

Choose a reason for hiding this comment

davisagli commented Feb 25, 2023

avoinea commented Mar 10, 2023

erral commented Mar 10, 2023

sneridagh commented Mar 15, 2023

tiberiuichim commented Mar 15, 2023

erral commented Mar 17, 2023 • edited Loading

davisagli commented Mar 17, 2023

stevepiercy commented Mar 17, 2023

sneridagh commented May 10, 2023 • edited Loading

erral commented Jul 1, 2023

stevepiercy left a comment

Choose a reason for hiding this comment

erral commented Jul 2, 2023

stevepiercy left a comment

Choose a reason for hiding this comment

stevepiercy commented Jul 2, 2023

netlify bot commented Feb 24, 2023 •

edited

Loading

cypress bot commented Feb 24, 2023 •

edited

Loading

erral commented Mar 17, 2023 •

edited

Loading

sneridagh commented May 10, 2023 •

edited

Loading