@backstage/plugin-catalog-backend 2.0.0-next.2 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,117 @@
 # @backstage/plugin-catalog-backend
 
+## 2.0.0
+
+### Major Changes
+
+- 90ab044: **BREAKING**: Removed all deprecated exports, and removed support for the old backend system.
+
+  It also removes the `CodeOwnersProcessor` from the default set of processors, because it is expensive to run and has vague semantics. You need to update your backend to add it to the `catalogProcessingExtensionPoint` if you wish to continue using it.
+
+  The following removed exports are available from `@backstage/plugin-catalog-node`:
+
+  - `locationSpecToMetadataName`
+  - `locationSpecToLocationEntity`
+  - `processingResult`
+  - `EntitiesSearchFilter`
+  - `EntityFilter`
+  - `DeferredEntity`
+  - `EntityRelationSpec`
+  - `CatalogProcessor`
+  - `CatalogProcessorParser`
+  - `CatalogProcessorCache`
+  - `CatalogProcessorEmit`
+  - `CatalogProcessorLocationResult`
+  - `CatalogProcessorEntityResult`
+  - `CatalogProcessorRelationResult`
+  - `CatalogProcessorErrorResult`
+  - `CatalogProcessorRefreshKeysResult`
+  - `CatalogProcessorResult`
+  - `EntityProvider`
+  - `EntityProviderConnection`
+  - `EntityProviderMutation`
+  - `AnalyzeOptions`
+  - `LocationAnalyzer`
+  - `ScmLocationAnalyzer`
+  - `PlaceholderResolver`
+  - `PlaceholderResolverParams`
+  - `PlaceholderResolverRead`
+  - `PlaceholderResolverResolveUrl`
+  - `parseEntityYaml`
+
+  The following removed exports are available from `@backstage/plugin-catalog-common`:
+
+  - `LocationSpec`
+  - `AnalyzeLocationRequest`
+  - `AnalyzeLocationResponse`
+  - `AnalyzeLocationExistingEntity`
+  - `AnalyzeLocationGenerateEntity`
+  - `AnalyzeLocationEntityField`
+
+  The following removed exports are instead implemented in the new backend system by `@backstage/plugin-search-backend-module-catalog`:
+
+  - `defaultCatalogCollatorEntityTransformer`
+  - `CatalogCollatorEntityTransformer`
+  - `DefaultCatalogCollator`
+
+  The following exports are removed without a direct replacement:
+
+  - `DefaultCatalogCollatorFactory`
+  - `DefaultCatalogCollatorFactoryOptions`
+  - `LocationEntityProcessor`
+  - `LocationEntityProcessorOptions`
+  - `CatalogBuilder`
+  - `CatalogEnvironment`
+  - `CatalogPermissionRuleInput`
+  - `CatalogProcessingEngine`
+  - `createRandomProcessingInterval`
+  - `ProcessingIntervalFunction`
+
+### Minor Changes
+
+- 6c9b88e: **BREAKING ALPHA**: You can no longer import the catalog plugin from the `/alpha` export; please use the regular root default export instead.
+- d88b922: Adds the ability to disable the default entity processors using a new boolean app config item `catalog.disableDefaultProcessors`.
+
+### Patch Changes
+
+- 0e710fc: This patch addresses an issue identified in Backstage when configured with a MySQL database. If an entity of type location
+  (e..all.yaml) has more than 70 referenced entities, clicking "Refresh" does not update the referenced entities as expected. This occurs because the TEXT type in MySQL has a limit of 65,535 bytes, which is insufficient to store all the referenced entities, causing the refresh operation to fail.
+- 8e0f15f: "Added a note clarifying that `entity-fetch` audit events are not visible by default in the logs and are only displayed when the log severity level is adjusted."
+- Updated dependencies
+  - @backstage/integration@1.17.0
+  - @backstage/catalog-model@1.7.4
+  - @backstage/plugin-catalog-node@1.17.0
+  - @backstage/backend-plugin-api@1.3.1
+  - @backstage/plugin-permission-common@0.9.0
+  - @backstage/plugin-permission-node@0.10.0
+  - @backstage/catalog-client@1.10.0
+  - @backstage/backend-openapi-utils@0.5.3
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-catalog-common@1.1.4
+  - @backstage/plugin-events-node@0.4.11
+
+## 2.0.0-next.3
+
+### Patch Changes
+
+- 8e0f15f: "Added a note clarifying that `entity-fetch` audit events are not visible by default in the logs and are only displayed when the log severity level is adjusted."
+- Updated dependencies
+  - @backstage/integration@1.17.0-next.3
+  - @backstage/backend-openapi-utils@0.5.3-next.2
+  - @backstage/backend-plugin-api@1.3.1-next.2
+  - @backstage/catalog-client@1.10.0-next.0
+  - @backstage/catalog-model@1.7.3
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-catalog-common@1.1.4-next.0
+  - @backstage/plugin-catalog-node@1.17.0-next.2
+  - @backstage/plugin-events-node@0.4.11-next.2
+  - @backstage/plugin-permission-common@0.9.0-next.0
+  - @backstage/plugin-permission-node@0.10.0-next.2
+
 ## 2.0.0-next.2
 
 ### Patch Changes

