Alamofire - Swift 3.0

The initial migration to Swift 3.0 has been completed, and can be found in the swift3 branch. Many thanks to the Apple Engineers in the labs at WWDC who assisted with some of the migration issues. :beers:

Please file Github issues for any problems discovered while using this branch.

This branch should be considered a work in progress, and will be updated as future Xcode 8 and Swift 3 seeds are released by Apple.

Official support for Swift 3.0 and Xcode 8 will be not available until the fall when Apple releases both.

Migration Notes

• Many Foundation types are now value types, instead of reference types. Please audit your code to ensure all references to NSMutableURLRequest are now properly handled as var and are of type URLRequest.

• Due to the Swift 3.0 naming conventions, many Alamofire API parameters that referenced an object in the URL Foundation loading system and began with capital letters now begin with lowercase letters. For example, URLRequest parameter names are now urlRequest to prevent confusion.

  More notes will be added as issues are discovered.

Radars

The following radars were filed as a result of this migration and are currently being tracked by the ASF team.

• 26850776: CharacterSet crashes when attempting to remove an item from the set in Swift 3.0
• 26849668: NSURLProtocol APIs still contain NSMutableURLRequest parameter types and do not support the Swift 3.0 value types
• 26870455: NSURLSession with background configuration does not function on the iOS simulator inside of test targets

TODO

• [x] Update Project Recommended Settings
• [x] Update Example
• [x] Travis CI Support
• [ ] Update Documentation/README

dyld: Library not loaded: @rpath/Alamofire.framework/Alamofire
  Referenced from: /private/var/mobile/Containers/Bundle/Application/XXX/Anachronos.app/Anachronos
  Reason: image not found

Xcode6 GM

I've read all the issues about this kind of problem, but couldn't solve the problem.

Also, there is the same issue in iOS Example project:

dyld: Library not loaded: @rpath/Alamofire.framework/Alamofire
  Referenced from: /private/var/mobile/Containers/Bundle/Application/CEA6C4C1-C211-460C-8ECF-4FD9C66F1016/iOS Example.app/iOS Example
  Reason: image not found

I'm getting this error when trying to run my app with Alamofire 5.0.0-rc3:

dyld: Library not loaded: @rpath/Alamofire.framework/Alamofire Referenced from: /private/var/containers/Bundle/Application/CC8FF01F-CB03-4D92-ADDE-8B458EDF3D74/SupremeYou.app/SupremeYou Reason: no suitable image found. Did find: /private/var/containers/Bundle/Application/CC8FF01F-CB03-4D92-ADDE-8B458EDF3D74/SupremeYou.app/Frameworks/Alamofire.framework/Alamofire: code signature invalid for '/private/var/containers/Bundle/Application/CC8FF01F-CB03-4D92-ADDE-8B458EDF3D74/SupremeYou.app/Frameworks/Alamofire.framework/Alamofire'

/private/var/containers/Bundle/Application/CC8FF01F-CB03-4D92-ADDE-8B458EDF3D74/SupremeYou.app/Frameworks/Alamofire.framework/Alamofire: stat() failed with errno=25
/private/var/containers/Bundle/Application/CC8FF01F-CB03-4D92-ADDE-8B458EDF3D74/SupremeYou.app/Frameworks/Alamofire.framework/Alamofire: code signature invalid for '/private/var/containers/Bundle/Application/CC8FF01F-CB03-4D92-ADDE-8B458EDF3D74/SupremeYou.app/Frameworks/Alamofire.framework/Alamofire'

I've been tested my app on an iPhone 11 Pro 13.3 and it was working fine until I decided to update the phone. So I update the iPhone 11 to the 13.3.1 version, and the error started to appear.

it works fine on an iPhone 8 Plus with iOS version 13.3.

Also it doesn't work on an iPhone 6s with iOS 13.3.1.

Hello,

Due to http://9to5mac.com/2016/05/04/apple-will-require-ios-app-store-apps-to-support-ipv6-only-networks-from-june-1/

I am opening this for raising a small issue, but also to ask a question.

