GN-4435: Use `cool-uri` to create permalink for `zitting` #34

dkozickis · 2023-10-06T09:29:18Z

Overview

GN-4435: Use cool-uri to create permalink for zitting

Setup cool-uri service to provide permalinks for zitting (and other entities via /permalink)

connected issues and PRs:

https://binnenland.atlassian.net/browse/GN-4435
lblod/besluit-publicatie-publish-service#11

Setup

Checkout
Checkout this PR GN-4435: Insert permalink for Zitting besluit-publicatie-publish-service#11 for besluit-publicatie-publish-service

Add following to docker-compose.override.yml

 version: "3.4"
 services:
   besluit-publicatie:
     image: mu-javascript-template:latest
     environment:
       NODE_ENV: "development"
     volumes:
       - ./data/files/:/share/
       - /<LOCATION_OF_BESLUIT_SERVICE>/:/app/

Where <LOCATION_OF_BESLUIT_SERVICE> is folder where the besluit-publicatie-publish-service is checked out

docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.override.yml up

How to test/reproduce

Confirm that migration was executed by running below query at http://localhost:8080/sparql

PREFIX foaf: <http://xmlns.com/foaf/0.1/>
SELECT * WHERE {
  ?permalink foaf:page ?redirect .
} LIMIT 10

Try to access http://localhost:8080/Huldenberg/Gemeente/zitting/b2f47ed1-3534-11e9-a984-7db43f975d75, confirm you are redirected to http://localhost:8080/Huldenberg/Gemeente/zittingen/b2f47ed1-3534-11e9-a984-7db43f975d75 (note zitting vs zittingen in URL)
Try to access http://localhost:8080/permalink?uri=http://data.lblod.info/id/zittingen/8c93d2cc-f4ba-4444-b09e-b7495e336ff8, confirm you are redirected to http://localhost:8080/Huldenberg/Gemeente/zittingen/b2f47ed1-3534-11e9-a984-7db43f975d75
Call curl -v http://localhost:8080/permalink?uri=http://data.lblod.info/id/zittingen/8c93d2cc-f4ba-4444-b09e-b7495e336ff8, confirm you get HTTP/1.1 303 See Other and location: /Huldenberg/Gemeente/zittingen/b2f47ed1-3534-11e9-a984-7db43f975d75 in the response headers

Confirm that besluit service is inserting permalink by either publishing something from GN, if you have it setup, or going to http://localhost:8080/sparql and executing following query

PREFIX sign: <http://mu.semte.ch/vocabularies/ext/signing/>

INSERT DATA {
GRAPH <http://mu.semte.ch/graphs/public> {
    <http://data.lblod.info/published-resources/0cf4b620-45f9-11ec-99f4-b935d359b4a5> a sign:PublishedResource ;
        <http://purl.org/dc/terms/created> "2023-10-04T09:47:30.818Z"^^<http://www.w3.org/2001/XMLSchema#dateTime> ;
        sign:text """<div class="au-c-template au-c-template--treatment behandeling"
     prefix="eli: http://data.europa.eu/eli/ontology# prov: http://www.w3.org/ns/prov# mandaat: http://data.vlaanderen.be/ns/mandaat# besluit: http://data.vlaanderen.be/ns/besluit# ext: http://mu.semte.ch/vocabularies/ext/ person: http://www.w3.org/ns/person# persoon: http://data.vlaanderen.be/ns/persoon# dateplugin: http://say.data.gift/manipulators/insertion/ besluittype: https://data.vlaanderen.be/id/concept/BesluitType/ dct: http://purl.org/dc/terms/ mobiliteit: https://data.vlaanderen.be/ns/mobiliteit# lblodmow: http://data.lblod.info/vocabularies/mobiliteit/">
    <div about="http://data.lblod.info/id/zittingen/6515CDF42C0D037764237179" typeof="besluit:Zitting"><span
            property="http://data.vlaanderen.be/ns/besluit#isGehoudenDoor"
            resource="http://data.lblod.info/id/bestuursorganen/28dca2b0f60eb33cdb72e8398fa63e19352f8fa67dfaa3a7784d83498d521bcf"></span>
        <span property="http://data.vlaanderen.be/ns/besluit#geplandeStart" content="2023-09-28T17:00:51.870Z"
              datatype="http://www.w3.org/2001/XMLSchema#dateTime"></span> <span
                property="http://www.w3.org/ns/prov#startedAtTime" content="2023-09-28T17:00:51.870Z"
                datatype="http://www.w3.org/2001/XMLSchema#dateTime" class="is-required"></span> <span
                property="http://www.w3.org/ns/prov#endedAtTime" content="2023-09-28T19:05:26.580Z"
                datatype="http://www.w3.org/2001/XMLSchema#dateTime"></span>
        <div class="au-c-template au-c-template--treatment" typeof="besluit:BehandelingVanAgendapunt"
             resource="http://data.lblod.info/id/behandelingen-van-agendapunten/6515CE5F2C0D03776423717A"><p
                content="true" datatype="xsd:boolean" property="besluit:openbaar"><span class="au-c-template-public">Openbare behandeling van agendapunt</span>
        </p>
            <h3 resource="http://data.lblod.info/id/agendapunten/6515CE602C0D03776423717B" property="dc:subject"><span
                    property="dc:title">besluit mbt vastgoedinformatieplatform</span> (<span
                    property="besluit:Agendapunt.type"
                    resource="http://lblod.data.gift/concepts/bdf68a65-ce15-42c8-ae1b-19eeb39e20d0"
                    typeof="skos:Concept">gepland</span>) </h3> <h4>Aanwezigen bij agendapunt</h4>

            <h4>Stemmingen bij agendapunt</h4>
            <div class="c-template-content c-template-content--treatment"></div>
        </div>
    </div>
</div>
""" .
}
}

