Adds repository factory provider

Signed-off-by: Bandini Bhopi <bandinib@amazon.com>

src/core/server/legacy/legacy_service.ts

@@ -275,6 +275,8 @@ export class LegacyService implements CoreService {
         addClientWrapper: setupDeps.core.savedObjects.addClientWrapper,
         registerType: setupDeps.core.savedObjects.registerType,
         getImportExportObjectLimit: setupDeps.core.savedObjects.getImportExportObjectLimit,
+        registerRepositoryFactoryProvider:
+          setupDeps.core.savedObjects.registerRepositoryFactoryProvider,
       },
       status: {
         isStatusPageAnonymous: setupDeps.core.status.isStatusPageAnonymous,

src/core/server/plugins/plugin_context.ts

@@ -204,6 +204,7 @@ export function createPluginSetupContext<TPlugin, TPluginDependencies>(
       addClientWrapper: deps.savedObjects.addClientWrapper,
       registerType: deps.savedObjects.registerType,
       getImportExportObjectLimit: deps.savedObjects.getImportExportObjectLimit,
+      registerRepositoryFactoryProvider: deps.savedObjects.registerRepositoryFactoryProvider,
     },
     status: {
       core$: deps.status.core$,

src/core/server/saved_objects/saved_objects_service.mock.ts

@@ -79,6 +79,7 @@ const createSetupContractMock = () => {
     addClientWrapper: jest.fn(),
     registerType: jest.fn(),
     getImportExportObjectLimit: jest.fn(),
+    registerRepositoryFactoryProvider: jest.fn(),
   };
 
   setupContract.getImportExportObjectLimit.mockReturnValue(100);

src/core/server/saved_objects/saved_objects_service.ts

@@ -54,6 +54,7 @@ import { OpenSearchDashboardsRequest, InternalHttpServiceSetup } from '../http';
 import { SavedObjectsClientContract, SavedObjectsType, SavedObjectStatusMeta } from './types';
 import { ISavedObjectsRepository, SavedObjectsRepository } from './service/lib/repository';
 import {
+  SavedObjectRepositoryFactoryProvider,
   SavedObjectsClientFactoryProvider,
   SavedObjectsClientWrapperFactory,
 } from './service/lib/scoped_client_provider';
@@ -117,6 +118,14 @@ export interface SavedObjectsServiceSetup {
     factory: SavedObjectsClientWrapperFactory
   ) => void;
 
+  /**
+   * Set the default {@link SavedObjectRepositoryFactoryProvider | factory provider} for creating Saved Objects repository.
+   * Only one repository can be set, subsequent calls to this method will fail.
+   */
+  registerRepositoryFactoryProvider: (
+    respositoryFactoryProvider: SavedObjectRepositoryFactoryProvider
+  ) => void;
+
   /**
    * Register a {@link SavedObjectsType | savedObjects type} definition.
    *
@@ -291,6 +300,8 @@ export class SavedObjectsService
   private typeRegistry = new SavedObjectTypeRegistry();
   private started = false;
 
+  private respositoryFactoryProvider?: SavedObjectRepositoryFactoryProvider;
+
   constructor(private readonly coreContext: CoreContext) {
     this.logger = coreContext.logger.get('savedobjects-service');
   }
@@ -341,6 +352,15 @@ export class SavedObjectsService
           factory,
         });
       },
+      registerRepositoryFactoryProvider: (repositoryProvider) => {
+        if (this.started) {
+          throw new Error('cannot call `registerRepositoryFactoryProvider` after service startup.');
+        }
+        if (this.respositoryFactoryProvider) {
+          throw new Error('custom repository factory is already set, and can only be set once');
+        }
+        this.respositoryFactoryProvider = repositoryProvider;
+      },
       registerType: (type) => {
         if (this.started) {
           throw new Error('cannot call `registerType` after service startup.');
@@ -422,13 +442,21 @@ export class SavedObjectsService
       opensearchClient: OpenSearchClient,
       includedHiddenTypes: string[] = []
     ) => {
-      return SavedObjectsRepository.createRepository(
-        migrator,
-        this.typeRegistry,
-        opensearchDashboardsConfig.index,
-        opensearchClient,
-        includedHiddenTypes
-      );
+      if (this.respositoryFactoryProvider) {
+        return this.respositoryFactoryProvider({
+          migrator,
+          typeRegistry: this.typeRegistry,
+          includedHiddenTypes,
+        });
+      } else {
+        return SavedObjectsRepository.createRepository(
+          migrator,
+          this.typeRegistry,
+          opensearchDashboardsConfig.index,
+          opensearchClient,
+          includedHiddenTypes
+        );
+      }
     };
 
     const repositoryFactory: SavedObjectsRepositoryFactory = {

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

@@ -31,8 +31,14 @@
 import { PriorityCollection } from './priority_collection';
 import { SavedObjectsClientContract } from '../../types';
 import { SavedObjectsRepositoryFactory } from '../../saved_objects_service';
-import { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry';
+import {
+  ISavedObjectTypeRegistry,
+  SavedObjectTypeRegistry,
+} from '../../saved_objects_type_registry';
 import { OpenSearchDashboardsRequest } from '../../../http';
+import { ISavedObjectsRepository } from './repository';
+import { OpenSearchClient } from '../../../opensearch';
+import { IOpenSearchDashboardsMigrator } from '../../migrations';
 
 /**
  * Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance.
@@ -44,6 +50,17 @@ export interface SavedObjectsClientWrapperOptions {
   request: OpenSearchDashboardsRequest;
 }
 
+/**
+ * Options passed to each SavedObjectRepositoryFactoryProvider to aid in creating the repository instance.
+ * @public
+ */
+export interface SavedObjectsRepositoryOptions {
+  migrator: IOpenSearchDashboardsMigrator;
+  typeRegistry: SavedObjectTypeRegistry;
+  includedHiddenTypes: string[];
+  client?: OpenSearchClient;
+}
+
 /**
  * Describes the factory used to create instances of Saved Objects Client Wrappers.
  * @public
@@ -72,6 +89,14 @@ export type SavedObjectsClientFactoryProvider = (
   repositoryFactory: SavedObjectsRepositoryFactory
 ) => SavedObjectsClientFactory;
 
+/**
+ * Provider to invoke to a factory function for creating ISavedObjectRepository {@link ISavedObjectRepository} instances.
+ * @public
+ */
+export type SavedObjectRepositoryFactoryProvider = (
+  options: SavedObjectsRepositoryOptions
+) => ISavedObjectsRepository;
+
 /**
  * Options to control the creation of the Saved Objects Client.
  * @public