feat: Normalize known DB errors to a MedusaError when possible

.changeset/cold-jeans-shave.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/utils": minor
+---
+
+Return normalized DB errors from the mikro ORM repository

integration-tests/api/__tests__/admin/product.js

@@ -2630,8 +2630,7 @@ medusaIntegrationTestRunner({
           )
         })
 
-        // TODO: This needs to be fixed
-        it.skip("successfully creates product with soft-deleted product handle and deletes it again", async () => {
+        it("successfully creates product with soft-deleted product handle and deletes it again", async () => {
           // First we soft-delete the product
           const response = await api
             .delete(`/admin/products/${baseProduct.id}`, adminHeaders)
@@ -2708,8 +2707,7 @@ medusaIntegrationTestRunner({
           expect(response.data.id).toEqual(baseCollection.id)
         })
 
-        // TODO: This needs to be fixed, it returns 422 now.
-        it.skip("successfully creates soft-deleted product collection", async () => {
+        it("successfully creates soft-deleted product collection", async () => {
           const response = await api.delete(
             `/admin/collections/${baseCollection.id}`,
             adminHeaders
@@ -2749,8 +2747,7 @@ medusaIntegrationTestRunner({
           }
         })
 
-        // TODO: This needs to be fixed
-        it.skip("successfully creates soft-deleted product variant", async () => {
+        it("successfully creates soft-deleted product variant", async () => {
           const variant = baseProduct.variants[0]
           const response = await api.delete(
             `/admin/products/${baseProduct.id}/variants/${variant.id}`,
@@ -2771,6 +2768,22 @@ medusaIntegrationTestRunner({
             ean: variant.ean,
             upc: variant.upc,
             barcode: variant.barcode,
+            ...breaking(
+              () => ({
+                options: [
+                  {
+                    option_id: baseProduct.options[0].id,
+                    value: "newval",
+                  },
+                  {
+                    option_id: baseProduct.options[1].id,
+                    value: "newval",
+                  },
+                ],
+              }),
+              // TODO: Require that options are passed if they belong on the product, and the combos are unique per variant
+              () => ({})
+            ),
             prices: [
               {
                 currency_code: "usd",

integration-tests/modules/__tests__/fulfillment/admin/shipping-option-rules.spec.ts

@@ -83,7 +83,7 @@ medusaIntegrationTestRunner({
           })
         })
 
-        it("should throw error when shipping option does not exist", async () => {
+        it.only("should throw error when shipping option does not exist", async () => {
           const { response } = await api
             .post(
               `/admin/fulfillment/shipping-options/does-not-exist/rules/batch/add`,
@@ -100,7 +100,7 @@ medusaIntegrationTestRunner({
           expect(response.data).toEqual({
             type: "not_found",
             message:
-              "Shipping_option with shipping_option_id does-not-exist does not exist.",
+              "You tried to set relationship shipping_option_id: does-not-exist, but such entity does not exist",
           })
         })
 

packages/customer/integration-tests/__tests__/services/customer-module/index.spec.ts

@@ -106,7 +106,7 @@ moduleIntegrationTestRunner({
             ],
           }
           await expect(service.create(customerData)).rejects.toThrow(
-            "A default shipping address already exists"
+            /Customer address with customer_id: .*? already exists./
           )
         })
 
@@ -727,7 +727,9 @@ moduleIntegrationTestRunner({
               country_code: "US",
               is_default_shipping: true,
             })
-          ).rejects.toThrow("A default shipping address already exists")
+          ).rejects.toThrow(
+            /Customer address with customer_id: .*? already exists./
+          )
         })
 
         it("should only be possible to add one default billing address per customer", async () => {
@@ -761,7 +763,9 @@ moduleIntegrationTestRunner({
               country_code: "US",
               is_default_billing: true,
             })
-          ).rejects.toThrow("A default billing address already exists")
+          ).rejects.toThrow(
+            /Customer address with customer_id: .*? already exists./
+          )
         })
       })
 
@@ -899,7 +903,9 @@ moduleIntegrationTestRunner({
 
           await expect(
             service.updateAddresses(address.id, { is_default_shipping: true })
-          ).rejects.toThrow("A default shipping address already exists")
+          ).rejects.toThrow(
+            /Customer address with customer_id: .*? already exists./
+          )
         })
       })
 

packages/customer/src/services/customer-module.ts

@@ -106,9 +106,7 @@ export default class CustomerModuleService<
       | CustomerTypes.CreateCustomerDTO[],
     @MedusaContext() sharedContext: Context = {}
   ): Promise<CustomerTypes.CustomerDTO | CustomerTypes.CustomerDTO[]> {
-    const customers = await this.create_(dataOrArray, sharedContext).catch(
-      this.handleDbErrors
-    )
+    const customers = await this.create_(dataOrArray, sharedContext)
 
     const serialized = await this.baseRepository_.serialize<
       CustomerTypes.CustomerDTO[]
@@ -351,9 +349,7 @@ export default class CustomerModuleService<
   ): Promise<
     CustomerTypes.CustomerAddressDTO | CustomerTypes.CustomerAddressDTO[]
   > {
-    const addresses = await this.addAddresses_(data, sharedContext).catch(
-      this.handleDbErrors
-    )
+    const addresses = await this.addAddresses_(data, sharedContext)
 
     const serialized = await this.baseRepository_.serialize<
       CustomerTypes.CustomerAddressDTO[]
@@ -434,7 +430,7 @@ export default class CustomerModuleService<
       sharedContext
     )
 
-    await this.flush(sharedContext).catch(this.handleDbErrors)
+    await this.flush(sharedContext)
 
     const serialized = await this.baseRepository_.serialize<
       CustomerTypes.CustomerAddressDTO[]
@@ -475,25 +471,4 @@ export default class CustomerModuleService<
     const em = (context.manager ?? context.transactionManager) as EntityManager
     await em.flush()
   }
-
-  private async handleDbErrors(err: any) {
-    if (isDuplicateError(err)) {
-      switch (err.constraint) {
-        case UNIQUE_CUSTOMER_SHIPPING_ADDRESS:
-          throw new MedusaError(
-            MedusaError.Types.DUPLICATE_ERROR,
-            "A default shipping address already exists"
-          )
-        case UNIQUE_CUSTOMER_BILLING_ADDRESS:
-          throw new MedusaError(
-            MedusaError.Types.DUPLICATE_ERROR,
-            "A default billing address already exists"
-          )
-        default:
-          break
-      }
-    }
-
-    throw err
-  }
 }

packages/fulfillment/integration-tests/__tests__/fulfillment-module-service/fulfillment-set.spec.ts

@@ -512,7 +512,7 @@ moduleIntegrationTestRunner({
             const err = await service.create(data).catch((e) => e)
 
             expect(err).toBeDefined()
-            expect(err.constraint).toBe("IDX_fulfillment_set_name_unique")
+            expect(err.message).toContain("exists")
           })
 
           it("should fail on creating a new fulfillment set with new service zones and new geo zones that are not valid", async function () {
@@ -837,7 +837,7 @@ moduleIntegrationTestRunner({
             const err = await service.update(updateData).catch((e) => e)
 
             expect(err).toBeDefined()
-            expect(err.constraint).toBe("IDX_fulfillment_set_name_unique")
+            expect(err.message).toContain("exists")
           })
 
           it("should update a collection of fulfillment sets and replace old service zones by new ones", async function () {

packages/fulfillment/integration-tests/__tests__/fulfillment-module-service/service-zone.spec.ts

@@ -187,7 +187,7 @@ moduleIntegrationTestRunner({
             const err = await service.createServiceZones(data).catch((e) => e)
 
             expect(err).toBeDefined()
-            expect(err.constraint).toBe("IDX_service_zone_name_unique")
+            expect(err.message).toContain("exists")
           })
 
           it("should fail on creating a service zone and new geo zones that are not valid", async function () {
@@ -435,7 +435,7 @@ moduleIntegrationTestRunner({
               .catch((e) => e)
 
             expect(err).toBeDefined()
-            expect(err.constraint).toBe("IDX_service_zone_name_unique")
+            expect(err.message).toContain("exists")
           })
         })
       })

packages/fulfillment/integration-tests/__tests__/fulfillment-module-service/shipping-profile.spec.ts

@@ -73,7 +73,7 @@ moduleIntegrationTestRunner({
               .catch((e) => e)
 
             expect(err).toBeDefined()
-            expect(err.constraint).toBe("IDX_shipping_profile_name_unique")
+            expect(err.message).toContain("exists")
           })
         })
       })

packages/tax/integration-tests/__tests__/index.spec.ts

@@ -711,7 +711,7 @@ moduleIntegrationTestRunner({
             ],
           })
         ).rejects.toThrowError(
-          /You are trying to create a Tax Rate Rule for a reference that already exists. Tax Rate id: .*?, reference id: product_id_1./
+          /Tax rate rule with tax_rate_id: .*?, reference_id: product_id_1 already exists./
         )
 
         const rate = await service.create({
@@ -729,7 +729,7 @@ moduleIntegrationTestRunner({
             reference_id: "product_id_1",
           })
         ).rejects.toThrowError(
-          /You are trying to create a Tax Rate Rule for a reference that already exists. Tax Rate id: .*?, reference id: product_id_1./
+          /Tax rate rule with tax_rate_id: .*?, reference_id: product_id_1 already exists./
         )
       })
 
