[Streams] Refactoring streams routes (#206526)

## Summary This PR consolidates the multiple `server/streams/*` route files into 4 `route.ts` files to optimize the Typescript parsing. I tried to organize the routes into 4 logical groups: - CRUD - edit, list, read, delete - Management - fork, resync, status, sample - Schema - unmapped fields, schema simulation - Enablement - disable, enable I left everything else "as is" since @dgieselaar is currently doing a refactor to consolidate most of the features into a new `StreamsClient` similar to the `AssetClient`
elastic · Jan 16, 2025 · 24f5153 · 24f5153
1 parent 10a2215
commit 24f5153
Show file tree

Hide file tree

Showing 17 changed files with 635 additions and 749 deletions.
diff --git a/x-pack/solutions/observability/plugins/streams/server/routes/index.ts b/x-pack/solutions/observability/plugins/streams/server/routes/index.ts
@@ -5,40 +5,22 @@
  * 2.0.
  */
 
-import { dashboardRoutes } from './dashboards/route';
 import { esqlRoutes } from './esql/route';
-import { deleteStreamRoute } from './streams/delete';
-import { streamDetailRoute } from './streams/details';
-import { disableStreamsRoute } from './streams/disable';
-import { editStreamRoute } from './streams/edit';
-import { enableStreamsRoute } from './streams/enable';
-import { forkStreamsRoute } from './streams/fork';
-import { listStreamsRoute } from './streams/list';
-import { readStreamRoute } from './streams/read';
-import { resyncStreamsRoute } from './streams/resync';
-import { sampleStreamRoute } from './streams/sample';
-import { schemaFieldsSimulationRoute } from './streams/schema/fields_simulation';
-import { unmappedFieldsRoute } from './streams/schema/unmapped_fields';
-import { simulateProcessorRoute } from './streams/processing/simulate';
-import { streamsStatusRoutes } from './streams/settings';
+import { dashboardRoutes } from './dashboards/route';
+import { crudRoutes } from './streams/crud/route';
+import { enablementRoutes } from './streams/enablement/route';
+import { managementRoutes } from './streams/management/route';
+import { schemaRoutes } from './streams/schema/route';
+import { processingRoutes } from './streams/processing/route';
 
 export const streamsRouteRepository = {
-  ...enableStreamsRoute,
-  ...resyncStreamsRoute,
-  ...forkStreamsRoute,
-  ...readStreamRoute,
-  ...editStreamRoute,
-  ...deleteStreamRoute,
-  ...listStreamsRoute,
-  ...streamsStatusRoutes,
   ...esqlRoutes,
-  ...disableStreamsRoute,
   ...dashboardRoutes,
-  ...sampleStreamRoute,
-  ...streamDetailRoute,
-  ...unmappedFieldsRoute,
-  ...simulateProcessorRoute,
-  ...schemaFieldsSimulationRoute,
+  ...crudRoutes,
+  ...enablementRoutes,
+  ...managementRoutes,
+  ...schemaRoutes,
+  ...processingRoutes,
 };
 
 export type StreamsRouteRepository = typeof streamsRouteRepository;
diff --git a/x-pack/solutions/observability/plugins/streams/server/routes/streams/crud/route.ts b/x-pack/solutions/observability/plugins/streams/server/routes/streams/crud/route.ts
@@ -0,0 +1,286 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { z } from '@kbn/zod';
+import { badRequest, internal, notFound } from '@hapi/boom';
+import { SearchTotalHits } from '@elastic/elasticsearch/lib/api/types';
+import {
+  streamConfigDefinitionSchema,
+  ListStreamsResponse,
+  FieldDefinitionConfig,
+  ReadStreamDefinition,
+  WiredReadStreamDefinition,
+  isWiredStream,
+} from '@kbn/streams-schema';
+import { isResponseError } from '@kbn/es-errors';
+import { MalformedStreamId } from '../../../lib/streams/errors/malformed_stream_id';
+import {
+  DefinitionNotFound,
+  ForkConditionMissing,
+  IndexTemplateNotFound,
+  RootStreamImmutabilityException,
+  SecurityException,
+} from '../../../lib/streams/errors';
+import { createServerRoute } from '../../create_server_route';
+import { getDataStreamLifecycle } from '../../../lib/streams/stream_crud';
+
+export const readStreamRoute = createServerRoute({
+  endpoint: 'GET /api/streams/{id}',
+  options: {
+    access: 'internal',
+  },
+  security: {
+    authz: {
+      enabled: false,
+      reason:
+        'This API delegates security to the currently logged in user and their Elasticsearch permissions.',
+    },
+  },
+  params: z.object({
+    path: z.object({ id: z.string() }),
+  }),
+  handler: async ({ params, request, getScopedClients }): Promise<ReadStreamDefinition> => {
+    try {
+      const { assetClient, streamsClient } = await getScopedClients({
+        request,
+      });
+
+      const name = params.path.id;
+
+      const [streamDefinition, dashboards, ancestors, dataStream] = await Promise.all([
+        streamsClient.getStream(name),
+        assetClient.getAssetIds({
+          entityId: name,
+          entityType: 'stream',
+          assetType: 'dashboard',
+        }),
+        streamsClient.getAncestors(name),
+        streamsClient.getDataStream(name),
+      ]);
+
+      const lifecycle = getDataStreamLifecycle(dataStream);
+
+      if (!isWiredStream(streamDefinition)) {
+        return {
+          ...streamDefinition,
+          lifecycle,
+          dashboards,
+          inherited_fields: {},
+        };
+      }
+
+      const body: WiredReadStreamDefinition = {
+        ...streamDefinition,
+        dashboards,
+        lifecycle,
+        inherited_fields: ancestors.reduce((acc, def) => {
+          Object.entries(def.stream.ingest.wired.fields).forEach(([key, fieldDef]) => {
+            acc[key] = { ...fieldDef, from: def.name };
+          });
+          return acc;
+          // TODO: replace this with a proper type
+        }, {} as Record<string, FieldDefinitionConfig & { from: string }>),
+      };
+
+      return body;
+    } catch (e) {
+      if (e instanceof DefinitionNotFound || (isResponseError(e) && e.statusCode === 404)) {
+        throw notFound(e);
+      }
+
+      throw internal(e);
+    }
+  },
+});
+
+export interface StreamDetailsResponse {
+  details: {
+    count: number;
+  };
+}
+
+export const streamDetailRoute = createServerRoute({
+  endpoint: 'GET /api/streams/{id}/_details',
+  options: {
+    access: 'internal',
+  },
+  security: {
+    authz: {
+      enabled: false,
+      reason:
+        'This API delegates security to the currently logged in user and their Elasticsearch permissions.',
+    },
+  },
+  params: z.object({
+    path: z.object({ id: z.string() }),
+    query: z.object({
+      start: z.string(),
+      end: z.string(),
+    }),
+  }),
+  handler: async ({ params, request, getScopedClients }): Promise<StreamDetailsResponse> => {
+    try {
+      const { scopedClusterClient, streamsClient } = await getScopedClients({ request });
+      const streamEntity = await streamsClient.getStream(params.path.id);
+
+      // check doc count
+      const docCountResponse = await scopedClusterClient.asCurrentUser.search({
+        index: streamEntity.name,
+        body: {
+          track_total_hits: true,
+          query: {
+            range: {
+              '@timestamp': {
+                gte: params.query.start,
+                lte: params.query.end,
+              },
+            },
+          },
+          size: 0,
+        },
+      });
+
+      const count = (docCountResponse.hits.total as SearchTotalHits).value;
+
+      return {
+        details: {
+          count,
+        },
+      };
+    } catch (e) {
+      if (e instanceof DefinitionNotFound) {
+        throw notFound(e);
+      }
+
+      throw internal(e);
+    }
+  },
+});
+
+export const listStreamsRoute = createServerRoute({
+  endpoint: 'GET /api/streams',
+  options: {
+    access: 'internal',
+  },
+  security: {
+    authz: {
+      enabled: false,
+      reason:
+        'This API delegates security to the currently logged in user and their Elasticsearch permissions.',
+    },
+  },
+  params: z.object({}),
+  handler: async ({ request, getScopedClients }): Promise<ListStreamsResponse> => {
+    try {
+      const { streamsClient } = await getScopedClients({ request });
+      return {
+        streams: await streamsClient.listStreams(),
+      };
+    } catch (e) {
+      if (e instanceof DefinitionNotFound) {
+        throw notFound(e);
+      }
+
+      throw internal(e);
+    }
+  },
+});
+
+export const editStreamRoute = createServerRoute({
+  endpoint: 'PUT /api/streams/{id}',
+  options: {
+    access: 'internal',
+  },
+  security: {
+    authz: {
+      enabled: false,
+      reason:
+        'This API delegates security to the currently logged in user and their Elasticsearch permissions.',
+    },
+  },
+  params: z.object({
+    path: z.object({
+      id: z.string(),
+    }),
+    body: streamConfigDefinitionSchema,
+  }),
+  handler: async ({ params, request, getScopedClients }) => {
+    try {
+      const { streamsClient } = await getScopedClients({ request });
+      const streamDefinition = { stream: params.body, name: params.path.id };
+
+      return await streamsClient.upsertStream({ definition: streamDefinition });
+    } catch (e) {
+      if (e instanceof IndexTemplateNotFound || e instanceof DefinitionNotFound) {
+        throw notFound(e);
+      }
+
+      if (
+        e instanceof SecurityException ||
+        e instanceof ForkConditionMissing ||
+        e instanceof MalformedStreamId ||
+        e instanceof RootStreamImmutabilityException
+      ) {
+        throw badRequest(e);
+      }
+
+      throw internal(e);
+    }
+  },
+});
+
+export const deleteStreamRoute = createServerRoute({
+  endpoint: 'DELETE /api/streams/{id}',
+  options: {
+    access: 'internal',
+  },
+  security: {
+    authz: {
+      enabled: false,
+      reason:
+        'This API delegates security to the currently logged in user and their Elasticsearch permissions.',
+    },
+  },
+  params: z.object({
+    path: z.object({
+      id: z.string(),
+    }),
+  }),
+  handler: async ({ params, request, getScopedClients }): Promise<{ acknowledged: true }> => {
+    try {
+      const { streamsClient } = await getScopedClients({
+        request,
+      });
+
+      await streamsClient.deleteStream(params.path.id);
+
+      return { acknowledged: true };
+    } catch (e) {
+      if (e instanceof IndexTemplateNotFound || e instanceof DefinitionNotFound) {
+        throw notFound(e);
+      }
+
+      if (
+        e instanceof SecurityException ||
+        e instanceof ForkConditionMissing ||
+        e instanceof MalformedStreamId
+      ) {
+        throw badRequest(e);
+      }
+
+      throw internal(e);
+    }
+  },
+});
+
+export const crudRoutes = {
+  ...readStreamRoute,
+  ...streamDetailRoute,
+  ...listStreamsRoute,
+  ...editStreamRoute,
+  ...deleteStreamRoute,
+};