feat: Implement get app API endpoint

packages/backend/src/controllers/api/v1/apps/get-app.js

@@ -0,0 +1,8 @@
+import App from '../../../../models/app.js';
+import { renderObject } from '../../../../helpers/renderer.js';
+
+export default async (request, response) => {
+  const app = await App.findOneByKey(request.params.appKey);
+
+  renderObject(response, app);
+};

packages/backend/src/controllers/api/v1/apps/get-app.test.js

@@ -0,0 +1,32 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app.js';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id';
+import { createUser } from '../../../../../test/factories/user';
+import getAppMock from '../../../../../test/mocks/rest/api/v1/apps/get-app.js';
+
+describe('GET /api/v1/apps/:appKey', () => {
+  let currentUser, token;
+
+  beforeEach(async () => {
+    currentUser = await createUser();
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return the app info', async () => {
+    const response = await request(app)
+      .get('/api/v1/apps/github')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = getAppMock('github');
+    expect(response.body).toEqual(expectedPayload);
+  });
+
+  it('should return not found response for invalid app key', async () => {
+    await request(app)
+      .get('/api/v1/apps/invalid-app-key')
+      .set('Authorization', token)
+      .expect(404);
+  });
+});

packages/backend/src/helpers/error-handler.js

@@ -9,12 +9,23 @@ const errorHandler = (error, request, response, next) => {
     response.status(404).end();
   }
 
+  if (notFoundAppError(error)) {
+    response.status(404).end();
+  }
+
   if (error instanceof DataError) {
     response.status(400).end();
   }
 
   logger.error(error.message + '\n' + error.stack);
-  response.status(error.statusCode || 500);
+  response.status(error.statusCode || 500).end();
+};
+
+const notFoundAppError = (error) => {
+  return (
+    error.message.includes('An application with the') ||
+    error.message.includes("key couldn't be found.")
+  );
 };
 
 export default errorHandler;

packages/backend/src/routes/api/v1/apps.js

@@ -0,0 +1,10 @@
+import { Router } from 'express';
+import asyncHandler from 'express-async-handler';
+import { authenticateUser } from '../../../helpers/authentication.js';
+import getAppAction from '../../../controllers/api/v1/apps/get-app.js';
+
+const router = Router();
+
+router.get('/:appKey', authenticateUser, asyncHandler(getAppAction));
+
+export default router;

packages/backend/src/routes/index.js

@@ -8,6 +8,7 @@ import usersRouter from './api/v1/users.js';
 import paymentRouter from './api/v1/payment.ee.js';
 import appAuthClientsRouter from './api/v1/app-auth-clients.js';
 import flowsRouter from './api/v1/flows.js';
+import appsRouter from './api/v1/apps.js';
 import samlAuthProvidersRouter from './api/v1/admin/saml-auth-providers.ee.js';
 import rolesRouter from './api/v1/admin/roles.ee.js';
 import permissionsRouter from './api/v1/admin/permissions.ee.js';
@@ -25,6 +26,7 @@ router.use('/api/v1/users', usersRouter);
 router.use('/api/v1/payment', paymentRouter);
 router.use('/api/v1/app-auth-clients', appAuthClientsRouter);
 router.use('/api/v1/flows', flowsRouter);
+router.use('/api/v1/apps', appsRouter);
 router.use('/api/v1/admin/saml-auth-providers', samlAuthProvidersRouter);
 router.use('/api/v1/admin/roles', rolesRouter);
 router.use('/api/v1/admin/permissions', permissionsRouter);