Use enum instead and address comments

Author: sirknightj

src/source/CurlApiCallbacks.c

@@ -14,7 +14,7 @@ STATUS createCurlApiCallbacks(PCallbacksProvider pCallbacksProvider, PCHAR regio
     ENTERS();
     STATUS retStatus = STATUS_SUCCESS, status;
     PCurlApiCallbacks pCurlApiCallbacks = NULL;
-    BOOL useDualStackEndpoint;
+    KvsControlPlaneEndpointType controlPlaneEndpointType;
 
     CHK(pCallbacksProvider != NULL && ppCurlApiCallbacks != NULL, STATUS_NULL_ARG);
     CHK(certPath == NULL || STRNLEN(certPath, MAX_PATH_LEN + 1) <= MAX_PATH_LEN, STATUS_INVALID_CERT_PATH_LENGTH);
@@ -80,19 +80,8 @@ STATUS createCurlApiCallbacks(PCallbacksProvider pCallbacksProvider, PCHAR regio
 
     // Construct Control Plane URL
     if (IS_NULL_OR_EMPTY_STRING(controlPlaneUrl)) {
-#if defined(AWS_KVS_USE_LEGACY_ENDPOINT_ONLY)
-        useDualStackEndpoint = FALSE;
-        DLOGI("Using legacy endpoint from AWS_KVS_USE_LEGACY_ENDPOINT_ONLY")
-#elif defined(AWS_KVS_USE_DUAL_STACK_ENDPOINT_ONLY)
-        useDualStackEndpoint = TRUE;
-        DLOGI("Using dual stack endpoint from AWS_KVS_USE_DUAL_STACK_ENDPOINT_ONLY")
-#else
-        useDualStackEndpoint = (GETENV(CONTROL_PLANE_USE_DUAL_STACK_ENDPOINT_ENV_VAR) != NULL) &&
-            (0 == STRNCMPI(GETENV(CONTROL_PLANE_USE_DUAL_STACK_ENDPOINT_ENV_VAR), "true", 4));
-        DLOGI("Using %s endpoint from environment", useDualStackEndpoint ? "dual stack" : "legacy");
-#endif
-
-        constructControlPlaneUrl(pCurlApiCallbacks->controlPlaneUrl, MAX_URI_CHAR_LEN, pCurlApiCallbacks->region, !useDualStackEndpoint);
+        CHK_STATUS(determineKvsControlPlaneEndpointType(&controlPlaneEndpointType));
+        CHK_STATUS(constructControlPlaneUrl(pCurlApiCallbacks->controlPlaneUrl, MAX_URI_CHAR_LEN, pCurlApiCallbacks->region, controlPlaneEndpointType));
     } else {
         STRNCPY(pCurlApiCallbacks->controlPlaneUrl, controlPlaneUrl, MAX_URI_CHAR_LEN);
     }
@@ -190,7 +179,51 @@ STATUS createCurlApiCallbacks(PCallbacksProvider pCallbacksProvider, PCHAR regio
     return retStatus;
 }
 
-STATUS constructControlPlaneUrl(const char* buffer, SIZE_T bufferSize, const char* region, BOOL useLegacyEndpoint)
+STATUS determineKvsControlPlaneEndpointType(PKvsControlPlaneEndpointType pEndpointType)
+{
+    ENTERS();
+    STATUS retStatus = STATUS_SUCCESS;
+    BOOL isDualStack = FALSE;
+    const char* envValue;
+
+    CHK(pEndpointType != NULL, STATUS_NULL_ARG);
+
+#if defined(AWS_KVS_USE_LEGACY_ENDPOINT_ONLY)
+    *pEndpointType = ENDPOINT_TYPE_LEGACY;
+    DLOGI("Using legacy endpoint from AWS_KVS_USE_LEGACY_ENDPOINT_ONLY");
+#elif defined(AWS_KVS_USE_DUAL_STACK_ENDPOINT_ONLY)
+    *pEndpointType = ENDPOINT_TYPE_DUAL_STACK;
+    DLOGI("Using dual stack endpoint from AWS_KVS_USE_DUAL_STACK_ENDPOINT_ONLY");
+#else
+    envValue = GETENV(CONTROL_PLANE_USE_DUAL_STACK_ENDPOINT_ENV_VAR);
+
+    // Check for "true" to make sure "false" actually disables it
+    // https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html
+    isDualStack = (envValue != NULL) && (0 == STRNCMPI(envValue, "true", 4));
+    *pEndpointType = isDualStack ? ENDPOINT_TYPE_DUAL_STACK : ENDPOINT_TYPE_LEGACY;
+
+    DLOGI("Using %s endpoint from environment", endpointTypeToString(*pEndpointType));
+#endif
+
+CleanUp:
+    CHK_LOG_ERR(retStatus);
+
+    LEAVES();
+    return retStatus;
+}
+
+const char* endpointTypeToString(const KvsControlPlaneEndpointType type) {
+    switch (type) {
+        case ENDPOINT_TYPE_LEGACY:
+            return "LEGACY";
+        case ENDPOINT_TYPE_DUAL_STACK:
+            return "DUAL_STACK";
+        default:
+            return "UNKNOWN";
+    }
+}
+
+STATUS constructControlPlaneUrl(const char* buffer, SIZE_T bufferSize, const char* region, KvsControlPlaneEndpointType endpointType)
 {
     ENTERS();
     STATUS retStatus = STATUS_SUCCESS;
@@ -203,21 +236,21 @@ STATUS constructControlPlaneUrl(const char* buffer, SIZE_T bufferSize, const cha
     if (0 == STRNCMP(region, AWS_ISO_B_REGION_PREFIX, STRLEN(AWS_ISO_B_REGION_PREFIX))) {
         // Top Secret Cloud regions: https://kinesisvideo-fips.us-isob-east-1.sc2s.sgov.gov
         serviceNamePostfix = AWS_KVS_FIPS_ENDPOINT_POSTFIX;
-        postfix = useLegacyEndpoint ? CONTROL_PLANE_URI_POSTFIX_ISO_B : CONTROL_PLANE_URI_POSTFIX_ISO_B_DUAL_STACK;
+        postfix = (endpointType == ENDPOINT_TYPE_LEGACY) ? CONTROL_PLANE_URI_POSTFIX_ISO_B : CONTROL_PLANE_URI_POSTFIX_ISO_B_DUAL_STACK;
     } else if (0 == STRNCMP(region, AWS_ISO_REGION_PREFIX, STRLEN(AWS_ISO_REGION_PREFIX))) {
         // Secret Cloud regions: https://kinesisvideo-fips.us-iso-east-1.c2s.ic.gov
         serviceNamePostfix = AWS_KVS_FIPS_ENDPOINT_POSTFIX;
-        postfix = useLegacyEndpoint ? CONTROL_PLANE_URI_POSTFIX_ISO : CONTROL_PLANE_URI_POSTFIX_ISO_DUAL_STACK;
+        postfix = (endpointType == ENDPOINT_TYPE_LEGACY) ? CONTROL_PLANE_URI_POSTFIX_ISO : CONTROL_PLANE_URI_POSTFIX_ISO_DUAL_STACK;
     } else if (0 == STRNCMP(region, AWS_GOV_CLOUD_REGION_PREFIX, STRLEN(AWS_GOV_CLOUD_REGION_PREFIX))) {
         // US Govcloud regions: https://kinesisvideo-fips.us-gov-east-1.amazonaws.com
         serviceNamePostfix = AWS_KVS_FIPS_ENDPOINT_POSTFIX;
-        postfix = useLegacyEndpoint ? CONTROL_PLANE_URI_POSTFIX : CONTROL_PLANE_URI_POSTFIX_DUAL_STACK;
+        postfix = (endpointType == ENDPOINT_TYPE_LEGACY) ? CONTROL_PLANE_URI_POSTFIX : CONTROL_PLANE_URI_POSTFIX_DUAL_STACK;
     } else if (0 == STRNCMP(region, AWS_CN_REGION_PREFIX, STRLEN(AWS_CN_REGION_PREFIX))) {
         // China regions: https://kinesisvideo.cn-north-1.amazonaws.com.cn"
-        postfix = useLegacyEndpoint ? CONTROL_PLANE_URI_POSTFIX_CN : CONTROL_PLANE_URI_POSTFIX_CN_DUAL_STACK;
+        postfix = (endpointType == ENDPOINT_TYPE_LEGACY) ? CONTROL_PLANE_URI_POSTFIX_CN : CONTROL_PLANE_URI_POSTFIX_CN_DUAL_STACK;
     } else {
         // Standard regions: https://kinesisvideo.us-west-2.amazonaws.com
-        postfix = useLegacyEndpoint ? CONTROL_PLANE_URI_POSTFIX : CONTROL_PLANE_URI_POSTFIX_DUAL_STACK;
+        postfix = (endpointType == ENDPOINT_TYPE_LEGACY) ? CONTROL_PLANE_URI_POSTFIX : CONTROL_PLANE_URI_POSTFIX_DUAL_STACK;
     }
 
     // Create a fully qualified URI

src/source/CurlApiCallbacks.h

@@ -22,6 +22,12 @@ extern "C" {
 
 #define CONTROL_PLANE_USE_DUAL_STACK_ENDPOINT_ENV_VAR "AWS_USE_DUALSTACK_ENDPOINT"
 
+typedef enum {
+    ENDPOINT_TYPE_LEGACY,
+    ENDPOINT_TYPE_DUAL_STACK
+} KvsControlPlaneEndpointType;
+typedef KvsControlPlaneEndpointType* PKvsControlPlaneEndpointType;
+
 #if defined(AWS_KVS_USE_LEGACY_ENDPOINT_ONLY) && defined(AWS_KVS_USE_DUAL_STACK_ENDPOINT_ONLY)
 #error "Only one of AWS_KVS_USE_LEGACY_ENDPOINT_ONLY or AWS_KVS_USE_DUAL_STACK_ENDPOINT_ONLY can be defined"
 #endif
@@ -183,14 +189,16 @@ typedef struct __CurlApiCallbacks* PCurlApiCallbacks;
 // Curl API Callbacks main functionality
 //////////////////////////////////////////////////////////////////////
 STATUS createCurlApiCallbacks(struct __CallbacksProvider*, PCHAR, API_CALL_CACHE_TYPE, UINT64, PCHAR, PCHAR, PCHAR, PCHAR, PCurlApiCallbacks*);
-STATUS constructControlPlaneUrl(const char*, SIZE_T, const char*, BOOL);
+STATUS constructControlPlaneUrl(const char*, SIZE_T, const char*, KvsControlPlaneEndpointType);
+STATUS determineKvsControlPlaneEndpointType(PKvsControlPlaneEndpointType);
 STATUS freeCurlApiCallbacks(PCurlApiCallbacks*);
 STATUS curlApiCallbacksShutdownActiveRequests(PCurlApiCallbacks, STREAM_HANDLE, UINT64, BOOL, BOOL);
 STATUS curlApiCallbacksShutdownCachedEndpoints(PCurlApiCallbacks, STREAM_HANDLE, BOOL);
 STATUS curlApiCallbacksShutdownActiveUploads(PCurlApiCallbacks, STREAM_HANDLE, UPLOAD_HANDLE, UINT64, BOOL, BOOL);
 STATUS curlApiCallbacksShutdown(PCurlApiCallbacks, UINT64);
 STATUS freeApiCallbacksCurl(PUINT64);
 STATUS findRequestWithUploadHandle(UPLOAD_HANDLE, PCurlApiCallbacks, PCurlRequest*);
+const char* endpointTypeToString(KvsControlPlaneEndpointType type);
 
 //////////////////////////////////////////////////////////////////////
 // Auxiliary functionality

src/source/Response.c

@@ -204,6 +204,8 @@ STATUS initializeCurlSession(PRequestInfo pRequestInfo, PCallInfo pCallInfo, CUR
 
 #ifndef NDEBUG
     // Only available in debug build
+    // This setting will have curl print out the IP address that it resolved and connected to
+    // More info: https://everything.curl.dev/usingcurl/verbose/index.html
     if (!IS_NULL_OR_EMPTY_STRING(GETENV(KVS_CURL_DEBUG_ENV_VAR))) {
         curl_easy_setopt(pCurl, CURLOPT_VERBOSE, 1L);
     }