From 1ef7e5a3640b5f2367a478c6c33b0a42bf89e65c Mon Sep 17 00:00:00 2001
From: Joe Portner <5295965+jportner@users.noreply.github.com>
Date: Mon, 15 Feb 2021 13:11:18 -0500
Subject: [PATCH] More PR review feedback

---
 .../es_ui_shared/public/request/send_request.ts    |  4 ++++
 .../es_ui_shared/public/request/use_request.ts     | 14 ++++++++++++--
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/src/plugins/es_ui_shared/public/request/send_request.ts b/src/plugins/es_ui_shared/public/request/send_request.ts
index 889ec59d91a4b..11ab99cfb6978 100644
--- a/src/plugins/es_ui_shared/public/request/send_request.ts
+++ b/src/plugins/es_ui_shared/public/request/send_request.ts
@@ -13,6 +13,10 @@ export interface SendRequestConfig {
   method: 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head';
   query?: HttpFetchQuery;
   body?: any;
+  /**
+   * If set, flags this as a "system request" to indicate that this is not a user-initiated request. For more information, see
+   * HttpFetchOptions#asSystemRequest.
+   */
   asSystemRequest?: boolean;
 }
 
diff --git a/src/plugins/es_ui_shared/public/request/use_request.ts b/src/plugins/es_ui_shared/public/request/use_request.ts
index 7d939141b7969..33085bdbf4478 100644
--- a/src/plugins/es_ui_shared/public/request/use_request.ts
+++ b/src/plugins/es_ui_shared/public/request/use_request.ts
@@ -77,6 +77,9 @@ export const useRequest = <D = any, E = Error>(
       // "old" error/data or loading state when a new request is in-flight.
       setIsLoading(true);
 
+      // Any requests that are sent in the background (without user interaction) should be flagged as "system requests". This should not be
+      // confused with any terminology in Elasticsearch. This is a Kibana-specific construct that allows the server to differentiate between
+      // user-initiated and requests "system"-initiated requests, for purposes like security features.
       const requestPayload = { ...requestBody, asSystemRequest };
       const response = await sendRequest<D, E>(httpClient, requestPayload);
       const { data: serializedResponseData, error: responseError } = response;
@@ -111,7 +114,10 @@ export const useRequest = <D = any, E = Error>(
     clearPollInterval();
 
     if (pollIntervalMs) {
-      pollIntervalIdRef.current = setTimeout(() => resendRequest(true), pollIntervalMs);
+      pollIntervalIdRef.current = setTimeout(
+        () => resendRequest(true), // This is happening on an interval in the background, so we flag it as a "system request".
+        pollIntervalMs
+      );
     }
   }, [pollIntervalMs, resendRequest, clearPollInterval]);
 
@@ -141,11 +147,15 @@ export const useRequest = <D = any, E = Error>(
     };
   }, [clearPollInterval]);
 
+  const resendRequestForConsumer = useCallback(() => {
+    return resendRequest();
+  }, [resendRequest]);
+
   return {
     isInitialRequest: isInitialRequestRef.current,
     isLoading,
     error,
     data,
-    resendRequest, // Gives the user the ability to manually request data
+    resendRequest: resendRequestForConsumer, // Gives the user the ability to manually request data
   };
 };