fix: allow proper encoding of string OIDs in PBF format (#946)

* fix: allow proper encoding of string OIDs in PBF format
koopjs · Mar 7, 2024 · 969d956 · 969d956
1 parent f2f1f7c
commit 969d956
Show file tree

Hide file tree

Showing 6 changed files with 115 additions and 12 deletions.
diff --git a/.changeset/lazy-wombats-relate.md b/.changeset/lazy-wombats-relate.md
@@ -0,0 +1,5 @@
+---
+"@koopjs/featureserver": patch
+---
+
+- allow proper PBF encoding of string OID values
diff --git a/demo/provider-data/points-w-metadata-id-string.geojson b/demo/provider-data/points-w-metadata-id-string.geojson
@@ -0,0 +1,62 @@
+{
+  "type": "FeatureCollection",
+  "metadata": {
+    "idField": "id",
+    "fields": [
+        { "name": "timestamp", "type": "Date" },
+        { "name": "id", "type": "String" },
+        { "name": "label", "type": "String" },
+        { "name": "category", "type": "String" }
+      ]
+    },
+  "features": [
+    {
+      "type": "Feature",
+      "properties": {
+        "id": "aaa",
+        "timestamp": "2023-04-10T16:15:30.000Z",
+        "label": "White Leg",
+        "category": "pinto"
+      },
+      "geometry": {
+        "type": "Point",
+        "coordinates": [
+          -80,
+          25
+        ]
+      }
+    },
+    {
+      "type": "Feature",
+      "properties": {
+        "id": "bbb",
+        "timestamp": "2020-04-12T16:15:30.000Z",
+        "label": "Fireman",
+        "category": "pinto"
+      },
+      "geometry": {
+        "type": "Point",
+        "coordinates": [
+          -120,
+          45
+        ]
+      }
+    },
+    {
+      "type": "Feature",
+      "properties": {
+        "id": "ccc",
+        "timestamp": "2015-04-11T16:15:30.000Z",
+        "label": "Workhorse",
+        "category": "draft"
+      },
+      "geometry": {
+        "type": "Point",
+        "coordinates": [
+          -100,
+          40
+        ]
+      }
+    }
+  ]
+}
diff --git a/packages/featureserver/coverage-unit.svg b/packages/featureserver/coverage-unit.svg
diff --git a/packages/featureserver/coverage.svg b/packages/featureserver/coverage.svg
diff --git a/packages/featureserver/src/response-handlers/helpers/send-pbf/transform-to-pbf-attributes.js b/packages/featureserver/src/response-handlers/helpers/send-pbf/transform-to-pbf-attributes.js
@@ -17,15 +17,21 @@ function transformToPbfAttributes(attributes, fieldMap) {
       name: key,
       value,
     }))
-    .orderBy(['name'],['asc'])
+    .orderBy(['name'], ['asc'])
     .map(({ name, value }) => {
       const type = fieldMap[name];
-      const pbfType = typeLookup[type];
+      const pbfType = dataTypeLookup(type, value);
       return { [pbfType]: value };
     })
     .value();
 }
 
+function dataTypeLookup(fieldType, value) {
+  if (fieldType === 'esriFieldTypeOID') {
+    return Number.isInteger(value) ? 'uintValue' : 'stringValue';
+  }
+  return typeLookup[fieldType];
+}
 module.exports = {
-  transformToPbfAttributes
+  transformToPbfAttributes,
 };
diff --git a/.../featureserver/src/response-handlers/helpers/send-pbf/transform-to-pbf-attributes.spec.js b/.../featureserver/src/response-handlers/helpers/send-pbf/transform-to-pbf-attributes.spec.js
@@ -80,7 +80,7 @@ const attributes = {
 
 describe('transformToPbfAttributes', () => {
   it('should transform Esri JSON to Esri PBF JSON', () => {
-    const result = transformToPbfAttributes(attributes ,fieldMap);
+    const result = transformToPbfAttributes(attributes, fieldMap);
     result.should.deepEqual([
       {
         sint64Value: 1421798400000,
@@ -105,4 +105,34 @@ describe('transformToPbfAttributes', () => {
       },
     ]);
   });
+
+  it('should properly handle OIDs that are strings', () => {
+    const result = transformToPbfAttributes(
+      { ...attributes, FID: 'foo' },
+      fieldMap,
+    );
+    result.should.deepEqual([
+      {
+        sint64Value: 1421798400000,
+      },
+      {
+        stringValue: '30040-085-3001-0126-000',
+      },
+      {
+        stringValue: 'foo',
+      },
+      {
+        stringValue: '9279699f-5ece-4ca6-8a3b-b559da37bc5e',
+      },
+      {
+        sintValue: 46104019,
+      },
+      {
+        doubleValue: 99,
+      },
+      {
+        sintValue: 6,
+      },
+    ]);
+  });
 });