[8.19] [Share] Add unused url cleanup task (#220138)

.buildkite/ftr_platform_stateful_configs.yml

@@ -400,3 +400,4 @@ enabled:
   - x-pack/platform/test/saved_object_api_integration/security_and_spaces/config_trial.ts
   - x-pack/platform/test/saved_object_api_integration/spaces_only/config.ts
   - x-pack/platform/test/saved_object_api_integration/user_profiles/config.ts
+  - src/platform/test/api_integration/apis/unused_urls_task/config.ts

.github/CODEOWNERS

@@ -2684,9 +2684,10 @@ x-pack/solutions/observability/plugins/observability_shared/public/components/pr
 
 # Shared UX
 /x-pack/test_serverless/api_integration/test_suites/common/favorites @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200985
-^/src/platform/test/api_integration/apis/short_url/**/*.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files#r1846654156
-^/src/platform/test/functional/page_objects/share_page.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files#r1846648444
-^/src/platform/test/accessibility/apps/kibana_overview_* @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files/cab99bce5ac2082fa77222beebe3b61ff836b94b#r1846659920
+/src/platform/test/api_integration/apis/short_url/**/*.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files#r1846654156
+/src/platform/test/api_integration/apis/unused_urls_task/**/*.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/220138
+/src/platform/test/functional/page_objects/share_page.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files#r1846648444
+/src/platform/test/accessibility/apps/kibana_overview_* @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200209/files/cab99bce5ac2082fa77222beebe3b61ff836b94b#r1846659920
 /x-pack/test/functional/services/sample_data @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200142#discussion_r1846512756
 ^/src/platform/test/functional/page_objects/files_management.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/200017#discussion_r1840477291
 ^/src/platform/test/accessibility/apps/home.ts @elastic/appex-sharedux # Assigned per https://github.com/elastic/kibana/pull/199771/files#r1840077237
@@ -2708,6 +2709,7 @@ x-pack/solutions/observability/plugins/observability_shared/public/components/pr
 /x-pack/test/functional/apps/advanced_settings @elastic/appex-sharedux
 ^/src/platform/test/functional/services/monaco_editor.ts @elastic/appex-sharedux
 /x-pack/test/functional/fixtures/kbn_archiver/global_search @elastic/appex-sharedux
+/src/platform/test/api_integration/fixtures/unused_urls_task @elastic/appex-sharedux
 /x-pack/test/plugin_functional/test_suites/global_search @elastic/appex-sharedux
 ^/src/platform/test/plugin_functional/test_suites/shared_ux @elastic/appex-sharedux
 ^/src/platform/test/plugin_functional/plugins/kbn_sample_panel_action @elastic/appex-sharedux

src/platform/plugins/shared/share/kibana.jsonc

@@ -13,6 +13,10 @@
     "server": true,
     "requiredBundles": [
       "kibanaUtils"
+    ],
+    "optionalPlugins": [
+      "licensing",
+      "taskManager"
     ]
   }
-}
+}

src/platform/plugins/shared/share/server/config.ts

@@ -8,13 +8,32 @@
  */
 
 import { schema, TypeOf } from '@kbn/config-schema';
+import {
+  DEFAULT_URL_LIMIT,
+  DEFAULT_URL_EXPIRATION_CHECK_INTERVAL,
+  DEFAULT_URL_EXPIRATION_DURATION,
+} from './unused_urls_task';
 
 export const configSchema = schema.object({
   new_version: schema.object({
     enabled: schema.boolean({
       defaultValue: false,
     }),
   }),
+  url_expiration: schema.object({
+    enabled: schema.boolean({
+      defaultValue: false,
+    }),
+    duration: schema.duration({
+      defaultValue: DEFAULT_URL_EXPIRATION_DURATION,
+    }),
+    check_interval: schema.duration({
+      defaultValue: DEFAULT_URL_EXPIRATION_CHECK_INTERVAL,
+    }),
+    url_limit: schema.number({
+      defaultValue: DEFAULT_URL_LIMIT,
+    }),
+  }),
 });
 
 export type ConfigSchema = TypeOf<typeof configSchema>;

src/platform/plugins/shared/share/server/index.ts

