Fix populateDB

badgeteam · Nov 27, 2024 · 2b5643f · 2b5643f
1 parent ef416f2
commit 2b5643f
Show file tree

Hide file tree

Showing 7 changed files with 179 additions and 116 deletions.
diff --git a/public/swagger.json b/public/swagger.json
@@ -148,7 +148,8 @@
             "format": "date-time"
           },
           "id": {
-            "type": "string"
+            "type": "number",
+            "format": "double"
           },
           "email": {
             "type": "string"
@@ -447,7 +448,8 @@
             "type": "string"
           },
           "user_id": {
-            "type": "string"
+            "type": "number",
+            "format": "double"
           },
           "git": {
             "type": "string"
@@ -656,7 +658,8 @@
             "type": "boolean"
           },
           "user_id": {
-            "type": "string"
+            "type": "number",
+            "format": "double"
           }
         },
         "required": ["user_id"],
@@ -676,7 +679,8 @@
             "type": "boolean"
           },
           "user_id": {
-            "type": "string"
+            "type": "number",
+            "format": "double"
           }
         },
         "required": ["user_id"],
@@ -696,7 +700,8 @@
             "type": "boolean"
           },
           "user_id": {
-            "type": "string"
+            "type": "number",
+            "format": "double"
           }
         },
         "type": "object",
@@ -1210,7 +1215,8 @@
             "name": "userId",
             "required": true,
             "schema": {
-              "type": "string"
+              "format": "double",
+              "type": "number"
             }
           }
         ],

diff --git a/src/db/BadgeHubDataPostgresAdapter.ts b/src/db/BadgeHubDataPostgresAdapter.ts
@@ -13,7 +13,7 @@ import { getPool } from "@db/connectionPool";
 import { DBProject as DBProject } from "@db/models/app/DBProject";
 import sql, { join, raw } from "sql-template-tag";
 import { DBInsertUser } from "@db/models/app/DBUser";
