[#3688] PR feedback

Author: Viicos

docker/docker-compose.objecttypes.yml docker/docker-compose.objects-apis.yml

@@ -2,19 +2,18 @@ version: '3'
 
 services:
   db:
-    image: postgres
+    image: postgres:${PG_VERSION:-14}
     environment:
       - POSTGRES_USER=${DB_USER:-objecttypes}
       - POSTGRES_PASSWORD=${DB_PASSWORD:-objecttypes}
 
-  web:
-    image: maykinmedia/objecttypes-api
+  objecttypes-web:
+    image: maykinmedia/objecttypes-api:${OBJECTTYPES_VERSION:-2.1.1}
     environment:
       - DJANGO_SETTINGS_MODULE=objecttypes.conf.docker
       - SECRET_KEY=${SECRET_KEY:-fgv=c0hz&tl*8*3m3893@m+1pstrvidc9e^5@fpspmg%cy$15d}
       - ALLOWED_HOSTS=*
-      - UWSGI_PORT=8001
     ports:
-      - 8001:8001
+      - 8001:8000
     depends_on:
       - db

docker/objects-apis/README.md

@@ -0,0 +1,29 @@
+# Objects APIs
+
+The `docker-compose.objects-apis.yml` compose file is available to run an instance of the Objects and Objecttypes API.
+
+(For now, only Objecttypes is available).
+
+## docker compose
+
+Start an instance in your local environment from the parent directory:
+
+```bash
+docker compose -f docker-compose.objects-apis.yml up -d
+```
+
+Create a super user:
+
+```bash
+docker compose -f docker-compose.objects-apis.yml exec objecttypes-web src/manage.py createsuperuser
+```
+
+This brings up Objecttypes, the admin interface is accessible at http://localhost:8001/admin/.
+
+## Load fixtures
+
+Before re-recording the related VCR tests, you must load some fixtures:
+
+```bash
+cat objects-apis/fixtures/objecttypes_api_fixtures.json | docker compose -f docker-compose.objects-apis.yml exec -T objecttypes-web src/manage.py loaddata --format=json -
+```

docker/objecttypes/fixtures/test_fixtures.json docker/objects-apis/fixtures/objecttypes_api_fixtures.json

@@ -1,14 +1,10 @@
-from typing import Any, Literal, TypeAlias
+from typing import Any
 from uuid import UUID
 
 from zgw_consumers.nlx import NLXClient
 
 from openforms.utils.api_clients import PaginatedResponseData, pagination_helper
 
-DataClassification: TypeAlias = Literal[
-    "confidential", "intern", "open", "strictly_confidential"
-]
-
 
 class ObjecttypesClient(NLXClient):
 
@@ -38,13 +34,10 @@ def _get_paginated(
 
     def list_objecttypes(
         self,
-        data_classification: DataClassification | None = None,
         page: int | None = None,
         page_size: int | None = None,
     ) -> list[dict[str, Any]]:
         query_params = {}
-        if data_classification is not None:
-            query_params["dataClassification"] = data_classification
 
         return self._get_paginated(
             "objecttypes", page=page, page_size=page_size, query_params=query_params

docker/objecttypes/README.md

@@ -1,9 +1,8 @@
 import {produce} from 'immer';
-import React, {useContext, useMemo, useState} from 'react';
+import React, {useContext, useState} from 'react';
 import {useIntl} from 'react-intl';
 import useAsync from 'react-use/esm/useAsync';
 
-import Loader from 'components/admin/Loader';
 import {CustomFieldTemplate} from 'components/admin/RJSFWrapper';
 import {
   REGISTRATION_OBJECTTYPES_ENDPOINT,
@@ -26,6 +25,15 @@ const Wrapper = ({children}) => (
   </form>
 );
 
+const getObjecttypeVersionsEndpoint = objecttype => {
+  const bits = [
+    '/api/v2/registration/plugins/objects-api/object-types',
+    encodeURIComponent(objecttype.uuid),
+    'versions',
+  ];
+  return bits.join('/');
+};
+
 const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange}) => {
   const intl = useIntl();
   const validationErrors = useContext(ValidationErrorContext);
@@ -48,10 +56,8 @@ const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange})
 
   // For existing registration options where the URL might not be valid
   // will default to a textinput in that case
-  const unknownObjecttype = useMemo(
-    () => objecttype && !availableObjecttypes.map(o => o.url).includes(objecttype),
-    [availableObjecttypes, objecttype]
-  );
+  const isUnknownObjecttype =
+    objecttype && availableObjecttypes.find(o => o.url === objecttype) === undefined;
 
   const onFieldChange = event => {
     const {name, value} = event.target;
@@ -78,25 +84,24 @@ const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange})
 
   const {loading: objecttypeVersionLoading, error: objecttypeVersionLoadingError} =
     useAsync(async () => {
-      if (!objecttype) return;
+      if (!objecttype) {
+        setAvailableObjecttypeVersions([]);
+        return;
+      }
 
-      const response = await get(
-        REGISTRATION_OBJECTTYPE_VERSIONS_ENDPOINT.replace(
-          '{objecttypeUuid}',
-          availableObjecttypes.find(o => o.url === objecttype).uuid
-        )
+      const url = getObjecttypeVersionsEndpoint(
+        availableObjecttypes.find(o => o.url === objecttype)
       );
+      const response = await get(url);
+
       if (!response.ok) {
         throw new Error('Error when loading objecttype versions');
       }
 
       setAvailableObjecttypeVersions(response.data);
     }, [objecttype]);
 
-  const hasApiError = useMemo(
-    () => objecttypesLoadingError || objecttypeVersionLoadingError,
-    [objecttypesLoadingError, objecttypeVersionLoadingError]
-  );
+  const hasApiError = objecttypesLoadingError || objecttypeVersionLoadingError;
 
   return (
     <Wrapper>
@@ -115,13 +120,13 @@ const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange})
         errors={buildErrorsComponent('objecttype')}
         displayLabel
       >
