Expanding API response fields

x-pack/plugins/cases/common/api/connectors/index.ts

@@ -117,7 +117,11 @@ export const CaseConnectorRt = rt.intersection([
 ]);
 
 export const GetCaseConnectorsResponseRt = rt.array(
-  rt.intersection([rt.type({ needsToBePushed: rt.boolean }), CaseConnectorRt])
+  rt.intersection([
+    rt.type({ needsToBePushed: rt.boolean, hasBeenPushed: rt.boolean }),
+    rt.partial(rt.type({ latestPushDate: rt.string }).props),
+    CaseConnectorRt,
+  ])
 );
 
 export type CaseUserActionConnector = rt.TypeOf<typeof CaseUserActionConnectorRt>;

x-pack/plugins/cases/server/client/mocks.ts

@@ -82,6 +82,7 @@ type UserActionsSubClientMock = jest.Mocked<UserActionsSubClient>;
 const createUserActionsSubClientMock = (): UserActionsSubClientMock => {
   return {
     getAll: jest.fn(),
+    getConnectors: jest.fn(),
   };
 };
 

x-pack/plugins/cases/server/client/user_actions/connectors.ts

@@ -59,6 +59,8 @@ export const getConnectors = async (
         ...enrichedConnector.connector,
         name: enrichedConnector.name,
         needsToBePushed: hasDataToPush(enrichedConnector),
+        latestPushDate: enrichedConnector.pushInfo?.pushDate.toISOString(),
+        hasBeenPushed: hasBeenPushed(enrichedConnector),
       });
     }
 
@@ -105,6 +107,11 @@ const checkConnectorsAuthorization = async ({
   });
 };
 
