Merge pull request #235 from wordpress-mobile/release/1.8.10

Merge Release/1.8.10 into master

Author: pinarol

.circleci/config.yml

@@ -9,21 +9,21 @@ workflows:
     jobs:
       - ios/test:
           name: Test
-          xcode-version: "10.2.0"
+          xcode-version: "11.2.1"
           workspace: WordPressShared.xcworkspace
           scheme: WordPressShared
-          device: iPhone XS
-          ios-version: "12.2"
+          device: iPhone 11
+          ios-version: "13.2.2"
           bundle-install: true
           pod-install: true
       - ios/validate-podspec:
           name: Validate Podspec
-          xcode-version: "10.2.0"
+          xcode-version: "11.2.1"
           podspec-path: WordPressShared.podspec
           bundle-install: true
       - ios/publish-podspec:
           name: Publish to Trunk
-          xcode-version: "10.2.0"
+          xcode-version: "11.2.1"
           podspec-path: WordPressShared.podspec
           bundle-install: true
           post-to-slack: true

WordPressShared.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name          = "WordPressShared"
-  s.version       = "1.8.9"
+  s.version       = "1.8.10"
   s.summary       = "Shared components used in building the WordPress iOS apps and other library components."
 
   s.description   = <<-DESC
@@ -27,4 +27,3 @@ Pod::Spec.new do |s|
   s.dependency 'CocoaLumberjack', '~> 3.4'
   s.dependency 'FormatterKit/TimeIntervalFormatter', '1.8.2'
 end
-

WordPressShared.xcodeproj/project.pbxproj

@@ -81,6 +81,8 @@
 		B5A7881F202B3A92007874FB /* WPTextFieldTableViewCell.h in Headers */ = {isa = PBXBuildFile; fileRef = B5A7881B202B3A92007874FB /* WPTextFieldTableViewCell.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		B5A78820202B3A92007874FB /* WPTextFieldTableViewCell.m in Sources */ = {isa = PBXBuildFile; fileRef = B5A7881C202B3A92007874FB /* WPTextFieldTableViewCell.m */; };
 		B5A78821202B3A92007874FB /* WPTableViewCell.h in Headers */ = {isa = PBXBuildFile; fileRef = B5A7881D202B3A92007874FB /* WPTableViewCell.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		E157E126239527700051AE41 /* Secret.swift in Sources */ = {isa = PBXBuildFile; fileRef = E157E125239527700051AE41 /* Secret.swift */; };
+		E157E128239527AD0051AE41 /* SecretTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = E157E127239527AD0051AE41 /* SecretTests.swift */; };
 		E18EABEA1F0E2C6800BFCB0B /* TestAnalyticsTracker.m in Sources */ = {isa = PBXBuildFile; fileRef = E18EABE81F0E2C6800BFCB0B /* TestAnalyticsTracker.m */; };
 		E18EABEB1F0E2C6800BFCB0B /* WPAnalyticsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = E18EABE91F0E2C6800BFCB0B /* WPAnalyticsTests.m */; };
 		E1A444281F063CAB00F6AA8A /* WPAnalytics.h in Headers */ = {isa = PBXBuildFile; fileRef = E1A444261F063CAB00F6AA8A /* WPAnalytics.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -191,6 +193,8 @@
 		B5A78823202B3B3C007874FB /* WordPressUIKit.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; path = WordPressUIKit.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		BAD47F9FCABF8C12D6352A20 /* Pods-WordPressSharedTests.release-internal.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-WordPressSharedTests.release-internal.xcconfig"; path = "Pods/Target Support Files/Pods-WordPressSharedTests/Pods-WordPressSharedTests.release-internal.xcconfig"; sourceTree = "<group>"; };
 		D62D565031D4683172615BAC /* Pods-WordPressSharedTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-WordPressSharedTests.release.xcconfig"; path = "Pods/Target Support Files/Pods-WordPressSharedTests/Pods-WordPressSharedTests.release.xcconfig"; sourceTree = "<group>"; };
+		E157E125239527700051AE41 /* Secret.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Secret.swift; sourceTree = "<group>"; };
+		E157E127239527AD0051AE41 /* SecretTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SecretTests.swift; sourceTree = "<group>"; };
 		E18EABE71F0E2C6800BFCB0B /* TestAnalyticsTracker.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TestAnalyticsTracker.h; sourceTree = "<group>"; };
 		E18EABE81F0E2C6800BFCB0B /* TestAnalyticsTracker.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = TestAnalyticsTracker.m; sourceTree = "<group>"; };
 		E18EABE91F0E2C6800BFCB0B /* WPAnalyticsTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = WPAnalyticsTests.m; sourceTree = "<group>"; };
@@ -299,6 +303,7 @@
 				7430C9D01F19302D0051B8E6 /* PhotonImageURLHelper.h */,
 				7430C9D11F19302D0051B8E6 /* PhotonImageURLHelper.m */,
 				7430C9DA1F1933F40051B8E6 /* RichContentFormatter.swift */,
+				E157E125239527700051AE41 /* Secret.swift */,
 				7414BD541F13CBE0005759F8 /* String+Helpers.swift */,
 				F19847DB226F92420004A8BC /* String+URLValidation.swift */,
 				7414BD5F1F13D084005759F8 /* UIDevice+Helpers.h */,
@@ -347,6 +352,7 @@
 				93A73ABE1EE9DDB000C0F2F9 /* WPMapFilterReduceTest.m */,
 				8270708F1ECA4E1C00155CBF /* WordPressSharedTests-Bridging-Header.h */,
 				F19847DD226F92EA0004A8BC /* StringURLValidationTests.swift */,
+				E157E127239527AD0051AE41 /* SecretTests.swift */,
 			);
 			name = Tests;
 			sourceTree = "<group>";
