fix: send full url when requesting the short link (#2025)

* fix: send full url when requesting the short link

* fix: tests

* fix: use a better var name and default value

Author: spaenleh

.devcontainer/docker-compose.yml

@@ -35,6 +35,8 @@ services:
       S3_FILE_ITEM_HOST: http://s3.garage.localhost:3900
       # the Iframely config is set by the "iframely" service below
       EMBEDDED_LINK_ITEM_IFRAMELY_HREF_ORIGIN: http://iframely:8061
+      # Redirection for shortlinks
+      SHORT_LINK_BASE_URL: http://localhost:3000/short-links
     links:
       - garage:s3.garage.localhost
     volumes:

README.md

@@ -207,6 +207,9 @@ CLIENT_HOST=http://localhost:3114
 LIBRARY_CLIENT_HOST=http://localhost:3005
 GRAASP_MOBILE_BUILDER=graasp-mobile-builder
 
+# Base url used to redirect shortlink aliases
+# SHORT_LINK_BASE_URL=http://localhost:3000/short-links
+
 # This is already set in the docker-compose file, un-comment below if you want to override it
 # IMAGE_CLASSIFIER_API=<url>
 

src/config/hosts.ts

@@ -0,0 +1,6 @@
+import { getEnv } from './env';
+
+getEnv();
+
+export const SHORT_LINK_BASE_URL =
+  process.env.SHORT_LINK_BASE_URL ?? 'http://localhost:3000/short-links';

src/services/item/plugins/shortLink/shortlink.controller.test.ts

@@ -11,6 +11,7 @@ import build, {
   unmockAuthenticate,
 } from '../../../../../test/app';
 import { seedFromJson } from '../../../../../test/mocks/seed';
+import { SHORT_LINK_BASE_URL } from '../../../../config/hosts';
 import { db } from '../../../../drizzle/db';
 import { shortLinksTable } from '../../../../drizzle/schema';
 import { assertIsDefined } from '../../../../utils/assertions';
@@ -765,7 +766,12 @@ describe('Short links routes tests', () => {
 
           const response = await injectGetAll(app, item.id);
           expect(response.statusCode).toEqual(StatusCodes.OK);
-          expect(response.json()).toEqual({ [shortLink.platform]: shortLink.alias });
+          expect(response.json()).toEqual({
+            [shortLink.platform]: {
+              alias: shortLink.alias,
+              url: `${SHORT_LINK_BASE_URL}/${shortLink.alias}`,
+            },
+          });
         });
         it('Success if read permission', async () => {
           const {

src/services/item/plugins/shortLink/shortlink.schemas.ts

@@ -15,6 +15,10 @@ const shortLink = customType.StrictObject({
 });
 
 const shortLinkAlias = Type.Pick(shortLink, ['alias']);
+const shortLinkPlatformResponse = Type.Object({
+  alias: Type.String(),
+  url: Type.String({ format: 'uri' }),
+});
 
 export const getRedirection = {
   operationId: 'getShortLinkRedirection',
@@ -56,9 +60,9 @@ export const getAllByItem = {
     [StatusCodes.OK]: Type.Union([
       customType.StrictObject(
         {
-          [ShortLinkPlatform.Builder]: Type.Optional(Type.String()),
-          [ShortLinkPlatform.Player]: Type.Optional(Type.String()),
-          [ShortLinkPlatform.Library]: Type.Optional(Type.String()),
+          [ShortLinkPlatform.Builder]: Type.Optional(shortLinkPlatformResponse),
+          [ShortLinkPlatform.Player]: Type.Optional(shortLinkPlatformResponse),
+          [ShortLinkPlatform.Library]: Type.Optional(shortLinkPlatformResponse),
         },
         { minProperties: 1 },
       ),

src/services/item/plugins/shortLink/shortlink.service.ts

@@ -10,6 +10,7 @@ import {
   type UpdateShortLink,
 } from '@graasp/sdk';
 
+import { SHORT_LINK_BASE_URL } from '../../../../config/hosts';
 import { type DBConnection } from '../../../../drizzle/db';
 import type { AuthenticatedUser, MinimalMember } from '../../../../types';
 import { ITEMS_ROUTE_PREFIX } from '../../../../utils/config';
@@ -79,14 +80,21 @@ export class ShortLinkService {
     });
 
     const res = await this.shortLinkRepository.getByItem(dbConnection, itemId);
-
     return res.reduce<ShortLinksOfItem>((acc, { alias, platform }) => {
       if (acc[platform]) {
         // This should never happen.
         throw new Error(`An alias for the platform "${platform}" already exist!`);
       }
 
-      return { ...acc, [platform]: alias };
+      return {
+        ...acc,
+        [platform]: {
+          alias,
+          // something of the form: https://go.graasp.org/:alias
+          // or in local it would be: http://localhost:3000/short-links/:alias
+          url: `${SHORT_LINK_BASE_URL}/${alias}`,
+        },
+      };
     }, {});
   }