@@ -764,7 +764,7 @@ moduleIntegrationTestRunner({
             province_code: "QC",
           })
         ).rejects.toThrowError(
-          "You are trying to create a Tax Region for (country_code: ca, province_code: qc) but one already exists."
+          "Tax region with country_code: ca, province_code: qc already exists."
         )
       })
 
@@ -797,7 +797,7 @@ moduleIntegrationTestRunner({
             is_default: true,
           })
         ).rejects.toThrowError(
-          /You are trying to create a default tax rate for region: .*? which already has a default tax rate. Unset the current default rate and try again./
+          /Tax rate with tax_region_id: .*? already exists./
         )
       })
 

packages/tax/src/services/tax-module-service.ts

@@ -21,9 +21,6 @@ import {
 } from "@medusajs/utils"
 import { TaxProvider, TaxRate, TaxRateRule, TaxRegion } from "@models"
 import { entityNameToLinkableKeysMap, joinerConfig } from "../joiner-config"
-import { singleDefaultRegionIndexName } from "../models/tax-rate"
-import { uniqueRateReferenceIndexName } from "../models/tax-rate-rule"
-import { countryCodeProvinceIndexName } from "../models/tax-region"
 
 type InjectedDependencies = {
   baseRepository: DAL.RepositoryService
@@ -106,11 +103,7 @@ export default class TaxModuleService<
     @MedusaContext() sharedContext: Context = {}
   ): Promise<TaxTypes.TaxRateDTO[] | TaxTypes.TaxRateDTO> {
     const input = Array.isArray(data) ? data : [data]
-    const rates = await this.create_(input, sharedContext).catch((err) => {
-      this.handleCreateError(err)
-      this.handleCreateRulesError(err)
-      throw err
-    })
+    const rates = await this.create_(input, sharedContext)
     return Array.isArray(data) ? rates : rates[0]
   }
 