@@ -653,6 +659,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				E1A444291F063CAB00F6AA8A /* WPAnalytics.m in Sources */,
+				E157E126239527700051AE41 /* Secret.swift in Sources */,
 				827070101ECA43AA00155CBF /* WPImageSource.m in Sources */,
 				93C674F51EE83D4B00BFAF05 /* Languages.swift in Sources */,
 				B5A787E6202B2BD3007874FB /* WPDeviceIdentification.m in Sources */,
@@ -704,6 +711,7 @@
 				B5393FDD206D6169007BF9D4 /* EmailTypoCheckerTests.swift in Sources */,
 				F1134A292270C19200B8F75F /* DebouncerTests.swift in Sources */,
 				7430C9D51F1930460051B8E6 /* PhotonImageURLHelperTest.m in Sources */,
+				E157E128239527AD0051AE41 /* SecretTests.swift in Sources */,
 				740B23CF1F17F28E00067A2A /* DisplayableImageHelperTest.m in Sources */,
 				E18EABEB1F0E2C6800BFCB0B /* WPAnalyticsTests.m in Sources */,
 				7430C9DD1F1934190051B8E6 /* RichContentFormatterTests.swift in Sources */,

WordPressShared/Core/Analytics/WPAnalytics.h

@@ -77,6 +77,7 @@ typedef NS_ENUM(NSUInteger, WPAnalyticsStat) {
     WPAnalyticsStatEditorAddedPhotoViaGiphy,
     WPAnalyticsStatEditorAddedPhotoViaOtherApps,
     WPAnalyticsStatEditorAddedPhotoViaStockPhotos,
+    WPAnalyticsStatEditorAddedPhotoViaMediaEditor,
     WPAnalyticsStatEditorAddedVideoViaOtherApps,
     WPAnalyticsStatEditorAztecBetaLink,
     WPAnalyticsStatEditorAztecPromoLink,
@@ -198,6 +199,8 @@ typedef NS_ENUM(NSUInteger, WPAnalyticsStat) {
     WPAnalyticsStatLoginSocialErrorUnknownUser,
     WPAnalyticsStatLogout,
     WPAnalyticsStatLowMemoryWarning,
+    WPAnalyticsStatMediaEditorShown,
+    WPAnalyticsStatMediaEditorUsed,
     WPAnalyticsStatMediaLibraryDeletedItems,
     WPAnalyticsStatMediaLibraryEditedItemMetadata,
     WPAnalyticsStatMediaLibraryPreviewedItem,
@@ -559,7 +562,18 @@ typedef NS_ENUM(NSUInteger, WPAnalyticsStat) {
     WPAnalyticsStatTwoFactorSentSMS,
     WPAnalyticsStatShareExtensionError,
     WPAnalyticsStatSearchAdsAttribution,
-    WPAnalyticsStatMaxValue
+    WPAnalyticsStatMaxValue,
+    /// Logged when there are orphaned entities (e.g. has NULL blog values).
+    ///
+    /// These are invalid rows in the database and will cause a crash in Core Data during saving.
+    ///
+    /// Event Properties:
+    ///
+    /// - entity_name: String. The Core Data entity name.
+    /// - deleted_count: Int. The number of deleted entities.
+    ///
+    /// This event is not logged when there are no entities to delete.
+    WPAnalyticsStatDebugDeletedOrphanedEntities
 };
 
 extern NSString *const WPAnalyticsStatEditorPublishedPostPropertyCategory;

WordPressShared/Core/Logging/WPSharedLogging.h

@@ -1,2 +1,4 @@
-int WPSharedGetLoggingLevel(void);
-void WPSharedSetLoggingLevel(int level);
+@import CocoaLumberjack;
+
+DDLogLevel WPSharedGetLoggingLevel(void);
+void WPSharedSetLoggingLevel(DDLogLevel level);

WordPressShared/Core/Logging/WPSharedLogging.m

@@ -1,10 +1,10 @@
 #import "WPSharedLogging.h"
 #import "WPSharedLoggingPrivate.h"
 
-int WPSharedGetLoggingLevel() {
+DDLogLevel WPSharedGetLoggingLevel() {
     return ddLogLevel;
 }
 
-void WPSharedSetLoggingLevel(int level) {
+void WPSharedSetLoggingLevel(DDLogLevel level) {
     ddLogLevel = level;
 }

WordPressShared/Core/Utility/Secret.swift

@@ -0,0 +1,49 @@
+import Foundation
+
+/// Wraps a value that contains sensitive information to prevent accidental logging
+///
+/// Usage example
+///
+/// ```
+/// let password = Secret("my secret password")
+/// print(password)             // Prints "--redacted--"
+/// print(password.secretValue) // Prints "my secret password"
+/// ```
+///
+public struct Secret<T> {
+    public let secretValue: T
+
+    public init(_ secretValue: T) {
+        self.secretValue = secretValue
+    }
+}
+
+extension Secret: RawRepresentable {
+    public typealias RawValue = T
+
+    public init?(rawValue: Self.RawValue) {
+        self.init(rawValue)
+    }
+
+    public var rawValue: T {
+        return secretValue
+    }
+}
+
+extension Secret: CustomStringConvertible, CustomDebugStringConvertible, CustomReflectable {
+    private static var redacted: String {
+        return "--redacted--"
+    }
+
+    public var description: String {
+        return Secret.redacted
+    }
+
+    public var debugDescription: String {
+        return Secret.redacted
+    }
+
+    public var customMirror: Mirror {
+        return Mirror(reflecting: Secret.redacted)
+    }
+}

WordPressShared/Private/WPSharedLoggingPrivate.h

@@ -1,2 +1,2 @@
 @import CocoaLumberjack;
-extern int ddLogLevel;
+extern DDLogLevel ddLogLevel;

WordPressShared/Private/WPSharedLoggingPrivate.m

@@ -1,2 +1,2 @@
 #import "WPSharedLoggingPrivate.h"
-int ddLogLevel = DDLogLevelWarning;
+DDLogLevel ddLogLevel = DDLogLevelWarning;

WordPressSharedTests/SecretTests.swift

@@ -0,0 +1,24 @@
+import WordPressShared
+import XCTest
+
+class SecretTests: XCTestCase {
+    func testSecretDescription() {
+        let secret = Secret("my secret")
+        XCTAssertEqual("--redacted--", secret.description, "Description should be redacted")
+    }
+
+    func testSecretDebugDescription() {
+        let secret = Secret("my secret")
+        XCTAssertEqual("--redacted--", secret.debugDescription, "Debug description should be redacted")
+    }
+
+    func testSecretMirror() {
+        let secret = Secret("my secret")
+        XCTAssertEqual("--redacted--", String(reflecting: secret), "Mirror should be redacted")
+    }
+
+    func testSecretUnwrapsValue() {
+        let secret = Secret("my secret")
+        XCTAssertEqual("my secret", secret.secretValue, "secretValue should not be redacted")
+    }
+}