package/README.md

@@ -94,6 +94,7 @@ The Catalog backend emits audit events for various operations. Events are groupe
 **Entity Events:**
 
 - **`entity-fetch`**: Retrieves entities.
+- **Note:** By default, "low" severity audit events like `entity-fetch` aren't logged because they map to the "debug" level, while Backstage defaults to "info" level logging. To see `entity-fetch` events, update your `app-config.yaml` by setting `backend.auditor.severityLogLevelMappings.low: info`. See the [Auditor Service documentation](https://backstage.io/docs/backend-system/core-services/auditor/#severity-levels-and-default-mappings) for details on severity mappings.
 
   Filter on `queryType`.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend",
-  "version": "2.0.0-next.2",
+  "version": "2.0.0",
   "description": "The Backstage backend plugin that provides the Backstage catalog",
   "backstage": {
     "role": "backend-plugin",
@@ -73,19 +73,19 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-openapi-utils": "0.5.3-next.1",
-    "@backstage/backend-plugin-api": "1.3.1-next.1",
-    "@backstage/catalog-client": "1.10.0-next.0",
-    "@backstage/catalog-model": "1.7.3",
-    "@backstage/config": "1.3.2",
-    "@backstage/errors": "1.2.7",
-    "@backstage/integration": "1.17.0-next.2",
-    "@backstage/plugin-catalog-common": "1.1.4-next.0",
-    "@backstage/plugin-catalog-node": "1.17.0-next.1",
-    "@backstage/plugin-events-node": "0.4.11-next.1",
-    "@backstage/plugin-permission-common": "0.9.0-next.0",
-    "@backstage/plugin-permission-node": "0.10.0-next.1",
-    "@backstage/types": "1.2.1",
+    "@backstage/backend-openapi-utils": "^0.5.3",
+    "@backstage/backend-plugin-api": "^1.3.1",
+    "@backstage/catalog-client": "^1.10.0",
+    "@backstage/catalog-model": "^1.7.4",
+    "@backstage/config": "^1.3.2",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/integration": "^1.17.0",
+    "@backstage/plugin-catalog-common": "^1.1.4",
+    "@backstage/plugin-catalog-node": "^1.17.0",
+    "@backstage/plugin-events-node": "^0.4.11",
+    "@backstage/plugin-permission-common": "^0.9.0",
+    "@backstage/plugin-permission-node": "^0.10.0",
+    "@backstage/types": "^1.2.1",
     "@opentelemetry/api": "^1.9.0",
     "codeowners-utils": "^1.0.2",
     "core-js": "^3.6.5",
@@ -106,12 +106,12 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "0.10.0-next.2",
-    "@backstage/backend-test-utils": "1.5.0-next.2",
-    "@backstage/cli": "0.32.1-next.2",
-    "@backstage/plugin-permission-common": "0.9.0-next.0",
-    "@backstage/repo-tools": "0.13.3-next.2",
-    "@backstage/test-utils": "1.7.8-next.1",
+    "@backstage/backend-defaults": "^0.10.0",
+    "@backstage/backend-test-utils": "^1.5.0",
+    "@backstage/cli": "^0.32.1",
+    "@backstage/plugin-permission-common": "^0.9.0",
+    "@backstage/repo-tools": "^0.13.3",
+    "@backstage/test-utils": "^1.7.8",
     "@types/core-js": "^2.5.4",
     "@types/express": "^4.17.6",
     "@types/git-url-parse": "^9.0.0",