Search refactor [WIP]

definition/entity/container.js

@@ -11,11 +11,6 @@ var checkIsObject = require('../../util/object/check');
  */
 const SEPARATOR = ".";
 
-/**
- * Definition of the search informations.
- * @type {object}
- */
-var searchDefinition = require('../../store/search/definition');
 /**
  * Container for the application entities.
  * @type {object}
@@ -68,7 +63,6 @@ function getFieldConfiguration(fieldPath, customFieldConf){
   return _getNode(fieldPath, customFieldConf).toJS();
 }
 
-setEntityConfiguration(searchDefinition);
 
 module.exports = {
   getEntityConfiguration: getEntityConfiguration,

search/action-builder.js

@@ -0,0 +1,54 @@
+let dispatcher = require('../dispatcher');
+let searchAction = require('./search-action');
+const NB_SEARCH_ELEMENT = 50;
+
+ /**
+  * Builded search action.
+  * @param  {object} options - The options used to build the service, it should have the following structure:
+  * ```javascript
+  * {
+  *   identifier: string: should be 'ADVANCED_SEARCH' or 'QUICK_SEARCH'
+  * 	service:{
+  * 		scoped: "function which launch the scope search"
+  * 		unScoped: "function whoch launch the unscoped search"
+  * 	}
+  * 	getSearchOptions a function which get the associated search store value
+  * 	nbSearchElement: number of elements to request on each search.
+  * }
+  * ```
+  * @return {function} - The builded search action.
+  */
+module.exports = function(config){
+  config = config || {};
+  if(!config.identifier){
+    console.warn('Your action should have an identifier');
+  }
+  if(!config.service){
+    console.warn('Your action should have a service');
+  }
+  if(!config.getSearchOptions){
+    console.warn('Your action should have a search options getter.');
+  }
+  if(!config.nbSearchElement){
+    config.nbSearchElement = NB_SEARCH_ELEMENT;
+  }
+  return {
+    /**
+     * Build the search for the identifier scope.
+     * @return {function} The search function for the given identifier.
+     */
+    search: searchAction(config),
+    /**
+     * Update the query for the identifier scope.
+     * @param  {string} value - The query value
+     * @return {function} The update query function for the given identifier.
+     */
+    updateProperties(value){
+      return dispatcher.handleViewAction({
+        data: value,
+        type: 'update',
+        identifier: config.identifier
+      });
+    }
+  };
+};

search/built-in-store.js

@@ -1,7 +1,7 @@
-var SearchStore = require('../store/search');
-var QueryStore = require('../store/query');
+let AdvancedSearchStore = require('../store/search/advanced-search');
+let QuickSearchStore = require('../store/search/quick-search');
 
 module.exports = {
-    searchStore: new SearchStore(),
-    queryStore: new QueryStore()
-};
+    quickSearchStore: new QuickSearchStore(),
+    advancedSearchStore: new AdvancedSearchStore()
+};

search/index.js

