refactor: Handle MULTI_DOMAIN as an optional config when checking health of domains

Author: justinhartman

controllers/healthController.spec.ts

@@ -132,25 +132,34 @@ describe('healthController', () => {
     const res = createRes();
     await healthController.getEmbedDomains({ query: {} } as unknown as Request, res);
 
-    expect(res.status).toHaveBeenCalledWith(503);
+    expect(res.status).toHaveBeenCalledWith(200);
     expect(res.json).toHaveBeenCalledWith({
-      status: 'error',
+      status: 'success',
       domains: [
         {
           name: 'VIDSRC_DOMAIN',
           domain: 'vidsrc.example',
           status: 'success',
           httpStatus: 200,
         },
-        {
-          name: 'MULTI_DOMAIN',
-          status: 'error',
-          message: 'Domain not configured',
-        },
       ],
     });
   });
 
+  test('getEmbedDomains rejects multi target when MULTI_DOMAIN is not configured', async () => {
+    (appConfig as any).MULTI_DOMAIN = undefined;
+    const res = createRes();
+
+    await healthController.getEmbedDomains({ query: { target: 'multi' } } as unknown as Request, res);
+
+    expect(res.status).toHaveBeenCalledWith(400);
+    expect(res.json).toHaveBeenCalledWith({
+      status: 'error',
+      message: 'Target not configured',
+      domains: [],
+    });
+  });
+
   test('getEmbedDomains filters by target query and returns 200 when healthy', async () => {
     mockedHttpClient.get.mockResolvedValue({ status: 200 } as any);
 

controllers/healthController.ts

@@ -82,18 +82,30 @@ const healthController = {
    * @param {Request} _req - Express request object.
    * @param {Response} res - Express response object.
    * @returns {Promise<Response>} JSON response containing domain health information.
-   */
+  */
   async getEmbedDomains(req: Request, res: Response): Promise<Response> {
     const target = typeof req.query.target === 'string' ? req.query.target.toLowerCase() : undefined;
 
+    // Return 400 if there is no `MULTI_DOMAIN` configured
+    if (target === 'multi' && !appConfig.MULTI_DOMAIN) {
+      return res.status(400).json({
+        status: 'error',
+        message: 'Target not configured',
+        domains: [],
+      });
+    }
+
     const checks: Array<Promise<DomainHealthResult>> = [];
 
     if (!target || target === 'vidsrc') {
       checks.push(checkDomainHealth('VIDSRC_DOMAIN', appConfig.VIDSRC_DOMAIN));
     }
 
     if (!target || target === 'multi') {
-      checks.push(checkDomainHealth('MULTI_DOMAIN', appConfig.MULTI_DOMAIN));
+      // This makes sure we make this optional as there will be scenarios where MULTI_DOMAIN isn't configured
+      if (appConfig.MULTI_DOMAIN) {
+        checks.push(checkDomainHealth('MULTI_DOMAIN', appConfig.MULTI_DOMAIN));
+      }
     }
 
     if (checks.length === 0) {