Is alamofire fully supporting IPv6? referencing the doc from Apple https://developer.apple.com/library/mac/documentation/NetworkingInternetWeb/Conceptual/NetworkingOverview/UnderstandingandPreparingfortheIPv6Transition/UnderstandingandPreparingfortheIPv6Transition.html#//apple_ref/doc/uid/TP40010220-CH213-SW1

I haven't found any hardcoded IP address or reference to low level api apart those:

NetworkReachabilityManager.swift
is using IPv4 only: AF_INET and sockaddr_in

Apple suggest to support also IPv6 counterparts: https://developer.apple.com/library/mac/documentation/NetworkingInternetWeb/Conceptual/NetworkingOverview/UnderstandingandPreparingfortheIPv6Transition/UnderstandingandPreparingfortheIPv6Transition.html#//apple_ref/doc/uid/TP40010220-CH213-SW12

If your code handles IPv4 types, make sure the IPv6 equivalents are handled too.

IPv4 IPv6 AF_INET AF_INET6 PF_INET PF_INET6 struct in_addr struct in_addr6 struct sockaddr_in struct sockaddr_in6 kDNSServiceProtocol_IPv4 kDNSServiceProtocol_IPv6

Thanks

Facing below error: SourcePackages/checkouts/Alamofire/Source/Combine.swift:25:5: Failed to build module 'Combine'; this SDK is not supported by the compiler (the SDK is built with 'Apple Swift version 5.5 (swiftlang-1300.0.24.14 clang-1300.0.25.10)', while this compiler is 'Apple Swift version 5.5 (swiftlang-1300.0.24.13 clang-1300.0.25.10)'). Please select a toolchain which matches the SDK.

What did you expect to happen?

it should build project successfully.

What happened instead?

Its throwing error. Same problem was in Kingfisher GitHub repository, They created new branch with fix, changed deployment target from v10 to 12

Alamofire Environment

Alamofire Version: 5.2.1 Dependency Manager: Swift Package Manager Xcode Version: Version 13.0 beta 3 (13A5192i) Swift Version: Swift 5 Platform(s) Running Alamofire: iOS macOS Version Running Xcode: 12.0 Beta (21A5284e)

This pull request adds support for uploading MultipartFormData to Alamofire. I would love feedback from the community to make sure everything here is in tip-top shape before rolling it in. Any feedback would be much appreciated.

MultipartFormData

The general idea is that you append body parts to the larger MultipartFormData object, then encode it when you want the cumulative result. Encoding can be performed in two different ways:

1. Encoding In-Memory
2. Encoding Data by Streaming to Disk

Encoding In-Memory

Encoding in-memory should only be used with small datasets. If the contentLength of the MultipartFormData is too large, you run the risk of your app being terminated due to memory usage.

Encoding Data by Streaming to Disk

Sometimes you need to upload a very large dataset to a server such as a bundle of large images or videos. In these cases, your dataset is too large to perform the encoding in-memory. For these cases, the MultipartFormData class supports encoding the data using a combination of input and output streams keeping the memory footprint very small.

Uploading from Manager

The upload methods for uploading MultipartFormData support the idea of a memory threshold. To make it as easy as possible, the memory threshold is used to determine whether the MultipartFormData can be encoded in-memory or whether it needs to be written to disk first. The default value for the memory threshold is currently set to 10MB.

In order to make the encoding process asynchronous, the upload methods could not return a Request object directly. To handle this case, the MultipartFormDataEncodingResult enumeration was added and exposed in an encodingCompletion closure. The resulting Request object is contained as an associated value in the .Success case which can then be used to chain additional methods against. While this is a bit different than the other public APIs, it still is quite simple to use.

Alamofire.upload(
    .POST,
    URLString: "http://httpbin.org/post",
    multipartFormData: { multipartFormData in
        multipartFormData.appendBodyPart(fileURL: unicornImageURL, name: "unicorn")
        multipartFormData.appendBodyPart(fileURL: rainbowImageURL, name: "rainbow")
    },
    encodingCompletion: { encodingResult in
        switch encodingResult {
        case .Success(let upload, _, _):
            upload.responseJSON { request, response, JSON, error in
                println(JSON)
            }
        case .Failure(let encodingError):
            println(encodingError)
        }
    }
)

