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

chore: Rename config properties to camelCase (#7498)

Browse Source 
* refactor: rename config types to camelCase

* refactor: update config references to use renamed options

* refactor: update more references

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
Harminder Virk
2024-05-28 14:49:29 +02:00
committed by GitHub
co-authored by Oli Juhl
parent e60b4bafe1
commit 82be054a1a
15 changed files with 297 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/medusa-test-utils/src/medusa-test-runner.ts
+2 -2
View File
@@ -103,8 +103,8 @@ export function medusaIntegrationTestRunner({
rootDirectory: string
) => {
const config = originalConfigLoader(rootDirectory)
config.projectConfig.database_url = dbConfig.clientUrl
config.projectConfig.database_driver_options = dbConfig.clientUrl.includes(
config.projectConfig.databaseUrl = dbConfig.clientUrl
config.projectConfig.databaseDriverOptions = dbConfig.clientUrl.includes(
"localhost"
)
? {}
packages/core/types/src/common/config-module.ts
+30 -28
View File
@@ -118,7 +118,7 @@ export type HttpCompressionOptions = {
*/
export type ProjectConfigOptions = {
/**
* The name of the database to connect to. If specified in `database_url`, then it’s not required to include it.
* The name of the database to connect to. If specified in `databaseUrl`, then it’s not required to include it.
*
* Make sure to create the PostgreSQL database before using it. You can check how to create a database in
* [PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html).
@@ -127,7 +127,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* database_database: process.env.DATABASE_DATABASE ||
* databaseName: process.env.DATABASE_DATABASE ||
* "medusa-store",
* // ...
* },
@@ -135,7 +135,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
database_database?: string
databaseName?: string
/**
* The connection URL of the database. The format of the connection URL for PostgreSQL is:
@@ -166,21 +166,22 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* database_url: process.env.DATABASE_URL,
* databaseUrl: process.env.DATABASE_URL,
* // ...
* },
* // ...
* }
* ```
*/
database_url?: string
databaseUrl?: string
/**
* The database schema to connect to. This is not required to provide if you’re using the default schema, which is `public`.
*
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* database_schema: process.env.DATABASE_SCHEMA ||
* databaseSchema: process.env.DATABASE_SCHEMA ||
* "custom",
* // ...
* },
@@ -188,7 +189,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
database_schema?: string
databaseSchema?: string
/**
* This configuration specifies what database messages to log. Its value can be one of the following:
@@ -203,7 +204,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* database_logging: [
* databaseLogging: [
* "query", "error",
* ],
* // ...
@@ -212,7 +213,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
database_logging: LoggerOptions
databaseLogging: LoggerOptions
/**
* @ignore
@@ -221,7 +222,7 @@ export type ProjectConfigOptions = {
* @privateRemarks
* only postgres is supported, so this config has no effect
*/
database_type?: string
databaseType?: string
/**
* An object that includes additional configurations to pass to the database connection. You can pass any configuration. One defined configuration to pass is
@@ -234,7 +235,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* database_extra:
* databaseExtra:
* process.env.NODE_ENV !== "development"
* ? { ssl: { rejectUnauthorized: false } }
* : {},
@@ -244,7 +245,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
database_extra?: Record<string, unknown> & {
databaseExtra?: Record<string, unknown> & {
/**
* Configure support for TLS/SSL connection
*/
@@ -267,7 +268,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* database_driver_options:
* databaseDriverOptions:
* process.env.NODE_ENV !== "development"
* ? { connection: { ssl: { rejectUnauthorized: false } } }
* : {},
@@ -277,7 +278,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
database_driver_options?: Record<string, unknown> & {
databaseDriverOptions?: Record<string, unknown> & {
connection?: {
/**
* Configure support for TLS/SSL connection
@@ -312,7 +313,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* redis_url: process.env.REDIS_URL ||
* redisUrl: process.env.REDIS_URL ||
* "redis://localhost:6379",
* // ...
* },
@@ -320,7 +321,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
redis_url?: string
redisUrl?: string
/**
* The prefix set on all keys stored in Redis. The default value is `sess:`.
@@ -331,7 +332,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* redis_prefix: process.env.REDIS_PREFIX ||
* redisPrefix: process.env.REDIS_PREFIX ||
* "medusa:",
* // ...
* },
@@ -339,7 +340,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
redis_prefix?: string
redisPrefix?: string
/**
* An object of options to pass ioredis. You can refer to [ioredis’s RedisOptions documentation](https://redis.github.io/ioredis/index.html#RedisOptions)
@@ -349,7 +350,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* redis_options: {
* redisOptions: {
* connectionName: process.env.REDIS_CONNECTION_NAME ||
* "medusa",
* },
@@ -359,7 +360,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
redis_options?: RedisOptions
redisOptions?: RedisOptions
/**
* An object of options to pass to [express-session](https://www.npmjs.com/package/express-session).
@@ -368,7 +369,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* session_options: {
* sessionOptions: {
* name: process.env.SESSION_NAME ||
* "custom",
* },
@@ -378,7 +379,7 @@ export type ProjectConfigOptions = {
* }
* ```
*/
session_options?: SessionOptions
sessionOptions?: SessionOptions
/**
* Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.
@@ -390,7 +391,7 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* http_compression: {
* httpCompression: {
* enabled: true,
* level: 6,
* memLevel: 8,
@@ -405,7 +406,7 @@ export type ProjectConfigOptions = {
* @deprecated use {@link http }'s `compression` property instead.
*
*/
http_compression?: HttpCompressionOptions
httpCompression?: HttpCompressionOptions
/**
* Configure the number of staged jobs that are polled from the database. Default is `1000`.
@@ -414,14 +415,14 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* jobs_batch_size: 100
* jobsBatchSize: 100
* // ...
* },
* // ...
* }
* ```
*/
jobs_batch_size?: number
jobsBatchSize?: number
/**
* Configure the application's worker mode. Default is `shared`.
@@ -436,14 +437,14 @@ export type ProjectConfigOptions = {
* ```js title="medusa-config.js"
* module.exports = {
* projectConfig: {
* worker_mode: "shared"
* workerMode: "shared"
* // ...
* },
* // ...
* }
* ```
*/
worker_mode?: "shared" | "worker" | "server"
workerMode?: "shared" | "worker" | "server"
/**
* Configure the application's http-specific settings
@@ -652,6 +653,7 @@ export type ProjectConfigOptions = {
* ```
*/
storeCors: string
/**
* The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.
*
packages/medusa/src/loaders/config.ts
+7 -7
View File
@@ -57,30 +57,30 @@ const buildHttpConfig = (projectConfig: ConfigModule["projectConfig"]) => {
const normalizeProjectConfig = (
projectConfig: ConfigModule["projectConfig"]
) => {
if (!projectConfig?.redis_url) {
if (!projectConfig?.redisUrl) {
console.log(
`[medusa-config] ⚠️ redis_url not found. A fake redis instance will be used.`
`[medusa-config] ⚠️ redisUrl not found. A fake redis instance will be used.`
)
}
projectConfig.http = buildHttpConfig(projectConfig)
let worker_mode = projectConfig?.worker_mode
let workedMode = projectConfig?.workerMode
if (!isDefined(worker_mode)) {
if (!isDefined(workedMode)) {
const env = process.env.MEDUSA_WORKER_MODE
if (isDefined(env)) {
if (env === "shared" || env === "worker" || env === "server") {
worker_mode = env
workedMode = env
}
} else {
worker_mode = "shared"
workedMode = "shared"
}
}
return {
...projectConfig,
worker_mode,
workerMode: workedMode,
}
}
packages/medusa/src/loaders/express.ts
+11 -11
View File
@@ -28,33 +28,33 @@ export default async ({
sameSite = "none"
}
const { http, session_options } = configModule.projectConfig
const { http, sessionOptions } = configModule.projectConfig
const sessionOpts = {
name: session_options?.name ?? "connect.sid",
resave: session_options?.resave ?? true,
rolling: session_options?.rolling ?? false,
saveUninitialized: session_options?.saveUninitialized ?? true,
name: sessionOptions?.name ?? "connect.sid",
resave: sessionOptions?.resave ?? true,
rolling: sessionOptions?.rolling ?? false,
saveUninitialized: sessionOptions?.saveUninitialized ?? true,
proxy: true,
secret: session_options?.secret ?? http?.cookieSecret,
secret: sessionOptions?.secret ?? http?.cookieSecret,
cookie: {
sameSite,
secure,
maxAge: session_options?.ttl ?? 10 * 60 * 60 * 1000,
maxAge: sessionOptions?.ttl ?? 10 * 60 * 60 * 1000,
},
store: null,
}
let redisClient
if (configModule?.projectConfig?.redis_url) {
if (configModule?.projectConfig?.redisUrl) {
const RedisStore = createStore(session)
redisClient = new Redis(
configModule.projectConfig.redis_url,
configModule.projectConfig.redis_options ?? {}
configModule.projectConfig.redisUrl,
configModule.projectConfig.redisOptions ?? {}
)
sessionOpts.store = new RedisStore({
client: redisClient,
prefix: `${configModule?.projectConfig?.redis_prefix ?? ""}sess:`,
prefix: `${configModule?.projectConfig?.redisPrefix ?? ""}sess:`,
})
}
packages/medusa/src/loaders/helpers/routing/__fixtures__/mocks/index.ts
+1 -1
View File
@@ -6,7 +6,7 @@ export const storeGlobalMiddlewareMock = jest.fn()
export const config: ConfigModule = {
projectConfig: {
database_logging: false,
databaseLogging: false,
http: {
authCors: "http://localhost:9000",
storeCors: "http://localhost:8000",
packages/medusa/src/loaders/index.ts
+1 -1
View File
@@ -27,7 +27,7 @@ type Options = {
}
const isWorkerMode = (configModule) => {
return configModule.projectConfig.worker_mode === "worker"
return configModule.projectConfig.workerMode === "worker"
}
async function subscribersLoader(
packages/medusa/src/loaders/medusa-app.ts
+10 -10
View File
@@ -85,9 +85,9 @@ async function runMedusaAppMigrations({
clientUrl:
injectedDependencies[ContainerRegistrationKeys.PG_CONNECTION]?.client
?.config?.connection?.connectionString ??
configModule.projectConfig.database_url,
driverOptions: configModule.projectConfig.database_driver_options,
debug: !!(configModule.projectConfig.database_logging ?? false),
configModule.projectConfig.databaseUrl,
driverOptions: configModule.projectConfig.databaseDriverOptions,
debug: !!(configModule.projectConfig.databaseLogging ?? false),
},
}
const configModules = mergeDefaultModules(configModule.modules)
@@ -175,9 +175,9 @@ export const loadMedusaApp = async (
const sharedResourcesConfig = {
database: {
clientUrl: configModule.projectConfig.database_url,
driverOptions: configModule.projectConfig.database_driver_options,
debug: !!(configModule.projectConfig.database_logging ?? false),
clientUrl: configModule.projectConfig.databaseUrl,
driverOptions: configModule.projectConfig.databaseDriverOptions,
debug: !!(configModule.projectConfig.databaseLogging ?? false),
},
}
@@ -187,7 +187,7 @@ export const loadMedusaApp = async (
const configModules = mergeDefaultModules(configModule.modules)
const medusaApp = await MedusaApp({
workerMode: configModule.projectConfig.worker_mode,
workerMode: configModule.projectConfig.workerMode,
modulesConfig: configModules,
sharedContainer: container,
linkModules,
@@ -256,9 +256,9 @@ export async function runModulesLoader({
const sharedResourcesConfig = {
database: {
clientUrl: configModule.projectConfig.database_url,
driverOptions: configModule.projectConfig.database_driver_options,
debug: !!(configModule.projectConfig.database_logging ?? false),
clientUrl: configModule.projectConfig.databaseUrl,
driverOptions: configModule.projectConfig.databaseDriverOptions,
debug: !!(configModule.projectConfig.databaseLogging ?? false),
},
}
packages/medusa/src/loaders/pg-connection.ts
+3 -3
View File
@@ -13,10 +13,10 @@ export default async ({ container, configModule }: Options): Promise<any> => {
}
// Share a knex connection to be consumed by the shared modules
const connectionString = configModule.projectConfig.database_url
const connectionString = configModule.projectConfig.databaseUrl
const driverOptions: any =
configModule.projectConfig.database_driver_options || {}
const schema = configModule.projectConfig.database_schema || "public"
configModule.projectConfig.databaseDriverOptions || {}
const schema = configModule.projectConfig.databaseSchema || "public"
const idleTimeoutMillis = driverOptions.pool?.idleTimeoutMillis ?? undefined // prevent null to be passed
const poolMax = driverOptions.pool?.max
packages/medusa/src/loaders/redis.ts
+3 -3
View File
@@ -19,11 +19,11 @@ async function redisLoader({
}: Options): Promise<{ shutdown: () => Promise<void> }> {
let client!: Redis | FakeRedis
if (configModule.projectConfig.redis_url) {
client = new Redis(configModule.projectConfig.redis_url, {
if (configModule.projectConfig.redisUrl) {
client = new Redis(configModule.projectConfig.redisUrl, {
// Lazy connect to properly handle connection errors
lazyConnect: true,
...(configModule.projectConfig.redis_options ?? {}),
...(configModule.projectConfig.redisOptions ?? {}),
})
try {
packages/modules/event-bus-redis/src/loaders/index.ts
+2 -2
View File
@@ -13,7 +13,7 @@ export default async ({
if (!redisUrl) {
throw Error(
"No `redis_url` provided in project config. It is required for the Redis Event Bus."
"No `redisUrl` provided in project config. It is required for the Redis Event Bus."
)
}
@@ -27,7 +27,7 @@ export default async ({
})
try {
await new Promise(async resolve => {
await new Promise(async (resolve) => {
await connection.connect(resolve)
})
logger?.info(`Connection to Redis in module 'event-bus-redis' established`)