SDL 0180 - Fix to support broaden choice cell uniqueness

SmartDeviceLink/private/SDLChoiceSetManager.m

@@ -448,8 +448,9 @@ - (void)dismissKeyboardWithCancelID:(NSNumber<SDLInt> *)cancelID {
 /// @return The choices that have not yet been uploaded to the module
 - (NSSet<SDLChoiceCell *> *)sdl_choicesToBeUploadedWithArray:(NSArray<SDLChoiceCell *> *)choices {
     NSMutableSet<SDLChoiceCell *> *choicesSet = [NSMutableSet setWithArray:choices];
-    SDLVersion *choiceUniquenessSupportedVersion = [[SDLVersion alloc] initWithMajor:7 minor:1 patch:0];
-    if ([[SDLGlobals sharedGlobals].rpcVersion isLessThanVersion:choiceUniquenessSupportedVersion]) {
+
+    // If we're running on a connection < RPC 7.1, we need to de-duplicate cells because presenting them will fail if we have the same cell primary text.
+    SDLVersion *choiceUniquenessSupportedVersion = [[SDLVersion alloc] initWithMajor:7 minor:1 patch:0];    if ([[SDLGlobals sharedGlobals].rpcVersion isLessThanVersion:choiceUniquenessSupportedVersion]) {
         [self sdl_addUniqueNamesToCells:choicesSet];
     }
     [choicesSet minusSet:self.preloadedChoices];

SmartDeviceLink/private/SDLMenuManager.m

@@ -179,13 +179,34 @@ - (void)setMenuCells:(NSArray<SDLMenuCell *> *)menuCells {
     self.waitingOnHMIUpdate = NO;
 
     NSMutableSet<NSString *> *allMenuVoiceCommands = [NSMutableSet set];
+    NSMutableSet *cellCheckSet = [NSMutableSet set];
     NSUInteger voiceCommandCount = 0;
     for (SDLMenuCell *cell in cells) {
+        [cellCheckSet addObject:cell];
+        if (cell.subCells.count > 0) {
+            NSMutableSet *subCellsCheckSet = [NSMutableSet set];
+            for (SDLMenuCell *subCell in cell.subCells) {
+                [subCellsCheckSet addObject:subCell];
+                if (subCell.voiceCommands == nil) { continue; }
+                [allMenuVoiceCommands addObjectsFromArray:subCell.voiceCommands];
+                voiceCommandCount += subCell.voiceCommands.count;
+            }
+
+            if (subCellsCheckSet.count != cell.subCells.count) {
+                SDLLogE(@"Not all subCells are unique. The menu will not be set.");
+                return;
+            }
+        }
         if (cell.voiceCommands == nil) { continue; }
         [allMenuVoiceCommands addObjectsFromArray:cell.voiceCommands];
         voiceCommandCount += cell.voiceCommands.count;
     }
 
+    if (cellCheckSet.count != cells.count) {
+        SDLLogE(@"Not all cells are unique. The menu will not be set.");
+        return;
+    }
+
     // Check for duplicate voice recognition commands
     if (allMenuVoiceCommands.count != voiceCommandCount) {
         SDLLogE(@"Attempted to create a menu with duplicate voice commands. Voice commands must be unique. The menu will not be set.");

SmartDeviceLink/public/SDLChoiceSet.m

@@ -69,16 +69,23 @@ - (instancetype)initWithTitle:(NSString *)title delegate:(id<SDLChoiceSetDelegat
         return nil;
     }
 
+    NSMutableSet<SDLChoiceCell *> *choicesSet = [NSMutableSet setWithCapacity:choices.count];
     NSMutableSet<NSString *> *uniqueVoiceCommands = [NSMutableSet set];
     NSUInteger allVoiceCommandsCount = 0;
     NSUInteger choiceCellWithVoiceCommandCount = 0;
     for (SDLChoiceCell *cell in choices) {
+        [choicesSet addObject:cell];
         if (cell.voiceCommands == nil) { continue; }
         [uniqueVoiceCommands addObjectsFromArray:cell.voiceCommands];
         choiceCellWithVoiceCommandCount += 1;
         allVoiceCommandsCount += cell.voiceCommands.count;
     }
 
+    if (choicesSet.count < choices.count) {
+        SDLLogE(@"Attempted to create a choice set with duplicate cell text. Cell text must be unique. The choice set will not be set.");
+        return nil;
+    }
+
     // All or none of the choices must have VR commands
     if ((choiceCellWithVoiceCommandCount > 0 && choiceCellWithVoiceCommandCount < choices.count)) {
         SDLLogE(@"If using voice recognition commands, all of the choice set cells must have unique VR commands. There are %lu cells with unique voice commands and %lu total cells. The choice set will not be set.", (unsigned long)choiceCellWithVoiceCommandCount, (unsigned long)choices.count);

SmartDeviceLinkTests/DevAPISpecs/SDLChoiceSetSpec.m

@@ -156,12 +156,12 @@ @interface SDLChoiceSet()
                 expect(testChoiceSet).to(beNil());
             });
 
-            it(@"should not return nil with equivalent cell text", ^{
+            it(@"should return nil when 2 or more cells are identical", ^{
                 // Cell `text` cannot be equal
                 SDLChoiceCell *equalCell = [[SDLChoiceCell alloc] initWithText:@"Text"];
                 SDLChoiceCell *equalCell2 = [[SDLChoiceCell alloc] initWithText:@"Text"];
                 testChoiceSet = [[SDLChoiceSet alloc] initWithTitle:testTitle delegate:testDelegate choices:@[equalCell, equalCell2]];
-                expect(testChoiceSet).toNot(beNil());
+                expect(testChoiceSet).to(beNil());
             });
 
             context(@"With bad VR data", ^{