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

feat: Modify api key and sales channel link to use modules and add test (#6546)

Browse Source
This commit is contained in:
Stevche Radevski
2024-03-01 10:24:50 +01:00
committed by GitHub
parent 55275f0eba
commit 196e821ff2
12 changed files with 146 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
integration-tests/modules/__tests__/link-modules/publishable-key-sales-channel.spec.ts Normal file
View File

@@ -0,0 +1,105 @@
import { ModuleRegistrationName, Modules } from "@medusajs/modules-sdk"
import {
IApiKeyModuleService,
ISalesChannelModuleService,
} from "@medusajs/types"
import path from "path"
import { startBootstrapApp } from "../../../environment-helpers/bootstrap-app"
import { getContainer } from "../../../environment-helpers/use-container"
import { initDb, useDb } from "../../../environment-helpers/use-db"
import { remoteQueryObjectFromString } from "@medusajs/utils"
jest.setTimeout(50000)
const env = { MEDUSA_FF_MEDUSA_V2: true }
describe("Publishable keys and sales channel link", () => {
let dbConnection
let appContainer
let shutdownServer
let apiKeyModule: IApiKeyModuleService
let scModuleService: ISalesChannelModuleService
let remoteQuery
let remoteLink
beforeAll(async () => {
const cwd = path.resolve(path.join(__dirname, "..", ".."))
dbConnection = await initDb({ cwd, env } as any)
shutdownServer = await startBootstrapApp({ cwd, env })
appContainer = getContainer()
apiKeyModule = appContainer.resolve(ModuleRegistrationName.API_KEY)
scModuleService = appContainer.resolve(ModuleRegistrationName.SALES_CHANNEL)
remoteQuery = appContainer.resolve("remoteQuery")
remoteLink = appContainer.resolve("remoteLink")
})
afterAll(async () => {
const db = useDb()
await db.shutdown()
await shutdownServer()
})
afterEach(async () => {
const db = useDb()
await db.teardown()
})
it("should query api key and sales channels link with remote query", async () => {
const salesChannel = await scModuleService.create({
name: "Webshop",
})
const apiKeys = await apiKeyModule.create([
{
title: "Api key",
type: "publishable",
created_by: "test",
},
{
title: "Api key 2",
type: "publishable",
created_by: "test",
},
])
await remoteLink.create([
{
[Modules.API_KEY]: {
publishable_key_id: apiKeys[0].id,
},
[Modules.SALES_CHANNEL]: {
sales_channel_id: salesChannel.id,
},
},
{
[Modules.API_KEY]: {
publishable_key_id: apiKeys[1].id,
},
[Modules.SALES_CHANNEL]: {
sales_channel_id: salesChannel.id,
},
},
])
const queryObject = remoteQueryObjectFromString({
entryPoint: "api_key",
variables: {
filters: { token: apiKeys[0].token },
},
fields: ["id", "sales_channels.id"],
})
const keyLinks = await remoteQuery(queryObject)
expect(keyLinks).toHaveLength(1)
expect(keyLinks).toEqual(
expect.arrayContaining([
expect.objectContaining({
id: apiKeys[0].id,
sales_channels: expect.arrayContaining([
expect.objectContaining({ id: salesChannel.id }),
]),
}),
])
)
})
})

13
packages/api-key/integration-tests/__tests__/api-key-module-service.spec.ts
View File

@@ -284,6 +284,19 @@ moduleIntegrationTestRunner({
expect(apiKeysInDatabase).toHaveLength(2)
})
it("should only return keys with matching token", async function () {
const created = await service.create([
createPublishableKeyFixture,
createPublishableKeyFixture,
])
const apiKeysInDatabase = await service.list({
token: created[0].token,
})
expect(apiKeysInDatabase).toHaveLength(1)
expect(apiKeysInDatabase[0].token).toEqual(created[0].token)
})
it("should not return the token and salt for secret keys when listing", async function () {
await service.create([createSecretKeyFixture])

2
packages/api-key/src/joiner-config.ts
View File

@@ -22,7 +22,7 @@ export const joinerConfig: ModuleJoinerConfig = {
linkableKeys: LinkableKeys,
alias: [
{
name: ["api-key", "api-keys"],
name: ["api_key", "api_keys"],
args: { entity: ApiKey.name },
},
],

4
packages/core-flows/src/api-key/steps/create-api-keys.ts
View File

@@ -3,7 +3,7 @@ import { CreateApiKeyDTO, IApiKeyModuleService } from "@medusajs/types"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type CreateApiKeysStepInput = {
apiKeysData: CreateApiKeyDTO[]
api_keys: CreateApiKeyDTO[]
}
export const createApiKeysStepId = "create-api-keys"
@@ -13,7 +13,7 @@ export const createApiKeysStep = createStep(
const service = container.resolve<IApiKeyModuleService>(
ModuleRegistrationName.API_KEY
)
const created = await service.create(data.apiKeysData)
const created = await service.create(data.api_keys)
return new StepResponse(
created,
created.map((apiKey) => apiKey.id)

2
packages/core-flows/src/api-key/workflows/create-api-keys.ts
View File

@@ -2,7 +2,7 @@ import { ApiKeyDTO, CreateApiKeyDTO } from "@medusajs/types"
import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
import { createApiKeysStep } from "../steps"
type WorkflowInput = { apiKeysData: CreateApiKeyDTO[] }
type WorkflowInput = { api_keys: CreateApiKeyDTO[] }
export const createApiKeysWorkflowId = "create-api-keys"
export const createApiKeysWorkflow = createWorkflow(

1
packages/link-modules/src/definitions/index.ts
View File

@@ -9,4 +9,3 @@ export * from "./product-shipping-profile"
export * from "./product-variant-inventory-item"
export * from "./product-variant-price-set"
export * from "./publishable-api-key-sales-channel"

16
packages/link-modules/src/definitions/publishable-api-key-sales-channel.ts
View File

@@ -1,5 +1,6 @@
import { ModuleJoinerConfig } from "@medusajs/types"
import { LINKS } from "../links"
import { Modules } from "@medusajs/modules-sdk"
export const PublishableApiKeySalesChannel: ModuleJoinerConfig = {
serviceName: LINKS.PublishableApiKeySalesChannel,
@@ -19,14 +20,14 @@ export const PublishableApiKeySalesChannel: ModuleJoinerConfig = {
primaryKeys: ["id", "publishable_key_id", "sales_channel_id"],
relationships: [
{
serviceName: "publishableApiKeyService",
serviceName: Modules.API_KEY,
isInternalService: true,
primaryKey: "id",
foreignKey: "publishable_key_id",
alias: "publishable_key",
alias: "api_key",
},
{
serviceName: "salesChannelService",
serviceName: Modules.SALES_CHANNEL,
isInternalService: true,
primaryKey: "id",
foreignKey: "sales_channel_id",
@@ -35,7 +36,7 @@ export const PublishableApiKeySalesChannel: ModuleJoinerConfig = {
],
extends: [
{
serviceName: "publishableApiKeyService",
serviceName: Modules.API_KEY,
fieldAlias: {
sales_channels: "sales_channels_link.sales_channel",
},
@@ -49,13 +50,16 @@ export const PublishableApiKeySalesChannel: ModuleJoinerConfig = {
},
},
{
serviceName: "salesChannelService",
serviceName: Modules.SALES_CHANNEL,
fieldAlias: {
api_keys: "api_keys_link.api_key",
},
relationship: {
serviceName: LINKS.PublishableApiKeySalesChannel,
isInternalService: true,
primaryKey: "sales_channel_id",
foreignKey: "id",
alias: "publishable_keys_link",
alias: "api_keys_link",
isList: true,
},
},

4
packages/link-modules/src/links.ts
View File

@@ -41,8 +41,8 @@ export const LINKS = {
"sales_channel_id"
),
PublishableApiKeySalesChannel: composeLinkName(
"publishableApiKeyService",
"publishable_key_id",
Modules.API_KEY,
"api_key_id",
Modules.SALES_CHANNEL,
"sales_channel_id"
),

4
packages/medusa/src/api-v2/admin/api-keys/[id]/route.ts
View File

@@ -20,7 +20,7 @@ export const GET = async (
const variables = { id: req.params.id }
const queryObject = remoteQueryObjectFromString({
entryPoint: "api-key",
entryPoint: "api_key",
variables,
fields: defaultAdminApiKeyFields,
})
@@ -66,7 +66,7 @@ export const DELETE = async (
res.status(200).json({
id,
object: "api-key",
object: "api_key",
deleted: true,
})
}

4
packages/medusa/src/api-v2/admin/api-keys/route.ts
View File

@@ -15,7 +15,7 @@ export const GET = async (
const remoteQuery = req.scope.resolve("remoteQuery")
const queryObject = remoteQueryObjectFromString({
entryPoint: "api-key",
entryPoint: "api_key",
variables: {
filters: req.filterableFields,
order: req.listConfig.order,
@@ -47,7 +47,7 @@ export const POST = async (
]
const { result, errors } = await createApiKeysWorkflow(req.scope).run({
input: { apiKeysData: input },
input: { api_keys: input },
throwOnError: false,
})

7
packages/medusa/src/api-v2/admin/api-keys/validators.ts
View File

@@ -34,6 +34,13 @@ export class AdminGetApiKeysParams extends extendedFindParamsMixin({
@IsOptional()
title?: string | string[]
/**
* Filter by token
*/
@IsString({ each: true })
@IsOptional()
token?: string | string[]
/**
* Filter by type
*/

1
packages/types/src/api-key/common/api-key.ts
View File

@@ -17,6 +17,7 @@ export interface ApiKeyDTO {
export interface FilterableApiKeyProps
extends BaseFilterable<FilterableApiKeyProps> {
id?: string | string[]
token?: string | string[]
title?: string | string[]
type?: ApiKeyType
}