feat: add boosting to context based search

config/default.ts

@@ -178,51 +178,86 @@ const config: Partial<SCConfigFile> = {
         fieldName: 'type',
       },
     ],
-    boostings: [
-      {
-        factor: 1,
-        fields: {
-          'academicTerms.acronym': {
-            'SS 2018': 1.05,
-            'WS 2018/19': 1.1,
-          },
-          categories: {
-            'course': 1.08,
-            'integrated course': 1.08,
-            'introductory class': 1.05,
-            'lecture': 1.1,
-            'seminar': 1.01,
-            'tutorial': 1.05,
+    boostings: {
+      default: [
+        {
+          factor: 1,
+          fields: {
+            'academicTerms.acronym': {
+              'SS 2018': 1.05,
+              'WS 2018/19': 1.1,
+            },
+            'categories': {
+              'course': 1.08,
+              'integrated course': 1.08,
+              'introductory class': 1.05,
+              'lecture': 1.1,
+              'seminar': 1.01,
+              'tutorial': 1.05,
+            },
           },
+          type: SCThingType.AcademicEvent,
         },
-        type: SCThingType.AcademicEvent,
-      },
-      {
-        factor: 1.6,
-        type: SCThingType.Building,
-      },
-      {
-        factor: 1,
-        fields: {
-          'categories': {
-            'cafe': 1.1,
-            'learn': 1.1,
-            'library': 1.2,
-            'restaurant': 1.1,
-          },
+        {
+          factor: 1.6,
+          type: SCThingType.Building,
         },
-        type: SCThingType.PointOfInterest,
-      },
-      {
-        factor: 1,
-        fields: {
-          'categories': {
-            'main dish': 2,
+        {
+          factor: 1,
+          fields: {
+            'categories': {
+              'cafe': 1.1,
+              'learn': 1.1,
+              'library': 1.2,
+              'restaurant': 1.1,
+            },
           },
+          type: SCThingType.PointOfInterest,
         },
-        type: SCThingType.Dish,
-      },
-    ],
+        {
+          factor: 1,
+          fields: {
+            'categories': {
+              'main dish': 2,
+            },
+          },
+          type: SCThingType.Dish,
+        },
+      ],
+      place: [
+        {
+          factor: 2,
+          type: SCThingType.Building,
+        },
+        {
+          factor: 2,
+          type: SCThingType.PointOfInterest,
+        },
+        {
+          factor: 2,
+          type: SCThingType.Room,
+        },
+      ],
+      dining: [
+        {
+          factor: 1,
+          fields: {
+            'categories': {
+              'cafe': 2,
+              'restaurant': 2,
+              'canteen': 2,
+              'student canteen': 2,
+              'restroom': 1.2,
+            },
+          },
+          type: SCThingType.Building,
+        },
+        {
+          factor: 2,
+          type: SCThingType.Dish,
+        },
+      ],
+    },
   },
   uid: 'b-tu',
 };

package.json

@@ -12,16 +12,17 @@
   ],
   "scripts": {
     "build": "npm run tslint && npm run compile",
-    "compile": "rimraf lib && tsc --outDir lib && prepend lib/cli.js '#!/usr/bin/env node\n'",
+    "compile": "rimraf lib && tsc && prepend lib/cli.js '#!/usr/bin/env node\n'",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md && git commit -m 'docs: update changelog'",
     "check-configuration": "openstapps-configuration",
-    "documentation": "typedoc --includeDeclarations --excludeExternals --mode modules --out docs src",
+    "documentation": "typedoc --includeDeclarations --mode modules --out docs --readme README.md --listInvalidSymbolLinks src",
+    "prepublishOnly": "npm ci && npm run build",
     "start": "NODE_CONFIG_ENV=elasticsearch ALLOW_NO_TRANSPORT=true node ./lib/cli.js",
     "tslint": "tslint 'src/**/*.ts'"
   },
   "dependencies": {
-    "@openstapps/core": "0.12.0",
-    "@openstapps/core-tools": "0.3.0",
+    "@openstapps/core": "0.15.0",
+    "@openstapps/core-tools": "0.5.1",
     "@openstapps/logger": "0.0.5",
     "config": "3.0.1",
     "cors": "2.8.5",
@@ -42,7 +43,7 @@
     "uuid": "3.3.2"
   },
   "devDependencies": {
-    "@openstapps/configuration": "0.6.0",
+    "@openstapps/configuration": "0.8.0",
     "@types/config": "0.0.34",
     "@types/cors": "2.8.4",
     "@types/elasticsearch": "5.0.31",
@@ -61,6 +62,6 @@
     "prepend-file-cli": "1.0.6",
     "rimraf": "2.6.3",
     "typedoc": "0.14.2",
-    "typescript": "3.3.3333"
+    "typescript": "3.3.4000"
   }
 }

src/storage/elasticsearch/query.ts

@@ -14,9 +14,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 import {
-  SCBackendConfigurationSearchBoosting,
+  SCBackendConfigurationSearchBoostingContext,
+  SCBackendConfigurationSearchBoostingType,
   SCConfigFile,
   SCSearchBooleanFilter,
+  SCSearchContext,
   SCSearchFilter,
   SCSearchQuery,
   SCSearchSort,
@@ -147,15 +149,37 @@ export function buildFilter(filter: SCSearchFilter): ESTermFilter | ESGeoDistanc
 
 /**
  * Builds scorings functions from boosting config
- * @param boosting
- * @returns
+ * @param boostings Backend boosting configuration for contexts and types
+ * @param context The context of the app from where the search was initiated
  */
-export function buildFunctions(boosting: SCBackendConfigurationSearchBoosting[]): ESFunctionScoreQueryFunction[] {
+function buildFunctions(
+  boostings: SCBackendConfigurationSearchBoostingContext,
+  context: SCSearchContext | undefined,
+): ESFunctionScoreQueryFunction[] {
 
+  // default context
+  let functions: ESFunctionScoreQueryFunction[] =
+    buildFunctionsForBoostingTypes(boostings['default' as SCSearchContext]);
+
+  if (typeof context !== 'undefined' && context !== 'default') {
+    // specific context provided, extend default context with additional boosts
+    functions = functions.concat(buildFunctionsForBoostingTypes(boostings[context]));
+  }
+
+  return functions;
+}
+
+/**
+ * Creates boost functions for all type boost configurations
+ * 
+ * @param boostingTypes Array of type boosting configurations
+ */
+function buildFunctionsForBoostingTypes(
+  boostingTypes: SCBackendConfigurationSearchBoostingType[],
+): ESFunctionScoreQueryFunction[] {
   const functions: ESFunctionScoreQueryFunction[] = [];
 
-  // add a good scoring subset from config file
-  boosting.forEach((boostingForOneSCType) => {
+  boostingTypes.forEach((boostingForOneSCType) => {
     const typeFilter: ESTypeFilter = {
       type: {
         value: boostingForOneSCType.type,
@@ -305,7 +329,7 @@ export function buildQuery(
 
   const functionScoreQuery: ESFunctionScoreQuery = {
     function_score: {
-      functions: buildFunctions(defaultConfig.internal.boostings),
+      functions: buildFunctions(defaultConfig.internal.boostings, params.context),
       query: {
         bool: {
           minimum_should_match: 0, // if we have no should, nothing can match