@backstage/plugin-search-backend-node 1.4.3-next.1 → 1.4.3-next.2
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
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @backstage/plugin-search-backend-node
|
|
2
2
|
|
|
3
|
+
## 1.4.3-next.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 482ceed: Migrated from `assertError` to `toError` for error handling.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/errors@1.3.0-next.0
|
|
10
|
+
- @backstage/backend-plugin-api@1.9.0-next.2
|
|
11
|
+
- @backstage/config@1.3.7-next.0
|
|
12
|
+
- @backstage/plugin-permission-common@0.9.8-next.0
|
|
13
|
+
- @backstage/plugin-search-common@1.2.23-next.0
|
|
14
|
+
|
|
3
15
|
## 1.4.3-next.1
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
|
@@ -19,8 +19,7 @@ class BatchSearchEngineIndexer extends node_stream.Writable {
|
|
|
19
19
|
await this.initialize();
|
|
20
20
|
done();
|
|
21
21
|
} catch (e) {
|
|
22
|
-
errors.
|
|
23
|
-
done(e);
|
|
22
|
+
done(errors.toError(e));
|
|
24
23
|
}
|
|
25
24
|
}
|
|
26
25
|
/**
|
|
@@ -38,8 +37,7 @@ class BatchSearchEngineIndexer extends node_stream.Writable {
|
|
|
38
37
|
this.currentBatch = [];
|
|
39
38
|
done();
|
|
40
39
|
} catch (e) {
|
|
41
|
-
errors.
|
|
42
|
-
done(e);
|
|
40
|
+
done(errors.toError(e));
|
|
43
41
|
}
|
|
44
42
|
}
|
|
45
43
|
/**
|
|
@@ -55,8 +53,7 @@ class BatchSearchEngineIndexer extends node_stream.Writable {
|
|
|
55
53
|
await this.finalize();
|
|
56
54
|
done();
|
|
57
55
|
} catch (e) {
|
|
58
|
-
errors.
|
|
59
|
-
done(e);
|
|
56
|
+
done(errors.toError(e));
|
|
60
57
|
}
|
|
61
58
|
}
|
|
62
59
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BatchSearchEngineIndexer.cjs.js","sources":["../../src/indexing/BatchSearchEngineIndexer.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":"BatchSearchEngineIndexer.cjs.js","sources":["../../src/indexing/BatchSearchEngineIndexer.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 { toError } from '@backstage/errors';\nimport { IndexableDocument } from '@backstage/plugin-search-common';\nimport { Writable } from 'node:stream';\n\n/**\n * Options for {@link BatchSearchEngineIndexer}\n * @public\n */\nexport type BatchSearchEngineOptions = {\n batchSize: number;\n};\n\n/**\n * Base class encapsulating batch-based stream processing. Useful as a base\n * class for search engine indexers.\n * @public\n */\nexport abstract class BatchSearchEngineIndexer extends Writable {\n private batchSize: number;\n private currentBatch: IndexableDocument[] = [];\n\n constructor(options: BatchSearchEngineOptions) {\n super({ objectMode: true });\n this.batchSize = options.batchSize;\n }\n\n /**\n * Receives an array of indexable documents (of size this.batchSize) which\n * should be written to the search engine. This method won't be called again\n * at least until it resolves.\n */\n public abstract index(documents: IndexableDocument[]): Promise<void>;\n\n /**\n * Any asynchronous setup tasks can be performed here.\n */\n public abstract initialize(): Promise<void>;\n\n /**\n * Any asynchronous teardown tasks can be performed here.\n */\n public abstract finalize(): Promise<void>;\n\n /**\n * Encapsulates initialization logic.\n * @internal\n */\n async _construct(done: (error?: Error | null | undefined) => void) {\n try {\n await this.initialize();\n done();\n } catch (e) {\n done(toError(e));\n }\n }\n\n /**\n * Encapsulates batch stream write logic.\n * @internal\n */\n async _write(\n doc: IndexableDocument,\n _e: any,\n done: (error?: Error | null) => void,\n ) {\n this.currentBatch.push(doc);\n if (this.currentBatch.length < this.batchSize) {\n done();\n return;\n }\n\n try {\n await this.index(this.currentBatch);\n this.currentBatch = [];\n done();\n } catch (e) {\n done(toError(e));\n }\n }\n\n /**\n * Encapsulates finalization and final error handling logic.\n * @internal\n */\n async _final(done: (error?: Error | null) => void) {\n try {\n // Index any remaining documents.\n if (this.currentBatch.length) {\n await this.index(this.currentBatch);\n this.currentBatch = [];\n }\n await this.finalize();\n done();\n } catch (e) {\n done(toError(e));\n }\n }\n}\n"],"names":["Writable","toError"],"mappings":";;;;;AAiCO,MAAe,iCAAiCA,oBAAA,CAAS;AAAA,EACtD,SAAA;AAAA,EACA,eAAoC,EAAC;AAAA,EAE7C,YAAY,OAAA,EAAmC;AAC7C,IAAA,KAAA,CAAM,EAAE,UAAA,EAAY,IAAA,EAAM,CAAA;AAC1B,IAAA,IAAA,CAAK,YAAY,OAAA,CAAQ,SAAA;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,MAAM,WAAW,IAAA,EAAkD;AACjE,IAAA,IAAI;AACF,MAAA,MAAM,KAAK,UAAA,EAAW;AACtB,MAAA,IAAA,EAAK;AAAA,IACP,SAAS,CAAA,EAAG;AACV,MAAA,IAAA,CAAKC,cAAA,CAAQ,CAAC,CAAC,CAAA;AAAA,IACjB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MAAA,CACJ,GAAA,EACA,EAAA,EACA,IAAA,EACA;AACA,IAAA,IAAA,CAAK,YAAA,CAAa,KAAK,GAAG,CAAA;AAC1B,IAAA,IAAI,IAAA,CAAK,YAAA,CAAa,MAAA,GAAS,IAAA,CAAK,SAAA,EAAW;AAC7C,MAAA,IAAA,EAAK;AACL,MAAA;AAAA,IACF;AAEA,IAAA,IAAI;AACF,MAAA,MAAM,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,YAAY,CAAA;AAClC,MAAA,IAAA,CAAK,eAAe,EAAC;AACrB,MAAA,IAAA,EAAK;AAAA,IACP,SAAS,CAAA,EAAG;AACV,MAAA,IAAA,CAAKA,cAAA,CAAQ,CAAC,CAAC,CAAA;AAAA,IACjB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAO,IAAA,EAAsC;AACjD,IAAA,IAAI;AAEF,MAAA,IAAI,IAAA,CAAK,aAAa,MAAA,EAAQ;AAC5B,QAAA,MAAM,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,YAAY,CAAA;AAClC,QAAA,IAAA,CAAK,eAAe,EAAC;AAAA,MACvB;AACA,MAAA,MAAM,KAAK,QAAA,EAAS;AACpB,MAAA,IAAA,EAAK;AAAA,IACP,SAAS,CAAA,EAAG;AACV,MAAA,IAAA,CAAKA,cAAA,CAAQ,CAAC,CAAC,CAAA;AAAA,IACjB;AAAA,EACF;AACF;;;;"}
|
|
@@ -16,8 +16,7 @@ class DecoratorBase extends node_stream.Transform {
|
|
|
16
16
|
await this.initialize();
|
|
17
17
|
done();
|
|
18
18
|
} catch (e) {
|
|
19
|
-
errors.
|
|
20
|
-
done(e);
|
|
19
|
+
done(errors.toError(e));
|
|
21
20
|
}
|
|
22
21
|
}
|
|
23
22
|
/**
|
|
@@ -41,8 +40,7 @@ class DecoratorBase extends node_stream.Transform {
|
|
|
41
40
|
this.push(decorated);
|
|
42
41
|
done();
|
|
43
42
|
} catch (e) {
|
|
44
|
-
errors.
|
|
45
|
-
done(e);
|
|
43
|
+
done(errors.toError(e));
|
|
46
44
|
}
|
|
47
45
|
}
|
|
48
46
|
/**
|
|
@@ -54,8 +52,7 @@ class DecoratorBase extends node_stream.Transform {
|
|
|
54
52
|
await this.finalize();
|
|
55
53
|
done();
|
|
56
54
|
} catch (e) {
|
|
57
|
-
errors.
|
|
58
|
-
done(e);
|
|
55
|
+
done(errors.toError(e));
|
|
59
56
|
}
|
|
60
57
|
}
|
|
61
58
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DecoratorBase.cjs.js","sources":["../../src/indexing/DecoratorBase.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":"DecoratorBase.cjs.js","sources":["../../src/indexing/DecoratorBase.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 { toError } from '@backstage/errors';\nimport { IndexableDocument } from '@backstage/plugin-search-common';\nimport { Transform } from 'node:stream';\n\n/**\n * Base class encapsulating simple async transformations. Useful as a base\n * class for Backstage search decorators.\n * @public\n */\nexport abstract class DecoratorBase extends Transform {\n constructor() {\n super({ objectMode: true });\n }\n\n /**\n * Any asynchronous setup tasks can be performed here.\n */\n public abstract initialize(): Promise<void>;\n\n /**\n * Receives a single indexable document. In your decorate method, you can:\n *\n * - Resolve `undefined` to indicate the record should be omitted.\n * - Resolve a single modified document, which could contain new fields,\n * edited fields, or removed fields.\n * - Resolve an array of indexable documents, if the purpose if the decorator\n * is to convert one document into multiple derivative documents.\n */\n public abstract decorate(\n document: IndexableDocument,\n ): Promise<IndexableDocument | IndexableDocument[] | undefined>;\n\n /**\n * Any asynchronous teardown tasks can be performed here.\n */\n public abstract finalize(): Promise<void>;\n\n /**\n * Encapsulates initialization logic.\n * @internal\n */\n async _construct(done: (error?: Error | null | undefined) => void) {\n try {\n await this.initialize();\n done();\n } catch (e) {\n done(toError(e));\n }\n }\n\n /**\n * Encapsulates simple transform stream logic.\n * @internal\n */\n async _transform(\n document: IndexableDocument,\n _: any,\n done: (error?: Error | null) => void,\n ) {\n try {\n const decorated = await this.decorate(document);\n\n // If undefined was returned, omit the record and move on.\n if (decorated === undefined) {\n done();\n return;\n }\n\n // If an array of documents was given, push them all.\n if (Array.isArray(decorated)) {\n decorated.forEach(doc => {\n this.push(doc);\n });\n done();\n return;\n }\n\n // Otherwise, just push the decorated document.\n this.push(decorated);\n done();\n } catch (e) {\n done(toError(e));\n }\n }\n\n /**\n * Encapsulates finalization and final error handling logic.\n * @internal\n */\n async _final(done: (error?: Error | null) => void) {\n try {\n await this.finalize();\n done();\n } catch (e) {\n done(toError(e));\n }\n }\n}\n"],"names":["Transform","toError"],"mappings":";;;;;AAyBO,MAAe,sBAAsBA,qBAAA,CAAU;AAAA,EACpD,WAAA,GAAc;AACZ,IAAA,KAAA,CAAM,EAAE,UAAA,EAAY,IAAA,EAAM,CAAA;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA,EA6BA,MAAM,WAAW,IAAA,EAAkD;AACjE,IAAA,IAAI;AACF,MAAA,MAAM,KAAK,UAAA,EAAW;AACtB,MAAA,IAAA,EAAK;AAAA,IACP,SAAS,CAAA,EAAG;AACV,MAAA,IAAA,CAAKC,cAAA,CAAQ,CAAC,CAAC,CAAA;AAAA,IACjB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,UAAA,CACJ,QAAA,EACA,CAAA,EACA,IAAA,EACA;AACA,IAAA,IAAI;AACF,MAAA,MAAM,SAAA,GAAY,MAAM,IAAA,CAAK,QAAA,CAAS,QAAQ,CAAA;AAG9C,MAAA,IAAI,cAAc,KAAA,CAAA,EAAW;AAC3B,QAAA,IAAA,EAAK;AACL,QAAA;AAAA,MACF;AAGA,MAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,SAAS,CAAA,EAAG;AAC5B,QAAA,SAAA,CAAU,QAAQ,CAAA,GAAA,KAAO;AACvB,UAAA,IAAA,CAAK,KAAK,GAAG,CAAA;AAAA,QACf,CAAC,CAAA;AACD,QAAA,IAAA,EAAK;AACL,QAAA;AAAA,MACF;AAGA,MAAA,IAAA,CAAK,KAAK,SAAS,CAAA;AACnB,MAAA,IAAA,EAAK;AAAA,IACP,SAAS,CAAA,EAAG;AACV,MAAA,IAAA,CAAKA,cAAA,CAAQ,CAAC,CAAC,CAAA;AAAA,IACjB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,OAAO,IAAA,EAAsC;AACjD,IAAA,IAAI;AACF,MAAA,MAAM,KAAK,QAAA,EAAS;AACpB,MAAA,IAAA,EAAK;AAAA,IACP,SAAS,CAAA,EAAG;AACV,MAAA,IAAA,CAAKA,cAAA,CAAQ,CAAC,CAAC,CAAA;AAAA,IACjB;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.3-next.
|
|
3
|
+
"version": "1.4.3-next.2",
|
|
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,11 +61,11 @@
|
|
|
61
61
|
"test": "backstage-cli package test"
|
|
62
62
|
},
|
|
63
63
|
"dependencies": {
|
|
64
|
-
"@backstage/backend-plugin-api": "1.9.0-next.
|
|
65
|
-
"@backstage/config": "1.3.
|
|
66
|
-
"@backstage/errors": "1.
|
|
67
|
-
"@backstage/plugin-permission-common": "0.9.
|
|
68
|
-
"@backstage/plugin-search-common": "1.2.
|
|
64
|
+
"@backstage/backend-plugin-api": "1.9.0-next.2",
|
|
65
|
+
"@backstage/config": "1.3.7-next.0",
|
|
66
|
+
"@backstage/errors": "1.3.0-next.0",
|
|
67
|
+
"@backstage/plugin-permission-common": "0.9.8-next.0",
|
|
68
|
+
"@backstage/plugin-search-common": "1.2.23-next.0",
|
|
69
69
|
"@types/lunr": "^2.3.3",
|
|
70
70
|
"lodash": "^4.17.21",
|
|
71
71
|
"lunr": "^2.3.9",
|
|
@@ -73,9 +73,9 @@
|
|
|
73
73
|
"uuid": "^11.0.0"
|
|
74
74
|
},
|
|
75
75
|
"devDependencies": {
|
|
76
|
-
"@backstage/backend-defaults": "0.16.1-next.
|
|
77
|
-
"@backstage/backend-test-utils": "1.11.2-next.
|
|
78
|
-
"@backstage/cli": "0.36.1-next.
|
|
76
|
+
"@backstage/backend-defaults": "0.16.1-next.2",
|
|
77
|
+
"@backstage/backend-test-utils": "1.11.2-next.2",
|
|
78
|
+
"@backstage/cli": "0.36.1-next.2",
|
|
79
79
|
"@types/ndjson": "^2.0.1"
|
|
80
80
|
}
|
|
81
81
|
}
|