asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

breaking: remove loading middlewares file in favor of routes-config files (#8274)

Browse Source
This commit is contained in:
Harminder Virk
2024-07-25 12:53:35 +05:30
committed by GitHub
parent 13855e9167
commit 0bd46c97b7
5 changed files with 99 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/medusa/src/api/middlewares.ts → packages/medusa/src/api/routes-config.ts
+55 -57
View File
@@ -1,4 +1,4 @@
import { MiddlewaresConfig } from "../loaders/helpers/routing/types" import { defineRoutesConfig } from "../utils/define-routes-config"
import { adminApiKeyRoutesMiddlewares } from "./admin/api-keys/middlewares" import { adminApiKeyRoutesMiddlewares } from "./admin/api-keys/middlewares"
import { adminCampaignRoutesMiddlewares } from "./admin/campaigns/middlewares" import { adminCampaignRoutesMiddlewares } from "./admin/campaigns/middlewares"
import { adminCollectionRoutesMiddlewares } from "./admin/collections/middlewares" import { adminCollectionRoutesMiddlewares } from "./admin/collections/middlewares"
@@ -50,59 +50,57 @@ import { storeReturnReasonRoutesMiddlewares } from "./store/return-reasons/middl
import { storeShippingOptionRoutesMiddlewares } from "./store/shipping-options/middlewares" import { storeShippingOptionRoutesMiddlewares } from "./store/shipping-options/middlewares"
import { adminReturnRoutesMiddlewares } from "./admin/returns/middlewares" import { adminReturnRoutesMiddlewares } from "./admin/returns/middlewares"
export const config: MiddlewaresConfig = { export default defineRoutesConfig([
routes: [ ...adminCustomerGroupRoutesMiddlewares,
...adminCustomerGroupRoutesMiddlewares, ...adminCustomerRoutesMiddlewares,
...adminCustomerRoutesMiddlewares, ...adminPromotionRoutesMiddlewares,
...adminPromotionRoutesMiddlewares, ...adminCampaignRoutesMiddlewares,
...adminCampaignRoutesMiddlewares, ...storeCartRoutesMiddlewares,
...storeCartRoutesMiddlewares, ...storeCustomerRoutesMiddlewares,
...storeCustomerRoutesMiddlewares, ...storeCartRoutesMiddlewares,
...storeCartRoutesMiddlewares, ...storeCollectionRoutesMiddlewares,
...storeCollectionRoutesMiddlewares, ...storeProductCategoryRoutesMiddlewares,
...storeProductCategoryRoutesMiddlewares, ...storePaymentProvidersMiddlewares,
...storePaymentProvidersMiddlewares, ...storeShippingOptionRoutesMiddlewares,
...storeShippingOptionRoutesMiddlewares, ...storePaymentCollectionsMiddlewares,
...storePaymentCollectionsMiddlewares, ...storeOrderRoutesMiddlewares,
...storeOrderRoutesMiddlewares, ...authRoutesMiddlewares,
...authRoutesMiddlewares, ...adminWorkflowsExecutionsMiddlewares,
...adminWorkflowsExecutionsMiddlewares, ...adminReturnRoutesMiddlewares,
...adminReturnRoutesMiddlewares, ...storeRegionRoutesMiddlewares,
...storeRegionRoutesMiddlewares, ...adminRegionRoutesMiddlewares,
...adminRegionRoutesMiddlewares, ...adminReturnRoutesMiddlewares,
...adminReturnRoutesMiddlewares, ...adminUserRoutesMiddlewares,
...adminUserRoutesMiddlewares, ...adminInviteRoutesMiddlewares,
...adminInviteRoutesMiddlewares, ...adminTaxRateRoutesMiddlewares,
...adminTaxRateRoutesMiddlewares, ...adminTaxRegionRoutesMiddlewares,
...adminTaxRegionRoutesMiddlewares, ...adminApiKeyRoutesMiddlewares,
...adminApiKeyRoutesMiddlewares, ...hooksRoutesMiddlewares,
...hooksRoutesMiddlewares, ...adminStoreRoutesMiddlewares,
...adminStoreRoutesMiddlewares, ...adminCurrencyRoutesMiddlewares,
...adminCurrencyRoutesMiddlewares, ...storeCurrencyRoutesMiddlewares,
...storeCurrencyRoutesMiddlewares, ...adminProductRoutesMiddlewares,
...adminProductRoutesMiddlewares, ...adminPaymentRoutesMiddlewares,
...adminPaymentRoutesMiddlewares, ...adminPriceListsRoutesMiddlewares,
...adminPriceListsRoutesMiddlewares, ...adminPricePreferencesRoutesMiddlewares,
...adminPricePreferencesRoutesMiddlewares, ...adminInventoryRoutesMiddlewares,
...adminInventoryRoutesMiddlewares, ...adminCollectionRoutesMiddlewares,
...adminCollectionRoutesMiddlewares, ...adminShippingOptionRoutesMiddlewares,
...adminShippingOptionRoutesMiddlewares, ...adminDraftOrderRoutesMiddlewares,
...adminDraftOrderRoutesMiddlewares, ...adminSalesChannelRoutesMiddlewares,
...adminSalesChannelRoutesMiddlewares, ...adminStockLocationRoutesMiddlewares,
...adminStockLocationRoutesMiddlewares, ...adminProductTypeRoutesMiddlewares,
...adminProductTypeRoutesMiddlewares, ...adminProductTagRoutesMiddlewares,
...adminProductTagRoutesMiddlewares, ...adminUploadRoutesMiddlewares,
...adminUploadRoutesMiddlewares, ...adminFulfillmentSetsRoutesMiddlewares,
...adminFulfillmentSetsRoutesMiddlewares, ...adminNotificationRoutesMiddlewares,
...adminNotificationRoutesMiddlewares, ...adminOrderRoutesMiddlewares,
...adminOrderRoutesMiddlewares, ...adminReservationRoutesMiddlewares,
...adminReservationRoutesMiddlewares, ...adminProductCategoryRoutesMiddlewares,
...adminProductCategoryRoutesMiddlewares, ...adminShippingProfilesMiddlewares,
...adminShippingProfilesMiddlewares, ...adminFulfillmentsRoutesMiddlewares,
...adminFulfillmentsRoutesMiddlewares, ...adminFulfillmentProvidersRoutesMiddlewares,
...adminFulfillmentProvidersRoutesMiddlewares, ...storeProductRoutesMiddlewares,
...storeProductRoutesMiddlewares, ...storeReturnReasonRoutesMiddlewares,
...storeReturnReasonRoutesMiddlewares, ...adminReturnReasonRoutesMiddlewares,
...adminReturnReasonRoutesMiddlewares, ])
],
}
packages/medusa/src/loaders/helpers/routing/__fixtures__/routers-error-handler/middlewares.ts → packages/medusa/src/loaders/helpers/routing/__fixtures__/routers-error-handler/routes-config.ts
+3 -3
View File
@@ -1,6 +1,6 @@
import { MiddlewaresConfig } from "../../types" import { defineRoutesConfig } from "../../../../../utils/define-routes-config"
export const config: MiddlewaresConfig = { export default defineRoutesConfig({
errorHandler: (err, _req, res, _next) => { errorHandler: (err, _req, res, _next) => {
const { code, message } = err const { code, message } = err
@@ -36,4 +36,4 @@ export const config: MiddlewaresConfig = {
}) })
} }
}, },
} })
packages/medusa/src/loaders/helpers/routing/__fixtures__/routers-middleware/middlewares.ts → packages/medusa/src/loaders/helpers/routing/__fixtures__/routers-middleware/routes-config.ts
+22 -24
View File
@@ -1,10 +1,10 @@
import { NextFunction, Request, Response, raw } from "express" import { NextFunction, Request, Response, raw } from "express"
import { MiddlewaresConfig } from "../../types"
import { import {
customersCreateMiddlewareMock, customersCreateMiddlewareMock,
customersGlobalMiddlewareMock, customersGlobalMiddlewareMock,
storeGlobalMiddlewareMock, storeGlobalMiddlewareMock,
} from "../mocks" } from "../mocks"
import { defineRoutesConfig } from "../../../../../utils/define-routes-config"
const customersGlobalMiddleware = ( const customersGlobalMiddleware = (
req: Request, req: Request,
@@ -29,26 +29,24 @@ const storeGlobal = (req: Request, res: Response, next: NextFunction) => {
next() next()
} }
export const config: MiddlewaresConfig = { export default defineRoutesConfig([
routes: [ {
{ matcher: "/customers",
matcher: "/customers", middlewares: [customersGlobalMiddleware],
middlewares: [customersGlobalMiddleware], },
}, {
{ method: "POST",
method: "POST", matcher: "/customers",
matcher: "/customers", middlewares: [customersCreateMiddleware],
middlewares: [customersCreateMiddleware], },
}, {
{ matcher: "/store/*",
matcher: "/store/*", middlewares: [storeGlobal],
middlewares: [storeGlobal], },
}, {
{ matcher: "/webhooks/*",
matcher: "/webhooks/*", method: "POST",
method: "POST", bodyParser: false,
bodyParser: false, middlewares: [raw({ type: "application/json" })],
middlewares: [raw({ type: "application/json" })], },
}, ])
],
}
packages/medusa/src/loaders/helpers/routing/index.ts
+10 -10
View File
@@ -49,7 +49,7 @@ const AUTHTHENTICATE = "AUTHENTICATE"
/** /**
* File name for the global middlewares file * File name for the global middlewares file
*/ */
const MIDDLEWARES_NAME = "middlewares" const ROUTES_CONFIG_FILENAME = "routes-config"
const pathSegmentReplacer = { const pathSegmentReplacer = {
"\\[\\.\\.\\.\\]": () => `*`, "\\[\\.\\.\\.\\]": () => `*`,
@@ -216,7 +216,7 @@ export class RoutesLoader {
if (!config?.routes && !config?.errorHandler) { if (!config?.routes && !config?.errorHandler) {
log({ log({
activityId: this.activityId, activityId: this.activityId,
message: `Empty middleware config. Skipping middleware application.`, message: `Empty routes config. Skipping configuration.`,
}) })
return return
@@ -419,7 +419,7 @@ export class RoutesLoader {
}) { }) {
const files = await readdir(dirPath) const files = await readdir(dirPath)
const middlewareFilePath = files const routesConfigFiles = files
.filter((path) => { .filter((path) => {
if ( if (
this.excludes.length && this.excludes.length &&
@@ -431,29 +431,29 @@ export class RoutesLoader {
return true return true
}) })
.find((file) => { .find((file) => {
return file.replace(/\.[^/.]+$/, "") === MIDDLEWARES_NAME return file.replace(/\.[^/.]+$/, "") === ROUTES_CONFIG_FILENAME
}) })
if (!middlewareFilePath) { if (!routesConfigFiles) {
log({ log({
activityId: this.activityId, activityId: this.activityId,
message: `No middleware files found in ${dirPath}. Skipping middleware configuration.`, message: `No routes config file found in ${dirPath}. Skipping configuration.`,
}) })
return return
} }
const absolutePath = join(dirPath, middlewareFilePath) const absolutePath = join(dirPath, routesConfigFiles)
try { try {
await import(absolutePath).then((import_) => { await import(absolutePath).then((import_) => {
const middlewaresConfig = import_.config as const middlewaresConfig = import_.default as
| MiddlewaresConfig | MiddlewaresConfig
| undefined | undefined
if (!middlewaresConfig) { if (!middlewaresConfig) {
log({ log({
activityId: this.activityId, activityId: this.activityId,
message: `No middleware configuration found in ${absolutePath}. Skipping middleware configuration.`, message: `No routes config file found in ${absolutePath}. Skipping configuration.`,
}) })
return return
} }
@@ -476,7 +476,7 @@ export class RoutesLoader {
} catch (error) { } catch (error) {
log({ log({
activityId: this.activityId, activityId: this.activityId,
message: `Failed to load middleware configuration in ${absolutePath}. Skipping middleware configuration.`, message: `Failed to load routes configuration from ${absolutePath}. Skipping configuration.`,
}) })
return return
packages/medusa/src/utils/define-routes-config.ts
+9 -1
View File
@@ -32,8 +32,16 @@ export function defineRoutesConfig<
next: MedusaNextFunction next: MedusaNextFunction
) => any)[] ) => any)[]
} }
>(routes: Route[]): MiddlewaresConfig { >(
config:
| Route[]
| { routes?: Route[]; errorHandler?: MiddlewaresConfig["errorHandler"] }
): MiddlewaresConfig {
const routes = Array.isArray(config) ? config : config.routes || []
const errorHandler = Array.isArray(config) ? undefined : config.errorHandler
return { return {
errorHandler,
routes: routes.map((route) => { routes: routes.map((route) => {
const { middlewares, extendedValidators, ...rest } = route const { middlewares, extendedValidators, ...rest } = route
const customMiddleware: MedusaRequestHandler[] = [] const customMiddleware: MedusaRequestHandler[] = []