-        {unknownObjecttype || hasApiError ? (
+        {isUnknownObjecttype || hasApiError ? (
           <TextInput
             id="root_objecttype"
             name="objecttype"
             value={objecttype}
             onChange={onFieldChange}
-            allowBlank={true}
+            allowBlank
           />
         ) : (
           <Select
@@ -130,11 +135,10 @@ const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange})
             choices={
               objecttypesLoading
                 ? LOADING_OPTION
-                : availableObjecttypes.map(ot => [ot.url, `${ot.name} (${ot.uuid})`])
+                : availableObjecttypes.map(ot => [ot.url, `${ot.name}`])
             }
             value={objecttype}
             onChange={onFieldChange}
-            allowBlank={true}
           />
         )}
       </CustomFieldTemplate>
@@ -152,7 +156,7 @@ const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange})
         errors={buildErrorsComponent('objecttypeVersion')}
         displayLabel
       >
-        {unknownObjecttype || hasApiError ? (
+        {isUnknownObjecttype || hasApiError ? (
           <NumberInput
             id="root_objecttypeVersion"
             name="objecttypeVersion"
@@ -167,11 +171,12 @@ const ObjectsApiOptionsFormFields = ({index, name, schema, formData, onChange})
             choices={
               objecttypeVersionLoading
                 ? LOADING_OPTION
-                : availableObjecttypeVersions.map(otv => [otv.version, otv.version])
+                : availableObjecttypeVersions
+                    .sort((v1, v2) => v2.version - v1.version)
+                    .map(otv => [otv.version, otv.version])
             }
             value={objecttypeVersion}
             onChange={onFieldChange}
-            allowBlank={true}
           />
         )}
       </CustomFieldTemplate>

src/openforms/contrib/objects_api/clients/objecttypes.py

@@ -47,8 +47,14 @@ export default {
             name: 'Tree',
             namePlural: 'Trees',
           },
+          {
+            url: 'https://objecttypen.nl/api/v1/objecttypes/2c77babf-a967-4057-9969-0200320d23f2',
+            uuid: '2c77babf-a967-4057-9969-0200320d23f2',
+            name: 'Person',
+            namePlural: 'Persons',
+          },
         ]),
