Merge pull request #617 from dzcode-io/prepare-meilisearch

Add MeiliSearch service

README.md

@@ -61,7 +61,7 @@ npm run dev:api
 npm run dev:all
 ```
 
-- For api server go to <http://localhost:7070/docs>
+- For api server go to <http://localhost:7070>
 - For web server go to <http://localhost:8080>
 
 **Note**
@@ -70,6 +70,7 @@ In [`./api`](./api), keep in mind that you have limited calls to Github Api (60
 
 ```.env
 GITHUB_TOKEN=Paste_You_Token_Here
+NODE_ENV=development
 ```
 
 ### Run e2e locally

api/docker-compose.yml

@@ -9,3 +9,13 @@ services:
     environment:
       POSTGRES_HOST_AUTH_METHOD: trust
       POSTGRES_DB: db
+
+  meilisearch:
+    image: getmeili/meilisearch:latest
+    ports:
+      - "7700:7700"
+    volumes:
+      - ./meilisearch_db:/data.ms
+    environment:
+      MEILI_NO_ANALYTICS: true
+      MEILI_MASTER_KEY: "default"

api/package.json

@@ -25,6 +25,7 @@
     "helmet": "^7.1.0",
     "lodash": "^4.17.21",
     "make-fetch-happen": "^13.0.1",
+    "meilisearch": "^0.46.0",
     "morgan": "^1.10.0",
     "postgres": "^3.4.4",
     "reflect-metadata": "^0.2.2",

api/src/app/index.ts

@@ -3,24 +3,30 @@
 import "reflect-metadata";
 import "src/_utils/setup-sentry";
 
-import { fsConfig } from "@dzcode.io/utils/dist/config";
 import * as Sentry from "@sentry/node";
+
+import {
+  RoutingControllersOptions,
+  createExpressServer,
+  useContainer,
+} from "routing-controllers";
+
 import { Application } from "express";
-import { createExpressServer, RoutingControllersOptions, useContainer } from "routing-controllers";
 import { ConfigService } from "src/config/service";
+import Container from "typedi";
 import { ContributionController } from "src/contribution/controller";
 import { ContributorController } from "src/contributor/controller";
 import { DigestCron } from "src/digest/cron";
 import { GithubController } from "src/github/controller";
+import { LoggerMiddleware } from "./middlewares/logger";
 import { LoggerService } from "src/logger/service";
 import { MilestoneController } from "src/milestone/controller";
-import { ProjectController } from "src/project/controller";
 import { PostgresService } from "src/postgres/service";
-import Container from "typedi";
-
-import { LoggerMiddleware } from "./middlewares/logger";
+import { ProjectController } from "src/project/controller";
 import { RobotsController } from "./middlewares/robots";
+import { SearchController } from "src/search/controller";
 import { SecurityMiddleware } from "./middlewares/security";
+import { fsConfig } from "@dzcode.io/utils/dist/config";
 
 // Use typedi container
 useContainer(Container); // eslint-disable-line react-hooks/rules-of-hooks
@@ -45,6 +51,7 @@ useContainer(Container); // eslint-disable-line react-hooks/rules-of-hooks
       ProjectController,
       ContributorController,
       RobotsController,
+      SearchController,
     ],
     middlewares: [SecurityMiddleware, LoggerMiddleware],
     cors: Container.get(SecurityMiddleware).cors(),

api/src/config/types.ts

@@ -1,6 +1,10 @@
-import { Environment, environments } from "@dzcode.io/utils/dist/config/environment";
-import { Expose } from "class-transformer";
+import {
+  Environment,
+  environments,
+} from "@dzcode.io/utils/dist/config/environment";
 import { IsOptional, IsString, Matches } from "class-validator";
+
+import { Expose } from "class-transformer";
 import { readFileSync } from "fs-extra";
 
 let bundleInfo = { version: require("../../package.json").version }; // eslint-disable-line @typescript-eslint/no-require-imports
@@ -32,4 +36,13 @@ export class EnvRecord {
 
   @IsOptional()
   BUNDLE_INFO: { version: string } = bundleInfo;
+
+  @Expose()
+  get MEILISEARCH_URL() {
+    return this.NODE_ENV === "development"
+      ? "http://localhost:7700/"
+      : "http://meilisearch:7700/";
+  }
+
+  MEILISEARCH_MASTER_KEY = "default";
 }

api/src/search/controller.ts

@@ -0,0 +1,19 @@
+import { Controller, Get } from "routing-controllers";
+
+import { GetSearchResponse } from "./types";
+import { SearchService } from "./service";
+import { Service } from "typedi";
+
+@Service()
+@Controller("/Search")
+export class SearchController {
+  constructor(private readonly searchService: SearchService) {}
+
+  @Get("/")
+  public async search(): Promise<GetSearchResponse> {
+    const searchResults = await this.searchService.search("test");
+    return {
+      searchResults,
+    };
+  }
+}

api/src/search/service.ts

@@ -0,0 +1,27 @@
+import { ConfigService } from "src/config/service";
+import { LoggerService } from "src/logger/service";
+import { MeiliSearch } from "meilisearch";
+import { SearchItem } from "./types";
+import { Service } from "typedi";
+
+@Service()
+export class SearchService {
+  private readonly meilisearch: MeiliSearch;
+  constructor(
+    private readonly configService: ConfigService,
+    private readonly logger: LoggerService,
+  ) {
+    const { MEILISEARCH_URL, MEILISEARCH_MASTER_KEY } =
+      this.configService.env();
+
+    this.meilisearch = new MeiliSearch({
+      host: MEILISEARCH_URL,
+      apiKey: MEILISEARCH_MASTER_KEY,
+    });
+  }
+
+  public search = async (query: string): Promise<SearchItem[]> => {
+    this.logger.info({ message: `Searching for ${query}` });
+    return [];
+  };
+}

api/src/search/types.ts

@@ -0,0 +1,13 @@
+import { GeneralResponse } from "src/app/types";
+
+export interface GetSearchResponse extends GeneralResponse {
+  searchResults: Array<SearchItem>;
+}
+
+export interface SearchItem {
+  id: string;
+  title: string;
+  type: SearchType;
+}
+
+type SearchType = "project" | "contribution" | "contributor";