Skip to content

[URLSession] Refactor common protocol code into a new class #1355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

[URLSession] Refactor common protocol code into a new class #1355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
086acd2
Build File changes
saiHemak Dec 6, 2017
2086601
Moving TransferState out of http folder
saiHemak Dec 6, 2017
45f4332
Carving out common header parsing implementation from HTTPMessage.swift
saiHemak Dec 6, 2017
86c1f65
Refactor common protocol code into NativeProtocol.swift
saiHemak Dec 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions Foundation.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,8 @@
5BF9B8011FABD5DA00EE1A7C /* CFBundle_ResourceFork.c in Sources */ = {isa = PBXBuildFile; fileRef = 5BF9B7F61FABD5D400EE1A7C /* CFBundle_ResourceFork.c */; };
5BF9B8021FABD5DA00EE1A7C /* CFBundle_Tables.c in Sources */ = {isa = PBXBuildFile; fileRef = 5BF9B7F71FABD5D400EE1A7C /* CFBundle_Tables.c */; };
5FE52C951D147D1C00F7D270 /* TestNSTextCheckingResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5FE52C941D147D1C00F7D270 /* TestNSTextCheckingResult.swift */; };
61AB1C4C1FD151B8000947CC /* NativeProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61AB1C4B1FD151B8000947CC /* NativeProtocol.swift */; };
61B669201FD53F0200EAA8EC /* HTTPMessage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61B6691F1FD53F0200EAA8EC /* HTTPMessage.swift */; };
61E0117D1C1B5590000037DD /* RunLoop.swift in Sources */ = {isa = PBXBuildFile; fileRef = EADE0B761BD15DFF00C49C64 /* RunLoop.swift */; };
61E0117E1C1B55B9000037DD /* Timer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5BDC3F481BCC5DCB00ED97BB /* Timer.swift */; };
61E0117F1C1B5990000037DD /* CFRunLoop.c in Sources */ = {isa = PBXBuildFile; fileRef = 5B5D88D81BBC9AD800234F36 /* CFRunLoop.c */; };
Expand Down Expand Up @@ -337,7 +339,7 @@
B9974B971EDF4A22007F15B8 /* MultiHandle.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9974B901EDF4A22007F15B8 /* MultiHandle.swift */; };
B9974B981EDF4A22007F15B8 /* libcurlHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9974B911EDF4A22007F15B8 /* libcurlHelpers.swift */; };
B9974B991EDF4A22007F15B8 /* HTTPURLProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9974B921EDF4A22007F15B8 /* HTTPURLProtocol.swift */; };
B9974B9A1EDF4A22007F15B8 /* HTTPMessage.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9974B931EDF4A22007F15B8 /* HTTPMessage.swift */; };
B9974B9A1EDF4A22007F15B8 /* Message.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9974B931EDF4A22007F15B8 /* Message.swift */; };
B9974B9B1EDF4A22007F15B8 /* BodySource.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9974B941EDF4A22007F15B8 /* BodySource.swift */; };
B9974B9C1EDF4A22007F15B8 /* EasyHandle.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9974B951EDF4A22007F15B8 /* EasyHandle.swift */; };
BD8042161E09857800487EB8 /* TestLengthFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = BD8042151E09857800487EB8 /* TestLengthFormatter.swift */; };
Expand Down Expand Up @@ -779,6 +781,8 @@
5EF673AB1C28B527006212A3 /* TestNotificationQueue.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestNotificationQueue.swift; sourceTree = "<group>"; };
5FE52C941D147D1C00F7D270 /* TestNSTextCheckingResult.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestNSTextCheckingResult.swift; sourceTree = "<group>"; };
61A395F91C2484490029B337 /* TestNSLocale.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestNSLocale.swift; sourceTree = "<group>"; };
61AB1C4B1FD151B8000947CC /* NativeProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NativeProtocol.swift; sourceTree = "<group>"; };
61B6691F1FD53F0200EAA8EC /* HTTPMessage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HTTPMessage.swift; sourceTree = "<group>"; };
61D6C9EE1C1DFE9500DEF583 /* TestTimer.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestTimer.swift; sourceTree = "<group>"; };
61E0117B1C1B554D000037DD /* TestRunLoop.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestRunLoop.swift; sourceTree = "<group>"; };
61F8AE7C1C180FC600FB62F0 /* TestNotificationCenter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestNotificationCenter.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -810,11 +814,11 @@
B933A79C1F3055F600FE6846 /* NSString-UTF32-BE-data.txt */ = {isa = PBXFileReference; lastKnownFileType = text; path = "NSString-UTF32-BE-data.txt"; sourceTree = "<group>"; };
B933A79D1F3055F600FE6846 /* NSString-UTF32-LE-data.txt */ = {isa = PBXFileReference; lastKnownFileType = text; path = "NSString-UTF32-LE-data.txt"; sourceTree = "<group>"; };
B951B5EB1F4E2A2000D8B332 /* TestNSLock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestNSLock.swift; sourceTree = "<group>"; };
B9974B8F1EDF4A22007F15B8 /* TransferState.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = TransferState.swift; path = http/TransferState.swift; sourceTree = "<group>"; };
B9974B8F1EDF4A22007F15B8 /* TransferState.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TransferState.swift; sourceTree = "<group>"; };
B9974B901EDF4A22007F15B8 /* MultiHandle.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MultiHandle.swift; sourceTree = "<group>"; };
B9974B911EDF4A22007F15B8 /* libcurlHelpers.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = libcurlHelpers.swift; sourceTree = "<group>"; };
B9974B921EDF4A22007F15B8 /* HTTPURLProtocol.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = HTTPURLProtocol.swift; path = http/HTTPURLProtocol.swift; sourceTree = "<group>"; };
B9974B931EDF4A22007F15B8 /* HTTPMessage.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = HTTPMessage.swift; path = http/HTTPMessage.swift; sourceTree = "<group>"; };
B9974B931EDF4A22007F15B8 /* Message.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Message.swift; sourceTree = "<group>"; };
B9974B941EDF4A22007F15B8 /* BodySource.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BodySource.swift; sourceTree = "<group>"; };
B9974B951EDF4A22007F15B8 /* EasyHandle.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EasyHandle.swift; sourceTree = "<group>"; };
BD8042151E09857800487EB8 /* TestLengthFormatter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestLengthFormatter.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1010,12 +1014,15 @@
614732781FC2DEB7005B5E61 /* libcurl */,
E4F889331E9CF04D008A70EB /* http */,
5B1FD9C81D6D16580080E83C /* Configuration.swift */,
B9974B931EDF4A22007F15B8 /* Message.swift */,
B9974B8F1EDF4A22007F15B8 /* TransferState.swift */,
B9974B941EDF4A22007F15B8 /* BodySource.swift */,
5B1FD9CE1D6D16580080E83C /* URLSession.swift */,
5B1FD9CF1D6D16580080E83C /* URLSessionConfiguration.swift */,
5B1FD9D01D6D16580080E83C /* URLSessionDelegate.swift */,
5B1FD9D11D6D16580080E83C /* URLSessionTask.swift */,
5B1FD9D21D6D16580080E83C /* TaskRegistry.swift */,
61AB1C4B1FD151B8000947CC /* NativeProtocol.swift */,
);
name = Session;
path = URLSession;
Expand Down Expand Up @@ -1398,8 +1405,7 @@
isa = PBXGroup;
children = (
B9974B921EDF4A22007F15B8 /* HTTPURLProtocol.swift */,
B9974B8F1EDF4A22007F15B8 /* TransferState.swift */,
B9974B931EDF4A22007F15B8 /* HTTPMessage.swift */,
61B6691F1FD53F0200EAA8EC /* HTTPMessage.swift */,
);
name = http;
sourceTree = "<group>";
Expand Down Expand Up @@ -2200,7 +2206,10 @@
5BF7AEBB1BCD51F9008F214A /* NSSwiftRuntime.swift in Sources */,
5B5C5EF01CE61FA4001346BD /* Date.swift in Sources */,
EADE0B9B1BD15DFF00C49C64 /* FileHandle.swift in Sources */,
B9974B9A1EDF4A22007F15B8 /* Message.swift in Sources */,
B9974B9C1EDF4A22007F15B8 /* EasyHandle.swift in Sources */,
B9974B961EDF4A22007F15B8 /* TransferState.swift in Sources */,
61AB1C4C1FD151B8000947CC /* NativeProtocol.swift in Sources */,
EADE0BB11BD15E0000C49C64 /* NSPredicate.swift in Sources */,
5BF7AEC01BCD51F9008F214A /* NSUUID.swift in Sources */,
EADE0BCB1BD15E0000C49C64 /* XMLNode.swift in Sources */,
Expand Down Expand Up @@ -2245,7 +2254,6 @@
EADE0BB31BD15E0000C49C64 /* NSRegularExpression.swift in Sources */,
EADE0BA41BD15E0000C49C64 /* LengthFormatter.swift in Sources */,
5BDC3FCA1BCF176100ED97BB /* NSCFArray.swift in Sources */,
B9974B961EDF4A22007F15B8 /* TransferState.swift in Sources */,
EADE0BB21BD15E0000C49C64 /* Progress.swift in Sources */,
EADE0B961BD15DFF00C49C64 /* DateIntervalFormatter.swift in Sources */,
5B5BFEAC1E6CC0C200AC8D9E /* NSCFBoolean.swift in Sources */,
Expand Down Expand Up @@ -2295,13 +2303,13 @@
EADE0BBC1BD15E0000C49C64 /* URLCache.swift in Sources */,
5B4092121D1B30B40022B067 /* ExtraStringAPIs.swift in Sources */,
5BC46D541D05D6D900005853 /* DateInterval.swift in Sources */,
61B669201FD53F0200EAA8EC /* HTTPMessage.swift in Sources */,
EADE0BC51BD15E0000C49C64 /* UserDefaults.swift in Sources */,
5BF7AEB11BCD51F9008F214A /* NSLock.swift in Sources */,
5BF7AEB91BCD51F9008F214A /* NSSet.swift in Sources */,
EADE0B9E1BD15DFF00C49C64 /* HTTPCookie.swift in Sources */,
5BCCA8D91CE6697F0059B963 /* URLComponents.swift in Sources */,
5BDC3FCC1BCF177E00ED97BB /* NSCFString.swift in Sources */,
B9974B9A1EDF4A22007F15B8 /* HTTPMessage.swift in Sources */,
EADE0BAC1BD15E0000C49C64 /* NSOrderedSet.swift in Sources */,
EADE0BC31BD15E0000C49C64 /* URLResponse.swift in Sources */,
EADE0B971BD15DFF00C49C64 /* Decimal.swift in Sources */,
Expand Down
111 changes: 111 additions & 0 deletions Foundation/URLSession/Message.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
// Foundation/URLSession/Message.swift - Message parsing for native protocols
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
// -----------------------------------------------------------------------------
///
/// These are libcurl helpers for the URLSession API code.
/// - SeeAlso: https://curl.haxx.se/libcurl/c/
/// - SeeAlso: URLSession.swift
///
// -----------------------------------------------------------------------------

