Add full content serialization mode for GET /@dossier-transfers #7917
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukasgraf
force-pushed
the
lg/CA-6591/transfer-content
branch
from
3a904a4
to
d940dd8
Compare
lukasgraf
force-pushed
the
lg/CA-6591/transfer-content
branch
6 times, most recently
from
f551efc
to
14a6189
Compare
lukasgraf
force-pushed
the
lg/CA-6591/transfer-content
branch
from
b27f48e
to
f7697ff
Compare
When validating a dossier transfer token, we now also verify that the token that is being validated matches the token stored on the particular transfer in question. This was sort of validated before as a side effect, because we verified that the transfer ID from the signed claims matched the transfer's ID, but now we also explicitly require the token contents to match. In addition, the TokenManager will now update the persisted token on a transfer when issuing a token for it.
Provide an `is_valid_token` method on the DossierTransfer model instead of a method that may raise an InvalidToken exception. This makes it less clunky to use in later code where we would otherwise have to deal with the exception.
Depending on what flags the python interpreter is launched with, they may not even get checked when running in production.
lukasgraf
force-pushed
the
lg/CA-6591/transfer-content
branch
from
f7697ff
to
8ba1de6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a "full content serialization" mode to the
GET /@dossier-transfers/<id>endpoint.The
@perform-dossier-transferendpoint will use this (in a server-to-server request) to retrieve all the actual content data when performing a transfer.When invoked with the
?full_content=1query string parameter, the endpoint also adds serialization of the transfer contents to its response:{ "@id": "http://localhost:8080/fd/@dossier-transfers/42", "@type": "virtual.ogds.dossiertransfer", "...": "...", "content": { "dossiers": ["..."], "documents": ["..."], "contacts": {"..."} }, }In this mode,
X-GEVER-Dossier-Transfer-TokenHTTP headercontentpropertyISerializeToJsonserializers, minus some properties that are only of value to the frontend or otherwise uninterestingpath(parents before children).participationskey as part of the dossier metadata. It contains a list of(participant_id, roles_list)items where theparticipant_idmatches the ID used as the key in thecontents.contactsdictionaryExamples:
Overall structure of the additional
contentkey:Example of the
participationskey on the dossier serialization:(not to be confused with the top-level
participationskey for the transfer, which is an optional list of selected participations)The participant_id (
person:...) used in these participations is guaranteed to match the key used in thecontactsdictionary.Example dossier serialization (click to expand)
{ "@id": "http://localhost:8080/fd/ordnungssystem/fuehrung/gemeinderecht/dossier-20", "@type": "opengever.dossier.businesscasedossier", "UID": "1b6d8dbf1f954bbb9510a1b65d51ede5", "allow_discussion": false, "archival_value": { "title": "Nicht geprüft", "token": "unchecked" }, "archival_value_annotation": null, "back_references_relatedDossier": [], "blocked_local_roles": false, "changed": "2024-04-05T06:08:41+00:00", "checklist": null, "classification": { "title": "Nicht klassifiziert", "token": "unprotected" }, "container_location": null, "container_type": null, "created": "2024-03-21T10:51:21+00:00", "custody_period": { "title": "30", "token": "30" }, "custom_properties": null, "date_of_cassation": null, "date_of_submission": null, "description": "Beschreibung des Dossiers", "dossier_manager": null, "dossier_type": null, "email": "1569106123@localhost", "end": null, "external_reference": null, "filing_prefix": null, "former_reference_number": null, "has_pending_jobs": false, "id": "dossier-20", "is_folderish": true, "is_protected": false, "is_subdossier": false, "keywords": [], "layout": "tabbed_view", "modified": "2024-04-05T06:08:41+00:00", "number_of_containers": null, "oguid": "fd:1569106123", "parent": { "@id": "http://localhost:8080/fd/ordnungssystem/fuehrung/gemeinderecht", "@type": "opengever.repository.repositoryfolder", "UID": "e96a0525613f473a8c035cf1945b2561", "description": "", "is_leafnode": true, "review_state": "repositoryfolder-state-active", "title": "0.0. Gemeinderecht" }, "participations": [ [ "person:39c2789d-a123-44ba-a3b1-4323d6e941c6", ["final-drawing", "regard"] ] ], "privacy_layer": { "title": "Nein", "token": "privacy_layer_no" }, "public_trial": { "title": "Nicht geprüft", "token": "unchecked" }, "public_trial_statement": "", "reading": [], "reading_and_writing": [], "reference_number": "FD 0.0 / 6", "relatedDossier": [], "relative_path": "ordnungssystem/fuehrung/gemeinderecht/dossier-20", "responses": [], "responsible": { "title": "Boss Hugo (hugo.boss)", "token": "hugo.boss" }, "responsible_actor": { "@id": "http://localhost:8080/fd/@actors/hugo.boss", "identifier": "hugo.boss" }, "responsible_fullname": "Boss Hugo", "retention_period": { "title": "5", "token": "5" }, "retention_period_annotation": null, "review_state": "dossier-state-active", "sequence_number": 20, "start": "2024-03-21", "temporary_former_reference_number": null, "title": "Dossier zum Übertragen", "touched": "2024-04-05", "version": "current" }Example document serialization (click to expand)
{ "@id": "http://localhost:8080/fd/ordnungssystem/fuehrung/gemeinderecht/dossier-20/dossier-21/document-44", "@type": "opengever.document.document", "UID": "a663689540a34538b6f408d4b41baee8", "allow_discussion": false, "archival_file": null, "archival_file_state": null, "back_references_relatedItems": [], "changeNote": "", "changed": "2024-03-21T10:51:46+00:00", "checked_out": null, "checked_out_fullname": null, "checkout_collaborators": [], "classification": { "title": "Nicht klassifiziert", "token": "unprotected" }, "containing_dossier": "Dossier zum Übertragen", "containing_subdossier": "Subdossier zum Übertragen", "containing_subdossier_url": "http://localhost:8080/fd/ordnungssystem/fuehrung/gemeinderecht/dossier-20/dossier-21", "created": "2024-03-21T10:51:46+00:00", "creator": { "@id": "http://localhost:8080/fd/@actors/zopemaster", "identifier": "zopemaster" }, "current_version_id": 0, "custom_properties": null, "delivery_date": null, "description": "", "digitally_available": true, "document_author": null, "document_date": "2014-07-21", "document_type": null, "file": { "content-type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "download": "http://localhost:8080/fd/ordnungssystem/fuehrung/gemeinderecht/dossier-20/dossier-21/document-44/@@download/file", "filename": "Beilage.docx", "size": 123076 }, "file_extension": ".docx", "file_mtime": 1711018306.825305, "foreign_reference": null, "getObjPositionInParent": 0, "gever_url": "", "id": "document-44", "is_collaborative_checkout": false, "is_folderish": false, "is_locked": false, "is_shadow_document": false, "keywords": [], "layout": "tabbed_view", "meeting": null, "modified": "2024-03-21T10:51:46+00:00", "next_item": {}, "oguid": "fd:1569106125", "parent": { "@id": "http://localhost:8080/fd/ordnungssystem/fuehrung/gemeinderecht/dossier-20/dossier-21", "@type": "opengever.dossier.businesscasedossier", "UID": "f510a6bb410f40258b53090bf2f0c545", "description": "Subdossier-Beschreibung", "dossier_type": null, "is_leafnode": null, "is_subdossier": true, "review_state": "dossier-state-active", "title": "Subdossier zum Übertragen" }, "preserved_as_paper": true, "preview": null, "previous_item": {}, "privacy_layer": { "title": "Nein", "token": "privacy_layer_no" }, "proposal": null, "public_trial": { "title": "Nicht geprüft", "token": "unchecked" }, "public_trial_statement": "", "receipt_date": null, "reference_number": "FD 0.0 / 6.1 / 44", "relatedItems": [], "relative_path": "ordnungssystem/fuehrung/gemeinderecht/dossier-20/dossier-21/document-44", "review_state": "document-state-draft", "sequence_number": 44, "submitted_proposal": null, "submitted_with": [], "teamraum_connect_links": { "gever_document": null, "workspace_documents": [] }, "thumbnail": null, "title": "Beilage", "trashed": false, "version": "current", "workspace_document_urls": [] }Example contact serialization (click to expand)
For CA-6591
Note
I quickly tested whether these types of serialized represenations can be used to deserialize objects using the
IDeserializeFromJsondeserializers. And it seems to work. Slapping together a class based on the code in opengever/api/add.py I was able to use the serialized JSON output for dossiers and documents to recreate the respective objects, and at least some of the fields were correctly set. Might need quite some tweaking, but in principle the approach seems to work.For CA-6591
Checklist
Changelog entry
Link to issue (Jira or GitHub) and backlink in issue (Jira)
API change:
New functionality:
documentalso works formail