feat: introduce new search backend module for q&a

this fixes collator functionality in the new backend system

closes #106

.github/workflows/release.yaml

@@ -157,3 +157,30 @@ jobs:
       - run: yarn tsc
       - run: yarn build
       - run: yarn npm publish
+
+  search-backend-publish:
+    name: Publish search backend module
+    runs-on: ubuntu-latest
+    needs: [tagged-release]
+    defaults:
+      run:
+        working-directory: ./plugins/search-backend-module-qeta
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Create yarnrc.yml
+        run: |
+          echo "npmAuthToken: ${{ secrets.NPM_TOKEN }}" >> ~/.yarnrc.yml
+          echo "npmAlwaysAuth: true" >> ~/.yarnrc.yml
+          echo "npmPublishRegistry: https://registry.npmjs.org" >> ~/.yarnrc.yml
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: git pull
+      - run: yarn
+      - run: yarn tsc
+      - run: yarn build
+      - run: yarn npm publish

plugins/qeta-backend/src/search/collators/QetaCollatorFactory.ts

@@ -11,6 +11,7 @@ export type QetaCollatorFactoryOptions = {
   database: PluginDatabaseManager;
 };
 
+/** @deprecated use 'search-backend-module-qeta' collator instead for new backend system */
 export class QetaCollatorFactory implements DocumentCollatorFactory {
   public readonly type: string = 'qeta';
   private readonly logger: LoggerService;

plugins/qeta-common/package.json

@@ -40,7 +40,8 @@
   },
   "dependencies": {
     "@backstage/plugin-permission-common": "^0.7.11",
-    "@backstage/plugin-search-common": "^1.2.9"
+    "@backstage/plugin-search-common": "^1.2.9",
+    "ajv": "^8.12.0"
   },
   "peerDependencies": {
     "@backstage/catalog-model": "^1.4.3"

plugins/qeta-common/src/types.ts

@@ -1,4 +1,5 @@
 import { IndexableDocument } from '@backstage/plugin-search-common';
+import { ErrorObject } from 'ajv';
 
 export interface StatisticResponse {
   ranking: Statistic[];
@@ -86,4 +87,50 @@ export interface QetaDocument extends IndexableDocument {
   score: number;
   answerCount?: number;
   views?: number;
+  tags?: string[];
+}
+
+interface CustomError {
+  message: string;
+}
+
+interface ErrorResponse {
+  errors: ErrorObject<string, any>[] | CustomError[] | null | undefined;
+  type: 'query' | 'body';
+}
+
+export interface QuestionsResponse {
+  questions: Question[];
+  total: number;
+}
+
+export type QuestionsResponseBody = QuestionsResponse | ErrorResponse;
+
+export type QuestionResponseBody = Question | ErrorResponse;
+
+export interface QuestionRequest {
+  title: string;
+  content: string;
+  tags?: string[];
+  entities?: string[];
+  images?: number[];
+}
+
+export interface AnswerRequest {
+  questionId: number;
+  answer: string;
+  images?: number[];
+  anonymous?: boolean;
+}
+
+export type AnswerResponseBody = Answer | ErrorResponse;
+
+export interface TagResponse {
+  tag: string;
+  questionsCount: number;
 }
+
+export type AttachmentResponseBody = Attachment | ErrorResponse;
+
+export type QuestionResponse = Question;
+export type AnswerResponse = Answer;

plugins/qeta/src/api/QetaApi.ts

@@ -1,7 +1,3 @@
-import {
-  StatisticResponse,
-  StatisticsRequestParameters,
-} from '@drodil/backstage-plugin-qeta-common';
 import {
   AnswerRequest,
   AnswerResponse,
@@ -10,8 +6,10 @@ import {
   QuestionRequest,
   QuestionResponse,
   QuestionsResponse,
+  StatisticResponse,
+  StatisticsRequestParameters,
   TagResponse,
-} from './types';
+} from '@drodil/backstage-plugin-qeta-common';
 
 export type GetQuestionsOptions = {
   noCorrectAnswer: string;

plugins/qeta/src/api/QetaClient.ts

@@ -7,21 +7,18 @@ import {
 } from '@backstage/core-plugin-api';
 import { CustomErrorBase } from '@backstage/errors';
 import {
+  Answer,
   AnswerRequest,
   AnswerResponseBody,
   AttachmentResponseBody,
+  Question,
   QuestionRequest,
   QuestionResponseBody,
   QuestionsResponse,
   QuestionsResponseBody,
-  TagResponse,
-} from './types';
-
-import {
-  Answer,
-  Question,
   StatisticResponse,
   StatisticsRequestParameters,
+  TagResponse,
 } from '@drodil/backstage-plugin-qeta-common';
 import omitBy from 'lodash/omitBy';
 import isEmpty from 'lodash/isEmpty';

plugins/qeta/src/api/index.ts

@@ -1,3 +1,2 @@
 export type { QetaApi } from './QetaApi';
 export { qetaApiRef, QetaClient } from './QetaClient';
-export * from './types';

plugins/qeta/src/components/AskForm/AskForm.tsx

@@ -10,11 +10,9 @@ import React, { useEffect } from 'react';
 import { Controller, useForm } from 'react-hook-form';
 import { useNavigate, useSearchParams } from 'react-router-dom';
 import {
-  QetaApi,
-  qetaApiRef,
   QuestionRequest,
   QuestionResponse,
-} from '../../api';
+} from '@drodil/backstage-plugin-qeta-common';
 import { useStyles } from '../../utils/hooks';
 import { MarkdownEditor } from '../MarkdownEditor/MarkdownEditor';
 import { catalogApiRef } from '@backstage/plugin-catalog-react';
@@ -26,6 +24,7 @@ import { QuestionForm } from './types';
 import { EntitiesInput } from './EntitiesInput';
 import { questionRouteRef } from '../../routes';
 import { AskAnonymouslyCheckbox } from '../AskAnonymouslyCheckbox/AskAnonymouslyCheckbox';
+import { QetaApi, qetaApiRef } from '../../api';
 
 const formToRequest = (
   form: QuestionForm,

plugins/qeta/src/components/CommentSection/CommentList.tsx

@@ -1,11 +1,15 @@
-import { AnswerResponse, qetaApiRef, QuestionResponse } from '../../api';
+import {
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 import { Box, Divider, Typography } from '@material-ui/core';
 import React from 'react';
 import { Link, MarkdownContent } from '@backstage/core-components';
 import { useStyles } from '../../utils/hooks';
 import { useApi } from '@backstage/core-plugin-api';
 import { RelativeTimeWithTooltip } from '../RelativeTimeWithTooltip/RelativeTimeWithTooltip';
 import { AuthorLink } from '../Links/Links';
+import { qetaApiRef } from '../../api';
 
 export const CommentList = (props: {
   onCommentDelete: (

plugins/qeta/src/components/CommentSection/CommentSection.tsx

@@ -1,10 +1,14 @@
 import React, { useState } from 'react';
 import { Box, Button, Grid, TextField } from '@material-ui/core';
 import { Link } from '@backstage/core-components';
-import { AnswerResponse, qetaApiRef, QuestionResponse } from '../../api';
+import {
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 import { Controller, useForm } from 'react-hook-form';
 import { useAnalytics, useApi } from '@backstage/core-plugin-api';
 import { CommentList } from './CommentList';
+import { qetaApiRef } from '../../api';
 
 export const CommentSection = (props: {
   onCommentPost: (question: QuestionResponse, answer?: AnswerResponse) => void;

plugins/qeta/src/components/DeleteModal/DeleteModal.tsx

@@ -1,11 +1,15 @@
-import { AnswerResponse, qetaApiRef, QuestionResponse } from '../../api';
+import {
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 import { Backdrop, Box, Button, Modal, Typography } from '@material-ui/core';
 import { Alert } from '@material-ui/lab';
 import Delete from '@material-ui/icons/Delete';
 import React from 'react';
 import { useBasePath, useStyles } from '../../utils/hooks';
 import { useApi } from '@backstage/core-plugin-api';
 import { useNavigate } from 'react-router-dom';
+import { qetaApiRef } from '../../api';
 
 export const DeleteModal = (props: {
   entity: QuestionResponse | AnswerResponse;

plugins/qeta/src/components/QuestionPage/AnswerCard.tsx

@@ -1,4 +1,7 @@
-import { AnswerResponse, QuestionResponse } from '../../api';
+import {
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 import { Box, Card, CardContent, Grid, Typography } from '@material-ui/core';
 import { Link, MarkdownContent } from '@backstage/core-components';
 import React from 'react';

plugins/qeta/src/components/QuestionPage/AnswerForm.tsx

@@ -5,15 +5,15 @@ import { configApiRef, useAnalytics, useApi } from '@backstage/core-plugin-api';
 import {
   AnswerRequest,
   AnswerResponse,
-  qetaApiRef,
+  qetaCreateAnswerPermission,
   QuestionResponse,
-} from '../../api';
+} from '@drodil/backstage-plugin-qeta-common';
 import { useStyles } from '../../utils/hooks';
 import { Controller, useForm } from 'react-hook-form';
 import { MarkdownEditor } from '../MarkdownEditor/MarkdownEditor';
 import { RequirePermission } from '@backstage/plugin-permission-react';
-import { qetaCreateAnswerPermission } from '@drodil/backstage-plugin-qeta-common';
 import { AskAnonymouslyCheckbox } from '../AskAnonymouslyCheckbox/AskAnonymouslyCheckbox';
+import { qetaApiRef } from '../../api';
 
 const getDefaultValues = (questionId: number) => {
   return { questionId, answer: '' };

plugins/qeta/src/components/QuestionPage/AuthorBox.tsx

@@ -2,7 +2,10 @@ import { Avatar, Box, Grid, Typography } from '@material-ui/core';
 import { formatEntityName } from '../../utils/utils';
 import React, { useEffect } from 'react';
 import { useStyles } from '../../utils/hooks';
-import { AnswerResponse, QuestionResponse } from '../../api';
+import {
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 import { identityApiRef, useApi } from '@backstage/core-plugin-api';
 import { catalogApiRef } from '@backstage/plugin-catalog-react';
 import { UserEntity } from '@backstage/catalog-model';

plugins/qeta/src/components/QuestionPage/FavoriteButton.tsx

@@ -1,9 +1,10 @@
-import { qetaApiRef, QuestionResponse } from '../../api';
+import { QuestionResponse } from '@drodil/backstage-plugin-qeta-common';
 import { IconButton, Tooltip } from '@material-ui/core';
 import React from 'react';
 import { useApi } from '@backstage/core-plugin-api';
 import StarIcon from '@material-ui/icons/Star';
 import StarOutlineIcon from '@material-ui/icons/StarOutline';
+import { qetaApiRef } from '../../api';
 
 export const FavoriteButton = (props: { entity: QuestionResponse }) => {
   const [entity, setEntity] = React.useState<QuestionResponse>(props.entity);

plugins/qeta/src/components/QuestionPage/LinkButton.tsx

@@ -1,7 +1,10 @@
 import { IconButton, Tooltip } from '@material-ui/core';
 import Link from '@material-ui/icons/Link';
 import React from 'react';
-import { AnswerResponse, QuestionResponse } from '../../api';
+import {
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 
 export const LinkButton = (props: {
   entity: QuestionResponse | AnswerResponse;

plugins/qeta/src/components/QuestionPage/QuestionCard.tsx

@@ -1,4 +1,7 @@
-import { AnswerResponse, QuestionResponse } from '../../api';
+import {
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 import { Box, Card, CardContent, Grid, Typography } from '@material-ui/core';
 import { Link, MarkdownContent } from '@backstage/core-components';
 import React, { useEffect } from 'react';

plugins/qeta/src/components/QuestionPage/QuestionPage.tsx

@@ -16,13 +16,16 @@ import {
 import { useParams } from 'react-router-dom';
 import { useQetaApi, useStyles } from '../../utils/hooks';
 import { QuestionCard } from './QuestionCard';
-import { AnswerResponse, QuestionResponse } from '../../api';
+import {
+  Answer,
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 import { AnswerForm } from './AnswerForm';
 import { AnswerCard } from './AnswerCard';
 import { Skeleton } from '@material-ui/lab';
 import { AskQuestionButton } from '../Buttons/AskQuestionButton';
 import { BackToQuestionsButton } from '../Buttons/BackToQuestionsButton';
-import { Answer } from '@drodil/backstage-plugin-qeta-common';
 import { RelativeTimeWithTooltip } from '../RelativeTimeWithTooltip/RelativeTimeWithTooltip';
 import { UpdatedByLink } from '../Links/Links';
 

plugins/qeta/src/components/QuestionPage/TagsAndEntities.tsx

@@ -1,4 +1,4 @@
-import { QuestionResponse } from '../../api';
+import { QuestionResponse } from '@drodil/backstage-plugin-qeta-common';
 import { useApi, useRouteRef } from '@backstage/core-plugin-api';
 import { catalogApiRef } from '@backstage/plugin-catalog-react';
 import React, { useEffect } from 'react';

plugins/qeta/src/components/QuestionPage/VoteButtons.tsx

@@ -1,4 +1,7 @@
-import { AnswerResponse, qetaApiRef, QuestionResponse } from '../../api';
+import {
+  AnswerResponse,
+  QuestionResponse,
+} from '@drodil/backstage-plugin-qeta-common';
 import {
   Box,
   IconButton,
@@ -11,6 +14,7 @@ import ArrowUpward from '@material-ui/icons/ArrowUpward';
 import Check from '@material-ui/icons/Check';
 import React from 'react';
 import { useAnalytics, useApi } from '@backstage/core-plugin-api';
+import { qetaApiRef } from '../../api';
 
 export const VoteButtons = (props: {
   entity: QuestionResponse | AnswerResponse;