feat(server): reverse geocoding endpoint (#11430)

* feat(server): reverse geocoding endpoint * chore: rename error message
immich-app · Jul 29, 2024 · ebc71e4 · ebc71e4
1 parent a70cd36
commit ebc71e4
Show file tree

Hide file tree

Showing 12 changed files with 443 additions and 42 deletions.
diff --git a/e2e/src/api/specs/map.e2e-spec.ts b/e2e/src/api/specs/map.e2e-spec.ts
@@ -159,4 +159,75 @@ describe('/map', () => {
       expect(body).toEqual(expect.objectContaining({ id: 'immich-map-dark' }));
     });
   });
+
+  describe('GET /map/reverse-geocode', () => {
+    it('should require authentication', async () => {
+      const { status, body } = await request(app).get('/map/reverse-geocode');
+      expect(status).toBe(401);
+      expect(body).toEqual(errorDto.unauthorized);
+    });
+
+    it('should throw an error if a lat is not provided', async () => {
+      const { status, body } = await request(app)
+        .get('/map/reverse-geocode?lon=123')
+        .set('Authorization', `Bearer ${admin.accessToken}`);
+      expect(status).toBe(400);
+      expect(body).toEqual(errorDto.badRequest(['lat must be a number between -90 and 90']));
+    });
+
+    it('should throw an error if a lat is not a number', async () => {
+      const { status, body } = await request(app)
+        .get('/map/reverse-geocode?lat=abc&lon=123.456')
+        .set('Authorization', `Bearer ${admin.accessToken}`);
+      expect(status).toBe(400);
+      expect(body).toEqual(errorDto.badRequest(['lat must be a number between -90 and 90']));
+    });
+
+    it('should throw an error if a lat is out of range', async () => {
+      const { status, body } = await request(app)
+        .get('/map/reverse-geocode?lat=91&lon=123.456')
+        .set('Authorization', `Bearer ${admin.accessToken}`);
+      expect(status).toBe(400);
+      expect(body).toEqual(errorDto.badRequest(['lat must be a number between -90 and 90']));
+    });
+
+    it('should throw an error if a lon is not provided', async () => {
+      const { status, body } = await request(app)
+        .get('/map/reverse-geocode?lat=75')
+        .set('Authorization', `Bearer ${admin.accessToken}`);
+      expect(status).toBe(400);
+      expect(body).toEqual(errorDto.badRequest(['lon must be a number between -180 and 180']));
+    });
+
+    const reverseGeocodeTestCases = [
+      {
+        name: 'Vaucluse',
+        lat: -33.858_977_058_663_13,
+        lon: 151.278_490_730_270_48,
+        results: [{ city: 'Vaucluse', state: 'New South Wales', country: 'Australia' }],
+      },
+      {
+        name: 'Ravenhall',
+        lat: -37.765_732_399_174_75,
+        lon: 144.752_453_164_883_3,
+        results: [{ city: 'Ravenhall', state: 'Victoria', country: 'Australia' }],
+      },
+      {
+        name: 'Scarborough',
+        lat: -31.894_346_156_789_997,
+        lon: 115.757_617_103_904_64,
+        results: [{ city: 'Scarborough', state: 'Western Australia', country: 'Australia' }],
+      },
+    ];
+
+    it.each(reverseGeocodeTestCases)(`should resolve to $name`, async ({ lat, lon, results }) => {
+      const { status, body } = await request(app)
+        .get(`/map/reverse-geocode?lat=${lat}&lon=${lon}`)
+        .set('Authorization', `Bearer ${admin.accessToken}`);
+      expect(status).toBe(200);
+      expect(Array.isArray(body)).toBe(true);
+      expect(body.length).toBe(results.length);
+      expect(body).toEqual(results);
+    });
+  });
 });
diff --git a/mobile/openapi/README.md b/mobile/openapi/README.md
diff --git a/mobile/openapi/lib/api.dart b/mobile/openapi/lib/api.dart
diff --git a/mobile/openapi/lib/api/map_api.dart b/mobile/openapi/lib/api/map_api.dart
diff --git a/mobile/openapi/lib/api_client.dart b/mobile/openapi/lib/api_client.dart
diff --git a/mobile/openapi/lib/model/map_reverse_geocode_response_dto.dart b/mobile/openapi/lib/model/map_reverse_geocode_response_dto.dart
diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
@@ -3109,6 +3109,60 @@
         ]
       }
     },
+    "/map/reverse-geocode": {
+      "get": {
+        "operationId": "reverseGeocode",
+        "parameters": [
+          {
+            "name": "lat",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "format": "double",
+              "type": "number"
+            }
+          },
+          {
+            "name": "lon",
+            "required": true,
+            "in": "query",
+            "schema": {
+              "format": "double",
+              "type": "number"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "items": {
+                    "$ref": "#/components/schemas/MapReverseGeocodeResponseDto"
+                  },
+                  "type": "array"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          },
+          {
+            "cookie": []
+          },
+          {
+            "api_key": []
+          }
+        ],
+        "tags": [
+          "Map"
+        ]
+      }
+    },
     "/map/style.json": {
       "get": {
         "operationId": "getMapStyle",
@@ -9128,6 +9182,28 @@
         ],
         "type": "object"
       },
+      "MapReverseGeocodeResponseDto": {
+        "properties": {
+          "city": {
+            "nullable": true,
+            "type": "string"
+          },
+          "country": {
+            "nullable": true,
+            "type": "string"
+          },
+          "state": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "city",
+          "country",
+          "state"
+        ],
+        "type": "object"
+      },
       "MapTheme": {
         "enum": [
           "light",