feat: support for includeInactive param in entities gql request (#549)

Author: arjunlalb

projects/observability/src/shared/graphql/request/builders/argument/graphql-observability-argument-builder.ts

@@ -20,6 +20,9 @@ export class GraphQlObservabilityArgumentBuilder extends GraphQlArgumentBuilder
     };
   }
 
+  public forIncludeInactive(includeInactive?: boolean): GraphQlArgument[] {
+    return includeInactive !== undefined ? [{ name: 'includeInactive', value: includeInactive }] : [];
+  }
   public forNeighborType(type: EntityType): GraphQlArgument {
     return {
       name: 'neighborType',

projects/observability/src/shared/graphql/request/handlers/entities/query/entities-graphql-query-builder.service.ts

@@ -39,7 +39,8 @@ export class EntitiesGraphqlQueryBuilderService {
       this.argBuilder.forTimeRange(request.timeRange),
       ...this.argBuilder.forOffset(request.offset),
       ...this.argBuilder.forOrderBy(request.sort),
-      ...this.buildFilters(request)
+      ...this.buildFilters(request),
+      ...this.argBuilder.forIncludeInactive(request.includeInactive)
     ];
   }
 
@@ -103,6 +104,7 @@ export interface GraphQlEntitiesRequest {
   sort?: GraphQlSortBySpecification;
   filters?: GraphQlFilter[];
   includeTotal?: boolean;
+  includeInactive?: boolean;
 }
 
 export interface EntitiesResponse {

projects/observability/src/shared/graphql/request/handlers/entities/query/entities-graphql-query-handler.service.test.ts

@@ -58,19 +58,22 @@ describe('Entities graphql query handler', () => {
   const specBuilder = new ObservabilitySpecificationBuilder();
   const buildRequest = (
     entityType: ObservabilityEntityType = ObservabilityEntityType.Service,
-    limit: number = 30
+    limit: number = 30,
+    includeInactive?: boolean
   ): GraphQlEntitiesQueryRequest => ({
     requestType: ENTITIES_GQL_REQUEST,
     entityType: entityType,
     timeRange: testTimeRange,
     properties: [specBuilder.attributeSpecificationForKey('name')],
     limit: limit,
-    includeTotal: true
+    includeTotal: true,
+    includeInactive: includeInactive
   });
 
   const buildRequestGraphqlSelection = (
     entityType: ObservabilityEntityType = ObservabilityEntityType.Service,
-    limit: number = 30
+    limit: number = 30,
+    includeInactive?: boolean
   ): GraphQlSelection => ({
     path: 'entities',
     arguments: [
@@ -82,7 +85,8 @@ describe('Entities graphql query handler', () => {
           startTime: new Date(testTimeRange.from),
           endTime: new Date(testTimeRange.to)
         }
-      }
+      },
+      ...(includeInactive !== undefined ? [{ name: 'includeInactive', value: includeInactive }] : [])
     ],
     children: [
       {
@@ -130,6 +134,22 @@ describe('Entities graphql query handler', () => {
     const graphqlSelection = buildRequestGraphqlSelection(ObservabilityEntityType.Api);
     expect(spectator.service.convertRequest(buildRequest(ObservabilityEntityType.Api))).toEqual(graphqlSelection);
   });
+
+  test('adds includeInactive param when required', () => {
+    const spectator = createService();
+    expect(spectator.service.convertRequest(buildRequest(ObservabilityEntityType.Api, 30, true))).toEqual(
+      buildRequestGraphqlSelection(ObservabilityEntityType.Api, 30, true)
+    );
+
+    expect(spectator.service.convertRequest(buildRequest(ObservabilityEntityType.Api, 30, false))).toEqual(
+      buildRequestGraphqlSelection(ObservabilityEntityType.Api, 30, false)
+    );
+
+    expect(spectator.service.convertRequest(buildRequest(ObservabilityEntityType.Api, 30))).toEqual(
+      buildRequestGraphqlSelection(ObservabilityEntityType.Api, 30)
+    );
+  });
+
   test('converts response to entities array', fakeAsync(() => {
     const spectator = createService();
     const serverResponse = {