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

fix(routing): ensure UiState is cleaned up allowing "undefined" for values #5956

Merged
merged 5 commits into from
Dec 7, 2023
Merged

fix(routing): ensure UiState is cleaned up allowing "undefined" for values #5956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
55fbb9e
test(routing): enforce compatibility with "unsafe" uiState
Haroenv Dec 7, 2023
cbc7f32
fix(widgets): safely clean up UiState
Haroenv Dec 7, 2023
c35a1ab
!fixup
Haroenv Dec 7, 2023
ef88b45
!fixup
Haroenv Dec 7, 2023
ab708dd
all good
Haroenv Dec 7, 2023
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
52 changes: 26 additions & 26 deletions packages/instantsearch.js/src/connectors/breadcrumb/connectBreadcrumb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,13 +244,16 @@ const connectBreadcrumb: BreadcrumbConnector = function connectBreadcrumb(
hierarchicalFacetName
);

return removeEmptyRefinementsFromUiState({
...uiState,
hierarchicalMenu: {
...uiState.hierarchicalMenu,
[hierarchicalFacetName]: path,
return removeEmptyRefinementsFromUiState(
{
...uiState,
hierarchicalMenu: {
...uiState.hierarchicalMenu,
[hierarchicalFacetName]: path,
},
},
});
hierarchicalFacetName
);
},

getWidgetSearchParameters(searchParameters, { uiState }) {
Expand Down Expand Up @@ -333,29 +336,26 @@ function shiftItemsValues(array: BreadcrumbConnectorParamsItem[]) {
}));
}

function removeEmptyRefinementsFromUiState(indexUiState: IndexUiState) {
const { hierarchicalMenu, ...indexUiStateBase } = indexUiState;

if (!hierarchicalMenu) {
function removeEmptyRefinementsFromUiState(
indexUiState: IndexUiState,
attribute: string
): IndexUiState {
if (!indexUiState.hierarchicalMenu) {
return indexUiState;
}

const connectorUiState = Object.keys(hierarchicalMenu).reduce(
(acc, key) => ({
...acc,
...(hierarchicalMenu[key].length > 0
? { [key]: hierarchicalMenu[key] }
: {}),
}),
{}
);

return {
...indexUiStateBase,
...(Object.keys(connectorUiState).length > 0
? { hierarchicalMenu: connectorUiState }
: {}),
};
if (
!indexUiState.hierarchicalMenu[attribute] ||
!indexUiState.hierarchicalMenu[attribute].length
) {
delete indexUiState.hierarchicalMenu[attribute];
}

if (Object.keys(indexUiState.hierarchicalMenu).length === 0) {
delete indexUiState.hierarchicalMenu;
}

return indexUiState;
}

export default connectBreadcrumb;
52 changes: 26 additions & 26 deletions packages/instantsearch.js/src/connectors/hierarchical-menu/connectHierarchicalMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,13 +397,16 @@ const connectHierarchicalMenu: HierarchicalMenuConnector =
hierarchicalFacetName
);

return removeEmptyRefinementsFromUiState({
...uiState,
hierarchicalMenu: {
...uiState.hierarchicalMenu,
[hierarchicalFacetName]: path,
return removeEmptyRefinementsFromUiState(
{
...uiState,
hierarchicalMenu: {
...uiState.hierarchicalMenu,
[hierarchicalFacetName]: path,
},
},
});
hierarchicalFacetName
);
},

getWidgetSearchParameters(searchParameters, { uiState }) {
Expand Down Expand Up @@ -479,29 +482,26 @@ As this is not supported, please make sure to remove this other widget or this H
};
};

