fix: changed search route to autocomplete

Author: mariocoski

assets/jscpd-badge.svg

@@ -2,7 +2,7 @@ apiVersion: v1
 description: A Helm chart for kube-ts-server
 name: kube-ts-server
 version: 1.0.0
-appVersion: 1.5.2
+appVersion: 1.5.3
 home: https://cloud.docker.com/u/kubejs/repository/docker/kubejs/kube-ts-server
 icon: https://avatars2.githubusercontent.com/u/47761918?s=200&v=4
 sources:

k8s/Chart.yaml

@@ -6,7 +6,7 @@ replicaCount: 2
 
 image:
   repository: kubejs/kube-ts-server
-  tag: 1.5.2
+  tag: 1.5.3
   pullPolicy: Always
   containerPort: 3000
 

k8s/values.yaml

@@ -1,6 +1,7 @@
 
 import { TOO_MANY_REQUESTS } from 'http-status-codes';
 import {
+  AUTOCOMPLETE_QUERY_PARAM_NAME,
   CLIENT_RESET_PASSWORD_TOKEN_QUERY_PARAM_NAME,
   CLIENT_RESET_PASSWORD_URL,
   CLIENT_URL,
@@ -13,7 +14,6 @@ import {
   RATE_LIMITER_SKIP_METHODS,
   RATE_LIMITER_WINDOW_MS,
   READINESS_CHECK_URL,
-  SEARCH_QUERY_PARAM_NAME,
   TOO_MANY_REQUEST_MESSAGE,
   TRUST_PROXY,
   VERSION_CHECK_URL,
@@ -73,7 +73,7 @@ export interface ClientConfig {
   readonly verifyTokenQueryParamName: string;
   readonly resetPasswordUrl: string;
   readonly resetPasswordTokenQueryParamName: string;
-  readonly searchQueryParamName: string;
+  readonly autocompleteQueryParam: string;
 }
 
 export interface HttpConfig {
@@ -95,6 +95,7 @@ const config: HttpConfig = {
     version: getStringValue(process.env.VERSION_CHECK_URL, VERSION_CHECK_URL),
   },
   client: {
+    autocompleteQueryParam: getStringValue(process.env.AUTOCOMPLETE_QUERY_PARAM_NAME, AUTOCOMPLETE_QUERY_PARAM_NAME),
     resetPasswordTokenQueryParamName: getStringValue(
       process.env.CLIENT_RESET_PASSWORD_TOKEN_QUERY_PARAM_NAME,
       CLIENT_RESET_PASSWORD_TOKEN_QUERY_PARAM_NAME
@@ -103,7 +104,6 @@ const config: HttpConfig = {
       process.env.CLIENT_RESET_PASSWORD_URL,
       CLIENT_RESET_PASSWORD_URL
     ),
-    searchQueryParamName: getStringValue(process.env.SEARCH_QUERY_PARAM_NAME, SEARCH_QUERY_PARAM_NAME),
     siteUrl: getStringValue(process.env.CLIENT_URL, CLIENT_URL),
     verifyEmailUrl: getStringValue(
       process.env.CLIENT_VERIFY_EMAIL_URL,

src/config/subconfigs/http/index.ts

@@ -12,7 +12,7 @@ export const CLIENT_VERIFY_EMAIL_URL = 'http://localhost:9000/verify'; // @note:
 export const CLIENT_VERIFY_TOKEN_QUERY_PARAM_NAME = 'token';
 export const CLIENT_RESET_PASSWORD_URL = 'http://localhost:9000/reset-password'; // @note: this is client url
 export const CLIENT_RESET_PASSWORD_TOKEN_QUERY_PARAM_NAME = 'token';
-export const SEARCH_QUERY_PARAM_NAME = 'q';
+export const AUTOCOMPLETE_QUERY_PARAM_NAME = 'q';
 
 export const TOO_MANY_REQUEST_MESSAGE =
   'Too many accounts created from this IP, please try again after an 10 minutes';

src/constants/index.ts

@@ -26,4 +26,4 @@ export const MODULES = '/modules';
 export const UNITS = '/units';
 export const COMMENTS = '/comments';
 export const DISCOVERY_ITEMS = '/discovery-items';
-export const SEARCH = '/search';
+export const AUTOCOMPLETE = '/autocomplete';

src/constants/routes.ts

@@ -1,6 +1,7 @@
 import { Router } from 'express';
 import {
   AUTH,
+  AUTOCOMPLETE,
   CATEGORIES,
   COURSES,
   DISCOVERY_ITEMS,
@@ -10,18 +11,17 @@ import {
   PERMISSIONS,
   ROLES,
   ROOT,
-  SEARCH,
   USERS,
 } from '../../../../constants/routes';
 import Config from '../../presenterFactory/Config';
 import authFactory from './routes/auth/factory';
+import autocompleteHandler from './routes/autocompleteHandler';
 import categoriesFactory from './routes/categories/factory';
 import coursesFactory from './routes/courses/factory';
 import enrolmentsFactory from './routes/enrolments/factory';
 import getDiscoveryItems from './routes/getDiscoveryItems';
 import permissionsFactory from './routes/permissions/factory';
 import rolesFactory from './routes/roles/factory';
-import searchHandler from './routes/searchHandler';
 import usersFactory from './routes/users/factory';
 import describeApi from './routes/utils/describeApi';
 
@@ -43,7 +43,7 @@ const apiV1 = (config: Config): Router => {
   router.use(COURSES, coursesFactory(config));
   router.use(ENROLMENTS, enrolmentsFactory(config));
   router.use(DISCOVERY_ITEMS, getDiscoveryItems(config));
-  router.get(SEARCH, searchHandler(config));
+  router.get(AUTOCOMPLETE, autocompleteHandler(config));
   // router.use(MODULES, modulesFactory(config));
   // router.use(UNITS, unitsFactory(config));
   // TODO: add route for uploading /avatar

src/presenter/express/api/v1/index.ts

@@ -9,9 +9,9 @@ import Config from '../../../../presenterFactory/Config';
 import catchErrors from '../../../../utils/errors/catchErrors';
 
 
-const searchHandler = (config: Config) =>
+const autocompleteHandler = (config: Config) =>
   catchErrors(config, async (req, res) => {
-    const name = config.appConfig.http.client.searchQueryParamName;
+    const name = config.appConfig.http.client.autocompleteQueryParam;
 
     const validationSchema = {
       [name]: String(0, SAFE_URL_LENGTH),
@@ -24,7 +24,7 @@ const searchHandler = (config: Config) =>
 
     validateData(rules)(payload);
 
-    const response = await config.service.search({
+    const response = await config.service.autocomplete({
       query: value
     });
 
@@ -36,4 +36,4 @@ const searchHandler = (config: Config) =>
     });
   });
 
-export default searchHandler;
+export default autocompleteHandler;

src/presenter/express/api/v1/routes/searchHandler/index.ts renamed to src/presenter/express/api/v1/routes/autocompleteHandler/index.ts

@@ -1,19 +1,20 @@
 import migrationsServiceFactory from '@js-migrations/core/dist/factory';
 import FactoryConfig from './FactoryConfig';
 import authFactory from './functions/auth/factory';
+import autocomplete from './functions/autocomplete';
 import getCourseDetails from './functions/getCourseDetails';
 import getDiscoveryItemsForHomepage from './functions/getDiscoveryItemsForHomepage';
 import hasPermission from './functions/hasPermission';
 import assignRolePermission from './functions/roles/assignRolePermission';
 import revokeRolePermission from './functions/roles/revokeRolePermission';
-import search from './functions/search';
 import assignUserRole from './functions/users/assignUserRole';
 import revokeUserRole from './functions/users/revokeUserRole';
 
 export default (config: FactoryConfig) => ({
   assignRolePermission: assignRolePermission(config),
   assignUserRole: assignUserRole(config),
   auth: authFactory(config),
+  autocomplete: autocomplete(config),
   categories: config.repo.categories,
   closeDbConnection: config.repo.closeDbConnection,
   courses: config.repo.courses,
@@ -30,7 +31,6 @@ export default (config: FactoryConfig) => ({
   revokeUserRole: revokeUserRole(config),
   rolePermission: config.repo.rolePermission,
   roles: config.repo.roles,
-  search: search(config),
   sendEmail: config.repo.sendEmail,
   userRole: config.repo.userRole,
   users: config.repo.users,

src/service/factory.ts

@@ -6,7 +6,7 @@ export interface Options {
 }
 
 export default ({ repo }: Config) => async ({ query }: Options) => {
-  const { items: courses } = await repo.courses.getItems({
+  const courses = await repo.courses.getItems({
     filter: {
       $or: [
         {
@@ -25,7 +25,7 @@ export default ({ repo }: Config) => async ({ query }: Options) => {
     },
   });
 
-  const { items: users } = await repo.users.getItems({
+  const users = await repo.users.getItems({
     filter: {
       $or: [
         {
@@ -43,6 +43,9 @@ export default ({ repo }: Config) => async ({ query }: Options) => {
 
   return {
     courses,
-    users: users.map(getVisibleUserProperties),
+    users: {
+      cursor: users.cursor,
+      items: users.items.map(getVisibleUserProperties),
+    },
   };
 };