Files
medusa-store/packages/modules/locking/src/services/locking-provider.ts
Adrien de Peretti c490e08142 fix(modules): Fix miss leading provider resolution error (#10900)
FIXES SUP-560

**What**
Currently, no matter the error when looking for a provider to exists in the container we are throwing a normalized error stating that the provider does not exists in the container. The issue is that the first initialization of the provider occurs the first time we resolve it, and the error can be that the provider failed to be instanciated for any reason. 

In this pr, we are explicitly checking for the error to be an awilix resolution error to throw the classic error and otherwise we provide the issue why the provider failed to be resolved.
2025-01-10 01:16:33 +00:00

57 lines
1.7 KiB
TypeScript

import {
Constructor,
ILockingProvider,
Logger,
} from "@medusajs/framework/types"
import { MedusaError } from "@medusajs/framework/utils"
import { LockingProviderRegistrationPrefix } from "../types"
type InjectedDependencies = {
[key: `lp_${string}`]: ILockingProvider
logger?: Logger
}
export default class LockingProviderService {
protected __container__: InjectedDependencies
#logger: Logger
constructor(container: InjectedDependencies) {
this.__container__ = container
this.#logger = container["logger"]
? container.logger
: (console as unknown as Logger)
}
static getRegistrationIdentifier(
providerClass: Constructor<ILockingProvider>
) {
if (!(providerClass as any).identifier) {
throw new MedusaError(
MedusaError.Types.INVALID_ARGUMENT,
`Trying to register a locking provider without an identifier.`
)
}
return `${(providerClass as any).identifier}`
}
public retrieveProviderRegistration(providerId: string): ILockingProvider {
try {
return this.__container__[
`${LockingProviderRegistrationPrefix}${providerId}`
]
} catch (err) {
if (err.name === "AwilixResolutionError") {
const errMessage = `
Unable to retrieve the locking provider with id: ${providerId}
Please make sure that the provider is registered in the container and it is configured correctly in your project configuration file.`
throw new Error(errMessage)
}
const errMessage = `Unable to retrieve the locking provider with id: ${providerId}, the following error occurred: ${err.message}`
this.#logger.error(errMessage)
throw new Error(errMessage)
}
}
}