Add string array as an option for request context params for endpoint resolution (#276)

Co-authored-by: Waqar Ahmed Khan <waahm7@gmail.com>

Author: DmitriyMusatkin

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: GitHub Action for SwiftLint
         uses: norio-nomura/action-swiftlint@3.2.1
 
@@ -125,7 +125,7 @@ jobs:
     runs-on: ubuntu-22.04 # latest
     steps:
       - name: Checkout Source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: true
           fetch-depth: 0

Source/AwsCommonRuntimeKit/crt/Utilities.swift

@@ -272,3 +272,19 @@ func withByteCursorFromStrings<Result>(
         }
     }
 }
+
+extension Array where Element == String {
+  func withByteCursorArray<R>(_ body: (UnsafePointer<aws_byte_cursor>, Int) -> R) -> R {
+        let len = self.count
+        let cStrings = self.map { strdup($0) }
+        let cursors = cStrings.map { aws_byte_cursor_from_c_str($0) }
+        
+        defer {
+            cStrings.forEach { free($0) }
+        }
+
+        return cursors.withUnsafeBufferPointer { cursorsPtr in 
+            return body(cursorsPtr.baseAddress!, len)
+        }
+    }
+}

Source/AwsCommonRuntimeKit/sdkutils/endpoint/EndpointsRequestContext.swift

@@ -48,6 +48,23 @@ public class EndpointsRequestContext {
         }
     }
 
+    /// Add a string array endpoint parameter to the request context
+    /// - Parameters:
+    ///   - name: The name of the parameter
+    ///   - value: The value of the parameter
+    public func add(name: String, value: [String]?) throws {
+        guard let value = value else {
+            return
+        }
+        if (name.withByteCursor { nameCursor in
+            value.withByteCursorArray { ptr, len in        
+                aws_endpoints_request_context_add_string_array(allocator.rawValue, rawValue, nameCursor, ptr, len)
+            }
+        }) != AWS_OP_SUCCESS {
+            throw CommonRunTimeError.crtError(.makeFromLastError())
+        }
+    }
+
     deinit {
         aws_endpoints_request_context_release(rawValue)
     }

Test/AwsCommonRuntimeKitTests/crt/Utilities.swift

@@ -0,0 +1,27 @@
+//  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//  SPDX-License-Identifier: Apache-2.0.
+
+import XCTest
+@testable import AwsCommonRuntimeKit
+import AwsCCommon
+
+class UtilitiesTests: XCBaseTestCase {
+
+    func testStringArrayToByteCursorArray() {
+        let strings1 = ["a", "b"]
+        strings1.withByteCursorArray { cursors, len in
+            XCTAssertEqual(len, 2)
+            for i in 0..<len {
+                withUnsafePointer(to: cursors[i]) { pointer in
+                    XCTAssertTrue(aws_byte_cursor_is_valid(pointer))
+                }
+            }
+        }
+
+        let strings2: [String] = []
+        strings2.withByteCursorArray { cursors, len in
+            XCTAssertEqual(len, 0)
+        }
+    }
+}
+

Test/AwsCommonRuntimeKitTests/sdkutils/EndpointsRuleEngineTests.swift

@@ -13,7 +13,7 @@ class EndpointsRuleEngineTests: XCBaseTestCase {
       "partitions": [
         {
           "id": "aws",
-          "regionRegex": "^(us|eu|ap|sa|ca|me|af)-\\w+-\\d+$",
+          "regionRegex": "^(us|eu|ap|sa|ca|me|af)\\-\\w+\\-\\d+$",
           "regions": {
             "af-south-1": {},
             "af-east-1": {},
@@ -282,4 +282,12 @@ class EndpointsRuleEngineTests: XCBaseTestCase {
             let _ = try! engine.resolve(context: context)
         }
     }
+
+    func testRequestContext() {
+      let context = try! EndpointsRequestContext()
+      try! context.add(name: "Region", value: "us-west-2")
+      try! context.add(name: "Boolean", value: true)
+      try! context.add(name: "StringArray", value: ["a", "b"])
+      try! context.add(name: "StringArray", value: [])
+    }
 }