feat(public-api): add endpoint to list all tags (#3571)

Author: idoshamun

__tests__/routes/public/tags.ts

@@ -0,0 +1,49 @@
+import request from 'supertest';
+import { setupPublicApiTests, createTokenForUser } from './helpers';
+import { Keyword } from '../../../src/entity/Keyword';
+
+const state = setupPublicApiTests();
+
+describe('GET /public/v1/tags', () => {
+  beforeEach(async () => {
+    await state.con.getRepository(Keyword).save([
+      { value: 'eng688tagalpha', status: 'allow' },
+      { value: 'eng688tagbeta', status: 'allow' },
+    ]);
+  });
+
+  it('should return all tags for authenticated user', async () => {
+    const token = await createTokenForUser(state.con, '5');
+
+    const { body } = await request(state.app.server)
+      .get('/public/v1/tags')
+      .set('Authorization', `Bearer ${token}`)
+      .expect(200);
+
+    expect(Array.isArray(body.data)).toBe(true);
+    expect(body.data).toEqual(
+      expect.arrayContaining([
+        { name: 'eng688tagalpha' },
+        { name: 'eng688tagbeta' },
+      ]),
+    );
+  });
+
+  it('should return 401 without auth header', async () => {
+    await request(state.app.server).get('/public/v1/tags').expect(401);
+  });
+
+  it('should return data array without pagination', async () => {
+    const token = await createTokenForUser(state.con, '5');
+
+    const { body } = await request(state.app.server)
+      .get('/public/v1/tags')
+      .set('Authorization', `Bearer ${token}`)
+      .expect(200);
+
+    expect(body).toMatchObject({
+      data: expect.any(Array),
+    });
+    expect(body.pagination).toBeUndefined();
+  });
+});

src/routes/public/index.ts

@@ -12,6 +12,7 @@ import notificationsRoutes from './notifications';
 import profileRoutes from './profile';
 import stackRoutes from './stack';
 import experiencesRoutes from './experiences';
+import tagsRoutes from './tags';
 import { commonSchemas } from './schemas';
 import { PUBLIC_API_PREFIX } from '../../common/constants';
 
@@ -192,4 +193,5 @@ export default async function (
   await fastify.register(profileRoutes, { prefix: '/profile' });
   await fastify.register(stackRoutes, { prefix: '/profile/stack' });
   await fastify.register(experiencesRoutes, { prefix: '/profile/experiences' });
+  await fastify.register(tagsRoutes, { prefix: '/tags' });
 }

src/routes/public/tags.ts

@@ -0,0 +1,55 @@
+import type { FastifyInstance } from 'fastify';
+import { executeGraphql } from './graphqlExecutor';
+import { ensureDbConnection } from './common';
+
+const TAGS_QUERY = `
+  query PublicApiTags {
+    tags {
+      value
+    }
+  }
+`;
+
+type TagsResponse = {
+  tags: { value: string }[];
+};
+
+export default async function (fastify: FastifyInstance): Promise<void> {
+  fastify.get(
+    '/',
+    {
+      schema: {
+        description: 'Get all tags',
+        tags: ['tags'],
+        response: {
+          200: {
+            type: 'object',
+            properties: {
+              data: { type: 'array', items: { $ref: 'Tag#' } },
+            },
+          },
+          401: { $ref: 'Error#' },
+          429: { $ref: 'RateLimitError#' },
+        },
+      },
+    },
+    async (request, reply) => {
+      const con = ensureDbConnection(fastify.con);
+
+      return executeGraphql(
+        con,
+        {
+          query: TAGS_QUERY,
+          variables: {},
+        },
+        (json) => ({
+          data: (json as TagsResponse).tags.map(({ value }) => ({
+            name: value,
+          })),
+        }),
+        request,
+        reply,
+      );
+    },
+  );
+}