@backstage/plugin-catalog-backend 3.4.0-next.1 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,73 @@
 # @backstage/plugin-catalog-backend
 
+## 3.4.0
+
+### Minor Changes
+
+- f1d29b4: Failures to connect catalog providers are now attributed to the module that provided the failing provider. This means that such failures will be reported as module startup failures rather than a failure to start the catalog plugin, and will therefore respect `onPluginModuleBootFailure` configuration instead.
+- 34cc520: Implemented handling of events from the newly introduced alpha
+  `catalogScmEventsServiceRef` service, in the builtin entity providers. This
+  allows entities to get refreshed, and locations updated or removed, as a
+  response to incoming events. In its first iteration, only the GitHub module
+  implements such event handling however.
+
+  This is not yet enabled by default, but this fact may change in a future
+  release. To try it out, ensure that you have the latest catalog GitHub module
+  installed, and set the following in your app-config:
+
+  ```yaml
+  catalog:
+    scmEvents: true
+  ```
+
+  Or if you want to pick and choose from the various features:
+
+  ```yaml
+  catalog:
+    scmEvents:
+      # refresh (reprocess) upon events?
+      refresh: true
+      # automatically unregister locations based on events? (files deleted, repos archived, etc)
+      unregister: true
+      # automatically move locations based on events? (repo transferred, file renamed, etc)
+      move: true
+  ```
+
+- b4e8249: Implemented the `POST /locations/by-query` endpoint which allows paginated, filtered location queries
+
+### Patch Changes
+
+- cfd8103: Updated imports to use stable catalog extension points from `@backstage/plugin-catalog-node` instead of the deprecated alpha exports.
+- 7455dae: Use node prefix on native imports
+- 5e3ef57: Added `peerModules` metadata declaring recommended modules for cross-plugin integrations.
+- 08a5813: Fixed O(n²) performance bottleneck in `buildEntitySearch` `traverse()` by replacing `Array.some()` linear scan with a `Set` for O(1) duplicate path key detection.
+- 1e669cc: Migrate audit events reference docs to http://backstage.io/docs.
+- 69d880e: Bump to latest zod to ensure it has the latest features
+- Updated dependencies
+  - @backstage/integration@1.20.0
+  - @backstage/plugin-catalog-node@2.0.0
+  - @backstage/backend-openapi-utils@0.6.6
+  - @backstage/backend-plugin-api@1.7.0
+  - @backstage/catalog-client@1.13.0
+  - @backstage/filter-predicates@0.1.0
+  - @backstage/plugin-permission-common@0.9.6
+  - @backstage/plugin-permission-node@0.10.10
+  - @backstage/plugin-catalog-common@1.1.8
+  - @backstage/plugin-events-node@0.4.19
+
+## 3.4.0-next.2
+
+### Patch Changes
+
+- 08a5813: Fixed O(n²) performance bottleneck in `buildEntitySearch` `traverse()` by replacing `Array.some()` linear scan with a `Set` for O(1) duplicate path key detection.
+- Updated dependencies
+  - @backstage/integration@1.20.0-next.2
+  - @backstage/plugin-catalog-node@2.0.0-next.1
+  - @backstage/catalog-client@1.12.2-next.0
+  - @backstage/backend-plugin-api@1.7.0-next.1
+  - @backstage/plugin-events-node@0.4.19-next.0
+  - @backstage/plugin-permission-node@0.10.10-next.0
+
 ## 3.4.0-next.1
 
 ### Patch Changes

package/config.d.ts

@@ -257,5 +257,48 @@ export interface Config {
         priority?: number;
       };
     };
+
+    /**
+     * Settings that control what to do when receiving messages from the SCM
+     * events service.
+     *
+     * @defaultValue false
+     * @remarks
+     *
+     * This is primarily meant to affect builtin providers in the catalog
+     * backend such as the location handler, but other providers and processors
+     * may also read this configuration.
+     *
+     * If set to false, disable all handling of SCM events.
+     *
+     * If set to true, enable all default handling of SCM events. Note that the
+     * set of default handling can change over time.
+     *
+     * You can also configure individual handlers one by one.
+     */
+    scmEvents?:
+      | boolean
+      | {
+          /**
+           * Trigger refreshes (reprocessing) of entities that are affected by an
+           * SCM event. This may include source control file content changes,
+           * repository status changes, etc.
+           *
+           * @defaultValue true
+           */
+          refresh?: boolean;
+          /**
+           * Unregister entities that are deleted as a result of an SCM event.
+           *
+           * @defaultValue true
+           */
+          unregister?: boolean;
+          /**
+           * Move entities that are moved as a result of an SCM event.
+           *
+           * @defaultValue true
+           */
+          move?: boolean;
+        };
   };
 }

package/dist/database/operations/stitcher/buildEntitySearch.cjs.js

