Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(customer): list customer #6206

Merged
merged 4 commits into from
Jan 29, 2024
Merged

feat(customer): list customer #6206

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c37b269
feat: list customers and groups
srindom Jan 26, 2024
73aa023
fix: add filter test and prepare for remote query
srindom Jan 29, 2024
252aa09
Merge branch 'develop' into feat/customer-endpoints
srindom Jan 29, 2024
a63119d
Merge branch 'develop' into feat/customer-endpoints
srindom Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions integration-tests/plugins/__tests__/customer/admin/list-customer-groups.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ICustomerModuleService } from "@medusajs/types"
import path from "path"
import { startBootstrapApp } from "../../../../environment-helpers/bootstrap-app"
import { useApi } from "../../../../environment-helpers/use-api"
import { getContainer } from "../../../../environment-helpers/use-container"
import { initDb, useDb } from "../../../../environment-helpers/use-db"
import adminSeeder from "../../../../helpers/admin-seeder"

const env = { MEDUSA_FF_MEDUSA_V2: true }
const adminHeaders = {
headers: { "x-medusa-access-token": "test_token" },
}

describe("GET /admin/customer-groups", () => {
let dbConnection
let appContainer
let shutdownServer
let customerModuleService: ICustomerModuleService

beforeAll(async () => {
const cwd = path.resolve(path.join(__dirname, "..", "..", ".."))
dbConnection = await initDb({ cwd, env } as any)
shutdownServer = await startBootstrapApp({ cwd, env })
appContainer = getContainer()
customerModuleService = appContainer.resolve(
ModuleRegistrationName.CUSTOMER
)
})

afterAll(async () => {
const db = useDb()
await db.shutdown()
await shutdownServer()
})

beforeEach(async () => {
await adminSeeder(dbConnection)
})

afterEach(async () => {
const db = useDb()
await db.teardown()
})

it("should get all customer groups and its count", async () => {
await customerModuleService.createCustomerGroup({
name: "Test",
})

const api = useApi() as any
const response = await api.get(`/admin/customer-groups`, adminHeaders)

expect(response.status).toEqual(200)
expect(response.data.count).toEqual(1)
expect(response.data.groups).toEqual([
expect.objectContaining({
id: expect.any(String),
name: "Test",
}),
])
})
})
69 changes: 69 additions & 0 deletions integration-tests/plugins/__tests__/customer/admin/list-customers.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ICustomerModuleService } from "@medusajs/types"
import path from "path"
import { startBootstrapApp } from "../../../../environment-helpers/bootstrap-app"
import { useApi } from "../../../../environment-helpers/use-api"
import { getContainer } from "../../../../environment-helpers/use-container"
import { initDb, useDb } from "../../../../environment-helpers/use-db"
import adminSeeder from "../../../../helpers/admin-seeder"

const env = { MEDUSA_FF_MEDUSA_V2: true }
const adminHeaders = {
headers: { "x-medusa-access-token": "test_token" },
}

