feat: get geolocation within item, provide addressLabel (#814)

Author: pyphilia

package.json

@@ -66,7 +66,7 @@
     "@fastify/view": "7.4.1",
     "@fastify/websocket": "7.2.0",
     "@graasp/etherpad-api": "2.1.1",
-    "@graasp/sdk": "3.7.0",
+    "@graasp/sdk": "3.8.0",
     "@graasp/translations": "1.23.0",
     "@rapideditor/country-coder": "5.2.2",
     "@sentry/node": "7.64.0",

src/migrations/1707735413855-geolocation-address.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class Migrations1707735413855 implements MigrationInterface {
+  name = 'geolocation-address-1707735413855';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "item_geolocation" ADD "addressLabel" character varying(300)`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE "item_geolocation" DROP COLUMN "addressLabel"`);
+  }
+}

src/plugins/mailer/index.ts

@@ -6,7 +6,7 @@ import pointOfView from '@fastify/view';
 import { FastifyPluginAsync } from 'fastify';
 import fp from 'fastify-plugin';
 
-import { DEFAULT_LANG } from '@graasp/sdk';
+import { DEFAULT_LANG } from '@graasp/translations';
 
 import i18next from './i18n';
 import { applyLayout } from './layout';

src/services/auth/plugins/magicLink/index.ts

@@ -2,7 +2,8 @@ import { StatusCodes } from 'http-status-codes';
 
 import { FastifyPluginAsync } from 'fastify';
 
-import { DEFAULT_LANG, RecaptchaAction } from '@graasp/sdk';
+import { RecaptchaAction } from '@graasp/sdk';
+import { DEFAULT_LANG } from '@graasp/translations';
 
 import { AUTH_CLIENT_HOST } from '../../../../utils/config';
 import { MemberAlreadySignedUp } from '../../../../utils/errors';

src/services/auth/plugins/magicLink/service.ts

@@ -4,7 +4,7 @@ import { promisify } from 'util';
 
 import { FastifyBaseLogger, FastifyInstance } from 'fastify';
 
-import { DEFAULT_LANG } from '@graasp/sdk';
+import { DEFAULT_LANG } from '@graasp/translations';
 
 import { JWT_SECRET } from '../../../../utils/config';
 import {

src/services/auth/plugins/mobile/index.ts

@@ -2,7 +2,8 @@ import { StatusCodes } from 'http-status-codes';
 
 import { FastifyPluginAsync } from 'fastify';
 
-import { DEFAULT_LANG, RecaptchaAction } from '@graasp/sdk';
+import { RecaptchaAction } from '@graasp/sdk';
+import { DEFAULT_LANG } from '@graasp/translations';
 
 import { MOBILE_DEEP_LINK_PROTOCOL } from '../../../../utils/config';
 import { buildRepositories } from '../../../../utils/repositories';

src/services/auth/plugins/mobile/service.ts

@@ -5,7 +5,7 @@ import { promisify } from 'util';
 
 import { FastifyBaseLogger, FastifyInstance } from 'fastify';
 
-import { DEFAULT_LANG } from '@graasp/sdk';
+import { DEFAULT_LANG } from '@graasp/translations';
 
 import { JWT_SECRET } from '../../../../utils/config';
 import {

src/services/item/plugins/geolocation/ItemGeolocation.ts

@@ -33,6 +33,9 @@ export class ItemGeolocation extends BaseEntity {
   @Column({ type: 'float' })
   lng: number;
 
+  @Column({ length: 300, nullable: true })
+  addressLabel: string;
+
   @Column({ type: 'character varying', nullable: true, length: 4 })
   country: string | null;
 

src/services/item/plugins/geolocation/errors.ts

@@ -35,3 +35,16 @@ export class PartialItemGeolocation extends GraaspItemGeolocationError {
     );
   }
 }
+
+export class MissingGeolocationSearchParams extends GraaspItemGeolocationError {
+  constructor(data?) {
+    super(
+      {
+        code: 'GIGEOERR003',
+        statusCode: StatusCodes.BAD_REQUEST,
+        message: 'Geolocation Search should include parent item, or all lat1, lat2, lng1 and lng2',
+      },
+      data,
+    );
+  }
+}

src/services/item/plugins/geolocation/index.test.ts

@@ -11,7 +11,6 @@ import { saveItemAndMembership } from '../../../itemMembership/test/fixtures/mem
 import { saveMember } from '../../../member/test/fixtures/members';
 import { savePublicItem } from '../../test/fixtures/items';
 import { ItemGeolocation } from './ItemGeolocation';
-import { ItemGeolocationNotFound } from './errors';
 
 // mock datasource
 jest.mock('../../../../plugins/datasource');
@@ -114,13 +113,13 @@ describe('Item Geolocation', () => {
         });
       });
 
-      it('Throws if no geolocation', async () => {
+      it('Return null if no geolocation', async () => {
         const res = await app.inject({
           method: HttpMethod.GET,
           url: `${ITEMS_ROUTE_PREFIX}/${item.id}/geolocation`,
         });
-        expect(res.statusCode).toBe(StatusCodes.NOT_FOUND);
-        expect(res.json()).toMatchObject(new ItemGeolocationNotFound(expect.anything()));
+        expect(res.statusCode).toBe(StatusCodes.OK);
+        expect(res.json()).toBeNull();
       });
 
       it('Throws if id is not a uuid', async () => {
@@ -228,6 +227,51 @@ describe('Item Geolocation', () => {
         expect(res.json()).toHaveLength(3);
         expectItemGeolocations(res.json(), [geoloc1, geoloc2, geoloc3]);
       });
+
+      it('Get item geolocations within parent item', async () => {
+        const { item: parentItem } = await saveItemAndMembership({ member: actor });
+        const { item: item1 } = await saveItemAndMembership({
+          item: { name: 'hello bye' },
+          member: actor,
+          parentItem,
+        });
+        const geoloc1 = await repository.save({ item: item1, lat: 1, lng: 2, country: 'de' });
+        const { item: item2 } = await saveItemAndMembership({
+          item: { description: 'hello bye' },
+          member: actor,
+          parentItem,
+        });
+        const geoloc2 = await repository.save({ item: item2, lat: 1, lng: 2, country: 'de' });
+        const { item: item3 } = await saveItemAndMembership({
+          item: { name: 'bye hello' },
+          member: actor,
+        });
+        await repository.save({ item: item3, lat: 1, lng: 2, country: 'de' });
+
+        const res = await app.inject({
+          method: HttpMethod.GET,
+          url: `${ITEMS_ROUTE_PREFIX}/geolocation?parentItemId=${parentItem.id}`,
+        });
+        expect(res.statusCode).toBe(StatusCodes.OK);
+        expect(res.json()).toHaveLength(2);
+        expectItemGeolocations(res.json(), [geoloc1, geoloc2]);
+      });
+
+      it('Throw for incorrect parent item id', async () => {
+        const res = await app.inject({
+          method: HttpMethod.GET,
+          url: `${ITEMS_ROUTE_PREFIX}/geolocation?lat1=1&lat2=1&lng1=1&lng2=2&parentItemId=incorrect-id`,
+        });
+        expect(res.statusCode).toBe(StatusCodes.BAD_REQUEST);
+      });
+
+      it('Throw if no parent item id and no lat lng', async () => {
+        const res = await app.inject({
+          method: HttpMethod.GET,
+          url: `${ITEMS_ROUTE_PREFIX}/geolocation`,
+        });
+        expect(res.statusCode).toBe(StatusCodes.BAD_REQUEST);
+      });
     });
   });