Apollo: Improve Timat object caching some more

We now define proper id fields for:
- Versioned entities with `id` & `version` fields.
- Unversioned identified entities with `id` field.
- Embedded entitities without identity: Not normalized and Stored in
  cache as part of the owning parent object.

Additionally it is safe to merge all aforementioned Tiamat types.

Author: Huulivoide

codegen/TiamatVersionedObjectTypesResolverPlugin.ts

@@ -25,13 +25,35 @@ function TiamatVersionedObjectTypesResolverPluginImplementation(
     .filter((type) => type instanceof GraphQLObjectType)
     .filter((type) => type.name.startsWith('stop_registry_'));
 
+  // Tiamat Output Objects that define both an id field
+  const tiamatObjectsWithIds = tiamatObjects.filter((object) =>
+    hasField(object, 'id'),
+  );
+
   // Tiamat Output Objects that define both an id and version field
-  const versionedObjects = tiamatObjects.filter(
-    (object) => hasField(object, 'id') && hasField(object, 'version'),
+  const versionedObjects = tiamatObjectsWithIds.filter((object) =>
+    hasField(object, 'version'),
   );
 
-  const outputContent = versionedObjects.map((object) => object.name).sort();
-  return JSON.stringify(outputContent, null, 2);
+  const typesWithVersion = versionedObjects.map((object) => object.name).sort();
+
+  const typesWithId = tiamatObjectsWithIds
+    .map((object) => object.name)
+    .filter((name) => !typesWithVersion.includes(name))
+    .sort();
+
+  const embeddedTypes = tiamatObjects
+    .map((type) => type.name)
+    .filter(
+      (name) => !typesWithVersion.includes(name) && !typesWithId.includes(name),
+    )
+    .sort();
+
+  return JSON.stringify(
+    { typesWithVersion, typesWithId, embeddedTypes },
+    null,
+    2,
+  );
 }
 
 const TiamatVersionedObjectTypesResolverPlugin = {

ui/src/generated/versionedTiamatEntities.json

@@ -1,27 +1,56 @@
-[
-  "stop_registry_AccessibilityAssessment",
-  "stop_registry_AccessibilityLimitations",
-  "stop_registry_AddressablePlace",
-  "stop_registry_Contact",
-  "stop_registry_CycleStorageEquipment",
-  "stop_registry_FareZone",
-  "stop_registry_GeneralSign",
-  "stop_registry_GroupOfStopPlaces",
-  "stop_registry_GroupOfTariffZones",
-  "stop_registry_HslAccessibilityProperties",
-  "stop_registry_Organisation",
-  "stop_registry_ParentStopPlace",
-  "stop_registry_Parking",
-  "stop_registry_PathLink",
-  "stop_registry_PurposeOfGrouping",
-  "stop_registry_Quay",
-  "stop_registry_SanitaryEquipment",
-  "stop_registry_ShelterEquipment",
-  "stop_registry_StopPlace",
-  "stop_registry_TariffZone",
-  "stop_registry_TicketingEquipment",
-  "stop_registry_TopographicPlace",
-  "stop_registry_WaitingRoomEquipment",
-  "stop_registry_infoSpot",
-  "stop_registry_poster"
-]
+{
+  "typesWithVersion": [
+    "stop_registry_AccessibilityAssessment",
+    "stop_registry_AccessibilityLimitations",
+    "stop_registry_AddressablePlace",
+    "stop_registry_Contact",
+    "stop_registry_CycleStorageEquipment",
+    "stop_registry_FareZone",
+    "stop_registry_GeneralSign",
+    "stop_registry_GroupOfStopPlaces",
+    "stop_registry_GroupOfTariffZones",
+    "stop_registry_HslAccessibilityProperties",
+    "stop_registry_Organisation",
+    "stop_registry_ParentStopPlace",
+    "stop_registry_Parking",
+    "stop_registry_PathLink",
+    "stop_registry_PurposeOfGrouping",
+    "stop_registry_Quay",
+    "stop_registry_SanitaryEquipment",
+    "stop_registry_ShelterEquipment",
+    "stop_registry_StopPlace",
+    "stop_registry_TariffZone",
+    "stop_registry_TicketingEquipment",
+    "stop_registry_TopographicPlace",
+    "stop_registry_WaitingRoomEquipment",
+    "stop_registry_infoSpot",
+    "stop_registry_poster"
+  ],
+  "typesWithId": [
+    "stop_registry_BoardingPosition",
+    "stop_registry_PathLinkEnd",
+    "stop_registry_PlaceEquipments"
+  ],
+  "embeddedTypes": [
+    "stop_registry_AlternativeName",
+    "stop_registry_EmbeddableMultilingualString",
+    "stop_registry_EntityPermissions",
+    "stop_registry_EntityRef",
+    "stop_registry_GeoJSON",
+    "stop_registry_KeyValues",
+    "stop_registry_LocationRef",
+    "stop_registry_ParkingArea",
+    "stop_registry_ParkingCapacity",
+    "stop_registry_ParkingProperties",
+    "stop_registry_PrivateCode",
+    "stop_registry_StopPlaceOrganisationRef",
+    "stop_registry_Tag",
+    "stop_registry_TransferDuration",
+    "stop_registry_TransportModes",
+    "stop_registry_UserPermissions",
+    "stop_registry_ValidBetween",
+    "stop_registry_VersionLessEntityRef",
+    "stop_registry_externalLink",
+    "stop_registry_stopPlaceExternalLink"
+  ]
+}

ui/src/graphql/client.ts

@@ -17,11 +17,13 @@ import isString from 'lodash/isString';
 import { DateTime, Duration } from 'luxon';
 import introspectionResult from '../../graphql.schema.json';
 import { joreConfig } from '../config';
-import versionedTiamatEntities from '../generated/versionedTiamatEntities.json' with { type: 'json' };
+import tiamatTypeInfo from '../generated/versionedTiamatEntities.json' with { type: 'json' };
 import { isDateLike, parseDate } from '../time';
 import { mapHttpToWs } from '../utils/url';
 import { authRoleMiddleware, roleHeaderMap, userHasuraRole } from './auth';
 
+const { embeddedTypes, typesWithId, typesWithVersion } = tiamatTypeInfo;
+
 function parseDateTime(raw: unknown) {
   if (!isDateLike(raw)) {
     throw new Error(`Invalid graphql date input: '${raw}'`);
@@ -313,11 +315,17 @@ const buildCacheDefinition = () => {
         keyFields: ['netexId', 'version'],
       },
       ...Object.fromEntries(
-        versionedTiamatEntities.map((name) => [
+        typesWithVersion.map((name) => [
           name,
-          { keyFields: ['id', 'version'] },
+          { keyFields: ['id', 'version'], merge: true },
         ]),
       ),
+      ...Object.fromEntries(
+        typesWithId.map((name) => [name, { keyFields: ['id'], merge: true }]),
+      ),
+      ...Object.fromEntries(
+        embeddedTypes.map((name) => [name, { keyFields: false, merge: true }]),
+      ),
     },
   });