@@ -1,16 +1,15 @@
 let dispatcher = require('../dispatcher');
 module.exports = {
     builtInStore: require('./built-in-store'),
-    /*
-    * Dispatch the change of the query value, with the callerId information.
-    */
-    changeQuery(queryValue, callerId){
-      dispatcher.handleViewAction({data: {query: queryValue}, type: 'update', callerId: callerId});
-    },
-    /*
-    * Dispatch the change of the scope value, with the callerId information.
-    */
-    changeScope(scopeValue, callerId){
-      dispatcher.handleViewAction({data: {scope: scopeValue}, type: 'update', callerId: callerId});
+    /**
+     * Action builder
+     */
+    actionBuilder: require('./action-builder'),
+    log(){
+        let builtInStore = require('./built-in-store');
+        console.info('---------------------------');
+        console.info('QuickSearch', builtInStore.quickSearchStore.value);
+        console.info('AdvancedSearch', builtInStore.advancedSearchStore.value);
+        console.info('---------------------------');
     }
 };

search/search-action/builder.js

@@ -0,0 +1,50 @@
+let keys = require('lodash/object/keys');
+let _buildFacets = (facets) => {
+    return keys(facets).map((selectedFacetKey) => {
+        let selectedFacet = facets[selectedFacetKey];
+        return {
+            key: selectedFacetKey,
+            value: selectedFacet.key
+        };
+    });
+};
+
+/**
+ * Build sort infotmation.
+ * @param  {object} sortConf - The sort configuration.
+ * @return {object} - The builded sort configuration.
+ */
+let _buildOrderAndSort = (sortConf) => {
+    return {
+      sortFieldName: sortConf.sortBy,
+      sortDesc: !sortConf.sortAsc
+    }
+};
+
+
+
+let _buildPagination = (opts) => {
+    let resultsKeys = keys(opts.results);
+    if(opts.isScroll && resultsKeys.length === 1){
+      let key = resultsKeys[0];
+      let previousRes = opts.results[key];
+      if(previousRes.length < opts.totalCount){
+        return {
+          top: opts.nbSearchElement,
+          skip: previousRes.length
+        };
+        //Else should not be called.
+        console.warn('This should not happen.')
+      };
+    } else {
+      return {
+        skip: 0,
+        top: opts.nbSearchElement || 0
+      }
+    }
+};
+module.exports = {
+  pagination: _buildPagination,
+  orderAndSort: _buildOrderAndSort,
+  facets: _buildFacets
+};

search/search-action/index.js

@@ -0,0 +1,73 @@
+//Dependencies.
+let assign = require('object-assign');
+let _builder = require('./builder');
+let _parser = require('./parser');
+const ALL = 'ALL';
+const STAR = '*';
+
+
+/**
+* Search action generated from the config.
+* @param  {object} config - Action configuration.
+* @return {function} - The generated action from the congig.
+*/
+module.exports = function(config){
+    /**
+    * Dispatch the results on the search store
+    * @param  {object} data - The data to dispatch.
+    */
+    let _dispatchResult = (data) => {
+        Focus.dispatcher.handleServerAction({
+            data,
+            type: 'update',
+            identifier: config.identifier
+        });
+    };
+
+    /**
+    * Build search action.
+    * @param  {Boolean} isScroll - Is the action result from a scrolling.
+    */
+    return function searchAction(isScroll){
+        //Read search options from the accessor define in the config.
+        let {
+            scope, query, selectedFacets,
+            groupingKey, sortBy, sortAsc,
+            results, totalCount
+        } = config.getSearchOptions();
+
+        //Number of element to search on each search.
+        let nbSearchElement = config.nbSearchElement;
+        //Process the query if empty.
+        if(!query || query === ''){
+            query = STAR;
+        }
+        //Build URL data.
+        let urlData = assign(
+            _builder.pagination({results, totalCount, isScroll, nbSearchElement}),
+            _builder.orderAndSort({sortBy, sortAsc})
+        );
+        //Build body data.
+        let postData = {
+            criteria: {scope, query},
+            facets: selectedFacets ? _builder.facets(selectedFacets) : [],
+            group: groupingKey || ''
+        };
+        //Different call depending on the scope.
+        if(scope === ALL){
+            //Call the search action.
+            config.service.unscoped({urlData: urlData, data: postData})
+            .then(_parser.unscopedResponse)
+            .then(_dispatchResult);
+        }else{
+            //The component which call the serice should be know if it has all the data.
+            config.service.scoped({urlData: urlData, data: postData})
+            .then((response)=>{
+                return _parser.scopedResponse(
+                    response,
+                    {isScroll, scope, results}
+                );
+            }).then(_dispatchResult);
+        }
+    };
+};

search/search-action/parser.js

@@ -0,0 +1,44 @@
+//Requirements
+
+let keys = require('lodash/object/keys');
+
+let _parseFacets = (facets) => {
+    return keys(facets).reduce((formattedFacets, serverFacetKey) => {
+        let serverFacetData = facets[serverFacetKey];
+        formattedFacets[serverFacetKey] = keys(serverFacetData).reduce((facetData, serverFacetItemKey) => {
+            let serverFacetItemValue = serverFacetData[serverFacetItemKey];
+            facetData[serverFacetItemKey] = {
+                label: serverFacetItemKey,
+                count: serverFacetItemValue
+            };
+            return facetData;
+        }, {});
+        return formattedFacets;
+    }, {});
+};
+let _parseUnscopedResponse = (data) => {
+    return ({
+        results: data.groups,
+        facets: _parseFacets(data.facets),
+        totalCount: data.totalCount
+    });
+};
+
+let _parseScopedResponse = (data, context) => {
+    //Scroll can only happen when there is an ungroupSearch
+    if(context.isScroll){
+      let resultsKeys = keys(context.results);
+      let key = resultsKeys[0];
+      //Concat previous data with incoming data.
+      data.list = [...context.results[key], ...data.list];
+    }
+    return ({
+        results: data.groups || {[context.scope]: data.list},
+        facets: _parseFacets(data.facets),
+        totalCount: data.totalCount
+    });
+};
+module.exports = {
+  unscopedResponse: _parseUnscopedResponse,
+  scopedResponse: _parseScopedResponse
+};