backend-app-api: move healthchecks to healthService

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>

packages/backend-plugin-api/src/services/definitions/HealthService.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed 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.
+ */
+
+/**
+ * @public
+ */
+export interface HealthService {}

packages/backend-plugin-api/src/services/definitions/HttpRouterService.ts

@@ -26,11 +26,6 @@ export interface HttpRouterServiceAuthPolicy {
   allow: 'unauthenticated' | 'user-cookie';
 }
 
-/** @public */
-export interface HttpRouterHealthCheckConfig {
-  handler: () => Promise<any>;
-}
-
 /**
  * Allows plugins to register HTTP routes.
  *

packages/backend-plugin-api/src/services/definitions/coreServices.ts

@@ -102,6 +102,13 @@ export namespace coreServices {
     import('./DiscoveryService').DiscoveryService
   >({ id: 'core.discovery' });
 
+  /**
+   * The service reference for the plugin scoped {@link RootHealthService}.
+   */
+  export const health = createServiceRef<
+    import('./RootHealthService').RootHealthService
+  >({ id: 'core.health', scope: 'root' });
+
   /**
    * Authentication of HTTP requests.
    *

packages/backend-plugin-api/src/services/definitions/index.ts

@@ -32,10 +32,10 @@ export type {
 export type { RootConfigService } from './RootConfigService';
 export type { DatabaseService } from './DatabaseService';
 export type { DiscoveryService } from './DiscoveryService';
+export type { HealthService } from './HealthService';
 export type {
   HttpRouterService,
   HttpRouterServiceAuthPolicy,
-  HttpRouterHealthCheckConfig,
 } from './HttpRouterService';
 export type { HttpAuthService } from './HttpAuthService';
 export type {