describe("GET /admin/customers", () => {
let dbConnection
let appContainer
let shutdownServer
let customerModuleService: ICustomerModuleService

beforeAll(async () => {
const cwd = path.resolve(path.join(__dirname, "..", "..", ".."))
dbConnection = await initDb({ cwd, env } as any)
shutdownServer = await startBootstrapApp({ cwd, env })
appContainer = getContainer()
customerModuleService = appContainer.resolve(
ModuleRegistrationName.CUSTOMER
)
})

afterAll(async () => {
const db = useDb()
await db.shutdown()
await shutdownServer()
})

beforeEach(async () => {
await adminSeeder(dbConnection)
})

afterEach(async () => {
const db = useDb()
await db.teardown()
})

it("should get all customers and its count", async () => {
await customerModuleService.create([
{
first_name: "Test",
last_name: "Test",
email: "[email protected]",
},
])

const api = useApi() as any
const response = await api.get(`/admin/customers`, adminHeaders)

expect(response.status).toEqual(200)
expect(response.data.count).toEqual(1)
expect(response.data.customers).toEqual([
expect.objectContaining({
id: expect.any(String),
first_name: "Test",
last_name: "Test",
email: "[email protected]",
}),
])
})
})
5 changes: 5 additions & 0 deletions integration-tests/plugins/medusa-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,10 @@ module.exports = {
resources: "shared",
resolve: "@medusajs/promotion",
},
[Modules.CUSTOMER]: {
scope: "internal",
resources: "shared",
resolve: "@medusajs/customer",
},
},
}
1 change: 1 addition & 0 deletions integration-tests/plugins/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
},
"dependencies": {
"@medusajs/cache-inmemory": "workspace:*",
"@medusajs/customer": "workspace:^",
"@medusajs/event-bus-local": "workspace:*",
"@medusajs/inventory": "workspace:^",
"@medusajs/medusa": "workspace:*",
Expand Down
2 changes: 1 addition & 1 deletion packages/customer/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"@models": ["./src/models"],
"@services": ["./src/services"],
"@repositories": ["./src/repositories"],
"@types": ["./src/types"],
"@types": ["./src/types"]
}
},
"include": ["src"],
Expand Down
52 changes: 52 additions & 0 deletions packages/medusa/src/api-v2/admin/customer-groups/middlewares.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { MedusaV2Flag } from "@medusajs/utils"

import {
isFeatureFlagEnabled,
transformBody,
transformQuery,
} from "../../../api/middlewares"
import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
import * as QueryConfig from "./query-config"
import {
AdminGetCustomerGroupsParams,
AdminGetCustomerGroupsGroupParams,
AdminPostCustomerGroupsReq,
AdminPostCustomerGroupsGroupReq,
} from "./validators"

export const adminCustomerGroupRoutesMiddlewares: MiddlewareRoute[] = [
{
matcher: "/admin/customer-groups*",
middlewares: [isFeatureFlagEnabled(MedusaV2Flag.key)],
},
{
method: ["GET"],
matcher: "/admin/customer-groups",
middlewares: [
transformQuery(
AdminGetCustomerGroupsParams,
QueryConfig.listTransformQueryConfig
),
],
},
{
method: ["GET"],
matcher: "/admin/customer-groups/:id",
middlewares: [
transformQuery(
AdminGetCustomerGroupsGroupParams,
QueryConfig.retrieveTransformQueryConfig
),
],
},
{
method: ["POST"],
matcher: "/admin/customer-groups",
middlewares: [transformBody(AdminPostCustomerGroupsReq)],
},
{
method: ["POST"],
matcher: "/admin/customer-groups/:id",
middlewares: [transformBody(AdminPostCustomerGroupsGroupReq)],
},
]
21 changes: 21 additions & 0 deletions packages/medusa/src/api-v2/admin/customer-groups/query-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
export const defaultAdminCustomerGroupRelations = []
export const allowedAdminCustomerGroupRelations = ["customers"]
export const defaultAdminCustomerGroupFields = [
"id",
"name",
"created_at",
"updated_at",
"deleted_at",
]

export const retrieveTransformQueryConfig = {
defaultFields: defaultAdminCustomerGroupFields,
defaultRelations: defaultAdminCustomerGroupRelations,
allowedRelations: allowedAdminCustomerGroupRelations,
isList: false,
}

export const listTransformQueryConfig = {
...retrieveTransformQueryConfig,
isList: true,
}
24 changes: 24 additions & 0 deletions packages/medusa/src/api-v2/admin/customer-groups/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ICustomerModuleService } from "@medusajs/types"
import { MedusaRequest, MedusaResponse } from "../../../types/routing"

