status codes for thrown errors

Author: cnuss

src/controllers/ControllerV1.ts

@@ -4,6 +4,7 @@ import {
   Controller,
   Delete,
   Get,
+  HttpStatusCodeLiteral,
   Post,
   Put,
   Query,
@@ -13,10 +14,13 @@ import {
   Tags,
   TsoaResponse,
 } from 'tsoa';
+import { TerraformError } from '../interfaces/errors';
 import { StateLockRequest } from '../models/interfaces/StateLockRequest';
 import { GithubService } from '../services/GithubService';
 import { StateService } from '../services/StateService';
 
+type HeaderType = { [key: string]: string | string[] };
+
 @Route('/v1')
 @Tags('v1')
 export class ControllerV1 extends Controller {
@@ -31,9 +35,21 @@ export class ControllerV1 extends Controller {
   }
 
   @Get()
-  public async getState(@Request() request: HttpRequest): Promise<any> {
-    const identity = await this.githubService.getIdentity(request);
-    return this.stateService.getState(identity);
+  public async getState(
+    @Request() request: HttpRequest,
+    @Res() res: TsoaResponse<200 | 400 | 401 | 404, any>,
+  ): Promise<TsoaResponse<HttpStatusCodeLiteral, any, HeaderType>> {
+    try {
+      const identity = await this.githubService.getIdentity(request);
+      const state = await this.stateService.getState(identity);
+      const response = res(200, state);
+      return response;
+    } catch (e) {
+      if (e instanceof TerraformError) {
+        return e.respond(res);
+      }
+      throw e;
+    }
   }
 
   @Post()
@@ -42,38 +58,59 @@ export class ControllerV1 extends Controller {
     @Query('ID') id: string,
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     @Body() state: any,
-    @Res() res: TsoaResponse<200, void>,
-  ): Promise<void> {
-    const stateLockRequest = await this.stateService.getRequest(id);
-    const identity = await this.githubService.getIdentity(request, stateLockRequest);
-    await this.stateService.saveState(identity, id, state);
-    const response = res(200);
-    return response;
+    @Res() res: TsoaResponse<200 | 400 | 401 | 404 | 409, void>,
+  ): Promise<TsoaResponse<HttpStatusCodeLiteral, void, HeaderType>> {
+    try {
+      const stateLockRequest = await this.stateService.getRequest(id);
+      const identity = await this.githubService.getIdentity(request, stateLockRequest);
+      await this.stateService.saveState(identity, id, state);
+      const response = res(200);
+      return response;
+    } catch (e) {
+      if (e instanceof TerraformError) {
+        return e.respond(res);
+      }
+      throw e;
+    }
   }
 
   @Put('lock')
   public async lockState(
     @Request() request: HttpRequest,
     @Body() lockRequest: StateLockRequest,
-    @Res() res: TsoaResponse<200, boolean>,
-  ): Promise<boolean> {
-    const stateLockRequest = await this.stateService.saveRequest(lockRequest);
-    const identity = await this.githubService.getIdentity(request, stateLockRequest);
-    await this.stateService.lockState(identity, stateLockRequest);
-    const response = res(200, true);
-    return response;
+    @Res() res: TsoaResponse<200 | 400 | 401 | 404 | 409, boolean>,
+  ): Promise<TsoaResponse<HttpStatusCodeLiteral, boolean, HeaderType>> {
+    try {
+      const stateLockRequest = await this.stateService.saveRequest(lockRequest);
+      const identity = await this.githubService.getIdentity(request, stateLockRequest);
+      await this.stateService.lockState(identity, stateLockRequest);
+      const response = res(200, true);
+      return response;
+    } catch (e) {
+      if (e instanceof TerraformError) {
+        return e.respond(res);
+      }
+      throw e;
+    }
   }
 
   @Delete('lock')
   public async unlockState(
     @Request() request: HttpRequest,
     @Body() lockRequest: StateLockRequest,
-    @Res() res: TsoaResponse<200, boolean>,
-  ): Promise<boolean> {
-    const stateLockRequest = await this.stateService.getRequest(lockRequest.ID);
-    const identity = await this.githubService.getIdentity(request, stateLockRequest);
-    await this.stateService.unlockState(identity, stateLockRequest);
-    const response = res(200, true);
-    return response;
+    @Res() res: TsoaResponse<200 | 400 | 401 | 404 | 409, boolean>,
+  ): Promise<TsoaResponse<HttpStatusCodeLiteral, boolean, HeaderType>> {
+    try {
+      const stateLockRequest = await this.stateService.getRequest(lockRequest.ID);
+      const identity = await this.githubService.getIdentity(request, stateLockRequest);
+      await this.stateService.unlockState(identity, stateLockRequest);
+      const response = res(200, true);
+      return response;
+    } catch (e) {
+      if (e instanceof TerraformError) {
+        return e.respond(res);
+      }
+      throw e;
+    }
   }
 }

src/interfaces/errors.ts

@@ -1,16 +1,16 @@
-import { Response } from 'express';
+import { TsoaResponse } from 'tsoa';
 
 export class TerraformError extends Error {
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   constructor(public statusCode: number, public body?: any) {
     super();
   }
 
-  respond = (res: Response<any>): Response<any> => {
+  respond = (res: TsoaResponse<any, any>): TsoaResponse<any, any> => {
     if (!this.body) {
-      return res.status(this.statusCode);
+      return res(this.statusCode, {});
     }
 
-    return res.status(this.statusCode).json(JSON.stringify(this.body));
+    return res(this.statusCode, this.body);
   };
 }

src/services/GithubService.ts

@@ -186,6 +186,9 @@ export class GithubService {
     if (!identity && owner && repo) {
       console.log(`Fetching repository ${owner}/${repo}`);
       const data = await octokit.repos.get({ owner, repo });
+
+      // TODO: Restrict access to state for public repositories?
+
       identity = {
         pk: IdentityModel.prefix('pk', tokenSha),
         sk: IdentityModel.prefix('sk'),