Change saved object bulkUpdate to work across multiple namespaces

docs/development/core/server/kibana-plugin-core-server.md

@@ -221,6 +221,8 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  Variable | Description |
 |  --- | --- |
 |  [kibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) | Set of helpers used to create <code>KibanaResponse</code> to form HTTP response on an incoming request. Should be returned as a result of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) execution. |
+|  [namespaceIdToString](./kibana-plugin-core-server.namespaceidtostring.md) | Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with the exception of the <code>undefined</code> namespace ID (which has a namespace string of <code>'default'</code>). |
+|  [namespaceStringToId](./kibana-plugin-core-server.namespacestringtoid.md) | Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with the exception of the <code>'default'</code> namespace string (which has a namespace ID of <code>undefined</code>). |
 |  [ServiceStatusLevels](./kibana-plugin-core-server.servicestatuslevels.md) | The current "level" of availability of a service. |
 |  [validBodyOutput](./kibana-plugin-core-server.validbodyoutput.md) | The set of valid body.output |
 

docs/development/core/server/kibana-plugin-core-server.namespaceidtostring.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [namespaceIdToString](./kibana-plugin-core-server.namespaceidtostring.md)
+
+## namespaceIdToString variable
+
+Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with the exception of the `undefined` namespace ID (which has a namespace string of `'default'`<!-- -->).
+
+<b>Signature:</b>
+
+```typescript
+namespaceIdToString: (namespace?: string | undefined) => string
+```

docs/development/core/server/kibana-plugin-core-server.namespacestringtoid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [namespaceStringToId](./kibana-plugin-core-server.namespacestringtoid.md)
+
+## namespaceStringToId variable
+
+Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with the exception of the `'default'` namespace string (which has a namespace ID of `undefined`<!-- -->).
+
+<b>Signature:</b>
+
+```typescript
+namespaceStringToId: (namespace: string) => string | undefined
+```

docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.md

@@ -17,5 +17,6 @@ export interface SavedObjectsBulkUpdateObject<T = unknown> extends Pick<SavedObj
 |  --- | --- | --- |
 |  [attributes](./kibana-plugin-core-server.savedobjectsbulkupdateobject.attributes.md) | <code>Partial&lt;T&gt;</code> | The data for a Saved Object is stored as an object in the <code>attributes</code> property. |
 |  [id](./kibana-plugin-core-server.savedobjectsbulkupdateobject.id.md) | <code>string</code> | The ID of this Saved Object, guaranteed to be unique for all objects of the same <code>type</code> |
+|  [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md) | <code>string</code> | Optional namespace string to use for this document. If this is defined, it will supersede the namespace ID that is in [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md)<!-- -->.<!-- -->Note: the default namespace's string representation is <code>'default'</code>, and its ID representation is <code>undefined</code>. |
 |  [type](./kibana-plugin-core-server.savedobjectsbulkupdateobject.type.md) | <code>string</code> | The type of this Saved Object. Each plugin can define it's own custom Saved Object types. |
 

docs/development/core/server/kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsBulkUpdateObject](./kibana-plugin-core-server.savedobjectsbulkupdateobject.md) &gt; [namespace](./kibana-plugin-core-server.savedobjectsbulkupdateobject.namespace.md)
+
+## SavedObjectsBulkUpdateObject.namespace property
+
+Optional namespace string to use for this document. If this is defined, it will supersede the namespace ID that is in [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md)<!-- -->.
+
+Note: the default namespace's string representation is `'default'`<!-- -->, and its ID representation is `undefined`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+namespace?: string;
+```

src/core/server/index.ts

@@ -300,6 +300,8 @@ export {
   exportSavedObjectsToStream,
   importSavedObjectsFromStream,
   resolveSavedObjectsImportErrors,
+  namespaceIdToString,
+  namespaceStringToId,
 } from './saved_objects';
 
 export {

src/core/server/saved_objects/routes/bulk_update.ts

@@ -40,6 +40,7 @@ export const registerBulkUpdateRoute = (router: IRouter) => {
                 })
               )
             ),
+            namespace: schema.maybe(schema.string({ minLength: 1 })),
           })
         ),
       },

src/core/server/saved_objects/service/index.ts

@@ -58,6 +58,8 @@ export {
   SavedObjectsErrorHelpers,
   SavedObjectsClientFactory,
   SavedObjectsClientFactoryProvider,
+  namespaceIdToString,
+  namespaceStringToId,
 } from './lib';
 
 export * from './saved_objects_client';

src/core/server/saved_objects/service/lib/index.ts

@@ -30,3 +30,5 @@ export {
 } from './scoped_client_provider';
 
 export { SavedObjectsErrorHelpers } from './errors';
+
+export { namespaceIdToString, namespaceStringToId } from './namespace';

src/core/server/saved_objects/service/lib/namespace.test.ts

@@ -0,0 +1,53 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { namespaceIdToString, namespaceStringToId } from './namespace';
+
+describe('#namespaceIdToString', () => {
+  it('converts `undefined` to default namespace string', () => {
+    expect(namespaceIdToString(undefined)).toEqual('default');
+  });
+
+  it('leaves other namespace IDs as-is', () => {
+    expect(namespaceIdToString('foo')).toEqual('foo');
+  });
+
+  it('throws an error when a namespace ID is an empty string', () => {
+    expect(() => namespaceIdToString('')).toThrowError('namespace cannot be an empty string');
+  });
+});
+
+describe('#namespaceStringToId', () => {
+  it('converts default namespace string to `undefined`', () => {
+    expect(namespaceStringToId('default')).toBeUndefined();
+  });
+
+  it('leaves other namespace strings as-is', () => {
+    expect(namespaceStringToId('foo')).toEqual('foo');
+  });
+
+  it('throws an error when a namespace string is falsy', () => {
+    const test = (arg: any) =>
+      expect(() => namespaceStringToId(arg)).toThrowError('namespace must be a non-empty string');
+
+    test(undefined);
+    test(null);
+    test('');
+  });
+});

src/core/server/saved_objects/service/lib/namespace.ts

@@ -0,0 +1,50 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export const DEFAULT_NAMESPACE_STRING = 'default';
+
+/**
+ * @public
+ * Converts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with
+ * the exception of the `undefined` namespace ID (which has a namespace string of `'default'`).
+ *
+ * @param namespace The namespace ID, which must be either a non-empty string or `undefined`.
+ */
+export const namespaceIdToString = (namespace?: string) => {
+  if (namespace === '') {
+    throw new TypeError('namespace cannot be an empty string');
+  }
+
+  return namespace ?? DEFAULT_NAMESPACE_STRING;
+};
+
+/**
+ * @public
+ * Converts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with
+ * the exception of the `'default'` namespace string (which has a namespace ID of `undefined`).
+ *
+ * @param namespace The namespace string, which must be non-empty.
+ */
+export const namespaceStringToId = (namespace: string) => {
+  if (!namespace) {
+    throw new TypeError('namespace must be a non-empty string');
+  }
+
+  return namespace !== DEFAULT_NAMESPACE_STRING ? namespace : undefined;
+};