Then after running

PREFIX foaf: <http://xmlns.com/foaf/0.1/>
SELECT * WHERE {
  <http://data.lblod.info/id/zittingen/6515CDF42C0D037764237179> foaf:page ?redirect .
} LIMIT 10

You should be able to observe something like this, note that the ID part of the URL will be different

Checks PR readiness

UI: works on smaller screen sizes
UI: feedback for any loading/error states
Check cancel/go-back flows
Check database state correct when deleting/updating (especially regarding relationships)
changelog
no new deprecations

config/dispatcher/dispatcher.ex

abeforgit · 2023-10-06T11:16:17Z

config/dispatcher/dispatcher.ex

+    Proxy.forward conn, ["?uri=http://permalink", "zitting", id], "http://cooluri"
+  end
+
+  match "/permalink/*path", @any do


I'd like to see the actual uri of the requested resource used here, as discussed on rocket (if possible)
this means any visitor could visit https://publicatie.gelinkt-notuleren.vlaanderen.be/permalink?uri=<uri> and get the content for that resource

Sure, we can use actual URI, why I got confused is because I've first approached this from the point of using it just for redirecting access to {HOST}/Aalst/Gemeente/zitting/b2f47ed1-3534-11e9-a984-7db43f975d75, in that case we only have mu:uuid of zitting, which does not correspond to uh the uh ... letter/number combination in the URI, so cannot be referenced to the correct URI via cool-uri service directly

Updated to work via /permalink?uri=<uri>

Updated PR description as well

Try to access http://localhost:8080/Huldenberg/Gemeente/zitting/b2f47ed1-3534-11e9-a984-7db43f975d75, confirm you are redirected to http://localhost:8080/Huldenberg/Gemeente/zittingen/b2f47ed1-3534-11e9-a984-7db43f975d75 (note zitting vs zittingen in URL)

Try to access http://localhost:8080/permalink?uri=http://data.lblod.info/id/zittingen/8c93d2cc-f4ba-4444-b09e-b7495e336ff8, confirm you are redirected to http://localhost:8080/Huldenberg/Gemeente/zittingen/b2f47ed1-3534-11e9-a984-7db43f975d75

Call curl -v http://localhost:8080/permalink?uri=http://data.lblod.info/id/zittingen/8c93d2cc-f4ba-4444-b09e-b7495e336ff8, confirm you get HTTP/1.1 303 See Other and location: /Huldenberg/Gemeente/zittingen/b2f47ed1-3534-11e9-a984-7db43f975d75 in the response headers

piemonkey

Am I right in thinking the behaviour after the initial redirect isn't defined yet? Locally I get a strange 307 redirect after the first one (using httpie), e.g.

