e413cfefc2
** What
- Allow auto-loaded Medusa files to export a config object.
- Currently supports isDisabled to control loading.
- new instance `FeatureFlag` exported by `@medusajs/framework/utils`
- `feature-flags` is now a supported folder for medusa projects, modules, providers and plugins. They will be loaded and added to `FeatureFlag`
** Why
- Enables conditional loading of routes, migrations, jobs, subscribers, workflows, and other files based on feature flags.
```ts
// /src/feature-flags
import { FlagSettings } from "@medusajs/framework/feature-flags"
const CustomFeatureFlag: FlagSettings = {
key: "custom_feature",
default_val: false,
env_key: "FF_MY_CUSTOM_FEATURE",
description: "Enable xyz",
}
export default CustomFeatureFlag
```
```ts
// /src/modules/my-custom-module/migration/Migration20250822135845.ts
import { FeatureFlag } from "@medusajs/framework/utils"
export class Migration20250822135845 extends Migration {
override async up(){ }
override async down(){ }
}
defineFileConfig({
isDisabled: () => !FeatureFlag.isFeatureEnabled("custom_feature")
})
```
41 lines
1.3 KiB
TypeScript
41 lines
1.3 KiB
TypeScript
import { medusaIntegrationTestRunner } from "@medusajs/test-utils"
|
|
import {
|
|
adminHeaders,
|
|
createAdminUser,
|
|
} from "../../../../helpers/create-admin-user"
|
|
|
|
jest.setTimeout(30000)
|
|
|
|
medusaIntegrationTestRunner({
|
|
testSuite: ({ dbConnection, getContainer, api }) => {
|
|
describe("GET /admin/feature-flags", () => {
|
|
it("should return feature flags when unauthenticated", async () => {
|
|
const response = await api.get("/admin/feature-flags")
|
|
|
|
expect(response.status).toEqual(200)
|
|
expect(response.data).toHaveProperty("feature_flags")
|
|
expect(response.data.feature_flags).toEqual(
|
|
expect.objectContaining({
|
|
view_configurations: false,
|
|
})
|
|
)
|
|
})
|
|
|
|
it("should return feature flags when authenticated as admin", async () => {
|
|
const container = getContainer()
|
|
await createAdminUser(dbConnection, adminHeaders, container)
|
|
|
|
const response = await api.get("/admin/feature-flags", adminHeaders)
|
|
|
|
expect(response.status).toEqual(200)
|
|
expect(response.data).toHaveProperty("feature_flags")
|
|
expect(response.data.feature_flags).toEqual(
|
|
expect.objectContaining({
|
|
view_configurations: false,
|
|
})
|
|
)
|
|
})
|
|
})
|
|
},
|
|
})
|