@@ -16,6 +16,7 @@ const MAX_KEY_LENGTH = 200;
 const MAX_VALUE_LENGTH = 200;
 function traverse(root) {
   const output = [];
+  const seenPathKeys = /* @__PURE__ */ new Set();
   function visit(path, current) {
     if (SPECIAL_KEYS.includes(path)) {
       return;
@@ -32,9 +33,9 @@ function traverse(root) {
         visit(path, item);
         if (typeof item === "string") {
           const pathKey = `${path}.${item}`;
-          if (!output.some(
-            (kv) => kv.key.toLocaleLowerCase("en-US") === pathKey.toLocaleLowerCase("en-US")
-          )) {
+          const lowerKey = pathKey.toLocaleLowerCase("en-US");
+          if (!seenPathKeys.has(lowerKey)) {
+            seenPathKeys.add(lowerKey);
             output.push({ key: pathKey, value: true });
           }
         }

package/dist/database/operations/stitcher/buildEntitySearch.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"buildEntitySearch.cjs.js","sources":["../../../../src/database/operations/stitcher/buildEntitySearch.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { DEFAULT_NAMESPACE, Entity } from '@backstage/catalog-model';\nimport { InputError } from '@backstage/errors';\nimport { DbSearchRow } from '../../tables';\n\n// These are excluded in the generic loop, either because they do not make sense\n// to index, or because they are special-case always inserted whether they are\n// null or not\nconst SPECIAL_KEYS = [\n  'attachments',\n  'relations',\n  'status',\n  'metadata.name',\n  'metadata.namespace',\n  'metadata.uid',\n  'metadata.etag',\n];\n\n// The maximum length allowed for search values. These columns are indexed, and\n// database engines do not like to index on massive values. For example,\n// postgres will balk after 8191 byte line sizes.\nconst MAX_KEY_LENGTH = 200;\nconst MAX_VALUE_LENGTH = 200;\n\ntype Kv = {\n  key: string;\n  value: unknown;\n};\n\n// Helper for traversing through a nested structure and outputting a list of\n// path->value entries of the leaves.\n//\n// For example, this yaml structure\n//\n// a: 1\n// b:\n//   c: null\n//   e: [f, g]\n// h:\n//  - i: 1\n//    j: k\n//  - i: 2\n//    j: l\n//\n// will result in\n//\n// \"a\", 1\n// \"b.c\", null\n// \"b.e\": \"f\"\n// \"b.e.f\": true\n// \"b.e\": \"g\"\n// \"b.e.g\": true\n// \"h.i\": 1\n// \"h.j\": \"k\"\n// \"h.i\": 2\n// \"h.j\": \"l\"\nexport function traverse(root: unknown): Kv[] {\n  const output: Kv[] = [];\n\n  function visit(path: string, current: unknown) {\n    if (SPECIAL_KEYS.includes(path)) {\n      return;\n    }\n\n    // empty or scalar\n    if (\n      current === undefined ||\n      current === null ||\n      ['string', 'number', 'boolean'].includes(typeof current)\n    ) {\n      output.push({ key: path, value: current });\n      return;\n    }\n\n    // unknown\n    if (typeof current !== 'object') {\n      return;\n    }\n\n    // array\n    if (Array.isArray(current)) {\n      for (const item of current) {\n        // NOTE(freben): The reason that these are output in two different ways,\n        // is to support use cases where you want to express that MORE than one\n        // tag is present in a list. Since the EntityFilters structure is a\n        // record, you can't have several entries of the same key. Therefore\n        // you will have to match on\n        //\n        // { \"a.b\": [\"true\"], \"a.c\": [\"true\"] }\n        //\n        // rather than\n        //\n        // { \"a\": [\"b\", \"c\"] }\n        //\n        // because the latter means EITHER b or c has to be present.\n        visit(path, item);\n        if (typeof item === 'string') {\n          const pathKey = `${path}.${item}`;\n          if (\n            !output.some(\n              kv =>\n                kv.key.toLocaleLowerCase('en-US') ===\n                pathKey.toLocaleLowerCase('en-US'),\n            )\n          ) {\n            output.push({ key: pathKey, value: true });\n          }\n        }\n      }\n      return;\n    }\n\n    // object\n    for (const [key, value] of Object.entries(current!)) {\n      visit(path ? `${path}.${key}` : key, value);\n    }\n  }\n\n  visit('', root);\n\n  return output;\n}\n\n// Translates a number of raw data rows to search table rows\nexport function mapToRows(input: Kv[], entityId: string): DbSearchRow[] {\n  const result: DbSearchRow[] = [];\n\n  for (const { key: rawKey, value: rawValue } of input) {\n    const key = rawKey.toLocaleLowerCase('en-US');\n    if (key.length > MAX_KEY_LENGTH) {\n      continue;\n    }\n    if (rawValue === undefined || rawValue === null) {\n      result.push({\n        entity_id: entityId,\n        key,\n        original_value: null,\n        value: null,\n      });\n    } else {\n      const value = String(rawValue).toLocaleLowerCase('en-US');\n      if (value.length <= MAX_VALUE_LENGTH) {\n        result.push({\n          entity_id: entityId,\n          key,\n          original_value: String(rawValue),\n          value: value,\n        });\n      } else {\n        result.push({\n          entity_id: entityId,\n          key,\n          original_value: null,\n          value: null,\n        });\n      }\n    }\n  }\n\n  return result;\n}\n\n/**\n * Generates all of the search rows that are relevant for this entity.\n *\n * @param entityId - The uid of the entity\n * @param entity - The entity\n * @returns A list of entity search rows\n */\nexport function buildEntitySearch(\n  entityId: string,\n  entity: Entity,\n): DbSearchRow[] {\n  // Visit the base structure recursively\n  const raw = traverse(entity);\n\n  // Start with some special keys that are always present because you want to\n  // be able to easily search for null specifically\n  raw.push({ key: 'metadata.name', value: entity.metadata.name });\n  raw.push({ key: 'metadata.namespace', value: entity.metadata.namespace });\n  raw.push({ key: 'metadata.uid', value: entity.metadata.uid });\n\n  // Namespace not specified has the default value \"default\", so we want to\n  // match on that as well\n  if (!entity.metadata.namespace) {\n    raw.push({ key: 'metadata.namespace', value: DEFAULT_NAMESPACE });\n  }\n\n  // Visit relations\n  for (const relation of entity.relations ?? []) {\n    raw.push({\n      key: `relations.${relation.type}`,\n      value: relation.targetRef,\n    });\n  }\n\n  // This validates that there are no keys that vary only in casing, such\n  // as `spec.foo` and `spec.Foo`.\n  const keys = new Set(raw.map(r => r.key));\n  const lowerKeys = new Set(raw.map(r => r.key.toLocaleLowerCase('en-US')));\n  if (keys.size !== lowerKeys.size) {\n    const difference = [];\n    for (const key of keys) {\n      const lower = key.toLocaleLowerCase('en-US');\n      if (!lowerKeys.delete(lower)) {\n        difference.push(lower);\n      }\n    }\n    const badKeys = `'${difference.join(\"', '\")}'`;\n    throw new InputError(\n      `Entity has duplicate keys that vary only in casing, ${badKeys}`,\n    );\n  }\n\n  return mapToRows(raw, entityId);\n}\n"],"names":["DEFAULT_NAMESPACE","InputError"],"mappings":";;;;;AAuBA,MAAM,YAAA,GAAe;AAAA,EACnB,aAAA;AAAA,EACA,WAAA;AAAA,EACA,QAAA;AAAA,EACA,eAAA;AAAA,EACA,oBAAA;AAAA,EACA,cAAA;AAAA,EACA;AACF,CAAA;AAKA,MAAM,cAAA,GAAiB,GAAA;AACvB,MAAM,gBAAA,GAAmB,GAAA;AAkClB,SAAS,SAAS,IAAA,EAAqB;AAC5C,EAAA,MAAM,SAAe,EAAC;AAEtB,EAAA,SAAS,KAAA,CAAM,MAAc,OAAA,EAAkB;AAC7C,IAAA,IAAI,YAAA,CAAa,QAAA,CAAS,IAAI,CAAA,EAAG;AAC/B,MAAA;AAAA,IACF;AAGA,IAAA,IACE,OAAA,KAAY,MAAA,IACZ,OAAA,KAAY,IAAA,IACZ,CAAC,QAAA,EAAU,QAAA,EAAU,SAAS,CAAA,CAAE,QAAA,CAAS,OAAO,OAAO,CAAA,EACvD;AACA,MAAA,MAAA,CAAO,KAAK,EAAE,GAAA,EAAK,IAAA,EAAM,KAAA,EAAO,SAAS,CAAA;AACzC,MAAA;AAAA,IACF;AAGA,IAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAC/B,MAAA;AAAA,IACF;AAGA,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC1B,MAAA,KAAA,MAAW,QAAQ,OAAA,EAAS;AAc1B,QAAA,KAAA,CAAM,MAAM,IAAI,CAAA;AAChB,QAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC5B,UAAA,MAAM,OAAA,GAAU,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAC/B,UAAA,IACE,CAAC,MAAA,CAAO,IAAA;AAAA,YACN,CAAA,EAAA,KACE,GAAG,GAAA,CAAI,iBAAA,CAAkB,OAAO,CAAA,KAChC,OAAA,CAAQ,kBAAkB,OAAO;AAAA,WACrC,EACA;AACA,YAAA,MAAA,CAAO,KAAK,EAAE,GAAA,EAAK,OAAA,EAAS,KAAA,EAAO,MAAM,CAAA;AAAA,UAC3C;AAAA,QACF;AAAA,MACF;AACA,MAAA;AAAA,IACF;AAGA,IAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,OAAQ,CAAA,EAAG;AACnD,MAAA,KAAA,CAAM,OAAO,CAAA,EAAG,IAAI,IAAI,GAAG,CAAA,CAAA,GAAK,KAAK,KAAK,CAAA;AAAA,IAC5C;AAAA,EACF;AAEA,EAAA,KAAA,CAAM,IAAI,IAAI,CAAA;AAEd,EAAA,OAAO,MAAA;AACT;AAGO,SAAS,SAAA,CAAU,OAAa,QAAA,EAAiC;AACtE,EAAA,MAAM,SAAwB,EAAC;AAE/B,EAAA,KAAA,MAAW,EAAE,GAAA,EAAK,MAAA,EAAQ,KAAA,EAAO,QAAA,MAAc,KAAA,EAAO;AACpD,IAAA,MAAM,GAAA,GAAM,MAAA,CAAO,iBAAA,CAAkB,OAAO,CAAA;AAC5C,IAAA,IAAI,GAAA,CAAI,SAAS,cAAA,EAAgB;AAC/B,MAAA;AAAA,IACF;AACA,IAAA,IAAI,QAAA,KAAa,MAAA,IAAa,QAAA,KAAa,IAAA,EAAM;AAC/C,MAAA,MAAA,CAAO,IAAA,CAAK;AAAA,QACV,SAAA,EAAW,QAAA;AAAA,QACX,GAAA;AAAA,QACA,cAAA,EAAgB,IAAA;AAAA,QAChB,KAAA,EAAO;AAAA,OACR,CAAA;AAAA,IACH,CAAA,MAAO;AACL,MAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,QAAQ,CAAA,CAAE,kBAAkB,OAAO,CAAA;AACxD,MAAA,IAAI,KAAA,CAAM,UAAU,gBAAA,EAAkB;AACpC,QAAA,MAAA,CAAO,IAAA,CAAK;AAAA,UACV,SAAA,EAAW,QAAA;AAAA,UACX,GAAA;AAAA,UACA,cAAA,EAAgB,OAAO,QAAQ,CAAA;AAAA,UAC/B;AAAA,SACD,CAAA;AAAA,MACH,CAAA,MAAO;AACL,QAAA,MAAA,CAAO,IAAA,CAAK;AAAA,UACV,SAAA,EAAW,QAAA;AAAA,UACX,GAAA;AAAA,UACA,cAAA,EAAgB,IAAA;AAAA,UAChB,KAAA,EAAO;AAAA,SACR,CAAA;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AASO,SAAS,iBAAA,CACd,UACA,MAAA,EACe;AAEf,EAAA,MAAM,GAAA,GAAM,SAAS,MAAM,CAAA;AAI3B,EAAA,GAAA,CAAI,IAAA,CAAK,EAAE,GAAA,EAAK,eAAA,EAAiB,OAAO,MAAA,CAAO,QAAA,CAAS,MAAM,CAAA;AAC9D,EAAA,GAAA,CAAI,IAAA,CAAK,EAAE,GAAA,EAAK,oBAAA,EAAsB,OAAO,MAAA,CAAO,QAAA,CAAS,WAAW,CAAA;AACxE,EAAA,GAAA,CAAI,IAAA,CAAK,EAAE,GAAA,EAAK,cAAA,EAAgB,OAAO,MAAA,CAAO,QAAA,CAAS,KAAK,CAAA;AAI5D,EAAA,IAAI,CAAC,MAAA,CAAO,QAAA,CAAS,SAAA,EAAW;AAC9B,IAAA,GAAA,CAAI,KAAK,EAAE,GAAA,EAAK,oBAAA,EAAsB,KAAA,EAAOA,gCAAmB,CAAA;AAAA,EAClE;AAGA,EAAA,KAAA,MAAW,QAAA,IAAY,MAAA,CAAO,SAAA,IAAa,EAAC,EAAG;AAC7C,IAAA,GAAA,CAAI,IAAA,CAAK;AAAA,MACP,GAAA,EAAK,CAAA,UAAA,EAAa,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,MAC/B,OAAO,QAAA,CAAS;AAAA,KACjB,CAAA;AAAA,EACH;AAIA,EAAA,MAAM,IAAA,GAAO,IAAI,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA,CAAA,KAAK,CAAA,CAAE,GAAG,CAAC,CAAA;AACxC,EAAA,MAAM,SAAA,GAAY,IAAI,GAAA,CAAI,GAAA,CAAI,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,GAAA,CAAI,iBAAA,CAAkB,OAAO,CAAC,CAAC,CAAA;AACxE,EAAA,IAAI,IAAA,CAAK,IAAA,KAAS,SAAA,CAAU,IAAA,EAAM;AAChC,IAAA,MAAM,aAAa,EAAC;AACpB,IAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,MAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,iBAAA,CAAkB,OAAO,CAAA;AAC3C,MAAA,IAAI,CAAC,SAAA,CAAU,MAAA,CAAO,KAAK,CAAA,EAAG;AAC5B,QAAA,UAAA,CAAW,KAAK,KAAK,CAAA;AAAA,MACvB;AAAA,IACF;AACA,IAAA,MAAM,OAAA,GAAU,CAAA,CAAA,EAAI,UAAA,CAAW,IAAA,CAAK,MAAM,CAAC,CAAA,CAAA,CAAA;AAC3C,IAAA,MAAM,IAAIC,iBAAA;AAAA,MACR,uDAAuD,OAAO,CAAA;AAAA,KAChE;AAAA,EACF;AAEA,EAAA,OAAO,SAAA,CAAU,KAAK,QAAQ,CAAA;AAChC;;;;;;"}
+{"version":3,"file":"buildEntitySearch.cjs.js","sources":["../../../../src/database/operations/stitcher/buildEntitySearch.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { DEFAULT_NAMESPACE, Entity } from '@backstage/catalog-model';\nimport { InputError } from '@backstage/errors';\nimport { DbSearchRow } from '../../tables';\n\n// These are excluded in the generic loop, either because they do not make sense\n// to index, or because they are special-case always inserted whether they are\n// null or not\nconst SPECIAL_KEYS = [\n  'attachments',\n  'relations',\n  'status',\n  'metadata.name',\n  'metadata.namespace',\n  'metadata.uid',\n  'metadata.etag',\n];\n\n// The maximum length allowed for search values. These columns are indexed, and\n// database engines do not like to index on massive values. For example,\n// postgres will balk after 8191 byte line sizes.\nconst MAX_KEY_LENGTH = 200;\nconst MAX_VALUE_LENGTH = 200;\n\ntype Kv = {\n  key: string;\n  value: unknown;\n};\n\n// Helper for traversing through a nested structure and outputting a list of\n// path->value entries of the leaves.\n//\n// For example, this yaml structure\n//\n// a: 1\n// b:\n//   c: null\n//   e: [f, g]\n// h:\n//  - i: 1\n//    j: k\n//  - i: 2\n//    j: l\n//\n// will result in\n//\n// \"a\", 1\n// \"b.c\", null\n// \"b.e\": \"f\"\n// \"b.e.f\": true\n// \"b.e\": \"g\"\n// \"b.e.g\": true\n// \"h.i\": 1\n// \"h.j\": \"k\"\n// \"h.i\": 2\n// \"h.j\": \"l\"\nexport function traverse(root: unknown): Kv[] {\n  const output: Kv[] = [];\n  // Use a Set for O(1) case-insensitive duplicate detection of synthetic\n  // boolean path keys (e.g. \"metadata.tags.java\"), instead of the previous\n  // O(n) Array.some() linear scan which caused O(n²) overall complexity\n  // and severe event loop blocking for entities with large arrays.\n  const seenPathKeys = new Set<string>();\n\n  function visit(path: string, current: unknown) {\n    if (SPECIAL_KEYS.includes(path)) {\n      return;\n    }\n\n    // empty or scalar\n    if (\n      current === undefined ||\n      current === null ||\n      ['string', 'number', 'boolean'].includes(typeof current)\n    ) {\n      output.push({ key: path, value: current });\n      return;\n    }\n\n    // unknown\n    if (typeof current !== 'object') {\n      return;\n    }\n\n    // array\n    if (Array.isArray(current)) {\n      for (const item of current) {\n        // NOTE(freben): The reason that these are output in two different ways,\n        // is to support use cases where you want to express that MORE than one\n        // tag is present in a list. Since the EntityFilters structure is a\n        // record, you can't have several entries of the same key. Therefore\n        // you will have to match on\n        //\n        // { \"a.b\": [\"true\"], \"a.c\": [\"true\"] }\n        //\n        // rather than\n        //\n        // { \"a\": [\"b\", \"c\"] }\n        //\n        // because the latter means EITHER b or c has to be present.\n        visit(path, item);\n        if (typeof item === 'string') {\n          const pathKey = `${path}.${item}`;\n          const lowerKey = pathKey.toLocaleLowerCase('en-US');\n          if (!seenPathKeys.has(lowerKey)) {\n            seenPathKeys.add(lowerKey);\n            output.push({ key: pathKey, value: true });\n          }\n        }\n      }\n      return;\n    }\n\n    // object\n    for (const [key, value] of Object.entries(current!)) {\n      visit(path ? `${path}.${key}` : key, value);\n    }\n  }\n\n  visit('', root);\n\n  return output;\n}\n\n// Translates a number of raw data rows to search table rows\nexport function mapToRows(input: Kv[], entityId: string): DbSearchRow[] {\n  const result: DbSearchRow[] = [];\n\n  for (const { key: rawKey, value: rawValue } of input) {\n    const key = rawKey.toLocaleLowerCase('en-US');\n    if (key.length > MAX_KEY_LENGTH) {\n      continue;\n    }\n    if (rawValue === undefined || rawValue === null) {\n      result.push({\n        entity_id: entityId,\n        key,\n        original_value: null,\n        value: null,\n      });\n    } else {\n      const value = String(rawValue).toLocaleLowerCase('en-US');\n      if (value.length <= MAX_VALUE_LENGTH) {\n        result.push({\n          entity_id: entityId,\n          key,\n          original_value: String(rawValue),\n          value: value,\n        });\n      } else {\n        result.push({\n          entity_id: entityId,\n          key,\n          original_value: null,\n          value: null,\n        });\n      }\n    }\n  }\n\n  return result;\n}\n\n/**\n * Generates all of the search rows that are relevant for this entity.\n *\n * @param entityId - The uid of the entity\n * @param entity - The entity\n * @returns A list of entity search rows\n */\nexport function buildEntitySearch(\n  entityId: string,\n  entity: Entity,\n): DbSearchRow[] {\n  // Visit the base structure recursively\n  const raw = traverse(entity);\n\n  // Start with some special keys that are always present because you want to\n  // be able to easily search for null specifically\n  raw.push({ key: 'metadata.name', value: entity.metadata.name });\n  raw.push({ key: 'metadata.namespace', value: entity.metadata.namespace });\n  raw.push({ key: 'metadata.uid', value: entity.metadata.uid });\n\n  // Namespace not specified has the default value \"default\", so we want to\n  // match on that as well\n  if (!entity.metadata.namespace) {\n    raw.push({ key: 'metadata.namespace', value: DEFAULT_NAMESPACE });\n  }\n\n  // Visit relations\n  for (const relation of entity.relations ?? []) {\n    raw.push({\n      key: `relations.${relation.type}`,\n      value: relation.targetRef,\n    });\n  }\n\n  // This validates that there are no keys that vary only in casing, such\n  // as `spec.foo` and `spec.Foo`.\n  const keys = new Set(raw.map(r => r.key));\n  const lowerKeys = new Set(raw.map(r => r.key.toLocaleLowerCase('en-US')));\n  if (keys.size !== lowerKeys.size) {\n    const difference = [];\n    for (const key of keys) {\n      const lower = key.toLocaleLowerCase('en-US');\n      if (!lowerKeys.delete(lower)) {\n        difference.push(lower);\n      }\n    }\n    const badKeys = `'${difference.join(\"', '\")}'`;\n    throw new InputError(\n      `Entity has duplicate keys that vary only in casing, ${badKeys}`,\n    );\n  }\n\n  return mapToRows(raw, entityId);\n}\n"],"names":["DEFAULT_NAMESPACE","InputError"],"mappings":";;;;;AAuBA,MAAM,YAAA,GAAe;AAAA,EACnB,aAAA;AAAA,EACA,WAAA;AAAA,EACA,QAAA;AAAA,EACA,eAAA;AAAA,EACA,oBAAA;AAAA,EACA,cAAA;AAAA,EACA;AACF,CAAA;AAKA,MAAM,cAAA,GAAiB,GAAA;AACvB,MAAM,gBAAA,GAAmB,GAAA;AAkClB,SAAS,SAAS,IAAA,EAAqB;AAC5C,EAAA,MAAM,SAAe,EAAC;AAKtB,EAAA,MAAM,YAAA,uBAAmB,GAAA,EAAY;AAErC,EAAA,SAAS,KAAA,CAAM,MAAc,OAAA,EAAkB;AAC7C,IAAA,IAAI,YAAA,CAAa,QAAA,CAAS,IAAI,CAAA,EAAG;AAC/B,MAAA;AAAA,IACF;AAGA,IAAA,IACE,OAAA,KAAY,MAAA,IACZ,OAAA,KAAY,IAAA,IACZ,CAAC,QAAA,EAAU,QAAA,EAAU,SAAS,CAAA,CAAE,QAAA,CAAS,OAAO,OAAO,CAAA,EACvD;AACA,MAAA,MAAA,CAAO,KAAK,EAAE,GAAA,EAAK,IAAA,EAAM,KAAA,EAAO,SAAS,CAAA;AACzC,MAAA;AAAA,IACF;AAGA,IAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAC/B,MAAA;AAAA,IACF;AAGA,IAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,OAAO,CAAA,EAAG;AAC1B,MAAA,KAAA,MAAW,QAAQ,OAAA,EAAS;AAc1B,QAAA,KAAA,CAAM,MAAM,IAAI,CAAA;AAChB,QAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC5B,UAAA,MAAM,OAAA,GAAU,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA;AAC/B,UAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,iBAAA,CAAkB,OAAO,CAAA;AAClD,UAAA,IAAI,CAAC,YAAA,CAAa,GAAA,CAAI,QAAQ,CAAA,EAAG;AAC/B,YAAA,YAAA,CAAa,IAAI,QAAQ,CAAA;AACzB,YAAA,MAAA,CAAO,KAAK,EAAE,GAAA,EAAK,OAAA,EAAS,KAAA,EAAO,MAAM,CAAA;AAAA,UAC3C;AAAA,QACF;AAAA,MACF;AACA,MAAA;AAAA,IACF;AAGA,IAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,OAAQ,CAAA,EAAG;AACnD,MAAA,KAAA,CAAM,OAAO,CAAA,EAAG,IAAI,IAAI,GAAG,CAAA,CAAA,GAAK,KAAK,KAAK,CAAA;AAAA,IAC5C;AAAA,EACF;AAEA,EAAA,KAAA,CAAM,IAAI,IAAI,CAAA;AAEd,EAAA,OAAO,MAAA;AACT;AAGO,SAAS,SAAA,CAAU,OAAa,QAAA,EAAiC;AACtE,EAAA,MAAM,SAAwB,EAAC;AAE/B,EAAA,KAAA,MAAW,EAAE,GAAA,EAAK,MAAA,EAAQ,KAAA,EAAO,QAAA,MAAc,KAAA,EAAO;AACpD,IAAA,MAAM,GAAA,GAAM,MAAA,CAAO,iBAAA,CAAkB,OAAO,CAAA;AAC5C,IAAA,IAAI,GAAA,CAAI,SAAS,cAAA,EAAgB;AAC/B,MAAA;AAAA,IACF;AACA,IAAA,IAAI,QAAA,KAAa,MAAA,IAAa,QAAA,KAAa,IAAA,EAAM;AAC/C,MAAA,MAAA,CAAO,IAAA,CAAK;AAAA,QACV,SAAA,EAAW,QAAA;AAAA,QACX,GAAA;AAAA,QACA,cAAA,EAAgB,IAAA;AAAA,QAChB,KAAA,EAAO;AAAA,OACR,CAAA;AAAA,IACH,CAAA,MAAO;AACL,MAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,QAAQ,CAAA,CAAE,kBAAkB,OAAO,CAAA;AACxD,MAAA,IAAI,KAAA,CAAM,UAAU,gBAAA,EAAkB;AACpC,QAAA,MAAA,CAAO,IAAA,CAAK;AAAA,UACV,SAAA,EAAW,QAAA;AAAA,UACX,GAAA;AAAA,UACA,cAAA,EAAgB,OAAO,QAAQ,CAAA;AAAA,UAC/B;AAAA,SACD,CAAA;AAAA,MACH,CAAA,MAAO;AACL,QAAA,MAAA,CAAO,IAAA,CAAK;AAAA,UACV,SAAA,EAAW,QAAA;AAAA,UACX,GAAA;AAAA,UACA,cAAA,EAAgB,IAAA;AAAA,UAChB,KAAA,EAAO;AAAA,SACR,CAAA;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAEA,EAAA,OAAO,MAAA;AACT;AASO,SAAS,iBAAA,CACd,UACA,MAAA,EACe;AAEf,EAAA,MAAM,GAAA,GAAM,SAAS,MAAM,CAAA;AAI3B,EAAA,GAAA,CAAI,IAAA,CAAK,EAAE,GAAA,EAAK,eAAA,EAAiB,OAAO,MAAA,CAAO,QAAA,CAAS,MAAM,CAAA;AAC9D,EAAA,GAAA,CAAI,IAAA,CAAK,EAAE,GAAA,EAAK,oBAAA,EAAsB,OAAO,MAAA,CAAO,QAAA,CAAS,WAAW,CAAA;AACxE,EAAA,GAAA,CAAI,IAAA,CAAK,EAAE,GAAA,EAAK,cAAA,EAAgB,OAAO,MAAA,CAAO,QAAA,CAAS,KAAK,CAAA;AAI5D,EAAA,IAAI,CAAC,MAAA,CAAO,QAAA,CAAS,SAAA,EAAW;AAC9B,IAAA,GAAA,CAAI,KAAK,EAAE,GAAA,EAAK,oBAAA,EAAsB,KAAA,EAAOA,gCAAmB,CAAA;AAAA,EAClE;AAGA,EAAA,KAAA,MAAW,QAAA,IAAY,MAAA,CAAO,SAAA,IAAa,EAAC,EAAG;AAC7C,IAAA,GAAA,CAAI,IAAA,CAAK;AAAA,MACP,GAAA,EAAK,CAAA,UAAA,EAAa,QAAA,CAAS,IAAI,CAAA,CAAA;AAAA,MAC/B,OAAO,QAAA,CAAS;AAAA,KACjB,CAAA;AAAA,EACH;AAIA,EAAA,MAAM,IAAA,GAAO,IAAI,GAAA,CAAI,GAAA,CAAI,IAAI,CAAA,CAAA,KAAK,CAAA,CAAE,GAAG,CAAC,CAAA;AACxC,EAAA,MAAM,SAAA,GAAY,IAAI,GAAA,CAAI,GAAA,CAAI,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,GAAA,CAAI,iBAAA,CAAkB,OAAO,CAAC,CAAC,CAAA;AACxE,EAAA,IAAI,IAAA,CAAK,IAAA,KAAS,SAAA,CAAU,IAAA,EAAM;AAChC,IAAA,MAAM,aAAa,EAAC;AACpB,IAAA,KAAA,MAAW,OAAO,IAAA,EAAM;AACtB,MAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,iBAAA,CAAkB,OAAO,CAAA;AAC3C,MAAA,IAAI,CAAC,SAAA,CAAU,MAAA,CAAO,KAAK,CAAA,EAAG;AAC5B,QAAA,UAAA,CAAW,KAAK,KAAK,CAAA;AAAA,MACvB;AAAA,IACF;AACA,IAAA,MAAM,OAAA,GAAU,CAAA,CAAA,EAAI,UAAA,CAAW,IAAA,CAAK,MAAM,CAAC,CAAA,CAAA,CAAA;AAC3C,IAAA,MAAM,IAAIC,iBAAA;AAAA,MACR,uDAAuD,OAAO,CAAA;AAAA,KAChE;AAAA,EACF;AAEA,EAAA,OAAO,SAAA,CAAU,KAAK,QAAQ,CAAA;AAChC;;;;;;"}

package/dist/providers/DefaultLocationStore.cjs.js

@@ -5,12 +5,22 @@ var uuid = require('uuid');
 var util = require('../processing/util.cjs.js');
 var conversion = require('../util/conversion.cjs.js');
 var catalogModel = require('@backstage/catalog-model');
+var lodash = require('lodash');
+var parseGitUrl = require('git-url-parse');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var parseGitUrl__default = /*#__PURE__*/_interopDefaultCompat(parseGitUrl);
 
 class DefaultLocationStore {
   _connection;
   db;
-  constructor(db) {
+  scmEvents;
+  scmEventHandlingConfig;
+  constructor(db, scmEvents, scmEventHandlingConfig) {
     this.db = db;
+    this.scmEvents = scmEvents;
+    this.scmEventHandlingConfig = scmEventHandlingConfig;
   }
   getProviderName() {
     return "DefaultLocationStore";
@@ -45,6 +55,36 @@ class DefaultLocationStore {
   async listLocations() {
     return await this.locations();
   }
+  async queryLocations(options) {
+    let itemsQuery = this.db("locations").whereNot(
+      "type",
+      "bootstrap"
+    );
+    if (options.query) {
+      itemsQuery = applyLocationFilterToQuery(
+        this.db.client.config.client,
+        itemsQuery,
+        options.query
+      );
+    }
+    const countQuery = itemsQuery.clone().count("*", { as: "count" });
+    itemsQuery = itemsQuery.orderBy("id", "asc");
+    if (options.afterId !== void 0) {
+      itemsQuery = itemsQuery.where("id", ">", options.afterId);
+    }
+    if (options.limit !== void 0) {
+      itemsQuery = itemsQuery.limit(options.limit);
+    }
+    const [items, [{ count }]] = await Promise.all([itemsQuery, countQuery]);
+    return {
+      items: items.map((item) => ({
+        id: item.id,
+        target: item.target,
+        type: item.type
+      })),
+      totalItems: Number(count)
+    };
+  }
   async getLocation(id) {
     const items = await this.db("locations").where({ id }).select();
     if (!items.length) {
@@ -112,6 +152,9 @@ class DefaultLocationStore {
       type: "full",
       entities
     });
+    if (this.scmEventHandlingConfig.unregister || this.scmEventHandlingConfig.move) {
+      this.scmEvents.subscribe({ onEvents: this.#onScmEvents.bind(this) });
+    }
   }
   async locations(dbOrTx = this.db) {
     const locations = await dbOrTx("locations").select();
@@ -121,6 +164,302 @@ class DefaultLocationStore {
       type: item.type
     }));
   }
+  // #region SCM event handling
+  async #onScmEvents(events) {
+    const exactLocationsToDelete = /* @__PURE__ */ new Set();
+    const locationPrefixesToDelete = /* @__PURE__ */ new Set();
+    const exactLocationsToCreate = /* @__PURE__ */ new Set();
+    const locationPrefixesToMove = /* @__PURE__ */ new Map();
+    for (const event of events) {
+      if (event.type === "location.deleted" && this.scmEventHandlingConfig.unregister) {
+        exactLocationsToDelete.add(event.url);
+      } else if (event.type === "location.moved" && this.scmEventHandlingConfig.move) {
+        exactLocationsToDelete.add(event.fromUrl);
+        exactLocationsToCreate.add(event.toUrl);
+      } else if (event.type === "repository.deleted" && this.scmEventHandlingConfig.unregister) {
+        locationPrefixesToDelete.add(event.url);
+      } else if (event.type === "repository.moved" && this.scmEventHandlingConfig.move) {
+        locationPrefixesToMove.set(event.fromUrl, event.toUrl);
+      }
+    }
+    if (exactLocationsToDelete.size > 0) {
+      await this.#deleteLocationsByExactUrl(exactLocationsToDelete);
+    }
+    if (locationPrefixesToDelete.size > 0) {
+      await this.#deleteLocationsByUrlPrefix(locationPrefixesToDelete);
+    }
+    if (exactLocationsToCreate.size > 0) {
+      await this.#createLocationsByExactUrl(exactLocationsToCreate);
+    }
+    if (locationPrefixesToMove.size > 0) {
+      await this.#moveLocationsByUrlPrefix(locationPrefixesToMove);
+    }
+  }
+  async #createLocationsByExactUrl(urls) {
+    let count = 0;
+    for (const batch of lodash.chunk(Array.from(urls), 100)) {
+      const existingUrls = await this.db("locations").where("type", "=", "url").whereIn("target", batch).select().then((rows) => new Set(rows.map((row) => row.target)));
+      const newLocations = batch.filter((url) => !existingUrls.has(url)).map((url) => ({ id: uuid.v4(), type: "url", target: url }));
+      if (newLocations.length) {
+        await this.db("locations").insert(newLocations);
+        await this.connection.applyMutation({
+          type: "delta",
+          added: newLocations.map((location) => {
+            const entity = conversion.locationSpecToLocationEntity({ location });
+            return { entity, locationKey: util.getEntityLocationRef(entity) };
+          }),
+          removed: []
+        });
+        count += newLocations.length;
+      }
+    }
+    return count;
+  }
+  async #deleteLocationsByExactUrl(urls) {
+    let count = 0;
+    for (const batch of lodash.chunk(Array.from(urls), 100)) {
+      const rows = await this.db("locations").where("type", "=", "url").whereIn("target", batch).select();
+      if (rows.length) {
+        await this.db("locations").whereIn(
+          "id",
+          rows.map((row) => row.id)
+        ).delete();
+        await this.connection.applyMutation({
+          type: "delta",
+          added: [],
+          removed: rows.map((row) => ({
+            entity: conversion.locationSpecToLocationEntity({ location: row })
+          }))
+        });
+        count += rows.length;
+      }
+    }
+    return count;
+  }
+  async #deleteLocationsByUrlPrefix(urls) {
+    const matches = await this.#findLocationsByPrefixOrExactMatch(urls);
+    if (matches.length) {
+      await this.#deleteLocations(matches.map((l) => l.row));
+    }
+    return matches.length;
+  }
+  async #moveLocationsByUrlPrefix(urlPrefixes) {
+    let count = 0;
+    for (const [fromPrefix, toPrefix] of urlPrefixes) {
+      if (fromPrefix === toPrefix) {
+        continue;
+      }
+      if (fromPrefix.match(/[?#]/) || toPrefix.match(/[?#]/)) {
+        continue;
+      }
+      const matches = await this.#findLocationsByPrefixOrExactMatch([
+        fromPrefix
+      ]);
+      if (matches.length) {
+        await this.#deleteLocations(matches.map((m) => m.row));
+        await this.#createLocationsByExactUrl(
+          matches.map((m) => {
+            const remainder = m.row.target.slice(fromPrefix.length).replace(/^\/+/, "");
+            if (!remainder) {
+              return toPrefix;
+            }
+            return `${toPrefix.replace(/\/+$/, "")}/${remainder}`;
+          })
+        );
+        count += matches.length;
+      }
+    }
+    return count;
+  }
+  async #deleteLocations(rows) {
+    for (const ids of lodash.chunk(
+      rows.map((l) => l.id),
+      100
+    )) {
+      await this.db("locations").whereIn("id", ids).delete();
+    }
+    await this.connection.applyMutation({
+      type: "delta",
+      added: [],
+      removed: rows.map((l) => ({
+        entity: conversion.locationSpecToLocationEntity({ location: l })
+      }))
+    });
+  }
+  /**
+   * Given a "base" URL prefix, find all locations that are for paths at or
+   * below it.
+   *
+   * For example, given a base URL prefix of
+   * "https://github.com/backstage/backstage/blob/master/plugins", it will match
+   * locations inside the plugins directory, and nowhere else.
+   */
+  async #findLocationsByPrefixOrExactMatch(urls) {
+    const result = new Array();
+    for (const url of urls) {
+      let base;
+      try {
+        base = parseGitUrl__default.default(url);
+      } catch (error) {
+        throw new Error(`Invalid URL prefix, could not parse: ${url}`);
+      }
+      if (!base.owner || !base.name) {
+        throw new Error(
+          `Invalid URL prefix, missing owner or repository: ${url}`
+        );
+      }
+      const pathPrefix = base.filepath === "" || base.filepath.endsWith("/") ? base.filepath : `${base.filepath}/`;
+      const rows = await this.db("locations").where("type", "=", "url").where("target", "like", `%${base.owner}%`).where("target", "like", `%${base.name}%`).select();
+      result.push(
+        ...rows.flatMap((row) => {
+          try {
+            const candidate = parseGitUrl__default.default(row.target);
+            if (candidate.protocol === base.protocol && candidate.resource === base.resource && candidate.port === base.port && candidate.organization === base.organization && candidate.owner === base.owner && candidate.name === base.name && // If the base has no ref (for example didn't have the "/blob/master"
+            // part and therefore targeted an entire repository) then we match any
+            // ref below that
+            (!base.ref || candidate.ref === base.ref) && // Match both on exact equality and any subpath with a slash between
+            (candidate.filepath === base.filepath || candidate.filepath.startsWith(pathPrefix))) {
+              return [{ row, parsed: candidate }];
+            }
+            return [];
+          } catch {
+            return [];
+          }
+        })
+      );
+    }
+    return lodash.uniqBy(result, (entry) => entry.row.id);
+  }
+  // #endregion
+}
+function applyLocationFilterToQuery(clientType, inputQuery, query) {
+  let result = inputQuery;
+  if (!query || typeof query !== "object" || Array.isArray(query)) {
+    throw new errors.InputError("Invalid filter predicate, expected an object");
+  }
+  if ("$all" in query) {
+    if (query.$all.length === 0) {
+      return result.whereRaw("1 = 0");
+    }
+    return result.where((outer) => {
+      for (const subQuery of query.$all) {
+        outer.andWhere((inner) => {
+          applyLocationFilterToQuery(clientType, inner, subQuery);
+        });
+      }
+    });
+  }
+  if ("$any" in query) {
+    if (query.$any.length === 0) {
+      return result.whereRaw("1 = 0");
+    }
+    return result.where((outer) => {
+      for (const subQuery of query.$any) {
+        outer.orWhere((inner) => {
+          applyLocationFilterToQuery(clientType, inner, subQuery);
+        });
+      }
+    });
+  }
+  if ("$not" in query) {
+    return result.whereNot((inner) => {
+      applyLocationFilterToQuery(clientType, inner, query.$not);
+    });
+  }
+  const entries = Object.entries(query);
+  const keys = entries.map((e) => e[0]);
+  if (keys.some((k) => k.startsWith("$"))) {
+    throw new errors.InputError(
+      `Invalid filter predicate, unknown logic operator '${keys.join(", ")}'`
+    );
+  }
+  for (const [keyAnyCase, value] of entries) {
+    const key = keyAnyCase.toLocaleLowerCase("en-US");
+    if (!["id", "type", "target"].includes(key)) {
+      throw new errors.InputError(
+        `Invalid filter predicate, expected key to be 'id', 'type', or 'target', got '${keyAnyCase}'`
+      );
+    }
+    result = applyFilterValueToQuery(clientType, result, key, value);
+  }
+  return result;
+}
+function applyFilterValueToQuery(clientType, result, key, value) {
+  if (["string", "number", "boolean"].includes(typeof value)) {
+    if (clientType === "pg") {
+      return result.whereRaw(`UPPER(??::text) = UPPER(?::text)`, [key, value]);
+    }
+    if (clientType.includes("mysql")) {
+      return result.whereRaw(
+        `UPPER(CAST(?? AS CHAR)) = UPPER(CAST(? AS CHAR))`,
+        [key, value]
+      );
+    }
+    return result.whereRaw(`UPPER(??) = UPPER(?)`, [key, value]);
+  }
+  if (typeof value === "object") {
+    if (!value || Array.isArray(value)) {
+      throw new errors.InputError(
+        `Invalid filter predicate, got unknown matcher object '${JSON.stringify(
+          value
+        )}'`
+      );
+    }
+    if ("$exists" in value) {
+      return value.$exists ? result.whereNotNull(key) : result.whereNull(key);
+    }
+    if ("$in" in value) {
+      if (value.$in.length === 0) {
+        return result.whereRaw("1 = 0");
+      }
+      if (key === "id") {
+        return result.whereIn(key, value.$in);
+      }
+      if (clientType === "pg") {
+        const rhs2 = value.$in.map(() => "UPPER(?::text)").join(", ");
+        return result.whereRaw(`UPPER(??::text) IN (${rhs2})`, [
+          key,
+          ...value.$in
+        ]);
+      }
+      if (clientType.includes("mysql")) {
+        const rhs2 = value.$in.map(() => "UPPER(CAST(? AS CHAR))").join(", ");
+        return result.whereRaw(`UPPER(CAST(?? AS CHAR)) IN (${rhs2})`, [
+          key,
+          ...value.$in
+        ]);
+      }
+      const rhs = value.$in.map(() => "UPPER(?)").join(", ");
+      return result.whereRaw(`UPPER(??) IN (${rhs})`, [key, ...value.$in]);
+    }
+    if ("$hasPrefix" in value) {
+      const escaped = value.$hasPrefix.replace(/([\\%_])/g, "\\$1");
+      if (clientType === "pg") {
+        return result.whereRaw("?? ilike ? escape '\\'", [key, `${escaped}%`]);
+      }
+      if (clientType.includes("mysql")) {
+        return result.whereRaw("UPPER(??) like UPPER(?) escape '\\\\'", [
+          key,
+          `${escaped}%`
+        ]);
+      }
+      return result.whereRaw("UPPER(??) like UPPER(?) escape '\\'", [
+        key,
+        `${escaped}%`
+      ]);
+    }
+    if ("$contains" in value) {
+      return result.whereRaw("1 = 0");
+    }
+    throw new errors.InputError(
+      `Invalid filter predicate, got unknown matcher object '${JSON.stringify(
+        value
+      )}'`
+    );
+  }
+  throw new errors.InputError(
+    `Invalid filter predicate, expected value to be a primitive value or a matcher object, got '${typeof value}'`
+  );
 }
 
 exports.DefaultLocationStore = DefaultLocationStore;