-        mockObjecttypeVersionsGet('2c77babf-a967-4057-9969-0200320d23f1', [{version: 1}]),
+        mockObjecttypeVersionsGet([{version: 1}]),
       ],
     },
   },

src/openforms/js/components/admin/form_design/registrations/objectsapi/ObjectsApiOptionsFormFields.js

@@ -7,9 +7,9 @@ export const mockObjecttypesGet = objecttypes =>
     return res(ctx.json(objecttypes));
   });
 
-export const mockObjecttypeVersionsGet = (objecttypeUuid, versions) =>
+export const mockObjecttypeVersionsGet = versions =>
   rest.get(
-    `${BASE_URL}/api/v2/registration/plugins/objects-api/object-types/${objecttypeUuid}/versions`,
+    `${BASE_URL}/api/v2/registration/plugins/objects-api/object-types/:uuid/versions`,
     (req, res, ctx) => {
       return res(ctx.json(versions));
     }

src/openforms/js/components/admin/form_design/registrations/objectsapi/ObjectsApiOptionsFormFields.stories.js

@@ -1,5 +1,8 @@
 import React from 'react';
 
+// TODO This is duplicated from the ZGW registration, but will be cleaned up
+// with the backend UI refactor.
+
 const getFieldErrors = (name, index, errors, field) => {
   const errorMessages = [];
 

src/openforms/js/components/admin/form_design/registrations/objectsapi/mocks.js

@@ -19,3 +19,4 @@ class ObjecttypeVersionSerializer(serializers.Serializer):
     version = serializers.IntegerField(
         label=_("Integer version of the Objecttype."),
     )
+    status = serializers.CharField(label=_("Status of the object type version"))

src/openforms/js/components/admin/form_design/registrations/objectsapi/utils.js

@@ -17,6 +17,8 @@
 class ObjecttypesListView(ListMixin, views.APIView):
     """
     List the available Objecttypes.
+
+    Note that the response data is essentially proxied from the configured Objecttypes API.
     """
 
     authentication_classes = (authentication.SessionAuthentication,)
@@ -36,6 +38,8 @@ def get_objects(self) -> list[dict[str, Any]]:
 class ObjecttypeVersionsListView(ListMixin, views.APIView):
     """
     List the available versions for an Objecttype.
+
+    Note that the response data is essentially proxied from the configured Objecttypes API.
     """
 
     authentication_classes = (authentication.SessionAuthentication,)

src/openforms/registrations/contrib/objects_api/api/serializers.py

@@ -0,0 +1,36 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate, br
+      Authorization:
+      - Token 171be5abaf41e7856b423ad513df1ef8f867ff48
+      Connection:
+      - keep-alive
+      User-Agent:
+      - python-requests/2.31.0
+    method: GET
+    uri: http://localhost:8001/api/v2/objecttypes?page=1&pageSize=1
+  response:
+    body:
+      string: '{"count":2,"next":"http://localhost:8001/api/v2/objecttypes?page=2&pageSize=1","previous":null,"results":[{"url":"http://localhost:8001/api/v2/objecttypes/3edfdaf7-f469-470b-a391-bb7ea015bd6f","uuid":"3edfdaf7-f469-470b-a391-bb7ea015bd6f","name":"Tree","namePlural":"Trees","description":"","dataClassification":"confidential","maintainerOrganization":"","maintainerDepartment":"","contactPerson":"","contactEmail":"","source":"","updateFrequency":"unknown","providerOrganization":"","documentationUrl":"","labels":{},"createdAt":"2024-02-08","modifiedAt":"2024-02-08","allowGeometry":true,"versions":["http://localhost:8001/api/v2/objecttypes/3edfdaf7-f469-470b-a391-bb7ea015bd6f/versions/1"]}]}'
+    headers:
+      Allow:
+      - GET, POST, HEAD, OPTIONS
+      Content-Length:
+      - '696'
+      Content-Type:
+      - application/json
+      Referrer-Policy:
+      - same-origin
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+    status:
+      code: 200
+      message: OK
+version: 1