create stack-overflow backend plugin and move collator there

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
This commit is contained in:
Emma Indal
2022-03-04 12:07:14 +01:00
parent fc67e62ac2
commit f80f3a7bc9
9 changed files with 201 additions and 96 deletions
+1 -22
View File
@@ -17,30 +17,9 @@ stackoverflow:
## Areas of Responsibility
This search plugin is primarily responsible for the following:
This stack overflow frontend plugin is primarily responsible for the following:
- Exposing various stack-overflow related components like `<StackOverflowSearchResultListItem />` which can be used for composing the search page, and `<HomePageStackOverflowQuestions/>` which can be used for composing the homepage.
- Provides a `StackOverflowQuestionsCollator`, which can be used in the search backend to index stack overflow questions to your Backstage Search.
### Index Stack Overflow Questions to search
Before you are able to start index stack overflow questions to search, you need to go through the [search getting started guide](https://backstage.io/docs/features/search/getting-started).
When you have your `packages/backend/src/plugins/search.ts` file ready to make modifications, add the following code snippet to add the `StackOverflowQuestionsCollator`. Note that you can modify the `requestParams`.
```ts
indexBuilder.addCollator({
defaultRefreshIntervalSeconds: 60,
collator: new StackOverflowQuestionsCollator({
config,
requestParams: {
tagged: ['backstage'],
site: 'stackoverflow',
pagesize: 100,
},
}),
});
```
#### Use specific search result list item for Stack Overflow Question
+1 -1
View File
@@ -13,9 +13,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {
stackOverflowPlugin,
StackOverflowSearchResultListItem,
HomePageStackOverflowQuestions,
} from './plugin';
export { StackOverflowQuestionsCollator } from './search/StackOverflowQuestionsCollator';
@@ -1,72 +0,0 @@
/*
* Copyright 2022 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { IndexableDocument, DocumentCollator } from '@backstage/search-common';
import { Config } from '@backstage/config';
import fetch from 'cross-fetch';
import qs from 'qs';
import {
StackOverflowQuestion,
StackOverflowQuestionsRequestParams,
} from '../../types';
interface StackOverflowDocument extends IndexableDocument {
answers: number;
tags: string[];
}
export class StackOverflowQuestionsCollator implements DocumentCollator {
protected baseUrl: string;
protected requestParams: StackOverflowQuestionsRequestParams;
public readonly type: string = 'stack-overflow';
constructor({
config,
requestParams,
}: {
config: Config;
requestParams: StackOverflowQuestionsRequestParams;
}) {
this.baseUrl = config.getString('stackoverflow.baseUrl');
this.requestParams = requestParams;
}
async execute() {
const params = this.requestParams
? `?${qs.stringify(this.requestParams)}`
: '';
const res = await fetch(`${this.baseUrl}/questions${params}`);
const data = await res.json();
return data.items.map(
({
title,
link,
owner: { display_name },
tags,
answer_count,
}: StackOverflowQuestion): StackOverflowDocument => {
return {
title: title,
location: link,
text: display_name,
tags: tags,
answers: answer_count,
};
},
);
}
}
@@ -1,17 +0,0 @@
/*
* Copyright 2022 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export { StackOverflowQuestionsCollator } from './StackOverflowQuestionsCollator';