@@ -182,13 +175,7 @@ export default class TaxModuleService<
     data: TaxTypes.UpdateTaxRateDTO,
     @MedusaContext() sharedContext: Context = {}
   ): Promise<TaxTypes.TaxRateDTO | TaxTypes.TaxRateDTO[]> {
-    const rates = await this.update_(selector, data, sharedContext).catch(
-      (err) => {
-        this.handleCreateError(err)
-        this.handleCreateRulesError(err)
-        throw err
-      }
-    )
+    const rates = await this.update_(selector, data, sharedContext)
     const serialized = await this.baseRepository_.serialize<
       TaxTypes.TaxRateDTO[]
     >(rates, { populate: true })
@@ -322,12 +309,7 @@ export default class TaxModuleService<
     @MedusaContext() sharedContext: Context = {}
   ) {
     const input = Array.isArray(data) ? data : [data]
-    const result = await this.createTaxRegions_(input, sharedContext).catch(
-      (err) => {
-        this.handleCreateRegionsError(err)
-        throw err
-      }
-    )
+    const result = await this.createTaxRegions_(input, sharedContext)
     return Array.isArray(data) ? result : result[0]
   }
 
@@ -382,12 +364,7 @@ export default class TaxModuleService<
     @MedusaContext() sharedContext: Context = {}
   ) {
     const input = Array.isArray(data) ? data : [data]
-    const result = await this.createTaxRateRules_(input, sharedContext).catch(
-      (err) => {
-        this.handleCreateRulesError(err)
-        throw err
-      }
-    )
+    const result = await this.createTaxRateRules_(input, sharedContext)
     return Array.isArray(data) ? result : result[0]
   }
 
@@ -748,49 +725,6 @@ export default class TaxModuleService<
     return code.toLowerCase()
   }
 
-  private handleCreateRegionsError(err: any) {
-    if (err.constraint === countryCodeProvinceIndexName) {
-      const [countryCode, provinceCode] = err.detail
-        .split("=")[1]
-        .match(/\(([^)]+)\)/)[1]
-        .split(",")
-
-      throw new MedusaError(
-        MedusaError.Types.INVALID_DATA,
-        `You are trying to create a Tax Region for (country_code: ${countryCode.trim()}, province_code: ${provinceCode.trim()}) but one already exists.`
-      )
-    }
-  }
-
-  private handleCreateError(err: any) {
-    if (err.constraint === singleDefaultRegionIndexName) {
-      // err.detail = Key (tax_region_id)=(txreg_01HQX5E8GEH36ZHJWFYDAFY67P) already exists.
-      const regionId = err.detail.split("=")[1].match(/\(([^)]+)\)/)[1]
-
-      throw new MedusaError(
-        MedusaError.Types.INVALID_DATA,
-        `You are trying to create a default tax rate for region: ${regionId} which already has a default tax rate. Unset the current default rate and try again.`
-      )
-    }
-  }
-
-  private handleCreateRulesError(err: any) {
-    if (err.constraint === uniqueRateReferenceIndexName) {
-      // err.detail == "Key (tax_rate_id, reference_id)=(txr_01HQWRXTC0JK0F02D977WRR45T, product_id_1) already exists."
-      // We want to extract the ids from the detail string
-      // i.e. txr_01HQWRXTC0JK0F02D977WRR45T and product_id_1
-      const [taxRateId, referenceId] = err.detail
-        .split("=")[1]
-        .match(/\(([^)]+)\)/)[1]
-        .split(",")
-
-      throw new MedusaError(
-        MedusaError.Types.INVALID_DATA,
-        `You are trying to create a Tax Rate Rule for a reference that already exists. Tax Rate id: ${taxRateId.trim()}, reference id: ${referenceId.trim()}.`
-      )
-    }
-  }
-
   // @InjectTransactionManager("baseRepository_")
   // async createProvidersOnLoad(@MedusaContext() sharedContext: Context = {}) {
   //   const providersToLoad = this.container_["tax_providers"] as ITaxProvider[]