Improved testing on illegal values

Author: mvanbeusekom

packages/in_app_purchase/in_app_purchase_ios/example/ios/RunnerTests/InAppPurchasePluginTests.m

@@ -203,6 +203,37 @@ - (void)testAddPaymentSuccessWithPaymentDiscount {
  XCTAssertEqual(transactionForUpdateBlock.transactionState, SKPaymentTransactionStatePurchased);
 }
 
+- (void)testAddPaymentFailureWithInvalidPaymentDiscount {
+ XCTestExpectation* expectation =
+ [self expectationWithDescription:@"result should return success state"];
+ FlutterMethodCall* call =
+ [FlutterMethodCall methodCallWithMethodName:@"-[InAppPurchasePlugin addPayment:result:]"
+ arguments:@{
+ @"productIdentifier" : @"123",
+ @"quantity" : @(1),
+ @"simulatesAskToBuyInSandbox" : @YES,
+ @"paymentDiscount" : @{
+ @"keyIdentifier" : @"test_key_identifier",
+ @"nonce" : @"4a11a9cc-3bc3-11ec-8d3d-0242ac130003",
+ @"signature" : @"test_signature",
+ @"timestamp" : @(1635847102),
+ }
+ }];
+
+ [self.plugin
+ handleMethodCall:call
+ result:^(id r){
+ XCTAssertTrue([r isKindOfClass:FlutterError.class]);
+ FlutterError *result = r;
+ XCTAssertEqualObjects(result.code, @"storekit_invalid_payment_discount_object");
+ XCTAssertEqualObjects(result.message, @"You have requested a payment and specified a payment discount with invalid properties. When specifying a payment discount the 'identifier' field is mandatory.");
+ XCTAssertEqualObjects(result.details, call.arguments);
+ [expectation fulfill];
+ }];
+
+ [self waitForExpectations:@[ expectation ] timeout:5];
+}
+
 - (void)testAddPaymentWithNullSandboxArgument {
  XCTestExpectation* expectation =
  [self expectationWithDescription:@"result should return success state"];

packages/in_app_purchase/in_app_purchase_ios/example/ios/RunnerTests/TranslatorTests.m

@@ -188,8 +188,9 @@ - (void)testSKStorefrontAndSKPaymentTransactionToMap {
 
 - (void)testSKPaymentDiscountFromMap {
  if (@available(iOS 12.2, *)) {
+ NSString *error = nil;
  SKPaymentDiscount *paymentDiscount =
- [FIAObjectTranslator getSKPaymentDiscountFromMap:self.paymentDiscountMap];
+ [FIAObjectTranslator getSKPaymentDiscountFromMap:self.paymentDiscountMap withError: &error];
 
  XCTAssertEqual(paymentDiscount.identifier, self.paymentDiscountMap[@"identifier"]);
  XCTAssertEqual(paymentDiscount.keyIdentifier, self.paymentDiscountMap[@"keyIdentifier"]);
@@ -202,66 +203,111 @@ - (void)testSKPaymentDiscountFromMap {
 
 - (void)testSKPaymentDiscountFromMapMissingIdentifier {
  if (@available(iOS 12.2, *)) {
- NSDictionary *discountMap = @{
- @"keyIdentifier" : @"payment_discount_key_identifier",
- @"nonce" : @"d18981e0-9003-4365-98a2-4b90e3b62c52",
- @"signature" : @"this is a encrypted signature",
- @"timestamp" : @([NSDate date].timeIntervalSince1970),
- };
-
- XCTAssertThrows([FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap]);
+ NSArray * invalidValues = @[[NSNull null], @(1), @""];
+ 
+ for (id value in invalidValues) {
+ NSDictionary *discountMap = @{
+ @"identifier" : value,
+ @"keyIdentifier" : @"payment_discount_key_identifier",
+ @"nonce" : @"d18981e0-9003-4365-98a2-4b90e3b62c52",
+ @"signature" : @"this is a encrypted signature",
+ @"timestamp" : @([NSDate date].timeIntervalSince1970),
+ };
+
+ NSString *error = nil;
+ [FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap withError:&error];
+ 
+ XCTAssertNotNil(error);
+ XCTAssertEqualObjects(error, @"When specifying a payment discount the 'identifier' field is mandatory.");
+ }
  }
 }
 
 - (void)testSKPaymentDiscountFromMapMissingKeyIdentifier {
  if (@available(iOS 12.2, *)) {
- NSDictionary *discountMap = @{
- @"identifier" : @"payment_discount_identifier",
- @"nonce" : @"d18981e0-9003-4365-98a2-4b90e3b62c52",
- @"signature" : @"this is a encrypted signature",
- @"timestamp" : @([NSDate date].timeIntervalSince1970),
- };
-
- XCTAssertThrows([FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap]);
+ NSArray * invalidValues = @[[NSNull null], @(1), @""];
+ 
+ for (id value in invalidValues) {
+ NSDictionary *discountMap = @{
+ @"identifier" : @"payment_discount_identifier",
+ @"keyIdentifier" : value,
+ @"nonce" : @"d18981e0-9003-4365-98a2-4b90e3b62c52",
+ @"signature" : @"this is a encrypted signature",
+ @"timestamp" : @([NSDate date].timeIntervalSince1970),
+ };
+
+ NSString *error = nil;
+ [FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap withError:&error];
+ 
+ XCTAssertNotNil(error);
+ XCTAssertEqualObjects(error, @"When specifying a payment discount the 'keyIdentifier' field is mandatory.");
+ }
  }
 }
 
 - (void)testSKPaymentDiscountFromMapMissingNonce {
  if (@available(iOS 12.2, *)) {
- NSDictionary *discountMap = @{
- @"identifier" : @"payment_discount_identifier",
- @"keyIdentifier" : @"payment_discount_key_identifier",
- @"signature" : @"this is a encrypted signature",
- @"timestamp" : @([NSDate date].timeIntervalSince1970),
- };
-
- XCTAssertThrows([FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap]);
+ NSArray * invalidValues = @[[NSNull null], @(1), @""];
+ 
+ for (id value in invalidValues) {
+ NSDictionary *discountMap = @{
+ @"identifier" : @"payment_discount_identifier",
+ @"keyIdentifier" : @"payment_discount_key_identifier",
+ @"nonce" : value,
+ @"signature" : @"this is a encrypted signature",
+ @"timestamp" : @([NSDate date].timeIntervalSince1970),
+ };
+
+ NSString *error = nil;
+ [FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap withError:&error];
+ 
+ XCTAssertNotNil(error);
+ XCTAssertEqualObjects(error, @"When specifying a payment discount the 'nonce' field is mandatory.");
+ }
  }
 }
 
 - (void)testSKPaymentDiscountFromMapMissingSignature {
  if (@available(iOS 12.2, *)) {
- NSDictionary *discountMap = @{
- @"identifier" : @"payment_discount_identifier",
- @"keyIdentifier" : @"payment_discount_key_identifier",
- @"nonce" : @"d18981e0-9003-4365-98a2-4b90e3b62c52",
- @"timestamp" : @([NSDate date].timeIntervalSince1970),
- };
-
- XCTAssertThrows([FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap]);
+ NSArray * invalidValues = @[[NSNull null], @(1), @""];
+ 
+ for (id value in invalidValues) {
+ NSDictionary *discountMap = @{
+ @"identifier" : @"payment_discount_identifier",
+ @"keyIdentifier" : @"payment_discount_key_identifier",
+ @"nonce" : @"d18981e0-9003-4365-98a2-4b90e3b62c52",
+ @"signature" : value,
+ @"timestamp" : @([NSDate date].timeIntervalSince1970),
+ };
+
+ NSString *error = nil;
+ [FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap withError:&error];
+ 
+ XCTAssertNotNil(error);
+ XCTAssertEqualObjects(error, @"When specifying a payment discount the 'signature' field is mandatory.");
+ }
  }
 }
 
 - (void)testSKPaymentDiscountFromMapMissingTimestamp {
  if (@available(iOS 12.2, *)) {
- NSDictionary *discountMap = @{
- @"identifier" : @"payment_discount_identifier",
- @"keyIdentifier" : @"payment_discount_key_identifier",
- @"nonce" : @"d18981e0-9003-4365-98a2-4b90e3b62c52",
- @"signature" : @"this is a encrypted signature",
- };
-
- XCTAssertThrows([FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap]);
+ NSArray * invalidValues = @[[NSNull null], @"", @(-1)];
+ 
+ for (id value in invalidValues) {
+ NSDictionary *discountMap = @{
+ @"identifier" : @"payment_discount_identifier",
+ @"keyIdentifier" : @"payment_discount_key_identifier",
+ @"nonce" : @"d18981e0-9003-4365-98a2-4b90e3b62c52",
+ @"signature" : @"this is a encrypted signature",
+ @"timestamp" : value,
+ };
+
+ NSString *error = nil;
+ [FIAObjectTranslator getSKPaymentDiscountFromMap:discountMap withError:&error];
+ 
+ XCTAssertNotNil(error);
+ XCTAssertEqualObjects(error, @"When specifying a payment discount the 'timestamp' field is mandatory.");
+ }
  }
 }
 

packages/in_app_purchase/in_app_purchase_ios/ios/Classes/FIAObjectTranslator.h

@@ -52,7 +52,7 @@ NS_ASSUME_NONNULL_BEGIN
  API_AVAILABLE(ios(13), macos(10.15), watchos(6.2));
 
 // Creates an instance of the SKPaymentDiscount class based on the supplied dictionary.
-+ (SKPaymentDiscount *)getSKPaymentDiscountFromMap:(NSDictionary *)map API_AVAILABLE(ios(12.2));
++ (SKPaymentDiscount *)getSKPaymentDiscountFromMap:(NSDictionary *)map withError:(NSString **)error API_AVAILABLE(ios(12.2));
 
 @end
 ;

packages/in_app_purchase/in_app_purchase_ios/ios/Classes/FIAObjectTranslator.m

@@ -208,30 +208,45 @@ + (NSDictionary *)getMapFromSKStorefront:(SKStorefront *)storefront
  return map;
 }
 
-+ (SKPaymentDiscount *)getSKPaymentDiscountFromMap:(NSDictionary *)map {
++ (SKPaymentDiscount *)getSKPaymentDiscountFromMap:(NSDictionary *)map withError:(NSString **)error{
  if (!map || map.count <= 0) {
  return nil;
  }
 
- NSAssert(map[@"identifier"],
- @"When specifying a payment discount the 'identifier' field is mandatory.");
- NSAssert(map[@"keyIdentifier"],
- @"When specifying a payment discount the 'keyIdentifier' field is mandatory.");
- NSAssert(map[@"nonce"], @"When specifying a payment discount the 'nonce' field is mandatory.");
- NSAssert(map[@"signature"],
- @"When specifying a payment discount the 'signature' field is mandatory.");
- NSAssert(map[@"timestamp"],
- @"When specifying a payment discount the 'timestamp' field is mandatory.");
-
  NSString *identifier = map[@"identifier"];
  NSString *keyIdentifier = map[@"keyIdentifier"];
- NSUUID *nonce = [[NSUUID alloc] initWithUUIDString:map[@"nonce"]];
+ NSString *nonce = map[@"nonce"];
  NSString *signature = map[@"signature"];
  NSNumber *timestamp = map[@"timestamp"];
+ 
+ if (!identifier || ![identifier isKindOfClass:NSString.class] || [identifier isEqualToString:@""]) {
+ *error = @"When specifying a payment discount the 'identifier' field is mandatory.";
+ return nil;
+ }
+ 
+ if (!keyIdentifier || ![keyIdentifier isKindOfClass:NSString.class] || [keyIdentifier isEqualToString:@""]) {
+ *error = @"When specifying a payment discount the 'keyIdentifier' field is mandatory.";
+ return nil;
+ }
+
+ if (!nonce || ![nonce isKindOfClass:NSString.class] || [nonce isEqualToString:@""]) {
+ *error = @"When specifying a payment discount the 'nonce' field is mandatory.";
+ return nil;
+ }
+ 
+ if (!signature || ![signature isKindOfClass:NSString.class] || [signature isEqualToString:@""]) {
+ *error = @"When specifying a payment discount the 'signature' field is mandatory.";
+ return nil;
+ }
+ 
+ if (!timestamp || ![timestamp isKindOfClass:NSNumber.class] || [timestamp intValue] <= 0) {
+ *error = @"When specifying a payment discount the 'timestamp' field is mandatory.";
+ return nil;
+ }
 
  SKPaymentDiscount *discount = [[SKPaymentDiscount alloc] initWithIdentifier:identifier
  keyIdentifier:keyIdentifier
- nonce:nonce
+ nonce:[[NSUUID alloc] initWithUUIDString:nonce]
  signature:signature
  timestamp:timestamp];
 

packages/in_app_purchase/in_app_purchase_ios/ios/Classes/InAppPurchasePlugin.m

@@ -204,8 +204,20 @@ - (void)addPayment:(FlutterMethodCall *)call result:(FlutterResult)result {
  : [simulatesAskToBuyInSandbox boolValue];
 
  if (@available(iOS 12.2, *)) {
+ NSString *error = nil;
  SKPaymentDiscount *paymentDiscount = [FIAObjectTranslator
- getSKPaymentDiscountFromMap:[paymentMap objectForKey:@"paymentDiscount"]];
+ getSKPaymentDiscountFromMap:[paymentMap objectForKey:@"paymentDiscount"] withError:&error];
+ 
+ if (error) {
+ result([FlutterError
+ errorWithCode:@"storekit_invalid_payment_discount_object"
+ message: [NSString stringWithFormat:
+ @"You have requested a payment and specified a payment discount with invalid properties. %@",
+ error]
+ details:call.arguments]);
+ return;
+ }
+ 
  payment.paymentDiscount = paymentDiscount;
  }