http :8080/Huldenberg/Gemeente/zitting/4b60e8f1-3532-11e9-a984-7db43f975d75
# HTTP/1.1 303 See Other
# location: /Langemark-Poelkapelle/Gemeente/zittingen/4b60e8f1-3532-11e9-a984-7db43f975d75
http :8080/Langemark-Poelkapelle/Gemeente/zittingen/4b60e8f1-3532-11e9-a984-7db43f975d75
# HTTP/1.1 307 Temporary Redirect
# location: //localhost:8080/Langemark-Poelkapelle/Gemeente

piemonkey · 2023-10-06T14:45:00Z

config/dispatcher/dispatcher.ex

+  ###############
+
+  # This will catch calls to links like {HOST}/Aalst/Gemeente/zitting/b2f47ed1-3534-11e9-a984-7db43f975d75
+  match "/:bestuurseenheid_naam/:bestuurseenheid_classificatie_code_label/zitting/:id", @any do


Am I missing something about how mu-dispatcher matches paths, or would this cause problems if we ever had a route in the UI which had 2 parts and then the word zitting? I feel like there should be a literal first part of the path to avoid collisions.

Yep, it would. Current FE also has similar capture route (https://github.com/lblod/frontend-gelinkt-notuleren-publicatie/blob/master/app/router.js#L13), so it kinda works in the same way 🤔

# HTTP/1.1 307 Temporary Redirect # location: //localhost:8080/Langemark-Poelkapelle/Gemeente

I am not exactly sure but that looks like the Ember intercepting and redirecting when there is no actual zitting with that ID

Hmm, that was for an id I got from the triplestore though, so I thought it should exist, unless I managed to use the wrong id.

I for one can't reproduce your issue @piemonkey
I get a 301, which is correct, and --follow can follow nicely

* Redirect calls like `{HOST}/Aalst/Gemeente/zitting/b2f47ed1-3534-11e9-a984-7db43f975d75` directly to "zitting" instead of using `cool-uri` * Update `/permalink` endpoint to expect `uri` query param

also redirects all further paths after /zitting, not just /zitting/:id

dkozickis requested review from piemonkey, abeforgit, elpoelma and x-m-el October 6, 2023 09:29

GN-4435: Use cool-uri to create permalink for zitting

555cfa2

dkozickis force-pushed the GN-4435 branch from ecaf6ab to 555cfa2 Compare October 6, 2023 09:36

dkozickis mentioned this pull request Oct 6, 2023

GN-4435: Insert permalink for Zitting lblod/besluit-publicatie-publish-service#11

Merged

abeforgit requested changes Oct 6, 2023

View reviewed changes

piemonkey reviewed Oct 6, 2023

View reviewed changes

GN-4435: Update based on PR review

adfe787

* Redirect calls like `{HOST}/Aalst/Gemeente/zitting/b2f47ed1-3534-11e9-a984-7db43f975d75` directly to "zitting" instead of using `cool-uri` * Update `/permalink` endpoint to expect `uri` query param

dkozickis requested review from piemonkey and abeforgit October 9, 2023 08:14

fix(dispatcher): redirect all /zitting to /zittingen

d764a0b

also redirects all further paths after /zitting, not just /zitting/:id

abeforgit merged commit 587e4df into master Oct 16, 2023

abeforgit deleted the GN-4435 branch October 16, 2023 11:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GN-4435: Use `cool-uri` to create permalink for `zitting` #34

GN-4435: Use `cool-uri` to create permalink for `zitting` #34

dkozickis commented Oct 6, 2023 •

edited

Loading

abeforgit Oct 6, 2023

dkozickis Oct 6, 2023

dkozickis Oct 9, 2023

dkozickis Oct 9, 2023 •

edited

Loading

piemonkey left a comment

piemonkey Oct 6, 2023

dkozickis Oct 6, 2023

dkozickis Oct 6, 2023

piemonkey Oct 9, 2023

abeforgit Oct 16, 2023

GN-4435: Use cool-uri to create permalink for zitting #34

GN-4435: Use cool-uri to create permalink for zitting #34

Conversation

dkozickis commented Oct 6, 2023 • edited Loading

Overview

connected issues and PRs:

Setup

How to test/reproduce

Checks PR readiness

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dkozickis Oct 9, 2023 • edited Loading

Choose a reason for hiding this comment

piemonkey 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

Choose a reason for hiding this comment

GN-4435: Use `cool-uri` to create permalink for `zitting` #34

GN-4435: Use `cool-uri` to create permalink for `zitting` #34

dkozickis commented Oct 6, 2023 •

edited

Loading

dkozickis Oct 9, 2023 •

edited

Loading