Summary

This was a fairly complicated feature to put together, so I'd really love to gather everyone's feedback. If you have a solid grasp of RFC 2388 and 2045, then please take the time to review these changes before we merge it in.

I'm seeing a fairly common EXC_BREAKPOINT crash in Crashlytics caused by a delegate handler in Alamofire. See below for the stack trace. The app in question is iOS 10 only, and the crash seems to happen on all devices and 10.x versions.

Crashed: NSOperationQueue 0x170034f60 :: NSOperation 0x1708519a0 (QOS: DEFAULT)
0  libswiftFoundation.dylib       0x100dc2e4c static Data._unconditionallyBridgeFromObjectiveC(NSData?) -> Data (__hidden#3516_:1698)
1  Alamofire                      0x10061388c @objc SessionDelegate.urlSession(URLSession, dataTask : URLSessionDataTask, didReceive : Data) -> () + 184
2  CFNetwork                      0x185672b1c __67-[NSURLSession delegate_dataTask:didReceiveData:completionHandler:]_block_invoke.242 + 36
3  Foundation                     0x185993fb0 __NSBLOCKOPERATION_IS_CALLING_OUT_TO_A_BLOCK__ + 16
4  Foundation                     0x1858d8aa8 -[NSBlockOperation main] + 96
5  Foundation                     0x1858c90a4 -[__NSOperationInternal _start:] + 620
6  Foundation                     0x18599635c __NSOQSchedule_f + 228
7  libdispatch.dylib              0x183d2e1bc _dispatch_client_callout + 16
8  libdispatch.dylib              0x183d3c3dc _dispatch_queue_serial_drain + 928
9  libdispatch.dylib              0x183d319a4 _dispatch_queue_invoke + 652
10 libdispatch.dylib              0x183d3e34c _dispatch_root_queue_drain + 572
11 libdispatch.dylib              0x183d3e0ac _dispatch_worker_thread3 + 124
12 libsystem_pthread.dylib        0x183f372a0 _pthread_wqthread + 1288
13 libsystem_pthread.dylib        0x183f36d8c start_wqthread + 4

Due to the crash being EXC_BREAKPOINT I'm assuming it's a failing assertion somewhere and may actually be happening in the Swift/Obj-C compatibility layer before the actual delegate code is even called. But I'm not sure how to debug this and was hoping someone on here has an idea why this would happen.

I use Alamofire for standard HTTPS requests to a JSON backend. I have one standard session manager and one background session manager. I'm setting the backgroundCompletionHandler in the app delegate as well.

Hi,

I'm using Alamofire for a https connection. I use a nodejs https server. When using curl and providing the CA using --cacert <ca-file> it works just fine. However when testing in Alamofire I get this error:

Error Domain=NSURLErrorDomain Code=-1200 "An SSL error has occurred and a secure connection to the server cannot be made." UserInfo={NSURLErrorFailingURLPeerTrustErrorKey=<SecTrustRef: 0x60c000047980>, NSLocalizedRecoverySuggestion=Would you like to connect to the server anyway?, _kCFStreamErrorDomainKey=3, _kCFStreamErrorCodeKey=-9802, NSErrorPeerCertificateChainKey=<CFArray 0x60600015e840 [0x10c05b7b0]>{type = immutable, count = 1, values = (
    0 : <cert(0x61600007e680) s: localhost i: localhost>
)}, NSUnderlyingError=0x6040000abe90 {Error Domain=kCFErrorDomainCFNetwork Code=-1200 "(null)" UserInfo={_kCFStreamPropertySSLClientCertificateState=0, kCFStreamPropertySSLPeerTrust=<SecTrustRef: 0x60c000047980>, _kCFNetworkCFStreamSSLErrorOriginalValue=-9802, _kCFStreamErrorDomainKey=3, _kCFStreamErrorCodeKey=-9802, kCFStreamPropertySSLPeerCertificates=<CFArray 0x60600015e840 [0x10c05b7b0]>{type = immutable, count = 1, values = (
    0 : <cert(0x61600007e680) s: localhost i: localhost>
)}}}, NSLocalizedDescription=An SSL error has occurred and a secure connection to the server cannot be made.

My source looks like this:

class Networking {
  static let manager: Manager = {
    let serverTrustPolicies: [String: ServerTrustPolicy] = [
      "localhost": .DisableEvaluation
    ]

    let configuration = NSURLSessionConfiguration.defaultSessionConfiguration()
    configuration.HTTPAdditionalHeaders = Alamofire.Manager.defaultHTTPHeaders

    return Alamofire.Manager(configuration: configuration,
      serverTrustPolicyManager: ServerTrustPolicyManager(policies: serverTrustPolicies))
  }()

  func test() {
    Networking.manager.request(.GET, "https://localhost:3000/", parameters: nil)
      .responseJSON { (response: Response<AnyObject, NSError>) in
        // nothing interesting
    }
  }

I'm using Alamofire from the xcode7.1 branch.

I need to make a POST request with an HTTP Body with a JSON object, but I also need to use url query parameters in the same request.

POST: http://www.mysite.com/api/create?param1=value&param2=value
HTTP Body: { foo : [ bar, foo], bar: foo}

Is this supported? How would I go about doing this?

Thanks

Since Xcode 12 is available in beta I've had to give it a try. There is some issue when trying to archive Alamofire.

Undefined symbols for architecture armv7: "type metadata for Swift._StringObject.Variant", referenced from: outlined init with take of Swift._StringObject.Variant in HTTPHeaders.o ld: symbol(s) not found for architecture armv7

When it comes to this issue I am aware that it may be fault of new Xcode, I just would like to start the discussion on this topic.

What did you do?

I've tried to archive Alamofire using new Xcode12-beta

What did you expect to happen?

Successful archive.

What happened instead?

Archive failed with error Undefined symbols for architecture armv7: "type metadata for Swift._StringObject.Variant", referenced from: outlined init with take of Swift._StringObject.Variant in HTTPHeaders.o ld: symbol(s) not found for architecture armv7

Alamofire Environment

Alamofire version: 5.2.1 Xcode version: 12-beta Swift version: 5.3 (swiftlang-1200.0.16.9 clang-1200.0.22.5) Platform(s) running Alamofire: iOS macOS version running Xcode: 10.15.4

Try to request to server

Duplicate response from server

Issue not happen if I try to use Alamofire 5.0.5-rc2. We also tried to check result from server by using ProxyServer. We found the result from server is correct. But data received by Alamofire was duplicated.

Alamofire Environment

**Alamofire version:After 5.0.0-rc2 **Xcode version:Any **Swift version:4.2 **Platform(s) running Alamofire:iOS

Demo Project

I tried to reproduce this issue with demo project. But I can not.

Only one of our users has a crash

Alamofire Version: 5.6.2 Dependency Manager: Carthage Xcode Version: 14.1 Swift Version: 5.7.2 Platform(s) Running Alamofire: iOS macOS Version Running Xcode: 13

Looking forward to your reply,thank you!

• [x] I've read, understood, and done my best to follow the *CONTRIBUTING guidelines.

What did you do?

We updated Alamofire to version 5 and replaced the deprecated methods like responseArray and responseObject with the responseDecodable as follows:

Alamofire version 4 - working (don't mind the error from v5):

Alamofire version 5 - not working:

We assured that our model was conforming to Codable, this is the one we are passing to the function:

What did you expect to happen?

We expected to receive a success response with a valid JSON mapped to our model.

What happened instead?

Sometimes it works, we get the response, but most of the times we get the following error:

updatesresponseSerializationFailed(reason: Alamofire.AFError.ResponseSerializationFailureReason.decodingFailed(error: Swift.DecodingError.dataCorrupted(Swift.DecodingError.Context(codingPath: [], debugDescription: "The given data was not valid JSON.", underlyingError: Optional(Error Domain=NSCocoaErrorDomain Code=3840 "Garbage at end around line 1, column 34645." UserInfo={NSDebugDescription=Garbage at end around line 1, column 34645., NSJSONSerializationErrorIndex=34645})))))

We already analysed the JSON from the server and it is valid and the same data was working before with Alamofire 4.

Alamofire Environment

Alamofire Version: 5.6.3 Xcode Version: 14.1 Swift Version: 5.0 Platform(s) Running Alamofire: iOS 15.6.1/16.0.2 macOS Version Running Xcode: 13.0.1

I am currently using Alamofire 5.6.2 and trying to upload one image with POST request.

The image is 10MB size, if I upload an image around 5MB everything works fine.

Creating the POST request from Postman everything works fine, so it's not an issue related with the server.

This is how I'm creating the request:

AF.upload(multipartFormData: { multipartFormData in
multipartFormData.append(InputStream(data: imageMedia.data), // 10MB data
                         withLength: UInt64(imageMedia.data.count),
                         name: imageMedia.type.rawValue,
                         fileName: imageMedia.filename,
                         mimeType: imageMedia.mimeType)
}, with: request).responseData { afDataResponse in
    switch afDataResponse.result {
    case .success(let data):
        completion(data)
    case .failure(let error):
        print("error with alamofire response: \(error.localizedDescription)")
        completion(nil)
    }
} 

And this is the error I am receiving in the failure case: error with alamofire response: URLSessionTask failed with error: The operation couldn’t be completed. Message too long

If I print the error (not localizedDescription):

sessionTaskFailed(error: Error Domain=NSPOSIXErrorDomain Code=40 "Message too long" UserInfo={_NSURLErrorFailingURLSessionTaskErrorKey=LocalUploadTask <8F7404DD-2947-4B18-9F23-C23F0483F440>.<1>, _kCFStreamErrorDomainKey=1, NSErrorPeerAddressKey=<CFData 0x600001068280 [0x1b9553c60]>{length = 16, capacity = 16, bytes = 0x100201bbd8ef26350000000000000000}, _kCFStreamErrorCodeKey=40, _NSURLErrorRelatedURLSessionTaskErrorKey=(
    "LocalUploadTask <8F7404DD-2947-4B18-9F23-C23F0483F440>.<1>"
)})

Any idea what's happening here?

ℹ Please fill out this template when filing an issue. All lines beginning with an ℹ symbol instruct you with what info we expect. You can delete those lines once you've filled in the info.

Per our *CONTRIBUTING guidelines, we use GitHub for bugs and feature requests, not general support. Other issues should be opened on Stack Overflow with the tag alamofire.

Please remove this line and everything above it before submitting.

• [x] I've read, understood, and done my best to follow the *CONTRIBUTING guidelines.

What did you do?

I've created and publish an application on iOS, this application use Alamofire v5.4.3 to communicate with the restful api. We also shipped the application with Firebase Crashlytics, and I received some crash logs which related to Alamofire. I've attached the crash log below. Please check it for me.

iPhone 12 Pro/ iOS 16.0.0

What did you expect to happen?

No crash

What happened instead?

Crash

Alamofire Environment

Alamofire Version: 5.4.3 Dependency Manager: Swift Package Manager Xcode Version: XCode 14.1 Swift Version: Swift 5.7 Platform(s) Running Alamofire: iOS 16.0.0 macOS Version Running Xcode: 12.6.1

Demo Project

Crashed: com.apple.main-thread

0 libobjc.A.dylib 0x21f94 objc_class::isInitialized() + 36 1 libobjc.A.dylib 0x794c lookUpImpOrForward + 60 2 libobjc.A.dylib 0x20c4 _objc_msgSend_uncached + 68 3 CoreFoundation 0x7a6f8 __CFBasicHashDrain + 320 4 CoreFoundation 0x7ed20 _CFRelease + 316 5 CFNetwork 0x5da80 CFHTTPCookieStorageCreateFromFile + 4332 6 CoreFoundation 0x7ed20 _CFRelease + 316 7 CFNetwork 0x167c8 CFURLRequestSetURL + 6816 8 CoreFoundation 0x7ed20 _CFRelease + 316 9 CFNetwork 0x1070cc _CFURLConnectionCopyTimingData + 16068 10 libobjc.A.dylib 0x14a4 object_cxxDestructFromClass(objc_object*, objc_class*) + 116 11 libobjc.A.dylib 0x621c objc_destructInstance + 80 12 libobjc.A.dylib 0xf9d0 _objc_rootDealloc + 80 13 CFNetwork 0x832fc CFURLResponseCreateWithHTTPResponse + 69584 14 CFNetwork 0x84834 CFURLResponseCreateWithHTTPResponse + 75016 15 CFNetwork 0x83e34 CFURLResponseCreateWithHTTPResponse + 72456 16 CFNetwork 0x479dc CFURLCacheRemoveAllCachedResponses + 11992 17 libobjc.A.dylib 0x14a4 object_cxxDestructFromClass(objc_object*, objc_class*) + 116 18 libobjc.A.dylib 0x621c objc_destructInstance + 80 19 libobjc.A.dylib 0xf9d0 _objc_rootDealloc + 80 20 CoreFoundation 0x6b5b0 RELEASE_OBJECTS_IN_THE_ARRAY + 112 21 CoreFoundation 0x6b720 -[__NSArrayM dealloc] + 268 22 CFNetwork 0xe770 CFURLCacheSetMemoryCapacity + 3764 23 libobjc.A.dylib 0x14a4 object_cxxDestructFromClass(objc_object*, objc_class*) + 116 24 libobjc.A.dylib 0x621c objc_destructInstance + 80 25 libobjc.A.dylib 0xf9d0 _objc_rootDealloc + 80 26 libobjc.A.dylib 0x14a4 object_cxxDestructFromClass(objc_object*, objc_class*) + 116 27 libobjc.A.dylib 0x621c objc_destructInstance + 80 28 libobjc.A.dylib 0xf9d0 objc_rootDealloc + 80 29 MyApp 0x1398c8c CompositeEventMonitor.request(:didParseResponse:) + 4324576396 30 libswiftCore.dylib 0x3da1d4 _swift_release_dealloc + 56 31 MyApp 0x13a1e44 outlined init with copy of AFError? + 4324613700 32 libswiftCore.dylib 0x3da1d4 _swift_release_dealloc + 56 33 libsystem_blocks.dylib 0x2124 _call_dispose_helpers_excp + 48 34 libsystem_blocks.dylib 0x1d54 Block_release + 252 35 libdispatch.dylib 0x3fdc dispatch_client_callout + 20 36 libdispatch.dylib 0x127f4 dispatch_main_queue_drain + 928 37 libdispatch.dylib 0x12444 dispatch_main_queue_callback_4CF + 44 38 CoreFoundation 0x9aa08 CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE + 16 39 CoreFoundation 0x7c368 __CFRunLoopRun + 2036 40 CoreFoundation 0x811e4 CFRunLoopRunSpecific + 612 41 GraphicsServices 0x1368 GSEventRunModal + 164 42 UIKitCore 0x3a2d88 -[UIApplication _run] + 888 43 UIKitCore 0x3a29ec UIApplicationMain + 340 44 libswiftUIKit.dylib 0x352a0 UIApplicationMain(::::) + 104 45 MyApp 0x8abc main + 4304063164 (IdeasAnalystCallScreen.swift:4304063164) 46 ??? 0x1b1609948 (Missing)

ℹ I've read, understood, and done my best to follow the *CONTRIBUTING guidelines.

What did you do?

I logged into my application and started a session using AuthenticationInterceptor, and it failed.

What did you expect to happen?

That the app follows its default flow without failing.

What happened instead?

App crashed and closed

Alamofire Environment

Alamofire Version: 5.6.2 Dependency Manager: SPM Xcode Version: 14.1 Swift Version: 5 Platform(s) Running Alamofire: iPhone 11 iOS 15.6.1 macOS Version Running Xcode: Ventura 13.0

The problem in question was reported by Firebase below the logs generated.

Full error log

I wonder how I can correct this and where I should start my analysis

https://github.com/AFNetworking/AFNetworking/issues/4762 I would like to ask if the oc version of AFNetworking has plans to release a new version, that community seems to be inactive.