extension _NativeProtocol {
/// A native protocol header like FTP or HTTP being parsed.
///
/// It can either be complete (i.e. the final CR LF CR LF has been
/// received), or partial.
internal enum _ParsedResponseHeader {
case partial(_ResponseHeaderLines)
case complete(_ResponseHeaderLines)
init() {
self = .partial(_ResponseHeaderLines())
}
}
/// A type safe wrapper around multiple lines of headers.
///
/// This can be converted into an `HTTPURLResponse`.
internal struct _ResponseHeaderLines {
let lines: [String]
init() {
self.lines = []
}
init(headerLines: [String]) {
self.lines = headerLines
}
}
}

extension _NativeProtocol._ParsedResponseHeader {
/// Parse a header line passed by libcurl.
///
/// These contain the <CRLF> ending and the final line contains nothing but
/// that ending.
/// - Returns: Returning nil indicates failure. Otherwise returns a new
/// `ParsedResponseHeader` with the given line added.
func byAppending(headerLine data: Data, isHeaderComplete: (String) -> Bool) -> _NativeProtocol._ParsedResponseHeader? {
// The buffer must end in CRLF
guard 2 <= data.count &&
data[data.endIndex - 2] == _Delimiters.CR &&
data[data.endIndex - 1] == _Delimiters.LF
else { return nil }
let lineBuffer = data.subdata(in: Range(data.startIndex..<data.endIndex-2))
guard let line = String(data: lineBuffer, encoding: String.Encoding.utf8) else { return nil}
return byAppending(headerLine: line, isHeaderComplete: isHeaderComplete)
}
/// Append a status line.
///
/// If the line is empty, it marks the end of the header, and the result
/// is a complete header. Otherwise it's a partial header.
/// - Note: Appending a line to a complete header results in a partial
/// header with just that line.
private func byAppending(headerLine line: String, isHeaderComplete: (String) -> Bool) -> _NativeProtocol._ParsedResponseHeader {
if isHeaderComplete(line) {
switch self {
case .partial(let header): return .complete(header)
case .complete: return .partial(_NativeProtocol._ResponseHeaderLines())
}
} else {
let header = partialResponseHeader
return .partial(header.byAppending(headerLine: line))
}
}

private var partialResponseHeader: _NativeProtocol._ResponseHeaderLines {
switch self {
case .partial(let header): return header
case .complete: return _NativeProtocol._ResponseHeaderLines()
}
}
}

private extension _NativeProtocol._ResponseHeaderLines {
/// Returns a copy of the lines with the new line appended to it.
func byAppending(headerLine line: String) -> _NativeProtocol._ResponseHeaderLines {
var l = self.lines
l.append(line)
return _NativeProtocol._ResponseHeaderLines(headerLines: l)
}
}

// Characters that we need for Header parsing:

struct _Delimiters {
/// *Carriage Return* symbol
static let CR: UInt8 = 0x0d
/// *Line Feed* symbol
static let LF: UInt8 = 0x0a
/// *Space* symbol
static let Space = UnicodeScalar(0x20)
static let HorizontalTab = UnicodeScalar(0x09)
static let Colon = UnicodeScalar(0x3a)
/// *Separators* according to RFC 2616
static let Separators = NSCharacterSet(charactersIn: "()<>@,;:\\\"/[]?={} \t")
}

Loading