4b4463f0e2
* fix babel transform-runtime regenerator required for migrations * add customer group model * add migration for customer group * add customer group model export * add customer group repository * add customer group service * add CustomerGroupRepository to "withTransaction" in CustomerGroupService * remove unnecessary argument to runtime plugin * service export ordering * add create customer group endpoint * add customergroup to route index in admin * add customer group service * add customer groups test * cleanup * add customers batch initial * batch creation of customer groups * integration testing batch creation * integration tests * chaining existing customers creation in repo * remove commented test * update unit tests to reflect change in idempotent behavior * ensure that exceptions are expected * update idempotency behavior * update formatting * update format * Update packages/medusa/src/repositories/customer-group.ts Co-authored-by: Sebastian Rindom <skrindom@gmail.com> * pr feedback * add In import * add seperate model dto * add integration test * error handling in repository * remove unused import * jsdoc * Update packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts Co-authored-by: Sebastian Rindom <skrindom@gmail.com> * Update packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts Co-authored-by: Sebastian Rindom <skrindom@gmail.com> * pr review comments * rename variable * fix: adds atomic phase clean up callback * fix: call error handler in new transaction block too * restore * error handling * fix: error handler in no isolation case * add integration test for missing group on update * final adjustments to test * fix pr feedback * cleanup core for pr * remove console.log * remove customergroupservice test from customers * Apply suggestions from code review Co-authored-by: Sebastian Rindom <skrindom@gmail.com> * add end bracket to customer tests * remove comments * change model decorator * fix integration test merge * onDelete cascade instead of cascade:true * remove verbose flag * fix: dedupe type * add save to customer groups * customer model delete cascade * add await to asyncronous save operations Co-authored-by: Sebastian Rindom <skrindom@gmail.com>
718 lines
18 KiB
JavaScript
718 lines
18 KiB
JavaScript
const path = require("path")
|
|
|
|
const setupServer = require("../../../helpers/setup-server")
|
|
const { useApi } = require("../../../helpers/use-api")
|
|
const { useDb, initDb } = require("../../../helpers/use-db")
|
|
|
|
const customerSeeder = require("../../helpers/customer-seeder")
|
|
const adminSeeder = require("../../helpers/admin-seeder")
|
|
|
|
jest.setTimeout(30000)
|
|
|
|
describe("/admin/customer-groups", () => {
|
|
let medusaProcess
|
|
let dbConnection
|
|
|
|
beforeAll(async () => {
|
|
const cwd = path.resolve(path.join(__dirname, "..", ".."))
|
|
dbConnection = await initDb({ cwd })
|
|
medusaProcess = await setupServer({ cwd })
|
|
})
|
|
|
|
afterAll(async () => {
|
|
const db = useDb()
|
|
await db.shutdown()
|
|
medusaProcess.kill()
|
|
})
|
|
|
|
describe("POST /admin/customer-groups", () => {
|
|
beforeEach(async () => {
|
|
try {
|
|
await adminSeeder(dbConnection)
|
|
await customerSeeder(dbConnection)
|
|
} catch (err) {
|
|
console.log(err)
|
|
throw err
|
|
}
|
|
})
|
|
|
|
afterEach(async () => {
|
|
const db = useDb()
|
|
await db.teardown()
|
|
})
|
|
|
|
it("creates customer group", async () => {
|
|
const api = useApi()
|
|
|
|
const payload = {
|
|
name: "test group",
|
|
}
|
|
|
|
const response = await api.post("/admin/customer-groups", payload, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
|
|
expect(response.status).toEqual(200)
|
|
expect(response.data.customer_group).toEqual(
|
|
expect.objectContaining({
|
|
name: "test group",
|
|
})
|
|
)
|
|
})
|
|
|
|
it("Fails to create duplciate customer group", async () => {
|
|
expect.assertions(3)
|
|
const api = useApi()
|
|
|
|
const payload = {
|
|
name: "vip-customers",
|
|
}
|
|
|
|
await api
|
|
.post("/admin/customer-groups", payload, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
.catch((err) => {
|
|
expect(err.response.status).toEqual(402)
|
|
expect(err.response.data.type).toEqual("duplicate_error")
|
|
expect(err.response.data.message).toEqual(
|
|
"Key (name)=(vip-customers) already exists."
|
|
)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe("DELETE /admin/customer-groups", () => {
|
|
beforeEach(async () => {
|
|
try {
|
|
await adminSeeder(dbConnection)
|
|
await customerSeeder(dbConnection)
|
|
} catch (err) {
|
|
console.log(err)
|
|
throw err
|
|
}
|
|
})
|
|
|
|
afterEach(async () => {
|
|
const db = useDb()
|
|
await db.teardown()
|
|
})
|
|
|
|
it("removes customer group from get endpoint", async () => {
|
|
expect.assertions(3)
|
|
|
|
const api = useApi()
|
|
|
|
const id = "customer-group-1"
|
|
|
|
const deleteResponse = await api.delete(`/admin/customer-groups/${id}`, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
|
|
expect(deleteResponse.data).toEqual({
|
|
id: id,
|
|
object: "customer_group",
|
|
deleted: true,
|
|
})
|
|
|
|
await api
|
|
.get(`/admin/customer-groups/${id}`, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
.catch((error) => {
|
|
expect(error.response.data.type).toEqual("not_found")
|
|
expect(error.response.data.message).toEqual(
|
|
`CustomerGroup with id ${id} was not found`
|
|
)
|
|
})
|
|
})
|
|
|
|
it("removes customer group from customer upon deletion", async () => {
|
|
expect.assertions(3)
|
|
|
|
const api = useApi()
|
|
|
|
const id = "test-group-delete"
|
|
|
|
const customerRes_preDeletion = await api.get(
|
|
`/admin/customers/test-customer-delete-cg?expand=groups`,
|
|
{
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
}
|
|
)
|
|
|
|
expect(customerRes_preDeletion.data.customer).toEqual(
|
|
expect.objectContaining({
|
|
groups: [
|
|
expect.objectContaining({
|
|
id: "test-group-delete",
|
|
name: "test-group-delete",
|
|
}),
|
|
],
|
|
})
|
|
)
|
|
|
|
const deleteResponse = await api
|
|
.delete(`/admin/customer-groups/${id}`, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
.catch((err) => console.log(err))
|
|
|
|
expect(deleteResponse.data).toEqual({
|
|
id: id,
|
|
object: "customer_group",
|
|
deleted: true,
|
|
})
|
|
|
|
const customerRes = await api.get(
|
|
`/admin/customers/test-customer-delete-cg?expand=groups`,
|
|
{
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
}
|
|
)
|
|
|
|
expect(customerRes.data.customer).toEqual(
|
|
expect.objectContaining({
|
|
groups: [],
|
|
})
|
|
)
|
|
})
|
|
})
|
|
|
|
describe("POST /admin/customer-groups/{id}/customers/batch", () => {
|
|
beforeEach(async () => {
|
|
try {
|
|
await adminSeeder(dbConnection)
|
|
await customerSeeder(dbConnection)
|
|
} catch (err) {
|
|
console.log(err)
|
|
throw err
|
|
}
|
|
})
|
|
|
|
afterEach(async () => {
|
|
const db = useDb()
|
|
await db.teardown()
|
|
})
|
|
|
|
it("adds multiple customers to a group", async () => {
|
|
const api = useApi()
|
|
|
|
const payload = {
|
|
customer_ids: [{ id: "test-customer-1" }, { id: "test-customer-2" }],
|
|
}
|
|
|
|
const batchAddResponse = await api.post(
|
|
"/admin/customer-groups/customer-group-1/customers/batch",
|
|
payload,
|
|
{
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
}
|
|
)
|
|
|
|
expect(batchAddResponse.status).toEqual(200)
|
|
expect(batchAddResponse.data.customer_group).toEqual(
|
|
expect.objectContaining({
|
|
name: "vip-customers",
|
|
})
|
|
)
|
|
|
|
const getCustomerResponse = await api.get(
|
|
"/admin/customers?expand=groups",
|
|
{
|
|
headers: { Authorization: "Bearer test_token" },
|
|
}
|
|
)
|
|
|
|
expect(getCustomerResponse.data.customers).toEqual(
|
|
expect.arrayContaining([
|
|
expect.objectContaining({
|
|
id: "test-customer-1",
|
|
groups: [
|
|
expect.objectContaining({
|
|
name: "vip-customers",
|
|
id: "customer-group-1",
|
|
}),
|
|
],
|
|
}),
|
|
expect.objectContaining({
|
|
id: "test-customer-2",
|
|
groups: [
|
|
expect.objectContaining({
|
|
name: "vip-customers",
|
|
id: "customer-group-1",
|
|
}),
|
|
],
|
|
}),
|
|
])
|
|
)
|
|
})
|
|
|
|
it("presents a descriptive error when presented with a non-existing group", async () => {
|
|
expect.assertions(2)
|
|
|
|
const api = useApi()
|
|
|
|
const payload = {
|
|
customer_ids: [{ id: "test-customer-1" }, { id: "test-customer-2" }],
|
|
}
|
|
|
|
await api
|
|
.post(
|
|
"/admin/customer-groups/non-existing-customer-group-1/customers/batch",
|
|
payload,
|
|
{
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
}
|
|
)
|
|
.catch((err) => {
|
|
expect(err.response.data.type).toEqual("not_found")
|
|
expect(err.response.data.message).toEqual(
|
|
"CustomerGroup with id non-existing-customer-group-1 was not found"
|
|
)
|
|
})
|
|
})
|
|
|
|
it("adds customers to a group idempotently", async () => {
|
|
expect.assertions(3)
|
|
|
|
const api = useApi()
|
|
|
|
// add customer-1 to the customer group
|
|
const payload_1 = {
|
|
customer_ids: [{ id: "test-customer-1" }],
|
|
}
|
|
|
|
await api
|
|
.post(
|
|
"/admin/customer-groups/customer-group-1/customers/batch",
|
|
payload_1,
|
|
{
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
}
|
|
)
|
|
.catch((err) => console.log(err))
|
|
|
|
// re-adding customer-1 to the customer group along with new addintion:
|
|
// customer-2 and some non-existing customers should cause the request to fail
|
|
const payload_2 = {
|
|
customer_ids: [
|
|
{ id: "test-customer-1" },
|
|
{ id: "test-customer-27" },
|
|
{ id: "test-customer-28" },
|
|
{ id: "test-customer-2" },
|
|
],
|
|
}
|
|
|
|
await api
|
|
.post(
|
|
"/admin/customer-groups/customer-group-1/customers/batch",
|
|
payload_2,
|
|
{
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
}
|
|
)
|
|
.catch((err) => {
|
|
expect(err.response.data.type).toEqual("not_found")
|
|
expect(err.response.data.message).toEqual(
|
|
'The following customer ids do not exist: "test-customer-27, test-customer-28"'
|
|
)
|
|
})
|
|
|
|
// check that customer-1 is only added once and that customer-2 is added correctly
|
|
const getCustomerResponse = await api.get(
|
|
"/admin/customers?expand=groups",
|
|
{
|
|
headers: { Authorization: "Bearer test_token" },
|
|
}
|
|
)
|
|
|
|
expect(getCustomerResponse.data.customers).toEqual(
|
|
expect.arrayContaining([
|
|
expect.objectContaining({
|
|
id: "test-customer-1",
|
|
groups: [
|
|
expect.objectContaining({
|
|
name: "vip-customers",
|
|
id: "customer-group-1",
|
|
}),
|
|
],
|
|
}),
|
|
expect.objectContaining({
|
|
id: "test-customer-2",
|
|
groups: [],
|
|
}),
|
|
])
|
|
)
|
|
})
|
|
})
|
|
|
|
describe("POST /admin/customer-groups/:id", () => {
|
|
beforeEach(async () => {
|
|
try {
|
|
await adminSeeder(dbConnection)
|
|
await customerSeeder(dbConnection)
|
|
} catch (err) {
|
|
console.log(err)
|
|
throw err
|
|
}
|
|
})
|
|
|
|
afterEach(async () => {
|
|
const db = useDb()
|
|
await db.teardown()
|
|
})
|
|
|
|
it("updates group name & metadata", async () => {
|
|
const api = useApi()
|
|
|
|
const id = "customer-group-2"
|
|
|
|
const body = {
|
|
name: "vip-customers-v2",
|
|
metadata: {
|
|
metaKey1: `metaValue1`,
|
|
},
|
|
}
|
|
|
|
const response = await api.post(`/admin/customer-groups/${id}`, body, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
|
|
expect(response.status).toEqual(200)
|
|
expect(response.data.customer_group).toEqual(
|
|
expect.objectContaining({
|
|
id: "customer-group-2",
|
|
name: "vip-customers-v2",
|
|
metadata: {
|
|
data1: "value1",
|
|
metaKey1: `metaValue1`,
|
|
},
|
|
})
|
|
)
|
|
expect(response.data.customer_group).not.toHaveProperty("customers")
|
|
})
|
|
|
|
it("deletes `metadata` nested key", async () => {
|
|
const api = useApi()
|
|
|
|
const id = "customer-group-2"
|
|
// already has some metadata initially
|
|
|
|
const body = {
|
|
name: "vip-customers-v2",
|
|
metadata: {
|
|
data1: null, // delete
|
|
data2: "val2", // insert
|
|
},
|
|
}
|
|
|
|
const response = await api
|
|
.post(`/admin/customer-groups/${id}?expand=customers`, body, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
.catch(console.log)
|
|
|
|
expect(response.status).toEqual(200)
|
|
expect(response.data.customer_group).toEqual(
|
|
expect.objectContaining({
|
|
id: "customer-group-2",
|
|
name: "vip-customers-v2",
|
|
metadata: { data1: null, data2: "val2" },
|
|
customers: [],
|
|
})
|
|
)
|
|
})
|
|
})
|
|
|
|
describe("GET /admin/customer-groups", () => {
|
|
beforeEach(async () => {
|
|
try {
|
|
await adminSeeder(dbConnection)
|
|
await customerSeeder(dbConnection)
|
|
} catch (err) {
|
|
console.log(err)
|
|
throw err
|
|
}
|
|
})
|
|
|
|
afterEach(async () => {
|
|
const db = useDb()
|
|
await db.teardown()
|
|
})
|
|
it("gets customer group", async () => {
|
|
const api = useApi()
|
|
|
|
const id = "customer-group-1"
|
|
|
|
const response = await api.get(`/admin/customer-groups/${id}`, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
|
|
expect(response.status).toEqual(200)
|
|
expect(response.data.customer_group).toEqual(
|
|
expect.objectContaining({
|
|
id: "customer-group-1",
|
|
name: "vip-customers",
|
|
})
|
|
)
|
|
expect(response.data.customer_group).not.toHaveProperty("customers")
|
|
})
|
|
|
|
it("gets customer group with `customers` prop", async () => {
|
|
const api = useApi()
|
|
|
|
const id = "customer-group-1"
|
|
|
|
const response = await api.get(
|
|
`/admin/customer-groups/${id}?expand=customers`,
|
|
{
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
}
|
|
)
|
|
|
|
expect(response.status).toEqual(200)
|
|
expect(response.data.customer_group).toEqual(
|
|
expect.objectContaining({
|
|
id: "customer-group-1",
|
|
name: "vip-customers",
|
|
})
|
|
)
|
|
expect(response.data.customer_group.customers).toEqual([])
|
|
})
|
|
|
|
it("throws error when a customer group doesn't exist", async () => {
|
|
const api = useApi()
|
|
|
|
const id = "test-group-000"
|
|
|
|
await api
|
|
.get(`/admin/customer-groups/${id}`, {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
})
|
|
.catch((err) => {
|
|
expect(err.response.status).toEqual(404)
|
|
expect(err.response.data.type).toEqual("not_found")
|
|
expect(err.response.data.message).toEqual(
|
|
`CustomerGroup with id ${id} was not found`
|
|
)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe("DELETE /admin/customer-groups/{id}/batch", () => {
|
|
beforeEach(async () => {
|
|
try {
|
|
await adminSeeder(dbConnection)
|
|
await customerSeeder(dbConnection)
|
|
} catch (err) {
|
|
console.log(err)
|
|
throw err
|
|
}
|
|
})
|
|
|
|
afterEach(async () => {
|
|
const db = useDb()
|
|
await db.teardown()
|
|
})
|
|
|
|
it("removes multiple customers from a group", async () => {
|
|
const api = useApi()
|
|
|
|
const payload = {
|
|
customer_ids: [{ id: "test-customer-5" }, { id: "test-customer-6" }],
|
|
}
|
|
|
|
const batchAddResponse = await api
|
|
.delete("/admin/customer-groups/test-group-5/customers/batch", {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
data: payload,
|
|
})
|
|
.catch((err) => console.log(err))
|
|
|
|
expect(batchAddResponse.status).toEqual(200)
|
|
expect(batchAddResponse.data).toEqual({
|
|
customer_group: expect.objectContaining({
|
|
id: "test-group-5",
|
|
name: "test-group-5",
|
|
}),
|
|
})
|
|
|
|
const getCustomerResponse = await api.get(
|
|
"/admin/customers?expand=groups",
|
|
{
|
|
headers: { Authorization: "Bearer test_token" },
|
|
}
|
|
)
|
|
|
|
expect(getCustomerResponse.data.customers).toEqual(
|
|
expect.arrayContaining([
|
|
expect.objectContaining({
|
|
id: "test-customer-5",
|
|
groups: [],
|
|
}),
|
|
expect.objectContaining({
|
|
id: "test-customer-6",
|
|
groups: [],
|
|
}),
|
|
])
|
|
)
|
|
})
|
|
|
|
it("removes customers from only one group", async () => {
|
|
const api = useApi()
|
|
|
|
const payload = {
|
|
customer_ids: [{ id: "test-customer-7" }],
|
|
}
|
|
|
|
const batchAddResponse = await api
|
|
.delete("/admin/customer-groups/test-group-5/customers/batch", {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
data: payload,
|
|
})
|
|
.catch((err) => console.log(err))
|
|
|
|
expect(batchAddResponse.status).toEqual(200)
|
|
expect(batchAddResponse.data).toEqual({
|
|
customer_group: expect.objectContaining({
|
|
id: "test-group-5",
|
|
name: "test-group-5",
|
|
}),
|
|
})
|
|
|
|
const getCustomerResponse = await api.get(
|
|
"/admin/customers/test-customer-7?expand=groups",
|
|
{
|
|
headers: { Authorization: "Bearer test_token" },
|
|
}
|
|
)
|
|
|
|
expect(getCustomerResponse.data.customer).toEqual(
|
|
expect.objectContaining({
|
|
id: "test-customer-7",
|
|
groups: [
|
|
expect.objectContaining({
|
|
id: "test-group-6",
|
|
name: "test-group-6",
|
|
}),
|
|
],
|
|
})
|
|
)
|
|
})
|
|
|
|
it("removes only select customers from a group", async () => {
|
|
const api = useApi()
|
|
|
|
// re-adding customer-1 to the customer group along with new addintion:
|
|
// customer-2 and some non-existing customers should cause the request to fail
|
|
const payload = {
|
|
customer_ids: [{ id: "test-customer-5" }],
|
|
}
|
|
|
|
await api.delete("/admin/customer-groups/test-group-5/customers/batch", {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
data: payload,
|
|
})
|
|
|
|
// check that customer-1 is only added once and that customer-2 is added correctly
|
|
const getCustomerResponse = await api
|
|
.get("/admin/customers?expand=groups", {
|
|
headers: { Authorization: "Bearer test_token" },
|
|
})
|
|
.catch((err) => console.log(err))
|
|
|
|
expect(getCustomerResponse.data.customers).toEqual(
|
|
expect.arrayContaining([
|
|
expect.objectContaining({
|
|
id: "test-customer-5",
|
|
groups: [],
|
|
}),
|
|
expect.objectContaining({
|
|
id: "test-customer-6",
|
|
groups: [
|
|
expect.objectContaining({
|
|
name: "test-group-5",
|
|
id: "test-group-5",
|
|
}),
|
|
],
|
|
}),
|
|
])
|
|
)
|
|
})
|
|
|
|
it("removes customers from a group idempotently", async () => {
|
|
const api = useApi()
|
|
|
|
// re-adding customer-1 to the customer group along with new addintion:
|
|
// customer-2 and some non-existing customers should cause the request to fail
|
|
const payload = {
|
|
customer_ids: [{ id: "test-customer-5" }],
|
|
}
|
|
|
|
await api.delete("/admin/customer-groups/test-group-5/customers/batch", {
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
data: payload,
|
|
})
|
|
|
|
const idempotentRes = await api.delete(
|
|
"/admin/customer-groups/test-group-5/customers/batch",
|
|
{
|
|
headers: {
|
|
Authorization: "Bearer test_token",
|
|
},
|
|
data: payload,
|
|
}
|
|
)
|
|
|
|
expect(idempotentRes.status).toEqual(200)
|
|
expect(idempotentRes.data).toEqual({
|
|
customer_group: expect.objectContaining({
|
|
id: "test-group-5",
|
|
name: "test-group-5",
|
|
}),
|
|
})
|
|
})
|
|
})
|
|
})
|