[feat] SNMNetwork 구현

[soletree]

🔖  Issue Number

close #13

📙 작업 내역

구현 내용 및 작업 했던 내역을 적어주세요.

설계했던 NW 구조에 따라 구현을 진행했습니다.

• SNMRequestConvertible, SNMResponse 인터페이스

public protocol SNMRequestConvertible {
    var endpoint: Endpoint { get }
    var requestType: SNMRequestType { get }
}

SNMRequestConvertible의 extension을 통해 urlRequest로 변환하는 메서드를 선언해 실제 NetworkProviderd에서 URLSession 작업이 가능하도록 했습니다.

public extension SNMRequestConvertible {
    func urlRequest() throws -> URLRequest {
        // 중략,,,
    }

• 사용 예시

enum MockRequest {
    case getUser(id: String)
    case postUser(user: User)
    case deleteUser(id: Int)
    case putUser(user: User)
}

extension MockRequest: SNMRequestConvertible {
    var endpoint: HGDNetwork.Endpoint {
        let baseURL = URL(string: "https://666329d362966e20ef0bb8de.mockapi.io")!
        var endpoint: Endpoint
        switch self {
        case .getUser(let id):
            endpoint = Endpoint(baseURL: baseURL, path: "user", method: .get)
            endpoint.query = ["id" : "\(id)"]
        case .postUser:
            endpoint = Endpoint(baseURL: baseURL, path: "user", method: .post)
        case .deleteUser(let id):
            endpoint = Endpoint(baseURL: baseURL, path: "user", method: .delete)
        case .putUser(let user):
            endpoint = Endpoint(baseURL: baseURL, path: "user", method: .put)
        }
        return endpoint
    }
    
    var requestType: �SNMRequestType {
        switch self {
        case .getUser(let id): .plain
        case .fetchUser: .plain
        case .postUser(let user): .jsonEncodableBody(with: user)
        case .deleteUser(let id): .header(with: ["Authorization": "Bearer HGDMBINPC"])
        case .putUser(let user): .header(with: ["Content-Type": "application/json"])
        }
    }
}

• NetworkProvider, SNMNetworkProvider 구현
  RequestConvertible를 파라미터로 받는 객체입니다.
  request를 처리하는 과정에서 Error가 발생하면 SNMError로 무조건 매핑해 던집니다.

protocol NetworkProvider {
    func request(with: any SNMRequestConvertible) async throws -> SNMNetworkResponse
}

📝 PR 특이사항

PR을 볼 때 팀원에게 알려야 할 특이사항을 알려주세요.

• SNMNetworkError 관련

편의를 위해 특정 HTTP statusCode와 관련된 에러 일부를 매핑해 내려주는 방식으로 구현을 진행했는데요.
에러가 많아서 다 컨트롤할 수 없거니와,,, 네트워크 모듈단에서 statusCode 에러까지 일일이 처리해주는 게 과한 것 같다는 생각이 들었습니다. 추후 개선할 예정입니다.

public enum SNMNetworkError: LocalizedError {
    // SNMNetwork Error
    case encodingError(with: any Encodable)
    case invalidRequest(request: any SNMRequestConvertible)
    case invalidURL(url: URL)
    case invalidStatusCode(statusCode: Int)
    /// HTTPResponse로 변환 실패
    case invalidResponse(response: URLResponse)
    // Status code 300번대
    // TODO: Redirect는 따로 처리 과정이 필요함
    case redirection
    // Status code 400번대
    case badRequest
    case unAuthorization
    case notFound
    case forbidden
    case methodNotAllowed
    case contentTooLarge
    case urlTooLong
    case unsupportMediaType
    // Status code 500번대
    case serverError
}

• public 키워드 관련
  추후 모듈화 진행을 위해 모듈화 대상 객체에 public 키워드를 붙였습니다.
• requestType (header+body 함께 보내는 타입), multipartformdata 도 주말에 추가해두겠습니다...

[green-yoon87]

수고하셨습니당!! 혜민님:)

[green-yoon87]

P3. 메서드가 실행될 때마다 새로운 JSONEncoder 객체를 생성되네요.
따로 타입을 분리하고 static 프로퍼티로 보관하여 사용한다면 생성 횟수를 줄일 수 있지 않을까 생각합니당

[soletree]

맞습니다! 쓸데없는 리소스 낭비네요... 사실 이 친구, 어떻게 분리해야할지 감이 안잡혔는데 말씀해주신대로 AnyEncodable 타입으로 분리하고 static 프로퍼티로 jsonEncoder를 관리하면 좋겠네요!
감사합니다~~ 개선해볼게요

[Kelly-Chui]

정말 수고하셨습니다 👍👍👍

[Kelly-Chui]

P5. URL Components를 사용해도 좋을거 같아요.

[soletree]

오 URLComponents는 처음 알았는데, Multipart 적용하면서 같이 적용해보겠습니다~~ 감사해요!

[Kelly-Chui]

👍