+interface EnrichedPushInfo {
+  pushDate: Date;
+  connectorFieldsUsedInPush: CaseConnector;
+}
+
 interface EnrichedConnector {
   connector: CaseConnector;
   name: string;
@@ -171,7 +178,7 @@ const getPushInfo = async ({
     return new Map();
   }
 
-  const priorToPushFields = await userActionService.getConnectorFieldsBeforePushes(
+  const priorToPushFields = await userActionService.getConnectorFieldsUsedInPushes(
     caseId,
     pushRequest
   );
@@ -184,7 +191,7 @@ const getPushInfo = async ({
     if (connectorFields != null) {
       enrichedPushInfo.set(request.connectorId, {
         pushDate: request.date,
-        connectorFieldsBeforePush: connectorFields,
+        connectorFieldsUsedInPush: connectorFields,
       });
     }
   }
@@ -208,11 +215,6 @@ const isDateValid = (date: Date): boolean => {
   return !isNaN(date.getTime());
 };
 
-interface EnrichedPushInfo {
-  pushDate: Date;
-  connectorFieldsBeforePush: CaseConnector;
-}
-
 const getConnectorInfoFromSavedObject = (
   savedObject: SavedObject<CaseUserActionResponse> | undefined
 ): CaseConnector | undefined => {
@@ -229,10 +231,14 @@ const hasDataToPush = (enrichedConnectorInfo: EnrichedConnector): boolean => {
   return (
     !isEqual(
       enrichedConnectorInfo.connector,
-      enrichedConnectorInfo.pushInfo?.connectorFieldsBeforePush
+      enrichedConnectorInfo.pushInfo?.connectorFieldsUsedInPush
     ) ||
     (enrichedConnectorInfo.pushInfo != null &&
       enrichedConnectorInfo.latestUserActionDate != null &&
-      enrichedConnectorInfo.pushInfo.pushDate < enrichedConnectorInfo.latestUserActionDate)
+      enrichedConnectorInfo.latestUserActionDate > enrichedConnectorInfo.pushInfo.pushDate)
   );
 };
+
+const hasBeenPushed = (enrichedConnectorInfo: EnrichedConnector): boolean => {
+  return enrichedConnectorInfo.pushInfo != null;
+};

x-pack/plugins/cases/server/client/user_actions/types.ts

@@ -15,6 +15,4 @@ export interface UserActionGet {
   caseId: string;
 }
 
-export interface GetConnectorsRequest {
-  caseId: string;
-}
+export type GetConnectorsRequest = UserActionGet;

x-pack/plugins/cases/server/services/mocks.ts

@@ -94,7 +94,7 @@ type FakeUserActionService = PublicMethodsOf<CaseUserActionService> & {
 export const createUserActionServiceMock = (): CaseUserActionServiceMock => {
   const service: FakeUserActionService = {
     creator: createUserActionPersisterServiceMock(),
-    getConnectorFieldsBeforePushes: jest.fn(),
+    getConnectorFieldsUsedInPushes: jest.fn(),
     getMostRecentUserAction: jest.fn(),
     getCaseConnectorInformation: jest.fn(),
     getAll: jest.fn(),

x-pack/plugins/cases/server/services/user_actions/index.ts

@@ -106,7 +106,7 @@ export class CaseUserActionService {
     return this._creator;
   }
 
-  public async getConnectorFieldsBeforePushes(
+  public async getConnectorFieldsUsedInPushes(
     caseId: string,
     pushes: PushInfo[]
   ): Promise<CaseConnectorFields> {
@@ -131,11 +131,11 @@ export class CaseUserActionService {
         page: 1,
         perPage: 1,
         sortField: defaultSortField,
-        aggs: CaseUserActionService.buildConnectorFieldsBeforePushAggs(pushes),
+        aggs: CaseUserActionService.buildConnectorFieldsUsedInPushAggs(pushes),
         filter: connectorsFilter,
       });
 
-      return this.createCaseConnectorFieldsBeforePushes(response.aggregations);
+      return this.createCaseConnectorFieldsUsedInPushes(response.aggregations);
     } catch (error) {
       this.context.log.error(
         `Error while retrieving the connector fields before the last push: ${caseId}: ${error}`
@@ -144,14 +144,14 @@ export class CaseUserActionService {
     }
   }
 
-  private static buildConnectorFieldsBeforePushAggs(
+  private static buildConnectorFieldsUsedInPushAggs(
     pushes: PushInfo[]
   ): Record<string, estypes.AggregationsAggregationContainer> {
     const filters: estypes.AggregationsBuckets<estypes.QueryDslQueryContainer> = {};
 
     /**
      * Group the user actions by the unique connector ids and bound the time range
-     * for that connector's push event
+     * for that connector's push event. We want to search for the fields before the push timestamp.
      */
     for (const push of pushes) {
       filters[push.connectorId] = {
@@ -231,7 +231,7 @@ export class CaseUserActionService {
     };
   }
 
-  private createCaseConnectorFieldsBeforePushes(
+  private createCaseConnectorFieldsUsedInPushes(
     aggsResults?: ConnectorFieldsBeforePushAggsResult
   ): CaseConnectorFields {
     const connectorFields: CaseConnectorFields = new Map();

x-pack/test/cases_api_integration/common/lib/connectors.ts

@@ -238,41 +238,43 @@ export const createCaseWithConnector = async ({
   });
 
   actionsRemover.add(auth?.space ?? 'default', connector.id, 'action', 'actions');
-  const configuration = await createConfiguration(
-    supertest,
-    {
-      ...getConfigurationRequest({
-        id: connector.id,
-        name: connector.name,
-        type: connector.connector_type_id as ConnectorTypes,
-      }),
-      ...configureReq,
-    },
-    200,
-    auth ?? undefined
-  );
 
-  const postedCase = await createCase(
-    supertest,
-    {
-      ...createCaseReq,
-      connector: {
-        id: connector.id,
-        name: connector.name,
-        type: connector.connector_type_id,
-        fields: {
-          urgency: '2',
-          impact: '2',
-          severity: '2',
-          category: 'software',
-          subcategory: 'os',
-        },
-      } as CaseConnector,
-    },
-    200,
-    auth,
-    headers
-  );
+  const [configuration, postedCase] = await Promise.all([
+    createConfiguration(
+      supertest,
+      {
+        ...getConfigurationRequest({
+          id: connector.id,
+          name: connector.name,
+          type: connector.connector_type_id as ConnectorTypes,
+        }),
+        ...configureReq,
+      },
+      200,
+      auth ?? undefined
+    ),
+    createCase(
+      supertest,
+      {
+        ...createCaseReq,
+        connector: {
+          id: connector.id,
+          name: connector.name,
+          type: connector.connector_type_id,
+          fields: {
+            urgency: '2',
+            impact: '2',
+            severity: '2',
+            category: 'software',
+            subcategory: 'os',
+          },
+        } as CaseConnector,
+      },
+      200,
+      auth,
+      headers
+    ),
+  ]);
 
   return { postedCase, connector, configuration };
 };