Add some more logs (#482)

Author: julienw

__mocks__/@google-cloud/storage.ts

@@ -96,6 +96,11 @@ class MockFile {
       delete this.bucket.files[this.name];
       return Promise.resolve();
     }
+
+    if (this.name === 'THROW_ERROR') {
+      throw new Error('Unexpected error!');
+    }
+
     // eslint-disable-next-line prefer-promise-reject-errors
     return Promise.reject({
       code: 404,

src/routes/profile.ts

@@ -15,7 +15,7 @@ import {
 } from '../utils/errors';
 import { config } from '../config';
 import { create as gcsStorageCreate } from '../logic/gcs';
-import { ErrorResponse } from '@google-cloud/storage';
+import { ApiError } from '@google-cloud/storage';
 
 export function profileRoutes() {
   const router = new Router();
@@ -90,15 +90,24 @@ export function profileRoutes() {
         await storage.deleteFile(profileToken);
       } catch (error: any) {
         if ('code' in error && 'message' in error) {
-          const { code } = error as ErrorResponse;
+          const { code } = error as ApiError;
           if (code === 404) {
+            log.info(
+              'gcs_deleteProfileNotFound',
+              'The profile data that we attempted to delete from Google Cloud Storage was not found.'
+            );
+
             throw new NotFoundError(
               'That profile was most likely already deleted.'
             );
           }
-          throw error;
         }
-        console.log(error);
+        log.warn(
+          'gcs_deleteProfileUnknownError',
+          'An unknown error occurred while deleting the profile from Google Cloud Storage: ' +
+            String(error)
+        );
+        throw error;
       }
 
       ctx.body = 'Profile successfully deleted.';

src/types/@google_cloud__storage.d.ts

@@ -46,7 +46,7 @@ describe('DELETE /profile', () => {
     return { acceptHeader, agent, postProfileToCompressedStore };
   }
 
-  it('gives a 200 response when successfully uploading a profile', async function () {
+  it('gives a 200 response when successfully deleting a profile', async function () {
     const { agent, acceptHeader, postProfileToCompressedStore } = setup();
 
     const { profileToken, jwtToken } = await postProfileToCompressedStore();
@@ -199,6 +199,38 @@ describe('DELETE /profile', () => {
     expect(process.stdout.write).toHaveBeenCalledWith(
       expect.stringMatching(/server_error.*NotFoundError/)
     );
+    expect(process.stdout.write).toHaveBeenCalledWith(
+      expect.stringMatching(
+        'FirefoxProfiler.routes.profile.delete.gcs_deleteProfileNotFound'
+      )
+    );
+  });
+
+  it('logs appropriately for any error', async function () {
+    jest
+      .spyOn(process.stdout, 'write')
+      .mockImplementation((_: string | Uint8Array) => true);
+    const { agent, acceptHeader } = setup();
+
+    // Generate a random token.
+    const profileToken = 'THROW_ERROR';
+    const jwtToken = generateToken({ profileToken });
+
+    await agent
+      .delete(`/profile/${profileToken}`)
+      .accept(acceptHeader)
+      .set('Authorization', `Bearer ${jwtToken}`)
+      .send()
+      .expect(500, 'Internal Server Error');
+
+    expect(process.stdout.write).toHaveBeenCalledWith(
+      expect.stringMatching(/server_error.*Unexpected error/)
+    );
+    expect(process.stdout.write).toHaveBeenCalledWith(
+      expect.stringMatching(
+        'FirefoxProfiler.routes.profile.delete.gcs_deleteProfileUnknownError'
+      )
+    );
   });
 
   it('implements security headers', async () => {