addsearch-search-ui/src/actions/search.js

JavaScript library to develop Search UIs for the web

/* global window */
import { WARMUP_QUERY_PREFIX } from '../index';
import { setHistory, HISTORY_PARAMETERS } from '../util/history';
import { sendSearchStats } from '../util/analytics';

export const START = 'START';
export const SET_SEARCH_RESULTS_PAGE_URL = 'SET_SEARCH_RESULTS_PAGE_URL';
export const SEARCH_FETCH_START = 'SEARCH_FETCH_START';
export const SEARCH_RESULTS = 'SEARCH_RESULTS';
export const CLEAR_SEARCH_RESULTS = 'CLEAR_SEARCH_RESULTS';
export const SEARCH_BY_COMPONENT = 'SEARCH_BY_COMPONENT';

export function start() {
  return {
    type: START
  }
}

function _matchKeywordToCustomFieldValue(keyword, hits, field) {
  return hits.find((hit) => {
    if (!hit.custom_fields || !hit.custom_fields[field]) {
      return false;
    }
    if (typeof hit.custom_fields[field] === 'string') {
      return keyword.toLowerCase() === hit.custom_fields[field].toLowerCase();
    }
    if (typeof hit.custom_fields[field] === 'object' && hit.custom_fields[field].length) {
      const customFieldsInLowerCase = hit.custom_fields[field].map(val => val.toLowerCase());
      const keywordInLowerCase = keyword.toLowerCase();
      return customFieldsInLowerCase.indexOf(keywordInLowerCase) > -1;
    }
    return false;
  });
}

export function search(client, keyword, onResultsScrollTo, appendResults, isHistoryDebounced, store,
                       fieldForInstantRedirect, requestBy, fieldForInstantRedirectGlobal) {
  // Update browser history
  setHistory(HISTORY_PARAMETERS.SEARCH, keyword, isHistoryDebounced, store);

  // Clear search results if there is no keyword
  if (!keyword || keyword === '') {
    return {
      type: CLEAR_SEARCH_RESULTS
    }
  }
  return dispatch => {
    dispatch(searchFetchStart());
    client.search(keyword, (res) => {
      if ((fieldForInstantRedirectGlobal || fieldForInstantRedirect) && res && res.hits && res.hits.length) {
        var field = fieldForInstantRedirectGlobal || fieldForInstantRedirect;
        var customFieldName = field.replace('custom_fields.', '');
        var matchedHit = _matchKeywordToCustomFieldValue(keyword, res.hits, customFieldName);

        if (matchedHit && !isHistoryDebounced) {
          window.location.replace(matchedHit.url);
          return;
        }
      }
      dispatch(searchResults(client, keyword, res, onResultsScrollTo, appendResults, requestBy));
    });
  }
}

export function searchFetchStart(keyword) {
  return {
    type: SEARCH_FETCH_START
  }
}

export function searchResults(client, keyword, results, onResultsScrollTo, appendResults, requestBy) {
  if (/top-delay-\d*$/.test(onResultsScrollTo)) {
    var delayInMs = parseInt(onResultsScrollTo.replace('top-delay-', ''), 10);
    window.setTimeout(function() {
      window.scrollTo(0, 0);
    }, delayInMs);
  } else if (onResultsScrollTo === 'top') {
    window.scrollTo(0, 0);
  }

  // Feed stats if not a warmup query
  if (keyword && keyword.indexOf(WARMUP_QUERY_PREFIX) === -1) {
    const hits = results ? results.total_hits : 0;
    const time = results ? results.processing_time_ms : 0;
    sendSearchStats(client, keyword, hits, time);
  }

  return {
    type: SEARCH_RESULTS,
    keyword,
    results,
    appendResults,
    requestBy
  }
}

export function clearSearchResults(scrollTo) {
  if (scrollTo === 'top') {
    window.scrollTo(0, 0);
  }

  return {
    type: CLEAR_SEARCH_RESULTS
  }
}

export function setSearchResultsPageUrl(url) {
  return {
    type: SET_SEARCH_RESULTS_PAGE_URL,
    url
  }
}