fix: added basic search functionality

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.0
+appVersion: 1.5.2
 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.0
+  tag: 1.5.2
   pullPolicy: Always
   containerPort: 3000
 

k8s/values.yaml

@@ -13,6 +13,7 @@ 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,
@@ -72,6 +73,7 @@ export interface ClientConfig {
   readonly verifyTokenQueryParamName: string;
   readonly resetPasswordUrl: string;
   readonly resetPasswordTokenQueryParamName: string;
+  readonly searchQueryParamName: string;
 }
 
 export interface HttpConfig {
@@ -101,6 +103,7 @@ 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,6 +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 TOO_MANY_REQUEST_MESSAGE =
   'Too many accounts created from this IP, please try again after an 10 minutes';
@@ -45,6 +46,7 @@ export const LOGGLY_SUBDOMAIN = 'your-loggly-subdomain';
 // MODEL
 export const UUID_LENGTH = 36;
 export const VARCHAR_LENGTH = 255;
+export const SAFE_URL_LENGTH = 2000;
 export const TEXT_LENGTH = 65535;
 export const KNEX_CLIENT = 'mysql';
 export const KNEX_DATABASE = 'test_db';

src/constants/index.ts

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

src/constants/routes.ts

@@ -10,6 +10,7 @@ import {
   PERMISSIONS,
   ROLES,
   ROOT,
+  SEARCH,
   USERS,
 } from '../../../../constants/routes';
 import Config from '../../presenterFactory/Config';
@@ -20,6 +21,7 @@ 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';
 
@@ -41,6 +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.use(MODULES, modulesFactory(config));
   // router.use(UNITS, unitsFactory(config));
   // TODO: add route for uploading /avatar

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

@@ -0,0 +1,39 @@
+import sendResponse from '@js-items/express/dist/utils/sendResponse';
+import { toSnake } from 'convert-keys';
+import { OK } from 'http-status-codes';
+import Record from 'rulr/Record';
+import validateData from 'rulr/validateData';
+import { SAFE_URL_LENGTH } from '../../../../../../constants';
+import String from '../../../../../../utils/validation/rules/String';
+import Config from '../../../../presenterFactory/Config';
+import catchErrors from '../../../../utils/errors/catchErrors';
+
+
+const searchHandler = (config: Config) =>
+  catchErrors(config, async (req, res) => {
+    const name = config.appConfig.http.client.searchQueryParamName;
+
+    const validationSchema = {
+      [name]: String(0, SAFE_URL_LENGTH),
+    };
+
+    const rules = Record(validationSchema);
+    const value = req.query[name];
+
+    const payload: any = {[name]:value};
+
+    validateData(rules)(payload);
+
+    const response = await config.service.search({
+      query: value
+    });
+       
+    sendResponse({
+      body: toSnake(response),
+      req,
+      res,
+      status: OK,
+    });
+  });
+
+export default searchHandler;

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

@@ -6,6 +6,7 @@ import getDiscoveryItemsForHomepage from './functions/getDiscoveryItemsForHomepa
 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';
 
@@ -29,6 +30,7 @@ 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

@@ -1,6 +1,7 @@
 import { Filter, ItemNotFoundError } from '@js-items/foundation';
 import _pluck from 'ramda/src/pluck';
 import Course from '../../../types/items/Course';
+import getVisibleUserProperties from '../../../utils/helpers/model/getVisibleUserProperties';
 import Config from '../../FactoryConfig';
 
 export interface Options {
@@ -30,7 +31,7 @@ export default ({ repo }: Config) => async ({ filter }: Options) => {
     course: {
       ...course,
       category,
-      user,
+      user: getVisibleUserProperties(user),
     },
   };
 };