@backstage/plugin-search-backend-module-explore 0.1.1 → 0.1.2-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/README.md +15 -0
- package/alpha/package.json +1 -1
- package/dist/index.cjs.js +9 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +3 -1
- package/package.json +9 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,44 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-module-explore
|
|
2
2
|
|
|
3
|
+
## 0.1.2-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/backend-common@0.19.0-next.1
|
|
9
|
+
- @backstage/backend-plugin-api@0.5.3-next.1
|
|
10
|
+
- @backstage/backend-tasks@0.5.3-next.1
|
|
11
|
+
- @backstage/plugin-search-backend-node@1.2.2-next.1
|
|
12
|
+
- @backstage/config@1.0.7
|
|
13
|
+
- @backstage/plugin-explore-common@0.0.1
|
|
14
|
+
- @backstage/plugin-search-common@1.2.4-next.0
|
|
15
|
+
|
|
16
|
+
## 0.1.2-next.0
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- a5baeea2cb87: Allows for an optional `tokenManager` to authenticate requests from the collator to the explore backend. For example:
|
|
21
|
+
|
|
22
|
+
```diff
|
|
23
|
+
indexBuilder.addCollator({
|
|
24
|
+
schedule: every10MinutesSchedule,
|
|
25
|
+
factory: ToolDocumentCollatorFactory.fromConfig(env.config, {
|
|
26
|
+
discovery: env.discovery,
|
|
27
|
+
logger: env.logger,
|
|
28
|
+
+ tokenManager: env.tokenManager,
|
|
29
|
+
}),
|
|
30
|
+
});
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
- Updated dependencies
|
|
34
|
+
- @backstage/backend-common@0.18.6-next.0
|
|
35
|
+
- @backstage/config@1.0.7
|
|
36
|
+
- @backstage/backend-plugin-api@0.5.3-next.0
|
|
37
|
+
- @backstage/backend-tasks@0.5.3-next.0
|
|
38
|
+
- @backstage/plugin-explore-common@0.0.1
|
|
39
|
+
- @backstage/plugin-search-backend-node@1.2.2-next.0
|
|
40
|
+
- @backstage/plugin-search-common@1.2.3
|
|
41
|
+
|
|
3
42
|
## 0.1.1
|
|
4
43
|
|
|
5
44
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -39,3 +39,18 @@ backend.add(searchPlugin());
|
|
|
39
39
|
backend.add(searchModuleExploreCollator({ schedule }));
|
|
40
40
|
backend.start();
|
|
41
41
|
```
|
|
42
|
+
|
|
43
|
+
### Using Auth Middleware
|
|
44
|
+
|
|
45
|
+
If your Backstage instance uses service-to-service authentication you can pass an optional `tokenManager` to the collator factory. This will ensure that the collator makes authenticated requests to the explore backend.
|
|
46
|
+
|
|
47
|
+
```tsx
|
|
48
|
+
indexBuilder.addCollator({
|
|
49
|
+
schedule: every10MinutesSchedule,
|
|
50
|
+
factory: ToolDocumentCollatorFactory.fromConfig(env.config, {
|
|
51
|
+
discovery: env.discovery,
|
|
52
|
+
logger: env.logger,
|
|
53
|
+
tokenManager: env.tokenManager,
|
|
54
|
+
}),
|
|
55
|
+
});
|
|
56
|
+
```
|
package/alpha/package.json
CHANGED
package/dist/index.cjs.js
CHANGED
|
@@ -14,6 +14,7 @@ class ToolDocumentCollatorFactory {
|
|
|
14
14
|
this.type = "tools";
|
|
15
15
|
this.discovery = options.discovery;
|
|
16
16
|
this.logger = options.logger;
|
|
17
|
+
this.tokenManager = options.tokenManager;
|
|
17
18
|
}
|
|
18
19
|
static fromConfig(_config, options) {
|
|
19
20
|
return new ToolDocumentCollatorFactory(options);
|
|
@@ -35,7 +36,14 @@ class ToolDocumentCollatorFactory {
|
|
|
35
36
|
}
|
|
36
37
|
async fetchTools() {
|
|
37
38
|
const baseUrl = await this.discovery.getBaseUrl("explore");
|
|
38
|
-
|
|
39
|
+
let headers = {};
|
|
40
|
+
if (this.tokenManager) {
|
|
41
|
+
const { token } = await this.tokenManager.getToken();
|
|
42
|
+
headers = {
|
|
43
|
+
Authorization: `Bearer ${token}`
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
const response = await fetch__default["default"](`${baseUrl}/tools`, headers);
|
|
39
47
|
if (!response.ok) {
|
|
40
48
|
throw new Error(
|
|
41
49
|
`Failed to explore fetch tools, ${response.status}: ${response.statusText}`
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/collators/ToolDocumentCollatorFactory.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/collators/ToolDocumentCollatorFactory.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n PluginEndpointDiscovery,\n TokenManager,\n} from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport { ExploreTool } from '@backstage/plugin-explore-common';\nimport {\n DocumentCollatorFactory,\n IndexableDocument,\n} from '@backstage/plugin-search-common';\nimport fetch from 'node-fetch';\nimport { Readable } from 'stream';\nimport { Logger } from 'winston';\n\n/**\n * Extended IndexableDocument with explore tool specific properties\n *\n * @public\n */\nexport interface ToolDocument extends IndexableDocument, ExploreTool {}\n\n/**\n * The options for the {@link ToolDocumentCollatorFactory}.\n *\n * @public\n */\nexport type ToolDocumentCollatorFactoryOptions = {\n discovery: PluginEndpointDiscovery;\n logger: Logger;\n tokenManager?: TokenManager;\n};\n\n/**\n * Search collator responsible for collecting explore tools to index.\n *\n * @public\n */\nexport class ToolDocumentCollatorFactory implements DocumentCollatorFactory {\n public readonly type: string = 'tools';\n\n private readonly discovery: PluginEndpointDiscovery;\n private readonly logger: Logger;\n private readonly tokenManager?: TokenManager;\n\n private constructor(options: ToolDocumentCollatorFactoryOptions) {\n this.discovery = options.discovery;\n this.logger = options.logger;\n this.tokenManager = options.tokenManager;\n }\n\n static fromConfig(\n _config: Config,\n options: ToolDocumentCollatorFactoryOptions,\n ) {\n return new ToolDocumentCollatorFactory(options);\n }\n\n async getCollator() {\n return Readable.from(this.execute());\n }\n\n async *execute(): AsyncGenerator<ToolDocument> {\n this.logger.info('Starting collation of explore tools');\n\n const tools = await this.fetchTools();\n\n for (const tool of tools) {\n yield {\n ...tool,\n text: tool.description,\n location: tool.url,\n };\n }\n\n this.logger.info('Finished collation of explore tools');\n }\n\n private async fetchTools() {\n const baseUrl = await this.discovery.getBaseUrl('explore');\n\n let headers = {};\n\n if (this.tokenManager) {\n const { token } = await this.tokenManager.getToken();\n headers = {\n Authorization: `Bearer ${token}`,\n };\n }\n\n const response = await fetch(`${baseUrl}/tools`, headers);\n\n if (!response.ok) {\n throw new Error(\n `Failed to explore fetch tools, ${response.status}: ${response.statusText}`,\n );\n }\n\n const data = await response.json();\n return data.tools;\n }\n}\n"],"names":["Readable","fetch"],"mappings":";;;;;;;;;;;AAqDO,MAAM,2BAA+D,CAAA;AAAA,EAOlE,YAAY,OAA6C,EAAA;AANjE,IAAA,IAAA,CAAgB,IAAe,GAAA,OAAA,CAAA;AAO7B,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,OAAO,UACL,CAAA,OAAA,EACA,OACA,EAAA;AACA,IAAO,OAAA,IAAI,4BAA4B,OAAO,CAAA,CAAA;AAAA,GAChD;AAAA,EAEA,MAAM,WAAc,GAAA;AAClB,IAAA,OAAOA,eAAS,CAAA,IAAA,CAAK,IAAK,CAAA,OAAA,EAAS,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAO,OAAwC,GAAA;AAC7C,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,qCAAqC,CAAA,CAAA;AAEtD,IAAM,MAAA,KAAA,GAAQ,MAAM,IAAA,CAAK,UAAW,EAAA,CAAA;AAEpC,IAAA,KAAA,MAAW,QAAQ,KAAO,EAAA;AACxB,MAAM,MAAA;AAAA,QACJ,GAAG,IAAA;AAAA,QACH,MAAM,IAAK,CAAA,WAAA;AAAA,QACX,UAAU,IAAK,CAAA,GAAA;AAAA,OACjB,CAAA;AAAA,KACF;AAEA,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,qCAAqC,CAAA,CAAA;AAAA,GACxD;AAAA,EAEA,MAAc,UAAa,GAAA;AACzB,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,SAAA,CAAU,WAAW,SAAS,CAAA,CAAA;AAEzD,IAAA,IAAI,UAAU,EAAC,CAAA;AAEf,IAAA,IAAI,KAAK,YAAc,EAAA;AACrB,MAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,aAAa,QAAS,EAAA,CAAA;AACnD,MAAU,OAAA,GAAA;AAAA,QACR,eAAe,CAAU,OAAA,EAAA,KAAA,CAAA,CAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,QAAW,GAAA,MAAMC,yBAAM,CAAA,CAAA,EAAG,iBAAiB,OAAO,CAAA,CAAA;AAExD,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,+BAAA,EAAkC,QAAS,CAAA,MAAA,CAAA,EAAA,EAAW,QAAS,CAAA,UAAA,CAAA,CAAA;AAAA,OACjE,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AACjC,IAAA,OAAO,IAAK,CAAA,KAAA,CAAA;AAAA,GACd;AACF;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { PluginEndpointDiscovery } from '@backstage/backend-common';
|
|
2
|
+
import { PluginEndpointDiscovery, TokenManager } from '@backstage/backend-common';
|
|
3
3
|
import { Config } from '@backstage/config';
|
|
4
4
|
import { ExploreTool } from '@backstage/plugin-explore-common';
|
|
5
5
|
import { IndexableDocument, DocumentCollatorFactory } from '@backstage/plugin-search-common';
|
|
@@ -21,6 +21,7 @@ interface ToolDocument extends IndexableDocument, ExploreTool {
|
|
|
21
21
|
type ToolDocumentCollatorFactoryOptions = {
|
|
22
22
|
discovery: PluginEndpointDiscovery;
|
|
23
23
|
logger: Logger;
|
|
24
|
+
tokenManager?: TokenManager;
|
|
24
25
|
};
|
|
25
26
|
/**
|
|
26
27
|
* Search collator responsible for collecting explore tools to index.
|
|
@@ -31,6 +32,7 @@ declare class ToolDocumentCollatorFactory implements DocumentCollatorFactory {
|
|
|
31
32
|
readonly type: string;
|
|
32
33
|
private readonly discovery;
|
|
33
34
|
private readonly logger;
|
|
35
|
+
private readonly tokenManager?;
|
|
34
36
|
private constructor();
|
|
35
37
|
static fromConfig(_config: Config, options: ToolDocumentCollatorFactoryOptions): ToolDocumentCollatorFactory;
|
|
36
38
|
getCollator(): Promise<Readable>;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-module-explore",
|
|
3
3
|
"description": "A module for the search backend that exports explore modules",
|
|
4
|
-
"version": "0.1.1",
|
|
4
|
+
"version": "0.1.2-next.1",
|
|
5
5
|
"main": "./dist/index.cjs.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -34,19 +34,20 @@
|
|
|
34
34
|
"clean": "backstage-cli package clean"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@backstage/backend-common": "^0.
|
|
38
|
-
"@backstage/backend-plugin-api": "^0.5.
|
|
39
|
-
"@backstage/backend-tasks": "^0.5.
|
|
37
|
+
"@backstage/backend-common": "^0.19.0-next.1",
|
|
38
|
+
"@backstage/backend-plugin-api": "^0.5.3-next.1",
|
|
39
|
+
"@backstage/backend-tasks": "^0.5.3-next.1",
|
|
40
40
|
"@backstage/config": "^1.0.7",
|
|
41
41
|
"@backstage/plugin-explore-common": "^0.0.1",
|
|
42
|
-
"@backstage/plugin-search-backend-node": "^1.2.1",
|
|
43
|
-
"@backstage/plugin-search-common": "^1.2.
|
|
42
|
+
"@backstage/plugin-search-backend-node": "^1.2.2-next.1",
|
|
43
|
+
"@backstage/plugin-search-common": "^1.2.4-next.0",
|
|
44
44
|
"node-fetch": "^2.6.7",
|
|
45
45
|
"winston": "^3.2.1"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
|
-
"@backstage/backend-test-utils": "^0.1.
|
|
49
|
-
"@backstage/cli": "^0.22.
|
|
48
|
+
"@backstage/backend-test-utils": "^0.1.38-next.1",
|
|
49
|
+
"@backstage/cli": "^0.22.8-next.1",
|
|
50
|
+
"msw": "^1.2.1"
|
|
50
51
|
},
|
|
51
52
|
"files": [
|
|
52
53
|
"dist",
|