SPT-1998 Документация

CHANGELOG.md

@@ -0,0 +1 @@
+# CHANGELOG

NodeKit/NodeKit.xcodeproj/project.pbxproj

@@ -203,9 +203,7 @@
 		90B609BF283E1287006F4309 /* Logable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B60980283E1287006F4309 /* Logable.swift */; };
 		90B609C0283E1287006F4309 /* LoggerExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B60981283E1287006F4309 /* LoggerExtensions.swift */; };
 		90B609C1283E1287006F4309 /* Log.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B60982283E1287006F4309 /* Log.swift */; };
-		90B609C2283E1287006F4309 /* MockerProxyConfigNode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B60984283E1287006F4309 /* MockerProxyConfigNode.swift */; };
 		90B609EF283E16DC006F4309 /* DTOMapperNodeTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B609C5283E16DC006F4309 /* DTOMapperNodeTests.swift */; };
-		90B609F2283E16DC006F4309 /* MockerProxyConfigNodeTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B609CB283E16DC006F4309 /* MockerProxyConfigNodeTests.swift */; };
 		90B609F3283E16DC006F4309 /* URLQueryDictionaryKeyEncodingDefaultStrategyTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B609CE283E16DC006F4309 /* URLQueryDictionaryKeyEncodingDefaultStrategyTests.swift */; };
 		90B609F4283E16DC006F4309 /* URLQueryArrayKeyEncodingBracketsStartegyTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B609CF283E16DC006F4309 /* URLQueryArrayKeyEncodingBracketsStartegyTests.swift */; };
 		90B609F5283E16DC006F4309 /* URLQueryBoolEncodingDefaultStartegyTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B609D0283E16DC006F4309 /* URLQueryBoolEncodingDefaultStartegyTests.swift */; };
@@ -438,9 +436,7 @@
 		90B60980283E1287006F4309 /* Logable.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Logable.swift; sourceTree = "<group>"; };
 		90B60981283E1287006F4309 /* LoggerExtensions.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LoggerExtensions.swift; sourceTree = "<group>"; };
 		90B60982283E1287006F4309 /* Log.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Log.swift; sourceTree = "<group>"; };
-		90B60984283E1287006F4309 /* MockerProxyConfigNode.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MockerProxyConfigNode.swift; sourceTree = "<group>"; };
 		90B609C5283E16DC006F4309 /* DTOMapperNodeTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DTOMapperNodeTests.swift; sourceTree = "<group>"; };
-		90B609CB283E16DC006F4309 /* MockerProxyConfigNodeTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MockerProxyConfigNodeTests.swift; sourceTree = "<group>"; };
 		90B609CE283E16DC006F4309 /* URLQueryDictionaryKeyEncodingDefaultStrategyTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = URLQueryDictionaryKeyEncodingDefaultStrategyTests.swift; sourceTree = "<group>"; };
 		90B609CF283E16DC006F4309 /* URLQueryArrayKeyEncodingBracketsStartegyTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = URLQueryArrayKeyEncodingBracketsStartegyTests.swift; sourceTree = "<group>"; };
 		90B609D0283E16DC006F4309 /* URLQueryBoolEncodingDefaultStartegyTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = URLQueryBoolEncodingDefaultStartegyTests.swift; sourceTree = "<group>"; };
@@ -614,7 +610,6 @@
 				90B609D3283E16DC006F4309 /* TokenRefresherNodeTests.swift */,
 				90B609C5283E16DC006F4309 /* DTOMapperNodeTests.swift */,
 				90B609D1283E16DC006F4309 /* URLQueryInjectorNodeTests.swift */,
-				90B609CB283E16DC006F4309 /* MockerProxyConfigNodeTests.swift */,
 				90B609EE283E16DC006F4309 /* AbortingTests.swift */,
 				50C8EB462BBF14CC00C5CB93 /* TechnicaErrorMapperNodeTests.swift */,
 				50C8EB482BBF185300C5CB93 /* RequestCreatorNodeTests.swift */,
@@ -809,7 +804,6 @@
 				90B608F1283E1268006F4309 /* Core */,
 				90B6090C283E1268006F4309 /* Encodings */,
 				90B6092E283E1287006F4309 /* Layers */,
-				90B60983283E1287006F4309 /* MockerIntegration */,
 				90B60972283E1287006F4309 /* Utils */,
 				90B608CE283E1110006F4309 /* NodeKit.h */,
 			);
@@ -1126,14 +1120,6 @@
 			path = Logging;
 			sourceTree = "<group>";
 		};
