Merge pull request #387 from AppQuality/develop

Release 20250519

Author: d-beezee

package.json

@@ -21,7 +21,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@appquality/tryber-database": "^0.44.0",
+    "@appquality/tryber-database": "^0.44.6",
     "@appquality/wp-auth": "^1.0.7",
     "@googlemaps/google-maps-services-js": "^3.3.7",
     "@sendgrid/mail": "^7.6.0",

src/reference/openapi.yml

@@ -10736,12 +10736,6 @@ components:
             - 0
           productType: 0
           notes: string
-      required:
-        - project
-        - testType
-        - title
-        - startDate
-        - deviceList
       properties:
         project:
           type: integer
@@ -10775,14 +10769,14 @@ components:
           type: array
           items:
             type: object
-            required:
-              - role
-              - user
             properties:
               role:
                 type: integer
               user:
                 type: integer
+            required:
+              - role
+              - user
         description:
           type: string
         productLink:
@@ -10818,6 +10812,37 @@ components:
           type: integer
         notes:
           type: string
+        additionals:
+          x-stoplight:
+            id: prsjf310wgcw1
+          type: array
+          items:
+            x-stoplight:
+              id: 05yh361c4m134
+            allOf:
+              - type: object
+                x-stoplight:
+                  id: ob87gktp597p8
+                properties:
+                  showInStats:
+                    type: boolean
+                    x-stoplight:
+                      id: h3ll753yh9e2x
+              - $ref: '#/components/schemas/CampaignAdditionalField'
+        bugTypes:
+          type: array
+          x-stoplight:
+            id: b3tzoarrt5ir1
+          items:
+            x-stoplight:
+              id: grb3h65cr8pmi
+            type: number
+      required:
+        - project
+        - testType
+        - title
+        - startDate
+        - deviceList
     FiscalBirthCity:
       title: FiscalBirthCity
       oneOf:

src/routes/dossiers/_post/creation.spec.ts