function removeEmptyRefinementsFromUiState(indexUiState: IndexUiState) {
const { hierarchicalMenu, ...indexUiStateBase } = indexUiState;

if (!hierarchicalMenu) {
function removeEmptyRefinementsFromUiState(
indexUiState: IndexUiState,
attribute: string
): IndexUiState {
if (!indexUiState.hierarchicalMenu) {
return indexUiState;
}

const connectorUiState = Object.keys(hierarchicalMenu).reduce(
(acc, key) => ({
...acc,
...(hierarchicalMenu[key].length > 0
? { [key]: hierarchicalMenu[key] }
: {}),
}),
{}
);

return {
...indexUiStateBase,
...(Object.keys(connectorUiState).length > 0
? { hierarchicalMenu: connectorUiState }
: {}),
};
if (
!indexUiState.hierarchicalMenu[attribute] ||
indexUiState.hierarchicalMenu[attribute].length === 0
) {
delete indexUiState.hierarchicalMenu[attribute];
}

if (Object.keys(indexUiState.hierarchicalMenu).length === 0) {
delete indexUiState.hierarchicalMenu;
}

return indexUiState;
}

export default connectHierarchicalMenu;
47 changes: 23 additions & 24 deletions packages/instantsearch.js/src/connectors/menu/connectMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,13 +334,16 @@ const connectMenu: MenuConnector = function connectMenu(
const [value] =
searchParameters.getHierarchicalFacetBreadcrumb(attribute);

return removeEmptyRefinementsFromUiState({
...uiState,
menu: {
...uiState.menu,
[attribute]: value,
return removeEmptyRefinementsFromUiState(
{
...uiState,
menu: {
...uiState.menu,
[attribute]: value,
},
},
});
attribute
);
},

getWidgetSearchParameters(searchParameters, { uiState }) {
Expand Down Expand Up @@ -397,27 +400,23 @@ As this is not supported, please make sure to remove this other widget or this M
};
};

function removeEmptyRefinementsFromUiState(indexUiState: IndexUiState) {
const { menu, ...indexUiStateBase } = indexUiState;

if (!menu) {
function removeEmptyRefinementsFromUiState(
indexUiState: IndexUiState,
attribute: string
): IndexUiState {
if (!indexUiState.menu) {
return indexUiState;
}

const connectorUiState = Object.keys(menu).reduce(
(acc, key) => ({
...acc,
...(menu[key]?.length > 0 ? { [key]: menu[key] } : {}),
}),
{}
);

return {
...indexUiStateBase,
...(Object.keys(connectorUiState).length > 0
? { menu: connectorUiState }
: {}),
};
if (indexUiState.menu[attribute] === undefined) {
delete indexUiState.menu[attribute];
}

if (Object.keys(indexUiState.menu).length === 0) {
delete indexUiState.menu;
}

return indexUiState;
}

export default connectMenu;
45 changes: 22 additions & 23 deletions packages/instantsearch.js/src/connectors/numeric-menu/connectNumericMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,13 +235,16 @@ const connectNumericMenu: NumericMenuConnector = function connectNumericMenu(
const min = (values['>='] && values['>='][0]) || '';
const max = (values['<='] && values['<='][0]) || '';

return removeEmptyRefinementsFromUiState({
...uiState,
numericMenu: {
...uiState.numericMenu,
[attribute]: `${min}:${max}`,
return removeEmptyRefinementsFromUiState(
{
...uiState,
numericMenu: {
...uiState.numericMenu,
[attribute]: `${min}:${max}`,
},
},
});
attribute
);
},

getWidgetSearchParameters(searchParameters, { uiState }) {
Expand Down Expand Up @@ -483,27 +486,23 @@ function hasNumericRefinement(
);
}

function removeEmptyRefinementsFromUiState(indexUiState: IndexUiState) {
const { numericMenu, ...indexUiStateBase } = indexUiState;

if (!numericMenu) {
function removeEmptyRefinementsFromUiState(
indexUiState: IndexUiState,
attribute: string
): IndexUiState {
if (!indexUiState.numericMenu) {
return indexUiState;
}

const connectorUiState = Object.keys(numericMenu).reduce(
(acc, key) => ({
...acc,
...(numericMenu[key] !== ':' ? { [key]: numericMenu[key] } : {}),
}),
{}
);
if (indexUiState.numericMenu[attribute] === ':') {
delete indexUiState.numericMenu[attribute];
}

return {
...indexUiStateBase,
...(Object.keys(connectorUiState).length > 0
? { numericMenu: connectorUiState }
: {}),
};
if (Object.keys(indexUiState.numericMenu).length === 0) {
delete indexUiState.numericMenu;
}

return indexUiState;
}

export default connectNumericMenu;
49 changes: 23 additions & 26 deletions packages/instantsearch.js/src/connectors/rating-menu/connectRatingMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,13 +439,16 @@ const connectRatingMenu: RatingMenuConnector = function connectRatingMenu(
getWidgetUiState(uiState, { searchParameters }) {
const value = getRefinedStar(searchParameters);

return removeEmptyRefinementsFromUiState({
...uiState,
ratingMenu: {
...uiState.ratingMenu,
[attribute]: typeof value === 'number' ? value : undefined,
return removeEmptyRefinementsFromUiState(
{
...uiState,
ratingMenu: {
...uiState.ratingMenu,
[attribute]: typeof value === 'number' ? value : undefined,
},
},
});
attribute
);
},

getWidgetSearchParameters(searchParameters, { uiState }) {
Expand All @@ -472,29 +475,23 @@ const connectRatingMenu: RatingMenuConnector = function connectRatingMenu(
};
};

function removeEmptyRefinementsFromUiState(indexUiState: IndexUiState) {
const { ratingMenu, ...indexUiStateBase } = indexUiState;

if (!ratingMenu) {
function removeEmptyRefinementsFromUiState(
indexUiState: IndexUiState,
attribute: string
): IndexUiState {
if (!indexUiState.ratingMenu) {
return indexUiState;
}

const connectorUiState = Object.keys(ratingMenu).reduce(
(acc, key) => ({
...acc,
...(typeof ratingMenu[key] === 'number'
? { [key]: ratingMenu[key] }
: {}),
}),
{}
);

return {
...indexUiStateBase,
...(Object.keys(connectorUiState).length > 0
? { ratingMenu: connectorUiState }
: {}),
};
if (typeof indexUiState.ratingMenu[attribute] !== 'number') {
delete indexUiState.ratingMenu[attribute];
}

if (Object.keys(indexUiState.ratingMenu).length === 0) {
delete indexUiState.ratingMenu;
}

return indexUiState;
}

export default connectRatingMenu;
Loading