-		90B60983283E1287006F4309 /* MockerIntegration */ = {
-			isa = PBXGroup;
-			children = (
-				90B60984283E1287006F4309 /* MockerProxyConfigNode.swift */,
-			);
-			path = MockerIntegration;
-			sourceTree = "<group>";
-		};
 		90B609C3283E16DC006F4309 /* UnitTests */ = {
 			isa = PBXGroup;
 			children = (
@@ -1535,7 +1521,6 @@
 				90B6091B283E1268006F4309 /* Array+RawMappable.swift in Sources */,
 				5060A4662BC3E6E8004E84E2 /* URLSessionDataTaskActor.swift in Sources */,
 				90B6098D283E1287006F4309 /* Method.swift in Sources */,
-				90B609C2283E1287006F4309 /* MockerProxyConfigNode.swift in Sources */,
 				502F9D972BAA36CF00151A8D /* LoggingContext.swift in Sources */,
 				90B60988283E1287006F4309 /* URLQueryArrayKeyEncodingStartegy.swift in Sources */,
 				50B569762BCFEF470054DC09 /* NodeResultPublisher.swift in Sources */,
@@ -1628,7 +1613,6 @@
 				5060A4842BC41C89004E84E2 /* VoidIONodeTests.swift in Sources */,
 				501349482BE3F8D6002CC3DA /* URLWithOrderedQuery.swift in Sources */,
 				50C8EB522BBF302E00C5CB93 /* ResponseDataPreprocessorNodeTests.swift in Sources */,
-				90B609F2283E16DC006F4309 /* MockerProxyConfigNodeTests.swift in Sources */,
 				5060A4802BC4164E004E84E2 /* RequestRouterNodeTests.swift in Sources */,
 				90B609FA283E16DC006F4309 /* FirstCachePolicyTests.swift in Sources */,
 				5060A4982BC44B61004E84E2 /* DataLoadingResponseProcessorTests.swift in Sources */,

NodeKit/NodeKit/CacheNode/ETag/ETagConstants.swift

@@ -8,11 +8,11 @@
 
 import Foundation
 
-/// Содержит константы для работы с eTag
-/// Эти кнстанты описаны в соответствии с RFC и AppleDeveloper
+/// Constants for working with eTags
+/// These constants are described in accordance with RFC and AppleDeveloper.
 public enum ETagConstants {
 
-    /// В хедерах **ответа** от сервера под **этим** ключем должен лежать eTag-токен
+    /// There should be the eTag token under **this** key in the **response** headers.
     ///
     /// - SeeAlso:
     ///     - [AppleDeveloper](https://developer.apple.com/documentation/foundation/httpurlresponse/1417930-allheaderfields)
@@ -21,7 +21,7 @@ public enum ETagConstants {
         return "Etag"
     }
 
-    /// В хедерах **запроса** к серверу под этим ключем должен лежать eTag-токен
+    /// /// There should be the eTag token under **this** key in the **response** headers.
     ///
     /// - SeeAlso: [RFC-7232](https://tools.ietf.org/html/rfc7232#section-3.2)
     ///

NodeKit/NodeKit/CacheNode/ETag/URLETagReaderNode.swift

@@ -8,29 +8,29 @@
 
 import Foundation
 
-/// Этот узел читает eTag-токен из хранилища и добавляет его к запросу.
+/// This node reads the eTag token from the storage and adds it to the request.
 open class URLETagReaderNode: AsyncNode {
 
-    // Следующий узел для обработки.
+    // The next node for processing.
     public var next: any TransportLayerNode
 
-    /// Ключ, по которому необходимо получить eTag-токен из хедеров.
-    /// По-молчанию имеет значение `eTagRequestHeaderKey`
+    /// The key to retrieve the eTag token from the headers.
+    /// The default value is `eTagRequestHeaderKey`.
     public var etagHeaderKey: String
 
-    /// Инициаллизирует узел.
+    /// Initializer.
     ///
     /// - Parameters:
-    ///   - next: Следующий узел для обработки.
-    ///   - eTagHeaderKey: Ключ, по которому необходимо добавить eTag-токен к запросу.
+    ///   - next: The next node for processing.
+    ///   - eTagHeaderKey: The key to retrieve the eTag token from the headers.
     public init(next: some TransportLayerNode,
                 etagHeaderKey: String = ETagConstants.eTagRequestHeaderKey) {
         self.next = next
         self.etagHeaderKey = etagHeaderKey
     }
 
-    /// Пытается прочесть eTag-токен из хранилища и добавить его к запросу.
-    /// В случае, если прочесть токен не удалось, то управление просто передается дальше.
+    /// Tries to read the eTag token from the storage and add it to the request.
+    /// If reading the token fails, control is simply passed on.
     open func process(
         _ data: TransportURLRequest,
         logContext: LoggingContextProtocol

NodeKit/NodeKit/CacheNode/ETag/URLETagSaverNode.swift

@@ -10,35 +10,35 @@ import Foundation
 
 // MARK: - UserDefaults eTag storage
 
-/// Содержит указатель на UserDefaults-хранилище для eTag токенов.
+/// Reference to the UserDefaults storage for eTag tokens.
 extension UserDefaults {
-    /// Хранилище для eTag-токенов
+    /// Storage for eTag tokens
     static var etagStorage = UserDefaults(suiteName: "\(String(describing: UserDefaults.self))")
 }
 
-/// Этот узел сохраняет пришедшие eTag-токены.
-/// В качестве ключа используется абсолютный URL до endpoint-a.
+/// This node stores received eTag tokens.
+/// The absolute URL to the endpoint is used as the key.
 open class URLETagSaverNode: AsyncNode {
 
-    /// Следующий узел для обработки.
+    /// The next node for processing.
     public var next: (any ResponsePostprocessorLayerNode)?
 
-    /// Ключ, по которому необходимо получить eTag-токен из хедеров.
-    /// По-молчанию имеет значение `ETagConstants.eTagResponseHeaderKey`
+    /// The key to retrieve the eTag token from the headers.
+    /// The default value is `ETagConstants.eTagResponseHeaderKey`.
     public var eTagHeaderKey: String
 
-    /// Инициаллизирует узел.
+    /// Initializer.
     ///
     /// - Parameters:
-    ///   - next: Следующий узел для обработки.
-    ///   - eTagHeaderKey: Ключ, по которому необходимо получить eTag-токен из хедеров.
+    ///   - next: The next node for processing.
+    ///   - eTagHeaderKey: The key to retrieve the eTag token from the headers.
     public init(next: (any ResponsePostprocessorLayerNode)?, eTagHeaderKey: String = ETagConstants.eTagResponseHeaderKey) {
         self.next = next
         self.eTagHeaderKey = eTagHeaderKey
     }
 
-    /// Пытается получить eTag-токен по ключу.
-    /// В любом случае передает управление дальше.
+    /// Tries to retrieve the eTag token by the key.
+    /// In any case, passes control further.
     open func process(
         _ data: URLProcessedResponse,
         logContext: LoggingContextProtocol
@@ -60,23 +60,23 @@ open class URLETagSaverNode: AsyncNode {
 
 public extension URL {
 
-    /// Берет исходный URL
-    /// Получает словарь параметров query
-    /// Если параметров нет - возвращает `self.absoluteString`
-    /// Если параметры есть - сортирует их соединяет в одну строку
-    /// Удаляет query параметры из исходного URL
-    /// Склеивает строковое представление URL без парамтеров со сторокой параметров
+    /// Takes the original URL
+    /// Gets dictionary of query parameters
+    /// If there are no parameters - returns `self.absoluteString`
+    /// If parameters exist - sorts them and joins them into one string
+    /// Removes query parameters from the original URL
+    /// Concatenates the string representation of the URL without parameters with the parameter string
     ///
-    /// **ВАЖНО**
+    /// **IMPORTANT**
     ///
-    /// Полученная строка может быть невалидным URL - т.к. задача этого метода - получить уникальный идентификатор из URL
-    /// Причем так, чтобы порядок перечисления query парамтеров был не важен.
+    /// The resulting string may be an invalid URL - since the purpose of this method is to extract a unique identifier from the URL
+    /// Moreover, the order of query parameters does not matter.
     func withOrderedQuery() -> String? {
         guard var comp = URLComponents(string: self.absoluteString) else {
             return nil
         }
 
-        // ели нет query параметров, то просто возвращаем этот url т.к. ничего сортировать не надо
+        // If there are no query parameters, return this URL because there is nothing to sort.
         if comp.queryItems == nil || comp.queryItems?.isEmpty == true {
             return self.absoluteString
         }
@@ -86,7 +86,7 @@ public extension URL {
             .sorted()
             .reduce("", { $1 + $0 })
 
-        // если в компонентах сбросить query в nil, то в итоговом URL не будет query
+        // If you reset the query component to nil, then the resulting URL will not have a query component.
         comp.query = nil
 
         guard let url = comp.url else {

NodeKit/NodeKit/CacheNode/FirstCachePolicyNode.swift

@@ -8,53 +8,53 @@
 
 import Foundation
 
-/// Ошибки для узла `FirstCachePolicyNode`
+/// Errors for the node `FirstCachePolicyNode`
 ///
 /// - SeeAlso: `FirstCachePolicyNode`
 ///
-/// - cantGetURLRequest: Возникает в случае, если запрос отправленный в сеть не содержит `URLRequest`
+/// - cantGetURLRequest: Occurs if the request sent over the network does not contain a `URLRequest`
 enum BaseFirstCachePolicyNodeError: Error {
     case cantGetURLRequest
 }
 
-/// Этот узел реализует политику кэширования
-/// "Сначала читаем из кэша, а затем запрашиваем у сервера"
-/// - Important: В общем случае слушатель может быть оповещен дважды. Первый раз, когда ответ прочитан из кэша, а второй раз, когда он был получен с сервера.
+/// This node implements the caching policy
+/// "First, read from the cache, then request from the server"
+/// - Important: In general, the listener may be notified twice. The first time when the response is read from the cache, and the second time when it is received from the server.
 class FirstCachePolicyNode: AsyncStreamNode {
     // MARK: - Nested
 
-    /// Тип для читающего из URL кэша узла
+    /// Type of the node reading from URL cache
     typealias CacheReaderNode = AsyncNode<URLNetworkRequest, Json>
 
-    /// Тип для следующего узла
+    /// Type of the next node
     typealias NextProcessorNode = AsyncNode<RawURLRequest, Json>
 
     // MARK: - Properties
 
-    /// Следующий узел для обработки.
+    /// The next node for processing.
     var next: any NextProcessorNode
 
-    /// Узел для чтения из кэша.
+    /// Node for reading from cache.
     var cacheReaderNode: any CacheReaderNode
 
     // MARK: - Init and Deinit
 
-    /// Инициаллизирует узел.
+    /// Initializer.
     ///
     /// - Parameters:
-    ///   - cacheReaderNode: Узел для чтения из кэша.
-    ///   - next: Следующий узел для обработки.
+    ///   - cacheReaderNode: Node for reading from cache.
+    ///   - next: Next node for processing.
     init(cacheReaderNode: any CacheReaderNode, next: any NextProcessorNode) {
         self.cacheReaderNode = cacheReaderNode
         self.next = next
     }
 
     // MARK: - Node
 
-    /// Пытается получить `URLRequest` и если удается, то обращается в кэш
-    /// а затем, передает управление следующему узлу.
-    /// В случае, если получить `URLRequest` не удалось,
-    /// то управление просто передается следующему узлу
+    /// Tries to get the `URLRequest` and if successful, accesses the cache
+    /// and then passes control to the next node.
+    /// If obtaining the `URLRequest` fails,
+    /// control is passed to the next node.
     func process(
         _ data: RawURLRequest,
         logContext: LoggingContextProtocol

NodeKit/NodeKit/CacheNode/IfServerFailsFromCacheNode.swift

@@ -8,28 +8,28 @@
 
 import Foundation
 
-/// Узел реализует политику кэширования "Если интернета нет, то запросить данные из кэша"
-/// Этот узел работает с URL кэшом.
+/// Node implements the caching policy "If there is no internet, request data from cache"
+/// This node works with the URL cache.
 open class IfConnectionFailedFromCacheNode: AsyncNode {
 
-    /// Следующий узел для обработки.
+    /// The next node for processing.
     public var next: any AsyncNode<URLRequest, Json>
-    /// Узел, считывающий данные из URL кэша.
+    /// Node that reads data from the URL cache.
     public var cacheReaderNode: any AsyncNode<URLNetworkRequest, Json>
 
-    /// Инициаллизирует узел.
+    /// Initializer.
     ///
     /// - Parameters:
-    ///   - next: Следующий узел для обработки.
-    ///   - cacheReaderNode: Узел, считывающий данные из URL кэша.
+    ///   - next: The next node for processing.
+    ///   - cacheReaderNode: Node that reads data from the URL cache.
     public init(next: any AsyncNode<URLRequest, Json>, cacheReaderNode: any AsyncNode<URLNetworkRequest, Json>) {
         self.next = next
         self.cacheReaderNode = cacheReaderNode
     }
 
-    /// Проверяет, произошла ли ошибка связи в ответ на запрос.
-    /// Если ошибка произошла, то возвращает успешный ответ из кэша.
-    /// В противном случае передает управление следующему узлу.
+    /// Checks if there was a ``BaseTechnicalError``  in response to the request.
+    /// If an error occurred, returns a successful response from the cache.
+    /// Otherwise, passes control to the next node.
     open func process(
         _ data: URLRequest,
         logContext: LoggingContextProtocol