[8.x] basic enhancements for import logging (#196056) (#198634)

kibanamachine · kyracho · afharo · web-flow · commit 937bfd5d8edb · 2024-11-01T04:50:11.000-05:00
# Backport This will backport the following commits from `main` to `8.x`: - [basic enhancements for import logging (#196056)](#196056)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Kyra Cho <wsc2119@columbia.edu> Co-authored-by: Alejandro Fernández Haro <alejandro.haro@elastic.co>
diff --git a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/import_saved_objects.test.ts b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/import_saved_objects.test.ts
@@ -19,6 +19,7 @@ import {
 } from './import_saved_objects.test.mock';
 
 import { Readable } from 'stream';
+import { loggerMock, type MockedLogger } from '@kbn/logging-mocks';
 import { v4 as uuidv4 } from 'uuid';
 import type {
   SavedObjectsImportFailure,
@@ -40,8 +41,10 @@ import {
 import type { ImportStateMap } from './lib';
 
 describe('#importSavedObjectsFromStream', () => {
+  let logger: MockedLogger;
   beforeEach(() => {
     jest.clearAllMocks();
+    logger = loggerMock.create();
     // mock empty output of each of these mocked modules so the import doesn't throw an error
     mockCollectSavedObjects.mockResolvedValue({
       errors: [],
@@ -72,7 +75,6 @@ describe('#importSavedObjectsFromStream', () => {
   let savedObjectsClient: jest.Mocked<SavedObjectsClientContract>;
   let typeRegistry: jest.Mocked<ISavedObjectTypeRegistry>;
   const namespace = 'some-namespace';
-
   const setupOptions = ({
     createNewCopies = false,
     getTypeImpl = (type: string) =>
@@ -102,6 +104,7 @@ describe('#importSavedObjectsFromStream', () => {
       createNewCopies,
       importHooks,
       managed,
+      log: logger,
     };
   };
   const createObject = ({
diff --git a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/import_saved_objects.ts b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/import_saved_objects.ts
@@ -17,6 +17,7 @@ import type {
   ISavedObjectTypeRegistry,
   SavedObjectsImportHook,
 } from '@kbn/core-saved-objects-server';
+import type { Logger } from '@kbn/logging';
 import {
   checkReferenceOrigins,
   validateReferences,
@@ -59,6 +60,7 @@ export interface ImportSavedObjectsOptions {
    * If provided, Kibana will apply the given option to the `managed` property.
    */
   managed?: boolean;
+  log: Logger;
 }
 
 /**
@@ -79,7 +81,11 @@ export async function importSavedObjectsFromStream({
   refresh,
   compatibilityMode,
   managed,
+  log,
 }: ImportSavedObjectsOptions): Promise<SavedObjectsImportResponse> {
+  log.debug(
+    `Importing with overwrite ${overwrite ? 'enabled' : 'disabled'} and size limit ${objectLimit}`
+  );
   let errorAccumulator: SavedObjectsImportFailure[] = [];
   const supportedTypes = typeRegistry.getImportableAndExportableTypes().map((type) => type.name);
 
@@ -90,6 +96,11 @@ export async function importSavedObjectsFromStream({
     supportedTypes,
     managed,
   });
+  log.debug(
+    `Importing types: ${[
+      ...new Set(collectSavedObjectsResult.collectedObjects.map((obj) => obj.type)),
+    ].join(', ')}`
+  );
   errorAccumulator = [...errorAccumulator, ...collectSavedObjectsResult.errors];
   // Map of all IDs for objects that we are attempting to import, and any references that are not included in the read stream;
   // each value is empty by default
@@ -197,7 +208,17 @@ export async function importSavedObjectsFromStream({
     objects: createSavedObjectsResult.createdObjects,
     importHooks,
   });
-
+  if (errorAccumulator.length > 0) {
+    log.error(
+      `Failed to import saved objects. ${errorAccumulator.length} errors: ${JSON.stringify(
+        errorAccumulator
+      )}`
+    );
+  } else {
+    log.info(
+      `Successfully imported ${createSavedObjectsResult.createdObjects.length} saved objects.`
+    );
+  }
   return {
     successCount: createSavedObjectsResult.createdObjects.length,
     success: errorAccumulator.length === 0,
diff --git a/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/saved_objects_importer.ts b/packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/import/saved_objects_importer.ts
@@ -62,7 +62,6 @@ export class SavedObjectsImporter implements ISavedObjectsImporter {
     compatibilityMode,
     managed,
   }: SavedObjectsImportOptions): Promise<SavedObjectsImportResponse> {
-    this.#log.debug('Starting the import process');
     return importSavedObjectsFromStream({
       readStream,
       createNewCopies,
@@ -75,6 +74,7 @@ export class SavedObjectsImporter implements ISavedObjectsImporter {
       typeRegistry: this.#typeRegistry,
       importHooks: this.#importHooks,
       managed,
+      log: this.#log,
     });
   }
 
diff --git a/src/core/server/integration_tests/saved_objects/routes/import.test.ts b/src/core/server/integration_tests/saved_objects/routes/import.test.ts
@@ -13,7 +13,6 @@ import supertest from 'supertest';
 import { SavedObjectsErrorHelpers } from '@kbn/core-saved-objects-server';
 import { savedObjectsClientMock } from '@kbn/core-saved-objects-api-server-mocks';
 import type { ICoreUsageStatsClient } from '@kbn/core-usage-data-base-server-internal';
-import type { Logger, LogLevelId } from '@kbn/logging';
 import {
   coreUsageStatsClientMock,
   coreUsageDataServiceMock,
@@ -28,6 +27,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { setupServer, createExportableType } from '@kbn/core-test-helpers-test-utils';
+import { loggerMock, type MockedLogger } from '@kbn/logging-mocks';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -41,6 +41,7 @@ describe(`POST ${URL}`, () => {
   let httpSetup: SetupServerReturn['httpSetup'];
   let handlerContext: SetupServerReturn['handlerContext'];
   let savedObjectsClient: ReturnType<typeof savedObjectsClientMock.create>;
+  let mockLogger: MockedLogger;
 
   const emptyResponse = { saved_objects: [], total: 0, per_page: 0, page: 0 };
   const mockIndexPattern = {
@@ -57,20 +58,10 @@ describe(`POST ${URL}`, () => {
     references: [],
     managed: false,
   };
-  const mockLogger: jest.Mocked<Logger> = {
-    debug: jest.fn(),
-    info: jest.fn(),
-    error: jest.fn(),
-    warn: jest.fn(),
-    trace: jest.fn(),
-    fatal: jest.fn(),
-    log: jest.fn(),
-    isLevelEnabled: jest.fn((level: LogLevelId) => true),
-    get: jest.fn(() => mockLogger),
-  };
 
   beforeEach(async () => {
     ({ server, httpSetup, handlerContext } = await setupServer());
+    mockLogger = loggerMock.create();
     handlerContext.savedObjects.typeRegistry.getImportableAndExportableTypes.mockReturnValue(
       allowedTypes.map(createExportableType)
     );
