Deploy May 14, 2024 (#483)

julienw · web-flow · commit 5f2de62bbfeb · 2024-05-14T13:40:04.000+02:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -3,7 +3,7 @@ version: 2.1
 executors:
   node:
     docker:
-      - image: cimg/node:18.14
+      - image: cimg/node:18.19
     environment:
       IMAGE_NAME: mozilla/profiler-server
 
@@ -12,7 +12,7 @@ executors:
   # preinstalled, but otherwise the exact version for node isn't important.
   python:
     docker:
-      - image: cimg/python:3.10-node
+      - image: cimg/python:3.11-node
 
 orbs:
   shellcheck: circleci/shellcheck@3.0.0
@@ -166,8 +166,7 @@ jobs:
       - attach_workspace:
           at: /tmp/workspace
       # This sets up a remote environment that's necessary to run docker commands.
-      - setup_remote_docker:
-          version: 19.03.12
+      - setup_remote_docker
       - run:
           name: Load archived Docker image
           command: docker load -i /tmp/workspace/image.tar
diff --git a/__mocks__/@google-cloud/storage.ts b/__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,
diff --git a/package.json b/package.json
@@ -35,42 +35,42 @@
     "ts-generate-types": "npx --yes dts-gen -m"
   },
   "devDependencies": {
-    "@babel/cli": "^7.23.4",
-    "@babel/core": "^7.23.7",
-    "@babel/eslint-parser": "^7.23.3",
-    "@babel/eslint-plugin": "^7.23.5",
-    "@babel/node": "^7.22.19",
+    "@babel/cli": "^7.24.5",
+    "@babel/core": "^7.24.5",
+    "@babel/eslint-parser": "^7.24.5",
+    "@babel/eslint-plugin": "^7.24.5",
+    "@babel/node": "^7.23.9",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
-    "@babel/preset-env": "^7.23.7",
-    "@babel/preset-typescript": "^7.23.3",
+    "@babel/preset-env": "^7.24.5",
+    "@babel/preset-typescript": "^7.24.1",
     "@types/content-type": "^1.1.8",
     "@types/convict": "^6.1.6",
-    "@types/jest": "^29.5.11",
-    "@types/jsonwebtoken": "^9.0.5",
+    "@types/jest": "^29.5.12",
+    "@types/jsonwebtoken": "^9.0.6",
     "@types/koa__cors": "^4.0.3",
     "@types/koa__router": "^12.0.4",
-    "@types/node": "^20.10.5",
+    "@types/node": "^20.12.7",
     "@types/node-fetch": "^2.6.2",
     "@types/supertest": "^6.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.13.2",
-    "@typescript-eslint/parser": "^6.13.2",
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
     "babel-jest": "^29.7.0",
     "devtools-license-check": "^0.9.0",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
     "husky": "^4.3.8",
     "jest": "^29.7.0",
-    "lockfile-lint": "^4.12.1",
+    "lockfile-lint": "^4.13.2",
     "mkdirp": "^3.0.1",
-    "nock": "^13.4.0",
-    "nodemon": "^3.0.2",
+    "nock": "^13.5.4",
+    "nodemon": "^3.1.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.1.1",
+    "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
-    "supertest": "^6.3.3",
-    "typescript": "^5.3.3"
+    "supertest": "^7.0.0",
+    "typescript": "^5.4.5"
   },
   "husky": {
     "hooks": {
@@ -81,14 +81,14 @@
     }
   },
   "dependencies": {
-    "@google-cloud/storage": "^7.7.0",
+    "@google-cloud/storage": "^7.10.1",
     "@koa/cors": "^4.0.0",
     "@koa/router": "^12.0.1",
     "content-type": "^1.0.5",
     "convict": "^6.2.4",
-    "dotenv": "^16.3.1",
+    "dotenv": "^16.4.5",
     "jsonwebtoken": "^9.0.2",
-    "koa": "^2.15.0",
+    "koa": "^2.15.3",
     "koa-helmet": "^7.0.2",
     "koa-json-body": "^5.3.0",
     "koa-jwt": "^4.0.4",
diff --git a/src/routes/profile.ts b/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.';
diff --git a/src/types/@google_cloud__storage.d.ts b/src/types/@google_cloud__storage.d.ts
diff --git a/test/api/profile.test.ts b/test/api/profile.test.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 () => {
diff --git a/yarn.lock b/yarn.lock
