Skip to content

Commit

Permalink
Merge pull request #3039 from microsoft-search/fix/2577
Browse files Browse the repository at this point in the history 
Fix for number tokens in refinement strings
  • Loading branch information
@wobba
wobba committed Jun 4, 2023
2 parents 52d0d90 + a6e3c41 commit 7b46e44
Showing 1 changed file with 117 additions and 117 deletions.
234 changes: 117 additions & 117 deletions search-parts/src/helpers/DataFilterHelper.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,109 +4,109 @@ import { BuiltinTokenNames } from "../services/tokenService/TokenService";

export class DataFilterHelper {

/**
* Returns the configuration for a specific filter
* @param filter the filter
* @param filtersConfiguration the filtes configuraton
*/
public static getConfigurationForFilter(filter: IDataFilter | IDataFilterResult, filtersConfiguration: IDataFilterConfiguration[]): IDataFilterConfiguration {

// Get the configuration for this filter
let filterConfiguration: IDataFilterConfiguration = undefined;
const filterConfigIdx = filtersConfiguration.map(configuration => { return configuration.filterName; }).indexOf(filter.filterName);

if (filterConfigIdx !== -1) {
filterConfiguration = filtersConfiguration[filterConfigIdx];
/**
* Returns the configuration for a specific filter
* @param filter the filter
* @param filtersConfiguration the filtes configuraton
*/
public static getConfigurationForFilter(filter: IDataFilter | IDataFilterResult, filtersConfiguration: IDataFilterConfiguration[]): IDataFilterConfiguration {

// Get the configuration for this filter
let filterConfiguration: IDataFilterConfiguration = undefined;
const filterConfigIdx = filtersConfiguration.map(configuration => { return configuration.filterName; }).indexOf(filter.filterName);

if (filterConfigIdx !== -1) {
filterConfiguration = filtersConfiguration[filterConfigIdx];
}

return filterConfiguration;
}

return filterConfiguration;
}
/**
* Returns the selected filters by type
* @param filters the list of selected filters
* @param type the filter type to get
* @param filtersConfiguration to filters configuration
*/
public static getSelectedFilterValuesByType(filters: IDataFilter[], type: FilterType, filtersConfiguration: IDataFilterConfiguration[]): string[] {

/**
* Returns the selected filters by type
* @param filters the list of selected filters
* @param type the filter type to get
* @param filtersConfiguration to filters configuration
*/
public static getSelectedFilterValuesByType(filters: IDataFilter[], type: FilterType, filtersConfiguration: IDataFilterConfiguration[]): string[] {
let selectedValues: string[] = [];

let selectedValues: string[] = [];
filters.forEach(filter => {

filters.forEach(filter => {
const configuration = this.getConfigurationForFilter(filter, filtersConfiguration);
if (configuration && configuration.type === type) {
selectedValues = selectedValues.concat(filter.values.map(value => value.value));
}
});

const configuration = this.getConfigurationForFilter(filter, filtersConfiguration);
if (configuration && configuration.type === type) {
selectedValues = selectedValues.concat(filter.values.map(value => value.value));
}
});
return selectedValues.sort();
}

return selectedValues.sort();
}
/**
* Determines if filters have been applied via tokens in the string
* @param selectedFilters the current selected filters
* @param inputString the string with tokens
*/
public static getAppliedFiltersFromTokens(selectedFilters: IDataFilter[], inputString: string): IDataFilter[] {

/**
* Determines if filters have been applied via tokens in the string
* @param selectedFilters the current selected filters
* @param inputString the string with tokens
*/
public static getAppliedFiltersFromTokens(selectedFilters: IDataFilter[], inputString: string): IDataFilter[] {
const tokens = inputString.match(/\{[^\{]*?\}/gi);
let selectedFiltersInTokens: IDataFilter[] = [];

const tokens = inputString.match(/\{[^\{]*?\}/gi);
let selectedFiltersInTokens: IDataFilter[] = [];
if (tokens !== null && tokens.length > 0) {

if (tokens !== null && tokens.length > 0) {
tokens.forEach(token => {

tokens.forEach(token => {
// Take the expression inside curly brackets
const tokenName = token.substr(1).slice(0, -1);
const tokenParts = tokenName.split('.');

// Take the expression inside curly brackets
const tokenName = token.substr(1).slice(0, -1);
const tokenParts = tokenName.split('.');
// If contains 'filters.XXX'
if (tokenName.indexOf(BuiltinTokenNames.filters) !== -1 && tokenParts.length > 1) {

// If contains 'filters.XXX'
if (tokenName.indexOf(BuiltinTokenNames.filters) !== -1 && tokenParts.length > 1) {

// See if the filter name is selected. 'tokenParts[1]' should be the filter name
const selectedFiltersByName = selectedFilters.filter(selectedFilter => selectedFilter.filterName === tokenParts[1]);
const alreadyAddedFitlers = selectedFiltersInTokens.filter(selectedFiltersInToken => selectedFiltersInToken.filterName === tokenParts[1]);
// See if the filter name is selected. 'tokenParts[1]' should be the filter name
const selectedFiltersByName = selectedFilters.filter(selectedFilter => selectedFilter.filterName === tokenParts[1]);
const alreadyAddedFitlers = selectedFiltersInTokens.filter(selectedFiltersInToken => selectedFiltersInToken.filterName === tokenParts[1]);

if (selectedFiltersByName.length > 0 && alreadyAddedFitlers.length === 0) {
selectedFiltersInTokens.push(selectedFilters[0]);
}
}
});
if (selectedFiltersByName.length > 0 && alreadyAddedFitlers.length === 0) {
selectedFiltersInTokens.push(selectedFilters[0]);
}
}
});
}

return selectedFiltersInTokens;
}

return selectedFiltersInTokens;
}
/**
* Build the refinement condition in FQL format
* @param selectedFilters The selected filter array
* @param filtersConfiguration The current filters configuration
* @param moment The moment.js instance to resolve dates
* @param encodeTokens If true, encodes the taxonomy refinement tokens in UTF-8 to work with GET requests. Javascript encodes natively in UTF-16 by default.
*/
public static buildFqlRefinementString(selectedFilters: IDataFilter[], filtersConfiguration: IDataFilterConfiguration[], moment: any, encodeTokens?: boolean): string[] {

/**
* Build the refinement condition in FQL format
* @param selectedFilters The selected filter array
* @param filtersConfiguration The current filters configuration
* @param moment The moment.js instance to resolve dates
* @param encodeTokens If true, encodes the taxonomy refinement tokens in UTF-8 to work with GET requests. Javascript encodes natively in UTF-16 by default.
*/
public static buildFqlRefinementString(selectedFilters: IDataFilter[], filtersConfiguration: IDataFilterConfiguration[], moment: any, encodeTokens?: boolean): string[] {

let refinementQueryConditions: string[] = [];
let refinementQueryConditions: string[] = [];

selectedFilters.forEach(filter => {
selectedFilters.forEach(filter => {

let operator: any = filter.operator;
let operator: any = filter.operator;

// Mutli values
if (filter.values.length > 1) {
// Mutli values
if (filter.values.length > 1) {

let startDate = null;
let endDate = null;
let startBehaviour = "GE";
let endBehavior = "LE";
let startDate = null;
let endDate = null;
let startBehaviour = "GE";
let endBehavior = "LE";

// A refiner can have multiple values selected in a multi or mon multi selection scenario
// The correct operator is determined by the refiner display template according to its behavior
const conditions = filter.values.map(filterValue => {
// A refiner can have multiple values selected in a multi or mon multi selection scenario
// The correct operator is determined by the refiner display template according to its behavior
const conditions = filter.values.map(filterValue => {

let value = filterValue.value;

if (moment(value, moment.ISO_8601, true).isValid()) {

if (!startDate && (filterValue.operator === FilterComparisonOperator.Geq || filterValue.operator === FilterComparisonOperator.Gt)) {
Expand All @@ -123,63 +123,63 @@ export class DataFilterHelper {
// If the value is null or undefined, we replace it by the FQL expression string('')
// Otherwise the query syntax won't be vaild resuting of to an HTTP 500
if (isEmpty(value)) {
value = "string('')";
value = "string('')";
}

// Enclose the expression with quotes if the value contains spaces
if (/\s/.test(value) && value.indexOf('range') === -1) {
value = `"${value}"`;
// Enclose the expression with quotes if the value contains spaces, or number only
if ((/\s/.test(value) && value.indexOf('range') === -1) || (filter.filterName.indexOf("RefinableString") && /^\d+$/.test(value))) {
value = `"${value}"`;
}

return /ǂǂ/.test(value) && encodeTokens ? encodeURIComponent(value) : value;

}).filter(c => c);

if (startDate && endDate) {
refinementQueryConditions.push(`${filter.filterName}:range(${startDate},${endDate},from="${startBehaviour}",to="${endBehavior}")`);
}).filter(c => c);

if (startDate && endDate) {
refinementQueryConditions.push(`${filter.filterName}:range(${startDate},${endDate},from="${startBehaviour}",to="${endBehavior}")`);
} else {
refinementQueryConditions.push(`${filter.filterName}:${operator}(${conditions.join(',')})`);
}

} else {
refinementQueryConditions.push(`${filter.filterName}:${operator}(${conditions.join(',')})`);
}

} else {
// Single value
if (filter.values.length === 1) {

// Single value
if (filter.values.length === 1) {
const filterValue = filter.values[0];

const filterValue = filter.values[0];
// See https://sharepoint.stackexchange.com/questions/258081/how-to-hex-encode-refiners/258161
let refinementToken = /ǂǂ/.test(filterValue.value) && encodeTokens ? encodeURIComponent(filterValue.value) : filterValue.value;

// See https://sharepoint.stackexchange.com/questions/258081/how-to-hex-encode-refiners/258161
let refinementToken = /ǂǂ/.test(filterValue.value) && encodeTokens ? encodeURIComponent(filterValue.value) : filterValue.value;
// https://docs.microsoft.com/en-us/sharepoint/dev/general-development/fast-query-language-fql-syntax-reference#fql_range_operator
if (moment(refinementToken, moment.ISO_8601, true).isValid()) {

// https://docs.microsoft.com/en-us/sharepoint/dev/general-development/fast-query-language-fql-syntax-reference#fql_range_operator
if (moment(refinementToken, moment.ISO_8601, true).isValid()) {
if (filterValue.operator === FilterComparisonOperator.Gt || filterValue.operator === FilterComparisonOperator.Geq) {
refinementToken = `range(${refinementToken},max)`;
}

if (filterValue.operator === FilterComparisonOperator.Gt || filterValue.operator === FilterComparisonOperator.Geq) {
refinementToken = `range(${refinementToken},max)`;
// Ex: scenario ('older than a year')
if (filterValue.operator === FilterComparisonOperator.Leq || filterValue.operator === FilterComparisonOperator.Lt) {
refinementToken = `range(min,${refinementToken})`;
}
}

// Ex: scenario ('older than a year')
if (filterValue.operator === FilterComparisonOperator.Leq || filterValue.operator === FilterComparisonOperator.Lt) {
refinementToken = `range(min,${refinementToken})`;
// If the value is null or undefined, we replace it by the FQL expression string('')
// Otherwise the query syntax won't be vaild resuting of to an HTTP 500
if (isEmpty(refinementToken)) {
refinementToken = "string('')";
}
}

// If the value is null or undefined, we replace it by the FQL expression string('')
// Otherwise the query syntax won't be vaild resuting of to an HTTP 500
if (isEmpty(refinementToken)) {
refinementToken = "string('')";
}
// Enclose the expression with quotes if the value contains spaces
if (/\s/.test(refinementToken) && refinementToken.indexOf('range') === -1) {
refinementToken = `"${refinementToken}"`;
}

// Enclose the expression with quotes if the value contains spaces
if (/\s/.test(refinementToken) && refinementToken.indexOf('range') === -1) {
refinementToken = `"${refinementToken}"`;
refinementQueryConditions.push(`${filter.filterName}:${refinementToken}`);
}

refinementQueryConditions.push(`${filter.filterName}:${refinementToken}`);
}
}
});
});

return refinementQueryConditions;
}
return refinementQueryConditions;
}
}

0 comments on commit 7b46e44

Please sign in to comment.