Skip to content

Commit 0bd46c9

Browse files
thetutlagethetutlage
authored
breaking: remove loading middlewares file in favor of routes-config files (#8274)
1 parent 13855e9 commit 0bd46c9

File tree

5 files changed

+99
-95
lines changed

5 files changed

+99
-95
lines changed

‎packages/medusa/src/api/middlewares.ts renamed to ‎packages/medusa/src/api/routes-config.ts

Lines changed: 55 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { MiddlewaresConfig } from "../loaders/helpers/routing/types"
1+
import { defineRoutesConfig } from "../utils/define-routes-config"
22
import { adminApiKeyRoutesMiddlewares } from "./admin/api-keys/middlewares"
33
import { adminCampaignRoutesMiddlewares } from "./admin/campaigns/middlewares"
44
import { adminCollectionRoutesMiddlewares } from "./admin/collections/middlewares"
@@ -50,59 +50,57 @@ import { storeReturnReasonRoutesMiddlewares } from "./store/return-reasons/middl
5050
import { storeShippingOptionRoutesMiddlewares } from "./store/shipping-options/middlewares"
5151
import { adminReturnRoutesMiddlewares } from "./admin/returns/middlewares"
5252

53-
export const config: MiddlewaresConfig = {
54-
routes: [
55-
...adminCustomerGroupRoutesMiddlewares,
56-
...adminCustomerRoutesMiddlewares,
57-
...adminPromotionRoutesMiddlewares,
58-
...adminCampaignRoutesMiddlewares,
59-
...storeCartRoutesMiddlewares,
60-
...storeCustomerRoutesMiddlewares,
61-
...storeCartRoutesMiddlewares,
62-
...storeCollectionRoutesMiddlewares,
63-
...storeProductCategoryRoutesMiddlewares,
64-
...storePaymentProvidersMiddlewares,
65-
...storeShippingOptionRoutesMiddlewares,
66-
...storePaymentCollectionsMiddlewares,
67-
...storeOrderRoutesMiddlewares,
68-
...authRoutesMiddlewares,
69-
...adminWorkflowsExecutionsMiddlewares,
70-
...adminReturnRoutesMiddlewares,
71-
...storeRegionRoutesMiddlewares,
72-
...adminRegionRoutesMiddlewares,
73-
...adminReturnRoutesMiddlewares,
74-
...adminUserRoutesMiddlewares,
75-
...adminInviteRoutesMiddlewares,
76-
...adminTaxRateRoutesMiddlewares,
77-
...adminTaxRegionRoutesMiddlewares,
78-
...adminApiKeyRoutesMiddlewares,
79-
...hooksRoutesMiddlewares,
80-
...adminStoreRoutesMiddlewares,
81-
...adminCurrencyRoutesMiddlewares,
82-
...storeCurrencyRoutesMiddlewares,
83-
...adminProductRoutesMiddlewares,
84-
...adminPaymentRoutesMiddlewares,
85-
...adminPriceListsRoutesMiddlewares,
86-
...adminPricePreferencesRoutesMiddlewares,
87-
...adminInventoryRoutesMiddlewares,
88-
...adminCollectionRoutesMiddlewares,
89-
...adminShippingOptionRoutesMiddlewares,
90-
...adminDraftOrderRoutesMiddlewares,
91-
...adminSalesChannelRoutesMiddlewares,
92-
...adminStockLocationRoutesMiddlewares,
93-
...adminProductTypeRoutesMiddlewares,
94-
...adminProductTagRoutesMiddlewares,
95-
...adminUploadRoutesMiddlewares,
96-
...adminFulfillmentSetsRoutesMiddlewares,
97-
...adminNotificationRoutesMiddlewares,
98-
...adminOrderRoutesMiddlewares,
99-
...adminReservationRoutesMiddlewares,
100-
...adminProductCategoryRoutesMiddlewares,
101-
...adminShippingProfilesMiddlewares,
102-
...adminFulfillmentsRoutesMiddlewares,
103-
...adminFulfillmentProvidersRoutesMiddlewares,
104-
...storeProductRoutesMiddlewares,
105-
...storeReturnReasonRoutesMiddlewares,
106-
...adminReturnReasonRoutesMiddlewares,
107-
],
108-
}
53+
export default defineRoutesConfig([
54+
...adminCustomerGroupRoutesMiddlewares,
55+
...adminCustomerRoutesMiddlewares,
56+
...adminPromotionRoutesMiddlewares,
57+
...adminCampaignRoutesMiddlewares,
58+
...storeCartRoutesMiddlewares,
59+
...storeCustomerRoutesMiddlewares,
60+
...storeCartRoutesMiddlewares,
61+
...storeCollectionRoutesMiddlewares,
62+
...storeProductCategoryRoutesMiddlewares,
63+
...storePaymentProvidersMiddlewares,
64+
...storeShippingOptionRoutesMiddlewares,
65+
...storePaymentCollectionsMiddlewares,
66+
...storeOrderRoutesMiddlewares,
67+
...authRoutesMiddlewares,
68+
...adminWorkflowsExecutionsMiddlewares,
69+
...adminReturnRoutesMiddlewares,
70+
...storeRegionRoutesMiddlewares,
71+
...adminRegionRoutesMiddlewares,
72+
...adminReturnRoutesMiddlewares,
73+
...adminUserRoutesMiddlewares,
74+
...adminInviteRoutesMiddlewares,
75+
...adminTaxRateRoutesMiddlewares,
76+
...adminTaxRegionRoutesMiddlewares,
77+
...adminApiKeyRoutesMiddlewares,
78+
...hooksRoutesMiddlewares,
79+
...adminStoreRoutesMiddlewares,
80+
...adminCurrencyRoutesMiddlewares,
81+
...storeCurrencyRoutesMiddlewares,
82+
...adminProductRoutesMiddlewares,
83+
...adminPaymentRoutesMiddlewares,
84+
...adminPriceListsRoutesMiddlewares,
85+
...adminPricePreferencesRoutesMiddlewares,
86+
...adminInventoryRoutesMiddlewares,
87+
...adminCollectionRoutesMiddlewares,
88+
...adminShippingOptionRoutesMiddlewares,
89+
...adminDraftOrderRoutesMiddlewares,
90+
...adminSalesChannelRoutesMiddlewares,
91+
...adminStockLocationRoutesMiddlewares,
92+
...adminProductTypeRoutesMiddlewares,
93+
...adminProductTagRoutesMiddlewares,
94+
...adminUploadRoutesMiddlewares,
95+
...adminFulfillmentSetsRoutesMiddlewares,
96+
...adminNotificationRoutesMiddlewares,
97+
...adminOrderRoutesMiddlewares,
98+
...adminReservationRoutesMiddlewares,
99+
...adminProductCategoryRoutesMiddlewares,
100+
...adminShippingProfilesMiddlewares,
101+
...adminFulfillmentsRoutesMiddlewares,
102+
...adminFulfillmentProvidersRoutesMiddlewares,
103+
...storeProductRoutesMiddlewares,
104+
...storeReturnReasonRoutesMiddlewares,
105+
...adminReturnReasonRoutesMiddlewares,
106+
])

‎packages/medusa/src/loaders/helpers/routing/__fixtures__/routers-error-handler/middlewares.ts renamed to ‎packages/medusa/src/loaders/helpers/routing/__fixtures__/routers-error-handler/routes-config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import { MiddlewaresConfig } from "../../types"
1+
import { defineRoutesConfig } from "../../../../../utils/define-routes-config"
22

3-
export const config: MiddlewaresConfig = {
3+
export default defineRoutesConfig({
44
errorHandler: (err, _req, res, _next) => {
55
const { code, message } = err
66

@@ -36,4 +36,4 @@ export const config: MiddlewaresConfig = {
3636
})
3737
}
3838
},
39-
}
39+
})

