Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

Commit

Permalink
feat(client): prevent displaying redundant product options (#342)
Browse files Browse the repository at this point in the history 
* feat: PoC - prevent displaying redundant product options
  • Loading branch information
@mkucmus
mkucmus authored Feb 5, 2020
1 parent 7a4fc2f commit ff1836a
Show file tree
Hide file tree
Showing 10 changed files with 296 additions and 156 deletions.
3 changes: 2 additions & 1 deletion packages/composables/src/hooks/useProductListing.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,12 @@ export const useProductListing = (
filters: getFilterSearchCriteria(selectedCriteria.filters),
sort: getSortingSearchCriteria(selectedCriteria.sorting),
configuration: {
// get product variant options
// fetch variant options
associations: [
{
name: "options"
},
// fetch productReviews
{
name: "productReviews"
}
Expand Down
8 changes: 8 additions & 0 deletions packages/shopware-6-client/__tests__/helpers/convertAssociations.spec.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { convertAssociations } from "../../src/helpers/convertAssociations";

describe("SearchConverter - convertAssociations", () => {
it("should return undefined if no params provided", () => {
const result = convertAssociations();
expect(result).toBeUndefined();
});
});
222 changes: 142 additions & 80 deletions packages/shopware-6-client/__tests__/helpers/convertSearchCriteria.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,20 @@ describe("SearchConverter - convertSearchCriteria", () => {
const result = convertSearchCriteria({
pagination: { page: PaginationLimit.ONE }
});
expect(result).toEqual({ page: 1, limit: config.defaultPaginationLimit });
expect(result?.page).toEqual(1);
expect(result?.limit).toEqual(config.defaultPaginationLimit);
});
it("should have page number", () => {
const result = convertSearchCriteria({ pagination: { limit: 5 } });
expect(result).toEqual({ limit: 5 });
expect(result?.limit).toEqual(5);
});
it("should not have not existing limit", () => {
const result = convertSearchCriteria({ pagination: { limit: 7 } });
expect(result).toEqual({});
expect(result).not.toHaveProperty("limit");
});
it("should not add pagination for an empty object", () => {
const result = convertSearchCriteria({ pagination: {} });
expect(result).toEqual({});
expect(result).not.toHaveProperty("page");
});
it("should have full pagination info", () => {
const result = convertSearchCriteria({
Expand All @@ -42,14 +43,16 @@ describe("SearchConverter - convertSearchCriteria", () => {
limit: 5
}
});
expect(result).toEqual({ page: 3, limit: 5 });
expect(result?.page).toEqual(3);
expect(result?.limit).toEqual(5);
});
it("should change default pagination limit", () => {
update({ defaultPaginationLimit: 50 });
const result = convertSearchCriteria({
pagination: { page: PaginationLimit.ONE }
});
expect(result).toEqual({ page: 1, limit: 50 });
expect(result?.page).toEqual(1);
expect(result?.limit).toEqual(50);
});
});
describe("sorting", () => {
Expand All @@ -61,11 +64,9 @@ describe("SearchConverter - convertSearchCriteria", () => {
},
filters: []
});
expect(paramsObject).toEqual({
page: 1,
limit: config.defaultPaginationLimit,
sort: "name"
});
expect(paramsObject?.page).toEqual(1);
expect(paramsObject?.limit).toEqual(config.defaultPaginationLimit);
expect(paramsObject?.sort).toEqual("name");
});
it("should add prefix when desc sort", () => {
const result = convertSearchCriteria({
Expand All @@ -74,16 +75,10 @@ describe("SearchConverter - convertSearchCriteria", () => {
desc: true
}
});
expect(result).toEqual({ sort: "-name" });
expect(result?.sort).toEqual("-name");
});
});
describe("filters", () => {
it("should not have filter property if empty array provided", () => {
const paramsObject = convertSearchCriteria({
filters: []
});
expect(paramsObject).toEqual({});
});
describe("EQUALS filters", () => {
it("should filter by name", () => {
const nameFilter: EqualsFilter = {
Expand All @@ -94,14 +89,10 @@ describe("SearchConverter - convertSearchCriteria", () => {
const result = convertSearchCriteria({
filters: [nameFilter]
});
expect(result).toEqual({
filter: [
{
type: "equals",
value: "Aerodynamic Iron Jetsilk",
field: "name"
}
]
expect(result?.filter?.[0]).toEqual({
type: "equals",
value: "Aerodynamic Iron Jetsilk",
field: "name"
});
});
});
Expand All @@ -118,17 +109,13 @@ describe("SearchConverter - convertSearchCriteria", () => {
const result = convertSearchCriteria({
filters: [nameFilter]
});
expect(result).toEqual({
filter: [
{
type: "range",
field: "price",
parameters: {
lt: 120,
gte: 5
}
}
]
expect(result?.filter?.[0]).toEqual({
type: "range",
field: "price",
parameters: {
lt: 120,
gte: 5
}
});
});
});
Expand Down Expand Up @@ -165,46 +152,115 @@ describe("SearchConverter - convertSearchCriteria", () => {
const result = convertSearchCriteria({
filters: [priceAndNamesFilter]
});
expect(result?.filter).toEqual([
{
type: "multi",
operator: "AND",
queries: [
{
type: "range",
field: "price",
parameters: {
gte: 0,
lte: 200
}
},

{
type: "multi",
operator: "OR",
queries: [
{
type: "equals",
value: "Aerodynamic Iron Jetsilk",
field: "name"
},

{
type: "equals",
value: "Rustic Copper Jimbies",
field: "name"
}
]
}
]
},
{
type: "not",
queries: [
{
type: "equals",
field: "displayGroup",
value: null
}
]
}
]);
});
});
});
describe("configuration", () => {
describe("displayParents", () => {
it("should not return displayGroup grouped parameter and appropriate filter when displayParents switch is on", () => {
const result = convertSearchCriteria({
filters: {},
configuration: {
displayParents: true
}
} as any);
expect(result).toEqual({});
});
it("should return displayGroup grouped parameter and appropriate filter by default", () => {
const result = convertSearchCriteria({
filters: [
{
type: "equals",
field: "name",
value: "test"
} as any
],
sort: {
field: "name",
desc: true
}
});
expect(result).toEqual({
grouping: {
field: "displayGroup"
},
filter: [
{
type: "multi",
operator: "AND",
field: "name",
type: "equals",
value: "test"
},
{
type: "not",
queries: [
{
type: "range",
field: "price",
parameters: {
gte: 0,
lte: 200
}
},

{
type: "multi",
operator: "OR",
queries: [
{
type: "equals",
value: "Aerodynamic Iron Jetsilk",
field: "name"
},

{
type: "equals",
value: "Rustic Copper Jimbies",
field: "name"
}
]
type: "equals",
field: "displayGroup",
value: null
}
]
}
]
],
sort: "-name"
});
});
});
});
describe("configuration", () => {
describe("grouping", () => {
it("should return grouped field", () => {
const result = convertSearchCriteria({
configuration: {
grouping: {
field: "displayGroup"
}
}
});
expect(result?.grouping).toEqual({ field: "displayGroup" });
});
});
describe("associations", () => {
it("should return association", () => {
const result = convertSearchCriteria({
Expand All @@ -216,7 +272,7 @@ describe("SearchConverter - convertSearchCriteria", () => {
]
}
});
expect(result).toEqual({ associations: { media: {} } });
expect(result?.associations).toEqual({ media: {} });
});

it("should not add associations on empty array", () => {
Expand All @@ -225,23 +281,31 @@ describe("SearchConverter - convertSearchCriteria", () => {
associations: []
}
});
expect(result).toEqual({});
expect(result).toHaveProperty("associations");
});

it("should return multiple associations", () => {
const result = convertSearchCriteria({
configuration: {
associations: [
{
name: "media"
name: "media",
associations: [
{
name: "cover"
}
]
},
{
name: "stock"
}
]
}
});
expect(result).toEqual({ associations: { media: {}, stock: {} } });
expect(result?.associations).toEqual({
media: { associations: { cover: {} } },
stock: {}
});
});

it("should return deep association", () => {
Expand All @@ -262,16 +326,14 @@ describe("SearchConverter - convertSearchCriteria", () => {
]
}
});
expect(result).toEqual({
associations: {
cmsPage: {
associations: {
sections: {
associations: {
blocks: {
associations: {
slots: {}
}
expect(result?.associations).toEqual({
cmsPage: {
associations: {
sections: {
associations: {
blocks: {
associations: {
slots: {}
}
}
}
Expand Down
Loading

1 comment on commit ff1836a

@github-actions
Copy link

Choose a reason for hiding this comment

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

Deploy preview for website ready!

Built with commit 2d6d65a

https://shopware-pwa-1qli20ipa.now.sh

Please sign in to comment.