@backstage/plugin-search-backend-node 1.4.8-next.1 → 1.4.8
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 +11 -0
- package/dist/IndexBuilder.cjs.js +1 -1
- package/dist/IndexBuilder.cjs.js.map +1 -1
- package/package.json +9 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-node
|
|
2
2
|
|
|
3
|
+
## 1.4.8
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 736d84e: Use locale-insensitive Unicode casing for consistent string handling across environments.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/config@1.3.9
|
|
10
|
+
- @backstage/backend-plugin-api@1.10.1
|
|
11
|
+
- @backstage/plugin-permission-common@0.9.11
|
|
12
|
+
- @backstage/plugin-search-common@1.2.25
|
|
13
|
+
|
|
3
14
|
## 1.4.8-next.1
|
|
4
15
|
|
|
5
16
|
### Patch Changes
|
package/dist/IndexBuilder.cjs.js
CHANGED
|
@@ -77,7 +77,7 @@ class IndexBuilder {
|
|
|
77
77
|
Object.keys(this.collators).forEach((type) => {
|
|
78
78
|
const taskLogger = this.logger.child({ documentType: type });
|
|
79
79
|
scheduler.addToSchedule({
|
|
80
|
-
id: `search_index_${type.replace("-", "_").
|
|
80
|
+
id: `search_index_${type.replace("-", "_").toLowerCase()}`,
|
|
81
81
|
scheduledRunner: this.collators[type].schedule,
|
|
82
82
|
task: async () => {
|
|
83
83
|
const collator = await this.collators[type].factory.getCollator();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IndexBuilder.cjs.js","sources":["../src/IndexBuilder.ts"],"sourcesContent":["/*\n * Copyright 2021 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 DocumentDecoratorFactory,\n DocumentTypeInfo,\n} from '@backstage/plugin-search-common';\nimport { pipeline, Transform } from 'node:stream';\nimport { Scheduler } from './Scheduler';\nimport {\n IndexBuilderOptions,\n RegisterCollatorParameters,\n RegisterDecoratorParameters,\n SearchEngine,\n} from './types';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\n/**\n * Used for adding collators, decorators and compile them into tasks which are added to a scheduler returned to the caller.\n * @public\n */\nexport class IndexBuilder {\n private collators: Record<string, RegisterCollatorParameters>;\n private decorators: Record<string, DocumentDecoratorFactory[]>;\n private documentTypes: Record<string, DocumentTypeInfo>;\n private searchEngine: SearchEngine;\n private logger: LoggerService;\n\n constructor(options: IndexBuilderOptions) {\n this.collators = {};\n this.decorators = {};\n this.documentTypes = {};\n this.logger = options.logger;\n this.searchEngine = options.searchEngine;\n }\n\n /**\n * Responsible for returning the registered search engine.\n */\n getSearchEngine(): SearchEngine {\n return this.searchEngine;\n }\n\n /**\n * Responsible for returning the registered document types.\n */\n getDocumentTypes(): Record<string, DocumentTypeInfo> {\n return this.documentTypes;\n }\n\n /**\n * Makes the index builder aware of a collator that should be executed at the\n * given refresh interval.\n */\n addCollator(options: RegisterCollatorParameters): void {\n const { factory, schedule } = options;\n\n this.logger.info(\n `Added ${factory.constructor.name} collator factory for type ${factory.type}`,\n );\n this.collators[factory.type] = {\n factory,\n schedule,\n };\n this.documentTypes[factory.type] = {\n visibilityPermission: factory.visibilityPermission,\n };\n }\n\n /**\n * Makes the index builder aware of a decorator. If no types are provided on\n * the decorator, it will be applied to documents from all known collators,\n * otherwise it will only be applied to documents of the given types.\n */\n addDecorator(options: RegisterDecoratorParameters): void {\n const { factory } = options;\n const types = factory.types || ['*'];\n this.logger.info(\n `Added decorator ${factory.constructor.name} to types ${types.join(\n ', ',\n )}`,\n );\n types.forEach(type => {\n if (this.decorators.hasOwnProperty(type)) {\n this.decorators[type].push(factory);\n } else {\n this.decorators[type] = [factory];\n }\n });\n }\n\n /**\n * Compiles collators and decorators into tasks, which are added to a\n * scheduler returned to the caller.\n */\n async build(): Promise<{ scheduler: Scheduler }> {\n const scheduler = new Scheduler({\n logger: this.logger,\n });\n\n Object.keys(this.collators).forEach(type => {\n const taskLogger = this.logger.child({ documentType: type });\n scheduler.addToSchedule({\n id: `search_index_${type.replace('-', '_').
|
|
1
|
+
{"version":3,"file":"IndexBuilder.cjs.js","sources":["../src/IndexBuilder.ts"],"sourcesContent":["/*\n * Copyright 2021 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 DocumentDecoratorFactory,\n DocumentTypeInfo,\n} from '@backstage/plugin-search-common';\nimport { pipeline, Transform } from 'node:stream';\nimport { Scheduler } from './Scheduler';\nimport {\n IndexBuilderOptions,\n RegisterCollatorParameters,\n RegisterDecoratorParameters,\n SearchEngine,\n} from './types';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\n/**\n * Used for adding collators, decorators and compile them into tasks which are added to a scheduler returned to the caller.\n * @public\n */\nexport class IndexBuilder {\n private collators: Record<string, RegisterCollatorParameters>;\n private decorators: Record<string, DocumentDecoratorFactory[]>;\n private documentTypes: Record<string, DocumentTypeInfo>;\n private searchEngine: SearchEngine;\n private logger: LoggerService;\n\n constructor(options: IndexBuilderOptions) {\n this.collators = {};\n this.decorators = {};\n this.documentTypes = {};\n this.logger = options.logger;\n this.searchEngine = options.searchEngine;\n }\n\n /**\n * Responsible for returning the registered search engine.\n */\n getSearchEngine(): SearchEngine {\n return this.searchEngine;\n }\n\n /**\n * Responsible for returning the registered document types.\n */\n getDocumentTypes(): Record<string, DocumentTypeInfo> {\n return this.documentTypes;\n }\n\n /**\n * Makes the index builder aware of a collator that should be executed at the\n * given refresh interval.\n */\n addCollator(options: RegisterCollatorParameters): void {\n const { factory, schedule } = options;\n\n this.logger.info(\n `Added ${factory.constructor.name} collator factory for type ${factory.type}`,\n );\n this.collators[factory.type] = {\n factory,\n schedule,\n };\n this.documentTypes[factory.type] = {\n visibilityPermission: factory.visibilityPermission,\n };\n }\n\n /**\n * Makes the index builder aware of a decorator. If no types are provided on\n * the decorator, it will be applied to documents from all known collators,\n * otherwise it will only be applied to documents of the given types.\n */\n addDecorator(options: RegisterDecoratorParameters): void {\n const { factory } = options;\n const types = factory.types || ['*'];\n this.logger.info(\n `Added decorator ${factory.constructor.name} to types ${types.join(\n ', ',\n )}`,\n );\n types.forEach(type => {\n if (this.decorators.hasOwnProperty(type)) {\n this.decorators[type].push(factory);\n } else {\n this.decorators[type] = [factory];\n }\n });\n }\n\n /**\n * Compiles collators and decorators into tasks, which are added to a\n * scheduler returned to the caller.\n */\n async build(): Promise<{ scheduler: Scheduler }> {\n const scheduler = new Scheduler({\n logger: this.logger,\n });\n\n Object.keys(this.collators).forEach(type => {\n const taskLogger = this.logger.child({ documentType: type });\n scheduler.addToSchedule({\n id: `search_index_${type.replace('-', '_').toLowerCase()}`,\n scheduledRunner: this.collators[type].schedule,\n task: async () => {\n // Instantiate the collator.\n const collator = await this.collators[type].factory.getCollator();\n taskLogger.info(\n `Collating documents for ${type} via ${this.collators[type].factory.constructor.name}`,\n );\n\n // Instantiate all relevant decorators.\n const decorators: Transform[] = await Promise.all(\n (this.decorators['*'] || [])\n .concat(this.decorators[type] || [])\n .map(async factory => {\n const decorator = await factory.getDecorator();\n taskLogger.info(\n `Attached decorator via ${factory.constructor.name} to ${type} index pipeline.`,\n );\n return decorator;\n }),\n );\n\n // Instantiate the indexer.\n const indexer = await this.searchEngine.getIndexer(type);\n\n // Compose collator/decorators/indexer into a pipeline\n return new Promise<void>((resolve, reject) => {\n pipeline(\n [collator, ...decorators, indexer],\n (error: NodeJS.ErrnoException | null) => {\n if (error) {\n taskLogger.error(\n `Collating documents for ${type} failed: ${error}`,\n );\n reject(error);\n } else {\n // Signal index pipeline completion!\n taskLogger.info(`Collating documents for ${type} succeeded`);\n resolve();\n }\n },\n );\n });\n },\n });\n });\n\n return {\n scheduler,\n };\n }\n}\n"],"names":["Scheduler","pipeline"],"mappings":";;;;;AAkCO,MAAM,YAAA,CAAa;AAAA,EAChB,SAAA;AAAA,EACA,UAAA;AAAA,EACA,aAAA;AAAA,EACA,YAAA;AAAA,EACA,MAAA;AAAA,EAER,YAAY,OAAA,EAA8B;AACxC,IAAA,IAAA,CAAK,YAAY,EAAC;AAClB,IAAA,IAAA,CAAK,aAAa,EAAC;AACnB,IAAA,IAAA,CAAK,gBAAgB,EAAC;AACtB,IAAA,IAAA,CAAK,SAAS,OAAA,CAAQ,MAAA;AACtB,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA,EAKA,eAAA,GAAgC;AAC9B,IAAA,OAAO,IAAA,CAAK,YAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAA,GAAqD;AACnD,IAAA,OAAO,IAAA,CAAK,aAAA;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAY,OAAA,EAA2C;AACrD,IAAA,MAAM,EAAE,OAAA,EAAS,QAAA,EAAS,GAAI,OAAA;AAE9B,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,MACV,SAAS,OAAA,CAAQ,WAAA,CAAY,IAAI,CAAA,2BAAA,EAA8B,QAAQ,IAAI,CAAA;AAAA,KAC7E;AACA,IAAA,IAAA,CAAK,SAAA,CAAU,OAAA,CAAQ,IAAI,CAAA,GAAI;AAAA,MAC7B,OAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,IAAA,CAAK,aAAA,CAAc,OAAA,CAAQ,IAAI,CAAA,GAAI;AAAA,MACjC,sBAAsB,OAAA,CAAQ;AAAA,KAChC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAa,OAAA,EAA4C;AACvD,IAAA,MAAM,EAAE,SAAQ,GAAI,OAAA;AACpB,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,KAAA,IAAS,CAAC,GAAG,CAAA;AACnC,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,MACV,CAAA,gBAAA,EAAmB,OAAA,CAAQ,WAAA,CAAY,IAAI,aAAa,KAAA,CAAM,IAAA;AAAA,QAC5D;AAAA,OACD,CAAA;AAAA,KACH;AACA,IAAA,KAAA,CAAM,QAAQ,CAAA,IAAA,KAAQ;AACpB,MAAA,IAAI,IAAA,CAAK,UAAA,CAAW,cAAA,CAAe,IAAI,CAAA,EAAG;AACxC,QAAA,IAAA,CAAK,UAAA,CAAW,IAAI,CAAA,CAAE,IAAA,CAAK,OAAO,CAAA;AAAA,MACpC,CAAA,MAAO;AACL,QAAA,IAAA,CAAK,UAAA,CAAW,IAAI,CAAA,GAAI,CAAC,OAAO,CAAA;AAAA,MAClC;AAAA,IACF,CAAC,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,KAAA,GAA2C;AAC/C,IAAA,MAAM,SAAA,GAAY,IAAIA,mBAAA,CAAU;AAAA,MAC9B,QAAQ,IAAA,CAAK;AAAA,KACd,CAAA;AAED,IAAA,MAAA,CAAO,IAAA,CAAK,IAAA,CAAK,SAAS,CAAA,CAAE,QAAQ,CAAA,IAAA,KAAQ;AAC1C,MAAA,MAAM,aAAa,IAAA,CAAK,MAAA,CAAO,MAAM,EAAE,YAAA,EAAc,MAAM,CAAA;AAC3D,MAAA,SAAA,CAAU,aAAA,CAAc;AAAA,QACtB,EAAA,EAAI,gBAAgB,IAAA,CAAK,OAAA,CAAQ,KAAK,GAAG,CAAA,CAAE,aAAa,CAAA,CAAA;AAAA,QACxD,eAAA,EAAiB,IAAA,CAAK,SAAA,CAAU,IAAI,CAAA,CAAE,QAAA;AAAA,QACtC,MAAM,YAAY;AAEhB,UAAA,MAAM,WAAW,MAAM,IAAA,CAAK,UAAU,IAAI,CAAA,CAAE,QAAQ,WAAA,EAAY;AAChE,UAAA,UAAA,CAAW,IAAA;AAAA,YACT,CAAA,wBAAA,EAA2B,IAAI,CAAA,KAAA,EAAQ,IAAA,CAAK,UAAU,IAAI,CAAA,CAAE,OAAA,CAAQ,WAAA,CAAY,IAAI,CAAA;AAAA,WACtF;AAGA,UAAA,MAAM,UAAA,GAA0B,MAAM,OAAA,CAAQ,GAAA;AAAA,YAAA,CAC3C,KAAK,UAAA,CAAW,GAAG,CAAA,IAAK,IACtB,MAAA,CAAO,IAAA,CAAK,UAAA,CAAW,IAAI,KAAK,EAAE,CAAA,CAClC,GAAA,CAAI,OAAM,OAAA,KAAW;AACpB,cAAA,MAAM,SAAA,GAAY,MAAM,OAAA,CAAQ,YAAA,EAAa;AAC7C,cAAA,UAAA,CAAW,IAAA;AAAA,gBACT,CAAA,uBAAA,EAA0B,OAAA,CAAQ,WAAA,CAAY,IAAI,OAAO,IAAI,CAAA,gBAAA;AAAA,eAC/D;AACA,cAAA,OAAO,SAAA;AAAA,YACT,CAAC;AAAA,WACL;AAGA,UAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,YAAA,CAAa,WAAW,IAAI,CAAA;AAGvD,UAAA,OAAO,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAA,KAAW;AAC5C,YAAAC,oBAAA;AAAA,cACE,CAAC,QAAA,EAAU,GAAG,UAAA,EAAY,OAAO,CAAA;AAAA,cACjC,CAAC,KAAA,KAAwC;AACvC,gBAAA,IAAI,KAAA,EAAO;AACT,kBAAA,UAAA,CAAW,KAAA;AAAA,oBACT,CAAA,wBAAA,EAA2B,IAAI,CAAA,SAAA,EAAY,KAAK,CAAA;AAAA,mBAClD;AACA,kBAAA,MAAA,CAAO,KAAK,CAAA;AAAA,gBACd,CAAA,MAAO;AAEL,kBAAA,UAAA,CAAW,IAAA,CAAK,CAAA,wBAAA,EAA2B,IAAI,CAAA,UAAA,CAAY,CAAA;AAC3D,kBAAA,OAAA,EAAQ;AAAA,gBACV;AAAA,cACF;AAAA,aACF;AAAA,UACF,CAAC,CAAA;AAAA,QACH;AAAA,OACD,CAAA;AAAA,IACH,CAAC,CAAA;AAED,IAAA,OAAO;AAAA,MACL;AAAA,KACF;AAAA,EACF;AACF;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-search-backend-node",
|
|
3
|
-
"version": "1.4.8
|
|
3
|
+
"version": "1.4.8",
|
|
4
4
|
"description": "A library for Backstage backend plugins that want to interact with the search backend plugin",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "node-library",
|
|
@@ -61,20 +61,20 @@
|
|
|
61
61
|
"test": "backstage-cli package test"
|
|
62
62
|
},
|
|
63
63
|
"dependencies": {
|
|
64
|
-
"@backstage/backend-plugin-api": "1.10.1
|
|
65
|
-
"@backstage/config": "1.3.9
|
|
66
|
-
"@backstage/errors": "1.3.1",
|
|
67
|
-
"@backstage/plugin-permission-common": "0.9.11
|
|
68
|
-
"@backstage/plugin-search-common": "1.2.25
|
|
64
|
+
"@backstage/backend-plugin-api": "^1.10.1",
|
|
65
|
+
"@backstage/config": "^1.3.9",
|
|
66
|
+
"@backstage/errors": "^1.3.1",
|
|
67
|
+
"@backstage/plugin-permission-common": "^0.9.11",
|
|
68
|
+
"@backstage/plugin-search-common": "^1.2.25",
|
|
69
69
|
"@types/lunr": "^2.3.3",
|
|
70
70
|
"lodash": "^4.17.21",
|
|
71
71
|
"lunr": "^2.3.9",
|
|
72
72
|
"ndjson": "^2.0.0"
|
|
73
73
|
},
|
|
74
74
|
"devDependencies": {
|
|
75
|
-
"@backstage/backend-defaults": "0.
|
|
76
|
-
"@backstage/backend-test-utils": "1.11.7
|
|
77
|
-
"@backstage/cli": "0.36.6
|
|
75
|
+
"@backstage/backend-defaults": "^0.18.0",
|
|
76
|
+
"@backstage/backend-test-utils": "^1.11.7",
|
|
77
|
+
"@backstage/cli": "^0.36.6",
|
|
78
78
|
"@types/ndjson": "^2.0.1"
|
|
79
79
|
}
|
|
80
80
|
}
|