@@ -17,6 +17,23 @@ export type {
 
 export { CSV_QUOTE_VALUES_SETTING, CSV_SEPARATOR_SETTING } from '../common/constants';
 
+export {
+  TASK_ID,
+  SAVED_OBJECT_TYPE,
+  DEFAULT_URL_LIMIT,
+  DEFAULT_URL_EXPIRATION_CHECK_INTERVAL,
+  DEFAULT_URL_EXPIRATION_DURATION,
+} from './unused_urls_task';
+
+export {
+  durationToSeconds,
+  getDeleteUnusedUrlTaskInstance,
+  deleteUnusedUrls,
+  fetchUnusedUrlsFromFirstNamespace,
+  runDeleteUnusedUrlsTask,
+  scheduleUnusedUrlsCleanupTask,
+} from './unused_urls_task';
+
 export async function plugin(initializerContext: PluginInitializerContext) {
   const { SharePlugin } = await import('./plugin');
   return new SharePlugin(initializerContext);

src/platform/plugins/shared/share/server/plugin.ts

@@ -9,7 +9,17 @@
 
 import { i18n } from '@kbn/i18n';
 import { schema } from '@kbn/config-schema';
-import { CoreSetup, Plugin, PluginInitializerContext } from '@kbn/core/server';
+import { CoreSetup, CoreStart, Logger, Plugin, PluginInitializerContext } from '@kbn/core/server';
+import {
+  TaskManagerSetupContract,
+  TaskManagerStartContract,
+} from '@kbn/task-manager-plugin/server';
+import { registerDeleteUnusedUrlsRoute } from './unused_urls_task/register_delete_unused_urls_route';
+import {
+  TASK_ID,
+  runDeleteUnusedUrlsTask,
+  scheduleUnusedUrlsCleanupTask,
+} from './unused_urls_task';
 import { CSV_SEPARATOR_SETTING, CSV_QUOTE_VALUES_SETTING } from '../common/constants';
 import { UrlService } from '../common/url_service';
 import {
@@ -20,6 +30,7 @@ import {
 } from './url_service';
 import { LegacyShortUrlLocatorDefinition } from '../common/url_service/locators/legacy_short_url_locator';
 import { ShortUrlRedirectLocatorDefinition } from '../common/url_service/locators/short_url_redirect_locator';
+import { ConfigSchema } from './config';
 
 /** @public */
 export interface SharePublicSetup {
@@ -31,11 +42,13 @@ export interface SharePublicStart {
   url: ServerUrlService;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface SharePublicSetupDependencies {}
+export interface SharePublicSetupDependencies {
+  taskManager?: TaskManagerSetupContract;
+}
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface SharePublicStartDependencies {}
+export interface SharePublicStartDependencies {
+  taskManager?: TaskManagerStartContract;
+}
 
 export class SharePlugin
   implements
@@ -47,13 +60,17 @@ export class SharePlugin
     >
 {
   private url?: ServerUrlService;
-  private version: string;
+  private readonly version: string;
+  private readonly logger: Logger;
+  private readonly config: ConfigSchema;
 
   constructor(private readonly initializerContext: PluginInitializerContext) {
     this.version = initializerContext.env.packageInfo.version;
+    this.logger = initializerContext.logger.get();
+    this.config = initializerContext.config.get<ConfigSchema>();
   }
 
-  public setup(core: CoreSetup) {
+  public setup(core: CoreSetup, { taskManager }: SharePublicSetupDependencies) {
     this.url = new UrlService({
       baseUrl: core.http.basePath.publicBaseUrl || core.http.basePath.serverBasePath,
       version: this.initializerContext.env.packageInfo.version,
@@ -75,6 +92,15 @@ export class SharePlugin
     registerUrlServiceSavedObjectType(core.savedObjects, this.url);
     registerUrlServiceRoutes(core, core.http.createRouter(), this.url);
 
+    registerDeleteUnusedUrlsRoute({
+      router: core.http.createRouter(),
+      core,
+      urlExpirationDuration: this.config.url_expiration.duration,
+      urlLimit: this.config.url_expiration.url_limit,
+      logger: this.logger,
+      isEnabled: this.config.url_expiration.enabled && Boolean(taskManager),
+    });
+
     core.uiSettings.register({
       [CSV_SEPARATOR_SETTING]: {
         name: i18n.translate('share.advancedSettings.csv.separatorTitle', {
@@ -98,20 +124,49 @@ export class SharePlugin
       },
     });
 
+    if (taskManager) {
+      taskManager.registerTaskDefinitions({
+        [TASK_ID]: {
+          title: 'Unused URLs Cleanup',
+          description: "Deletes unused saved objects of type 'url'",
+          maxAttempts: 5,
+          createTaskRunner: () => ({
+            run: async () => {
+              await runDeleteUnusedUrlsTask({
+                core,
+                urlExpirationDuration: this.config.url_expiration.duration,
+                logger: this.logger,
+                urlLimit: this.config.url_expiration.url_limit,
+                isEnabled: this.config.url_expiration.enabled,
+              });
+            },
+          }),
+        },
+      });
+    }
+
     return {
       url: this.url,
     };
   }
 
-  public start() {
-    this.initializerContext.logger.get().debug('Starting plugin');
+  public start(_core: CoreStart, { taskManager }: SharePublicStartDependencies) {
+    this.logger.debug('Starting plugin');
+
+    if (taskManager) {
+      void scheduleUnusedUrlsCleanupTask({
+        taskManager,
+        checkInterval: this.config.url_expiration.check_interval,
+        isEnabled: this.config.url_expiration.enabled,
+      });
+    }
 
     return {
       url: this.url!,
     };
   }
 
   public stop() {
-    this.initializerContext.logger.get().debug('Stopping plugin');
+    this.logger.debug('Stopping plugin');
   }
 }

src/platform/plugins/shared/share/server/unused_urls_task/constants.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export const TASK_ID = 'unusedUrlsCleanupTask';
+export const SAVED_OBJECT_TYPE = 'url';
+export const DEFAULT_URL_LIMIT = 10000;
+export const DEFAULT_URL_EXPIRATION_DURATION = '1y';
+export const DEFAULT_URL_EXPIRATION_CHECK_INTERVAL = '7d';

src/platform/plugins/shared/share/server/unused_urls_task/index.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export * from './constants';
+export * from './task';
+export * from './register_unused_urls_task_routes';

src/platform/plugins/shared/share/server/unused_urls_task/register_delete_unused_urls_route.test.ts

@@ -0,0 +1,120 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import moment from 'moment';
+import { KibanaRequest, ReservedPrivilegesSet } from '@kbn/core/server';
+import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
+import { coreMock, httpResourcesMock } from '@kbn/core/server/mocks';
+import { mockRouter as router } from '@kbn/core-http-router-server-mocks';
+import { registerDeleteUnusedUrlsRoute } from './register_delete_unused_urls_route';
+import { runDeleteUnusedUrlsTask } from './task';
+
+jest.mock('./task', () => ({
+  runDeleteUnusedUrlsTask: jest.fn().mockResolvedValue({ deletedCount: 5 }),
+}));
+
+describe('registerDeleteUnusedUrlsRoute', () => {
+  const mockRouter = router.create();
+  const mockCoreSetup = coreMock.createSetup();
+  const mockUrlExpirationDuration = moment.duration(1, 'year');
+  const mockUrlLimit = 1000;
+  const mockLogger = loggingSystemMock.create().get();
+  const mockResponseFactory = httpResourcesMock.createResponseFactory();
+
+  beforeEach(() => {
+    mockRouter.post.mockReset();
+  });
+
+  it('registers the POST route with correct path and options', () => {
+    registerDeleteUnusedUrlsRoute({
+      router: mockRouter,
+      core: mockCoreSetup,
+      urlExpirationDuration: mockUrlExpirationDuration,
+      urlLimit: mockUrlLimit,
+      logger: mockLogger,
+      isEnabled: true,
+    });
+
+    expect(mockRouter.post).toHaveBeenCalledTimes(1);
+    expect(mockRouter.post).toHaveBeenCalledWith(
+      expect.objectContaining({
+        path: '/internal/unused_urls_task/run',
+        security: {
+          authz: {
+            requiredPrivileges: [ReservedPrivilegesSet.superuser],
+          },
+        },
+        options: {
+          access: 'internal',
+          summary: 'Runs the unused URLs cleanup task',
+        },
+        validate: {},
+      }),
+      expect.any(Function)
+    );
+  });
+
+  it('route handler calls runDeleteUnusedUrlsTask and returns success response', async () => {
+    registerDeleteUnusedUrlsRoute({
+      router: mockRouter,
+      core: mockCoreSetup,
+      urlExpirationDuration: mockUrlExpirationDuration,
+      urlLimit: mockUrlLimit,
+      logger: mockLogger,
+      isEnabled: true,
+    });
+
+    const routeHandler = mockRouter.post.mock.calls[0][1];
+    const mockRequest = {} as KibanaRequest;
+    const mockContext = {} as any;
+
+    await routeHandler(mockContext, mockRequest, mockResponseFactory);
+
+    expect(runDeleteUnusedUrlsTask).toHaveBeenCalledTimes(1);
+    expect(runDeleteUnusedUrlsTask).toHaveBeenCalledWith({
+      core: mockCoreSetup,
+      urlExpirationDuration: mockUrlExpirationDuration,
+      urlLimit: mockUrlLimit,
+      logger: mockLogger,
+      isEnabled: true,
+    });
+
+    expect(mockResponseFactory.ok).toHaveBeenCalledTimes(1);
+    expect(mockResponseFactory.ok).toHaveBeenCalledWith({
+      body: {
+        message: 'Unused URLs cleanup task has finished.',
+        deletedCount: 5,
+      },
+    });
+  });
+
+  it('returns forbidden response if task is disabled', async () => {
+    registerDeleteUnusedUrlsRoute({
+      router: mockRouter,
+      core: mockCoreSetup,
+      urlExpirationDuration: mockUrlExpirationDuration,
+      urlLimit: mockUrlLimit,
+      logger: mockLogger,
+      isEnabled: false,
+    });
+
+    const routeHandler = mockRouter.post.mock.calls[0][1];
+    const mockRequest = {} as KibanaRequest;
+    const mockContext = {} as any;
+
+    await routeHandler(mockContext, mockRequest, mockResponseFactory);
+
+    expect(mockResponseFactory.forbidden).toHaveBeenCalledTimes(1);
+    expect(mockResponseFactory.forbidden).toHaveBeenCalledWith({
+      body: {
+        message: 'Unused URLs cleanup task is disabled. Enable it in the configuration.',
+      },
+    });
+  });
+});