feat(api): Update url cache for storage and api to nil (#2647)

Updates the cache control of Storage and API category to disable caching by default. This can be overridden for API Rest request by setting the Cache-Control request header.

Author: royjit

Amplify/Categories/API/Request/RESTRequest.swift

@@ -32,9 +32,13 @@ public class RESTRequest {
                 headers: [String: String]? = nil,
                 queryParameters: [String: String]? = nil,
                 body: Data? = nil) {
+        let inputHeaders = headers ?? [:]
+        self.headers = inputHeaders.merging(
+            ["Cache-Control": "no-store"],
+            uniquingKeysWith: { current, _ in current}
+        )
         self.apiName = apiName
         self.path = path
-        self.headers = headers
         self.queryParameters = queryParameters
         self.body = body
     }

AmplifyPlugins/API/Sources/AWSAPIPlugin/Support/Utils/GraphQLOperationRequestUtils.swift

@@ -22,7 +22,7 @@ class GraphQLOperationRequestUtils {
     // Construct a graphQL specific HTTP POST request with the request payload
     static func constructRequest(with baseUrl: URL, requestPayload: Data) -> URLRequest {
         var baseRequest = URLRequest(url: baseUrl)
-        let headers = ["content-type": "application/json"]
+        let headers = ["content-type": "application/json", "Cache-Control": "no-store"]
         baseRequest.allHTTPHeaderFields = headers
         baseRequest.httpMethod = "POST"
         baseRequest.httpBody = requestPayload

AmplifyPlugins/API/Tests/AWSAPIPluginTests/Request/GraphQLOperationRequestUtilsTests.swift

@@ -0,0 +1,21 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+import XCTest
+import Amplify
+@testable import AWSAPIPlugin
+
+class GraphQLOperationRequestUtilsTests: XCTestCase {
+
+    let baseURL = URL(string: "https://someurl")!
+    let testDocument = "testDocument"
+
+    func testGraphQLOperationRequestWithCache() throws {
+        let request = GraphQLOperationRequestUtils.constructRequest(with: baseURL,
+                                                                    requestPayload: Data())
+        XCTAssertEqual(request.allHTTPHeaderFields?["Cache-Control"], "no-store")
+    }
+}

AmplifyPlugins/Storage/Sources/AWSS3StoragePlugin/Service/Storage/AWSS3StorageService.swift

@@ -66,6 +66,7 @@ class AWSS3StorageService: AWSS3StorageServiceBehaviour, StorageServiceProxy {
             #else
             let sessionConfiguration = URLSessionConfiguration.background(withIdentifier: storageConfiguration.sessionIdentifier)
             #endif
+            sessionConfiguration.urlCache = nil
             sessionConfiguration.allowsCellularAccess = storageConfiguration.allowsCellularAccess
             sessionConfiguration.timeoutIntervalForResource = TimeInterval(storageConfiguration.timeoutIntervalForResource)
             _sessionConfiguration = sessionConfiguration

AmplifyTests/CategoryTests/API/APICategoryClientRESTTests.swift

@@ -44,6 +44,22 @@ class APICategoryClientRESTTests: XCTestCase {
         await waitForExpectations(timeout: 0.5)
     }
 
+    func testCacheInRequest() {
+        let request = RESTRequest(apiName: "someapi")
+        XCTAssertEqual(request.headers?["Cache-Control"], "no-store")
+    }
+
+    func testCustomCacheInRequest() {
+        let request = RESTRequest(apiName: "someapi", headers: ["Cache-Control": "private"])
+        XCTAssertEqual(request.headers?["Cache-Control"], "private")
+    }
+
+    func testCacheWithExistingValuesInRequest() {
+        let request = RESTRequest(apiName: "someapi", headers: ["somekey": "somevalue"])
+        XCTAssertEqual(request.headers?["Cache-Control"], "no-store")
+        XCTAssertEqual(request.headers?["somekey"], "somevalue")
+    }
+
     // MARK: - Utilities
 
     func makeAndAddMockPlugin() throws -> MockAPICategoryPlugin {