export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
const customerModuleService = req.scope.resolve<ICustomerModuleService>(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can align how we want to build the GET endpoints.
I believe we should use the remoteQuery to be able to easily expand relations from here.

We have 2 utils that can help on that:
remoteQueryObjectFromString and remoteQueryObjectToString

we can discuss it on Monday and come up with a pattern to follow in all the api-v2 endpoints. cc: @adrien2p @olivermrbl

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree remote query should be the way to go - do we have an example implementation of the approach somewhere?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have mixed examples that we need to normalize from now on.
I believe this test is a good starting point, where we have a list of all default fields and relations to be listed. We need to think about and implement how to have a list of "allowed" relations to be expanded, and how to customize this list, adding custom relations to it.

from there it is used like this:

const remoteQuery = container.resolve("remoteQuery")

const query = remoteQueryObjectFromString({
  entryPoint: "product",
  variables: {},
  fields,
})

const results = await remoteQuery(query)

variables are handled here before calling module.list(filters, options)
We can send all the filters and options needed to the service from here.

As this will be replicate in most GET endpoints, I think it worth spending some time in it, even if in another PR.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I will need to see an example with filters and expands applied - I wasn't able to get this to work for these.

I suggest that we merge PRs without RemoteQuery until we have its feature set more standardized.

ModuleRegistrationName.CUSTOMER
)

const [groups, count] =
await customerModuleService.listAndCountCustomerGroups(
req.filterableFields,
req.listConfig
)

const { offset, limit } = req.validatedQuery

res.json({
count,
groups,
offset,
limit,
})
}
114 changes: 114 additions & 0 deletions packages/medusa/src/api-v2/admin/customer-groups/validators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
import { OperatorMap } from "@medusajs/types"
import { Type } from "class-transformer"
import {
IsNotEmpty,
IsOptional,
IsString,
ValidateNested,
} from "class-validator"
import { FindParams, extendedFindParamsMixin } from "../../../types/common"
import { OperatorMapValidator } from "../../../types/validators/operator-map"

export class AdminGetCustomerGroupsGroupParams extends FindParams {}

class FilterableCustomerPropsValidator {
@IsOptional()
@IsString({ each: true })
id?: string | string[]

@IsOptional()
@ValidateNested({ each: true })
@Type(() => OperatorMapValidator)
email?: string | string[] | OperatorMap<string>

@IsOptional()
@IsString({ each: true })
default_billing_address_id?: string | string[] | null

@IsOptional()
@IsString({ each: true })
default_shipping_address_id?: string | string[] | null

@IsOptional()
@IsString({ each: true })
company_name?: string | string[] | OperatorMap<string> | null

@IsOptional()
@IsString({ each: true })
first_name?: string | string[] | OperatorMap<string> | null

@IsOptional()
@IsString({ each: true })
last_name?: string | string[] | OperatorMap<string> | null

@IsOptional()
@IsString({ each: true })
created_by?: string | string[] | null

@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
created_at?: OperatorMap<string>

@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
updated_at?: OperatorMap<string>
}

export class AdminGetCustomerGroupsParams extends extendedFindParamsMixin({
limit: 100,
offset: 0,
}) {
@IsOptional()
@IsString({ each: true })
id?: string | string[]

@IsOptional()
@ValidateNested({ each: true })
@Type(() => OperatorMapValidator)
name?: string | OperatorMap<string>

@IsOptional()
@ValidateNested()
@Type(() => FilterableCustomerPropsValidator)
customers?: FilterableCustomerPropsValidator | string | string[]

@IsOptional()
@IsString({ each: true })
created_by?: string | string[] | null

@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
created_at?: OperatorMap<string>

@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
updated_at?: OperatorMap<string>

// Additional filters from BaseFilterable
@IsOptional()
@ValidateNested({ each: true })
@Type(() => AdminGetCustomerGroupsParams)
$and?: AdminGetCustomerGroupsParams[]

@IsOptional()
@ValidateNested({ each: true })
@Type(() => AdminGetCustomerGroupsParams)
$or?: AdminGetCustomerGroupsParams[]
}

export class AdminPostCustomerGroupsReq {
@IsNotEmpty()
@IsString()
name: string
}

export class AdminPostCustomerGroupsGroupReq {
@IsNotEmpty()
@IsString()
@IsOptional()
name?: string
}
Loading
Loading