-import { Entry, getEntriesWithDefinedValues } from "@util/objectEntries";
+import { getEntriesWithDefinedValues } from "@util/objectEntries";
 import { DBBadge } from "@db/models/DBBadge";
 import {
   getBaseSelectProjectQuery,
@@ -33,19 +33,19 @@ import {
   DBInsertAppMetadataJSON,
 } from "@db/models/app/DBAppMetadataJSON";
 import { DBCategory } from "@db/models/app/DBCategory";
-import { getInsertKeysAndValuesSql } from "@db/sqlHelpers/objectToSQL";
+import {
+  assertValidColumKey,
+  getInsertKeysAndValuesSql,
+} from "@db/sqlHelpers/objectToSQL";
 
-function getUpdateAssigmentsSql(
-  definedEntries: Entry<Partial<Omit<ProjectCore, "slug">>>[]
-) {
+function getUpdateAssigmentsSql(changes: Object) {
+  const changeEntries = getEntriesWithDefinedValues(changes);
+  if (!changeEntries.length) {
+    return;
+  }
   return join(
-    definedEntries.map(
-      ([
-        key,
-        value,
-      ]) => sql`${raw(key)} // raw is ok here because these keys are checked against our typescript definitions by tsoa
-        =
-        ${value}`
+    changeEntries.map(
+      ([key, value]) => sql`${raw(assertValidColumKey(key))} = ${value}`
     )
   );
 }
@@ -91,13 +91,13 @@ export class BadgeHubDataPostgresAdapter implements BadgeHubDataPort {
     projectSlug: ProjectSlug,
     changes: Partial<Omit<ProjectCore, "slug">>
   ): Promise<void> {
-    const definedEntries = getEntriesWithDefinedValues(changes);
-    const setters = getUpdateAssigmentsSql(definedEntries);
-    if (definedEntries.length !== 0) {
-      await this.pool.query(sql`update projects
-                                set ${setters}
-                                where slug = ${projectSlug}`);
+    const setters = getUpdateAssigmentsSql(changes);
+    if (!setters) {
+      return;
     }
+    await this.pool.query(sql`update projects
+                              set ${setters}
+                              where slug = ${projectSlug}`);
   }
 
   // TODO test
@@ -107,12 +107,34 @@ export class BadgeHubDataPostgresAdapter implements BadgeHubDataPort {
                               where slug = ${projectSlug}`);
   }
 
-  writeFile(
+  async writeFile(
     projectSlug: ProjectSlug,
     filePath: string,
     contents: string | Uint8Array
   ): Promise<void> {
-    throw new Error("Method not implemented.");
+    if (filePath === "metadata.json") {
+      const appMetadata: DBAppMetadataJSON = JSON.parse(
+        typeof contents === "string"
+          ? contents
+          : new TextDecoder().decode(contents)
+      );
+      const setters = getUpdateAssigmentsSql(appMetadata);
+      if (!setters) {
+        return;
+      }
+
+      const appMetadataUpdateQuery = sql`update app_metadata_jsons
+                                         set ${setters}
+                                         where id = (select app_metadata_json_id
+                                                     from versions v
+                                                     where v.id =
+                                                           (select projects.version_id from projects where slug = ${projectSlug}))`;
+      await this.pool.query(appMetadataUpdateQuery);
+    } else {
+      throw new Error(
+        "Method not implemented for files other than the metadata.json file yet."
+      );
+    }
   }
 
   updateDraftMetadata(

diff --git a/src/db/models/DBProjectStatusOnBadge.ts b/src/db/models/DBProjectStatusOnBadge.ts
@@ -3,11 +3,15 @@ import { BadgeSlugRelation } from "./DBBadge";
 import { ProjectStatusName } from "@domain/readModels/app/Project";
 import { ProjectSlugRelation } from "@db/models/app/DBProject";
 
+export interface DBInsertProjectStatusOnBadge
+  extends BadgeSlugRelation,
+    ProjectSlugRelation {
+  status?: ProjectStatusName; // Status for this project for this particular badge
+}
+
 // table name: project_statuses_on_badges
 export interface DBProjectStatusOnBadge
-  extends DBDatedData,
-    BadgeSlugRelation,
-    ProjectSlugRelation {
+  extends DBInsertProjectStatusOnBadge,
+    DBDatedData {
   id: number;
-  status: ProjectStatusName; // Status for this project for this particular badge
 }
diff --git a/src/db/models/README.md b/src/db/models/README.md
@@ -5,3 +5,4 @@ In the db models, we try to stick to 2 principles
 - DRY, no data duplication, unless it's accidental duplication
 - No arrays. Arrays make querying and switching to another DB more difficult. So instead of arrays, we try to work with relation tables.
   - There is currently an exception here for the MetaDataFileContents, there the mappings are records and arrays and records with arrays, this is because the data comes from the json file and we could also just store it as stringified JSON.
+- Prefer slugs as primary keys where possible, because they are more human-readable which makes the api calls and db queries easier to read.
diff --git a/src/db/sqlHelpers/objectToSQL.ts b/src/db/sqlHelpers/objectToSQL.ts
@@ -1,9 +1,20 @@
 import { getEntriesWithDefinedValues } from "@util/objectEntries";
 import { join, raw } from "sql-template-tag";
 
+const COLUMN_KEY_REGEX = /^[a-zA-Z_][a-zA-Z0-9_]*$/;
+
+export function assertValidColumKey(key: string): string {
+  if (!COLUMN_KEY_REGEX.test(key)) {
+    throw new Error("Invalid column key: " + key);
+  }
+  return key;
+}
+
 export function getInsertKeysAndValuesSql(user: Object) {
   const definedEntries = getEntriesWithDefinedValues(user);
-  const keys = join(definedEntries.map(([key]) => raw(key))); // raw is ok here because these keys are checked against our typescript definitions by tsoa
+  const keys = join(
+    definedEntries.map(([key]) => raw(assertValidColumKey(key)))
+  );
   const values = join(definedEntries.map(([, value]) => value));
   return { keys, values };
 }
diff --git a/src/generated/routes.ts b/src/generated/routes.ts
@@ -1,11 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-import {
-  TsoaRoute,
-  fetchMiddlewares,
-  ExpressTemplateService,
-} from "@tsoa/runtime";
+import type { TsoaRoute } from "@tsoa/runtime";
+import { fetchMiddlewares, ExpressTemplateService } from "@tsoa/runtime";
 // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
 import { PublicRestController } from "./../controllers/public-rest.js";
 // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
@@ -110,7 +107,7 @@ const models: TsoaRoute.Models = {
       created_at: { dataType: "datetime", required: true },
       updated_at: { dataType: "datetime", required: true },
       deleted_at: { dataType: "datetime" },
-      id: { dataType: "string", required: true },
+      id: { dataType: "double", required: true },
       email: { dataType: "string", required: true },
       admin: { dataType: "boolean", required: true },
       name: { dataType: "string", required: true },
@@ -269,7 +266,7 @@ const models: TsoaRoute.Models = {
     dataType: "refObject",
     properties: {
       slug: { dataType: "string", required: true },
-      user_id: { dataType: "string", required: true },
+      user_id: { dataType: "double", required: true },
       git: { dataType: "string" },
       allow_team_fixes: { dataType: "boolean" },
       created_at: { dataType: "datetime", required: true },
@@ -369,7 +366,7 @@ const models: TsoaRoute.Models = {
         version_id: { dataType: "double" },
         git: { dataType: "string" },
         allow_team_fixes: { dataType: "boolean" },
-        user_id: { dataType: "string", required: true },
+        user_id: { dataType: "double", required: true },
       },
       validators: {},
     },
@@ -381,7 +378,7 @@ const models: TsoaRoute.Models = {
       version_id: { dataType: "double" },
       git: { dataType: "string" },
       allow_team_fixes: { dataType: "boolean" },
-      user_id: { dataType: "string", required: true },
+      user_id: { dataType: "double", required: true },
     },
     additionalProperties: false,
   },
@@ -392,7 +389,7 @@ const models: TsoaRoute.Models = {
       version_id: { dataType: "double" },
       git: { dataType: "string" },
       allow_team_fixes: { dataType: "boolean" },
-      user_id: { dataType: "string" },
+      user_id: { dataType: "double" },
     },
     additionalProperties: false,
   },
@@ -471,6 +468,7 @@ export function RegisterRoutes(app: Router) {
   //  NOTE: If you do not see routes for all of your controllers in this file, then you might not have informed tsoa of where to look
   //      Please look into the "controllerPathGlobs" config option described in the readme: https://github.com/lukeautry/tsoa
   // ###########################################################################################################
+
   app.get(
     "/api/v3/devices",
     ...fetchMiddlewares<RequestHandler>(PublicRestController),
@@ -850,7 +848,7 @@ export function RegisterRoutes(app: Router) {
           in: "path",
           name: "userId",
           required: true,
-          dataType: "string",
+          dataType: "double",
         },
         props: { in: "body", name: "props", required: true, ref: "UserProps" },
       };