‎packages/medusa/src/loaders/helpers/routing/__fixtures__/routers-middleware/middlewares.ts renamed to ‎packages/medusa/src/loaders/helpers/routing/__fixtures__/routers-middleware/routes-config.ts

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import { NextFunction, Request, Response, raw } from "express"
2-
import { MiddlewaresConfig } from "../../types"
32
import {
43
customersCreateMiddlewareMock,
54
customersGlobalMiddlewareMock,
65
storeGlobalMiddlewareMock,
76
} from "../mocks"
7+
import { defineRoutesConfig } from "../../../../../utils/define-routes-config"
88

99
const customersGlobalMiddleware = (
1010
req: Request,
@@ -29,26 +29,24 @@ const storeGlobal = (req: Request, res: Response, next: NextFunction) => {
2929
next()
3030
}
3131

32-
export const config: MiddlewaresConfig = {
33-
routes: [
34-
{
35-
matcher: "/customers",
36-
middlewares: [customersGlobalMiddleware],
37-
},
38-
{
39-
method: "POST",
40-
matcher: "/customers",
41-
middlewares: [customersCreateMiddleware],
42-
},
43-
{
44-
matcher: "/store/*",
45-
middlewares: [storeGlobal],
46-
},
47-
{
48-
matcher: "/webhooks/*",
49-
method: "POST",
50-
bodyParser: false,
51-
middlewares: [raw({ type: "application/json" })],
52-
},
53-
],
54-
}
32+
export default defineRoutesConfig([
33+
{
34+
matcher: "/customers",
35+
middlewares: [customersGlobalMiddleware],
36+
},
37+
{
38+
method: "POST",
39+
matcher: "/customers",
40+
middlewares: [customersCreateMiddleware],
41+
},
42+
{
43+
matcher: "/store/*",
44+
middlewares: [storeGlobal],
45+
},
46+
{
47+
matcher: "/webhooks/*",
48+
method: "POST",
49+
bodyParser: false,
50+
middlewares: [raw({ type: "application/json" })],
51+
},
52+
])

‎packages/medusa/src/loaders/helpers/routing/index.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const AUTHTHENTICATE = "AUTHENTICATE"
4949
/**
5050
* File name for the global middlewares file
5151
*/
52-
const MIDDLEWARES_NAME = "middlewares"
52+
const ROUTES_CONFIG_FILENAME = "routes-config"
5353

5454
const pathSegmentReplacer = {
5555
"\\[\\.\\.\\.\\]": () => `*`,
@@ -216,7 +216,7 @@ export class RoutesLoader {
216216
if (!config?.routes && !config?.errorHandler) {
217217
log({
218218
activityId: this.activityId,
219-
message: `Empty middleware config. Skipping middleware application.`,
219+
message: `Empty routes config. Skipping configuration.`,
220220
})
221221

222222
return
@@ -419,7 +419,7 @@ export class RoutesLoader {
419419
}) {
420420
const files = await readdir(dirPath)
421421

422-
const middlewareFilePath = files
422+
const routesConfigFiles = files
423423
.filter((path) => {
424424
if (
425425
this.excludes.length &&
@@ -431,29 +431,29 @@ export class RoutesLoader {
431431
return true
432432
})
433433
.find((file) => {
434-
return file.replace(/\.[^/.]+$/, "") === MIDDLEWARES_NAME
434+
return file.replace(/\.[^/.]+$/, "") === ROUTES_CONFIG_FILENAME
435435
})
436436

437-
if (!middlewareFilePath) {
437+
if (!routesConfigFiles) {
438438
log({
439439
activityId: this.activityId,
440-
message: `No middleware files found in ${dirPath}. Skipping middleware configuration.`,
440+
message: `No routes config file found in ${dirPath}. Skipping configuration.`,
441441
})
442442
return
443443
}
444444

445-
const absolutePath = join(dirPath, middlewareFilePath)
445+
const absolutePath = join(dirPath, routesConfigFiles)
446446

447447
try {
448448
await import(absolutePath).then((import_) => {
449-
const middlewaresConfig = import_.config as
449+
const middlewaresConfig = import_.default as
450450
| MiddlewaresConfig
451451
| undefined
452452

453453
if (!middlewaresConfig) {
454454
log({
455455
activityId: this.activityId,
456-
message: `No middleware configuration found in ${absolutePath}. Skipping middleware configuration.`,
456+
message: `No routes config file found in ${absolutePath}. Skipping configuration.`,
457457
})
458458
return
459459
}
@@ -476,7 +476,7 @@ export class RoutesLoader {
476476
} catch (error) {
477477
log({
478478
activityId: this.activityId,
479-
message: `Failed to load middleware configuration in ${absolutePath}. Skipping middleware configuration.`,
479+
message: `Failed to load routes configuration from ${absolutePath}. Skipping configuration.`,
480480
})
481481

482482
return

‎packages/medusa/src/utils/define-routes-config.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,16 @@ export function defineRoutesConfig<
3232
next: MedusaNextFunction
3333
) => any)[]
3434
}
35-
>(routes: Route[]): MiddlewaresConfig {
35+
>(
36+
config:
37+
| Route[]
38+
| { routes?: Route[]; errorHandler?: MiddlewaresConfig["errorHandler"] }
39+
): MiddlewaresConfig {
40+
const routes = Array.isArray(config) ? config : config.routes || []
41+
const errorHandler = Array.isArray(config) ? undefined : config.errorHandler
42+
3643
return {
44+
errorHandler,
3745
routes: routes.map((route) => {
3846
const { middlewares, extendedValidators, ...rest } = route
3947
const customMiddleware: MedusaRequestHandler[] = []

0 commit comments

Comments
 (0)