summaryrefslogtreecommitdiffstats
path: root/src/jaegertracing/thrift/lib/swift/Sources/TApplicationError.swift
blob: bc3939680059091068147a0ce0d9d6b87070d790 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
*   http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/


public struct TApplicationError : TError {
  public enum Code : TErrorCode {
    case unknown
    case unknownMethod(methodName: String?)
    case invalidMessageType
    case wrongMethodName(methodName: String?)
    case badSequenceId
    case missingResult(methodName: String?)
    case internalError
    case protocolError
    case invalidTransform
    case invalidProtocol
    case unsupportedClientType
    
    
    /// Initialize a TApplicationError with a Thrift error code
    /// Normally this would be achieved with RawRepresentable however
    /// by doing this we can allow for associated properties on enum cases for
    /// case specific context data in a Swifty, type-safe manner.
    ///
    /// - parameter thriftErrorCode: Integer TApplicationError(exception) error code.  
    ///                              Default to 0 (.unknown)
    public init(thriftErrorCode: Int) {
      switch thriftErrorCode {
      case 1:  self = .unknownMethod(methodName: nil)
      case 2:  self = .invalidMessageType
      case 3:  self = .wrongMethodName(methodName: nil)
      case 4:  self = .badSequenceId
      case 5:  self = .missingResult(methodName: nil)
      case 6:  self = .internalError
      case 7:  self = .protocolError
      case 8:  self = .invalidProtocol
      case 9:  self = .invalidTransform
      case 10: self = .unsupportedClientType
      default: self = .unknown
      }
    }
    public var thriftErrorCode: Int {
      switch self {
      case .unknown:                return 0
      case .unknownMethod:          return 1
      case .invalidMessageType:     return 2
      case .wrongMethodName:        return 3
      case .badSequenceId:          return 4
      case .missingResult:          return 5
      case .internalError:          return 6
      case .protocolError:          return 7
      case .invalidProtocol:        return 8
      case .invalidTransform:       return 9
      case .unsupportedClientType:  return 10
      }
    }
    
    public var description: String {
      /// Output "for #methodName" if method is not nil else empty
      let methodUnwrap: (String?) -> String =  { method in
        return "\(method == nil ? "" : " for \(method ?? "")")"
      }
      switch self {
      case .unknown:                      return "Unknown TApplicationError"
      case .unknownMethod(let method):    return "Unknown Method\(methodUnwrap(method))"
      case .invalidMessageType:           return "Invalid Message Type"
      case .wrongMethodName(let method):  return "Wrong Method Name\(methodUnwrap(method))"
      case .badSequenceId:                return "Bad Sequence ID"
      case .missingResult(let method):    return "Missing Result\(methodUnwrap(method))"
      case .internalError:                return "Internal Error"
      case .protocolError:                return "Protocol Error"
      case .invalidProtocol:              return "Invalid Protocol"
      case .invalidTransform:             return "Invalid Transform"
      case .unsupportedClientType:        return "Unsupported Client Type"
      }
    }
  }

  public init() { }
  
  public init(thriftErrorCode code: Int, message: String? = nil) {
    self.error = Code(thriftErrorCode: code)
    self.message = message
  }
  
  public var error: Code = .unknown
  public var message: String? = nil
  public static var defaultCase: Code { return .unknown }
}

extension TApplicationError : TSerializable {
  public static var thriftType: TType { return .struct }
  
  public static func read(from proto: TProtocol) throws -> TApplicationError {
    var errorCode: Int = 0
    var message: String? = nil
    _ = try proto.readStructBegin()
    fields: while true {
      let (_, fieldType, fieldID) = try proto.readFieldBegin()
      
      switch (fieldID, fieldType) {
      case (_, .stop):
        break fields
      case (1, .string):
        message = try proto.read()
      case (2, .i32):
        errorCode = Int(try proto.read() as Int32)
      
      case let (_, unknownType):
        try proto.skip(type: unknownType)
      }
      
      try proto.readFieldEnd()
    }
    try proto.readStructEnd()
    return TApplicationError(thriftErrorCode: errorCode, message: message)
  }

  public func write(to proto: TProtocol) throws {
    try proto.writeStructBegin(name: "TApplicationException")
    
    try proto.writeFieldBegin(name: "message", type: .string, fieldID: 1)
    try proto.write(message ?? "")
    try proto.writeFieldEnd()
    
    try proto.writeFieldBegin(name: "type", type: .i32, fieldID: 2)
    let val = Int32(error.thriftErrorCode)
    try proto.write(val)
    try proto.writeFieldEnd()
    try proto.writeFieldStop()
    try proto.writeStructEnd()
  }
  
  public var hashValue: Int {
    return error.thriftErrorCode &+ (message?.hashValue ?? 0)
  }
}

public func ==(lhs: TApplicationError, rhs: TApplicationError) -> Bool {
  return lhs.error.thriftErrorCode == rhs.error.thriftErrorCode && lhs.message == rhs.message
}