@@ -17,6 +17,7 @@ const baseRequest = {
 
 describe("Route POST /dossiers", () => {
   beforeAll(async () => {
+    await tryber.seeds().bug_types();
     await tryber.tables.CampaignPhase.do().insert([
       { id: 1, name: "Test Phase", type_id: 1 },
     ]);
@@ -116,6 +117,7 @@ describe("Route POST /dossiers", () => {
     await tryber.tables.CampaignDossierDataBrowsers.do().delete();
     await tryber.tables.CampaignDossierDataLanguages.do().delete();
     await tryber.tables.CampaignDossierDataCountries.do().delete();
+    await tryber.tables.WpAppqCampaignAdditionalFields.do().delete();
   });
 
   it("Should create a campaign", async () => {
@@ -274,6 +276,126 @@ describe("Route POST /dossiers", () => {
     expect(campaign).toHaveProperty("close_date", "2021-08-20 14:15:22");
   });
 
+  it("Should create a campaign with the specified additional fields", async () => {
+    const response = await request(app)
+      .post("/dossiers")
+      .set("authorization", "Bearer admin")
+      .send({
+        ...baseRequest,
+        additionals: [
+          {
+            name: "Regex Field",
+            slug: "regex-field",
+            error: "Regex error",
+            type: "text",
+            regex: "^[a-zA-Z0-9]+$",
+          },
+          {
+            name: "Select Field",
+            slug: "select-field",
+            error: "Select error",
+            type: "select",
+            showInStats: true,
+            options: ["Option 1", "Option 2"],
+          },
+        ],
+      });
+    expect(response.status).toBe(201);
+    expect(response.body).toHaveProperty("id");
+    const id = response.body.id;
+
+    const fields = await tryber.tables.WpAppqCampaignAdditionalFields.do()
+      .select()
+      .where("cp_id", id);
+
+    expect(fields).toHaveLength(2);
+    expect(fields).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          cp_id: id,
+          title: "Regex Field",
+          slug: "regex-field",
+          type: "regex",
+          validation: "^[a-zA-Z0-9]+$",
+          error_message: "Regex error",
+          stats: 0,
+        }),
+        expect.objectContaining({
+          cp_id: id,
+          title: "Select Field",
+          slug: "select-field",
+          type: "select",
+          validation: "Option 1;Option 2",
+          error_message: "Select error",
+          stats: 1,
+        }),
+      ])
+    );
+  });
+
+  it("Should create a campaign with the specified bug types", async () => {
+    const response = await request(app)
+      .post("/dossiers")
+      .set("authorization", "Bearer admin")
+      .send({
+        ...baseRequest,
+        bugTypes: [1, 2, 3],
+      });
+    expect(response.status).toBe(201);
+    expect(response.body).toHaveProperty("id");
+    const id = response.body.id;
+
+    const bugTypes = await tryber.tables.WpAppqAdditionalBugTypes.do()
+      .select()
+      .where("campaign_id", id);
+
+    expect(bugTypes).toHaveLength(3);
+    expect(bugTypes).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({
+          bug_type_id: 1,
+        }),
+        expect.objectContaining({
+          bug_type_id: 2,
+        }),
+        expect.objectContaining({
+          bug_type_id: 3,
+        }),
+      ])
+    );
+  });
+
+  it("Should create a campaign with default bug types if no specific bug types are selected", async () => {
+    const response = await request(app)
+      .post("/dossiers")
+      .set("authorization", "Bearer admin")
+      .send({
+        ...baseRequest,
+      });
+    expect(response.status).toBe(201);
+    expect(response.body).toHaveProperty("id");
+    const id = response.body.id;
+
+    const bugTypes = await tryber.tables.WpAppqAdditionalBugTypes.do()
+      .select()
+      .where("campaign_id", id);
+
+    expect(bugTypes).toHaveLength(0);
+  });
+
+  it("Should throw an error if invalid bugtype is sent", async () => {
+    const response = await request(app)
+      .post("/dossiers")
+      .set("authorization", "Bearer admin")
+      .send({
+        ...baseRequest,
+        bugTypes: [100],
+      });
+    expect(response.status).toBe(406);
+    expect(response.body).toHaveProperty("id");
+    const id = response.body.id;
+  });
+
   it("Should create a campaign with the end date as start date + 7 if left unspecified", async () => {
     const response = await request(app)
       .post("/dossiers")

src/routes/dossiers/_post/index.ts

@@ -44,6 +44,10 @@ export default class PostDossiers extends UserRoute<{
       this.setError(406, new OpenapiError("Invalid roles submitted"));
       return false;
     }
+    if (await this.invalidBugTypesSubmitted()) {
+      this.setError(406, new OpenapiError("Invalid bug types submitted"));
+      return false;
+    }
     if (!(await this.projectExists())) {
       this.setError(400, new OpenapiError("Project does not exist"));
       return false;
@@ -104,6 +108,17 @@ export default class PostDossiers extends UserRoute<{
     return false;
   }
 
+  private async invalidBugTypesSubmitted() {
+    const { bugTypes } = this.getBody();
+    if (!bugTypes || !bugTypes.length) return false;
+    const bugTypeIds = [...new Set(bugTypes)];
+    const bugTypesExist = await tryber.tables.WpAppqEvdBugType.do()
+      .select()
+      .whereIn("id", bugTypeIds);
+    if (bugTypesExist.length !== bugTypeIds.length) return true;
+    return false;
+  }
+
   private async projectExists(): Promise<boolean> {
     const { project: projectId } = this.getBody();
     const project = await tryber.tables.WpAppqProject.do()
@@ -292,6 +307,9 @@ export default class PostDossiers extends UserRoute<{
       await this.createCampaignMeta(campaignId);
     }
 
+    await this.createAdditionals(campaignId);
+    await this.setBugTypes(campaignId);
+
     const dossier = await tryber.tables.CampaignDossierData.do()
       .insert({
         campaign_id: campaignId,
@@ -353,6 +371,38 @@ export default class PostDossiers extends UserRoute<{
     return campaignId;
   }
 
+  private async createAdditionals(campaignId: number) {
+    const { additionals } = this.getBody();
+    if (!additionals || !additionals.length) return;
+
+    await tryber.tables.WpAppqCampaignAdditionalFields.do().insert(
+      additionals.map((additional) => ({
+        cp_id: campaignId,
+        type: additional.type === "text" ? "regex" : "select",
+        slug: additional.slug,
+        title: additional.name,
+        validation:
+          additional.type === "text"
+            ? additional.regex
+            : additional.options.join(";"),
+        error_message: additional.error,
+        stats: additional.showInStats ? 1 : 0,
+      }))
+    );
+  }
+
+  private async setBugTypes(campaignId: number) {
+    const { bugTypes } = this.getBody();
+    if (!bugTypes || !bugTypes.length) return;
+
+    await tryber.tables.WpAppqAdditionalBugTypes.do().insert(
+      bugTypes.map((bugType) => ({
+        campaign_id: campaignId,
+        bug_type_id: bugType,
+      }))
+    );
+  }
+
   private async linkRolesToCampaign(campaignId: number) {
     const roles = this.getBody().roles;
     if (!roles?.length) return;

src/schema.ts

@@ -830,6 +830,10 @@ export interface components {
       browsers?: number[];
       productType?: number;
       notes?: string;
+      additionals?: ({
+        showInStats?: boolean;
+      } & components["schemas"]["CampaignAdditionalField"])[];
+      bugTypes?: number[];
     };
     /** FiscalBirthCity */
     FiscalBirthCity:

yarn.lock

@@ -28,10 +28,10 @@
     "@babel/parser" "^7.22.5"
     "@babel/traverse" "^7.22.5"
 
-"@appquality/tryber-database@^0.44.0":
-  version "0.44.0"
-  resolved "https://registry.npmjs.org/@appquality/tryber-database/-/tryber-database-0.44.0.tgz#cac013386883c3bdc6940abdee69ac534d248cf7"
-  integrity sha512-5jUmbWu71phpASv19WLbO9dRHdgEiuVDyw9ECAaOS5o8GMZJLLD1G+O4Ev3vSQ335BphWsvubw9y8nVJUH+GQA==
+"@appquality/tryber-database@^0.44.6":
+  version "0.44.6"
+  resolved "https://registry.npmjs.org/@appquality/tryber-database/-/tryber-database-0.44.6.tgz#7791c4f351c2e10ac26f1c297f2297356391c848"
+  integrity sha512-a0hnYnAjyEiygjsujg1O3DDO7uEBA3RsEBCpcrz2Ltwkjwbbi2OzqOtmW9cn58scYC10U3rst/pWz9NZvcBCXA==
   dependencies:
     better-sqlite3 "^8.1.0"
     knex "^2.5.1"