Merge pull request #1816 from smartdevicelink/release/5.5.0_RC

Release 5.5.0

CHANGELOG.md

@@ -1,4 +1,4 @@
-# 5.4.0 Release Notes
+# 5.5.0 Release Notes
 
 ## Summary:
 ||Version|
@@ -7,51 +7,9 @@
 | **RPC** | 8.0.0
 | **Tested Targeting** | Android 31
 
-## Bug Fixes / Enhancements:
+## Bug Fixes:
 
-- [Video auto restarts streaming regardless if HMI level is streamable ](https://github.com/smartdevicelink/sdl_java_suite/issues/1807)
+- [ScreenManager tries to upload images even if they are not supported (SDL 2.0)](https://github.com/smartdevicelink/sdl_java_suite/issues/1738)
 
-- [Video Streaming Fails on Android 12 at Low Resolutions](https://github.com/smartdevicelink/sdl_java_suite/issues/1803)
-
-- [sdl_java_se uses deprecated testCompile in build.gradle](https://github.com/smartdevicelink/sdl_java_suite/issues/1805)
-
-- [Incorrect behavior and potential crashes in PresentAlertOperation.supportsSoftButtonImages()](https://github.com/smartdevicelink/sdl_java_suite/issues/1800)
-
-- [Bugfix/rs notification issue usb](https://github.com/smartdevicelink/sdl_java_suite/pull/1797)
-
-- [Attempting to Send Voice Command with No Strings Fails to Log Error](https://github.com/smartdevicelink/sdl_java_suite/issues/1798)
-
-- [Fix LCM to close down properly](https://github.com/smartdevicelink/sdl_java_suite/pull/1796)
-
-- [Cleanup/proposal sdl 0286 spacing](https://github.com/smartdevicelink/sdl_java_suite/pull/1782)
-
-- [API Reference Docs Typos](https://github.com/smartdevicelink/sdl_java_suite/issues/1792)
-
-- [Foreground Service Notifications can be delayed by 10 seconds](https://github.com/smartdevicelink/sdl_java_suite/issues/1733)
-
-- [Bluetooth Permission Requirements will change in Android 12](https://github.com/smartdevicelink/sdl_java_suite/issues/1732)
-
-- [[SDL 0345] Android 12 Issues](https://github.com/smartdevicelink/sdl_java_suite/issues/1794)
-
-- [SdlRouterService crashes if SDL app sets targetSdkVersion to 31, and running on Android 12](https://github.com/smartdevicelink/sdl_java_suite/issues/1751)
-
-- [Error Code is cut off from bulk data when reading a SEND_INTERNAL_ERROR query](https://github.com/smartdevicelink/sdl_java_suite/issues/1790)
-
-- [NPE crash in BaseLifecycleManager on checkLifecycleConfiguration](https://github.com/smartdevicelink/sdl_java_suite/issues/1783)
-
-- [NPE crash in SdlDeviceListener](https://github.com/smartdevicelink/sdl_java_suite/issues/1780)
-
-- [NPE crash in BaseLifecycleManager](https://github.com/smartdevicelink/sdl_java_suite/issues/1781)
-
-- [SoftButtonObject doesn't handle error states correctly](https://github.com/smartdevicelink/sdl_java_suite/issues/1774)
-
-- [ScrollableMessage.timeout units should be specified in documentation](https://github.com/smartdevicelink/sdl_java_suite/issues/1775)
-
-- [Incorrect SPP error notification presented to user](https://github.com/smartdevicelink/sdl_java_suite/issues/1661)
-
-- [SecurityQuery error notification payload not set](https://github.com/smartdevicelink/sdl_java_suite/issues/1753)
-
-- [Menu Manager won't send submenu cell images on RPC versions >= 5.0 && < 7.0 #2047](https://github.com/smartdevicelink/sdl_java_suite/issues/1756)
-
-- [GenerateSources gradle task in javaSE incorrectly reads the version from gradle.properties instead of VERSION file](https://github.com/smartdevicelink/sdl_java_suite/issues/1763)
+- [Fix formatting of many tables within the documentation](https://github.com/smartdevicelink/sdl_java_suite/pull/1810)
 

VERSION

@@ -1 +1 @@
-5.4.0
+5.5.0

android/sdl_android/build.gradle

@@ -5,7 +5,7 @@ android {
     defaultConfig {
         minSdkVersion 16
         targetSdkVersion 31
-        versionCode 22
+        versionCode 23
         versionName new File(projectDir.path, ('/../../VERSION')).text.trim()
         buildConfigField "String", "VERSION_NAME", '\"' + versionName + '\"'
         resValue "string", "SDL_LIB_VERSION", '\"' + versionName + '\"'

android/sdl_android/src/androidTest/java/com/smartdevicelink/managers/screen/SoftButtonManagerTests.java

@@ -140,6 +140,7 @@ public Void answer(InvocationOnMock invocation) {
         taskmaster.start();
         when(internalInterface.getTaskmaster()).thenReturn(taskmaster);
         softButtonManager = new SoftButtonManager(internalInterface, fileManager);
+        softButtonManager.isDynamicGraphicSupported = true;
 
 
         // When internalInterface.sendRPC() is called inside SoftButtonManager:
@@ -516,4 +517,27 @@ public void testAssignSameNameStateListToSoftButtonObject() {
 
         assertEquals(stateListUnique, softButtonObject.getStates());
     }
+
+    @Test
+    public void testSoftButtonManagerGraphicNotSupported() {
+        softButtonManager.isDynamicGraphicSupported = false;
+        fileManagerUploadArtworksListenerCalledCounter = 0;
+        internalInterfaceSendRPCListenerCalledCounter = 0;
+
+        softButtonManager.setSoftButtonObjects(Arrays.asList(softButtonObject1, softButtonObject2));
+        assertEquals("SoftButtonManager is uploading artwork, when graphic is not supported", 0, fileManagerUploadArtworksListenerCalledCounter);
+    }
+
+    @Test
+    public void testSoftButtonManagerDynamicImageNotSupportedNoText() {
+        softButtonManager.isDynamicGraphicSupported = false;
+        fileManagerUploadArtworksListenerCalledCounter = 0;
+        internalInterfaceSendRPCListenerCalledCounter = 0;
+
+        SoftButtonState softButtonState = new SoftButtonState("testState", null, new SdlArtwork("image", FileType.GRAPHIC_PNG, 1, true));
+        SoftButtonObject softButtonObject = new SoftButtonObject("obj1", softButtonState, null);
+
+        softButtonManager.setSoftButtonObjects(Arrays.asList(softButtonObject));
+        assertEquals("SoftButtonManager is uploading artwork, when graphic is not supported", 0, fileManagerUploadArtworksListenerCalledCounter);
+    }
 }

base/src/main/java/com/smartdevicelink/managers/screen/BaseSoftButtonManager.java

@@ -43,6 +43,7 @@
 import com.smartdevicelink.managers.lifecycle.SystemCapabilityManager;
 import com.smartdevicelink.protocol.enums.FunctionID;
 import com.smartdevicelink.proxy.RPCNotification;
+import com.smartdevicelink.proxy.rpc.DisplayCapabilities;
 import com.smartdevicelink.proxy.rpc.DisplayCapability;
 import com.smartdevicelink.proxy.rpc.OnButtonEvent;
 import com.smartdevicelink.proxy.rpc.OnButtonPress;
@@ -58,7 +59,6 @@
 
 import java.lang.ref.WeakReference;
 import java.util.ArrayList;
-import java.util.HashSet;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -71,6 +71,7 @@ abstract class BaseSoftButtonManager extends BaseSubManager {
     private static final String TAG = "BaseSoftButtonManager";
     private final WeakReference<FileManager> fileManager;
     SoftButtonCapabilities softButtonCapabilities;
+    boolean isDynamicGraphicSupported;
     private CopyOnWriteArrayList<SoftButtonObject> softButtonObjects;
     private HMILevel currentHMILevel;
     private final OnSystemCapabilityListener onDisplayCapabilityListener;
@@ -99,6 +100,11 @@ abstract class BaseSoftButtonManager extends BaseSubManager {
         this.currentHMILevel = null;
         this.transactionQueue = newTransactionQueue();
         this.batchQueue = new ArrayList<>();
+        DisplayCapabilities displayCapabilities = null;
+        if (internalInterface.getSystemCapabilityManager() != null) {
+            displayCapabilities = (DisplayCapabilities) this.internalInterface.getSystemCapabilityManager().getCapability(SystemCapabilityType.DISPLAY, null, false);
+        }
+        isDynamicGraphicSupported = (displayCapabilities != null && displayCapabilities.getGraphicSupported() != null) ? displayCapabilities.getGraphicSupported() : true;
 
         this.updateListener = new SoftButtonObject.UpdateListener() {
             @Override
@@ -152,7 +158,7 @@ public void onCapabilityRetrieved(Object capability) {
 
                 // Auto-send an updated Show if we have new capabilities
                 if (softButtonObjects != null && !softButtonObjects.isEmpty() && softButtonCapabilities != null && !softButtonCapabilitiesEquals(oldSoftButtonCapabilities, softButtonCapabilities)) {
-                    SoftButtonReplaceOperation operation = new SoftButtonReplaceOperation(internalInterface, fileManager, softButtonCapabilities, softButtonObjects, getCurrentMainField1());
+                    SoftButtonReplaceOperation operation = new SoftButtonReplaceOperation(internalInterface, fileManager, softButtonCapabilities, softButtonObjects, getCurrentMainField1(), isDynamicGraphicSupported);
                     transactionQueue.add(operation, false);
                 }
             }
@@ -311,7 +317,7 @@ protected void setSoftButtonObjects(@NonNull List<SoftButtonObject> list) {
         this.softButtonObjects = softButtonObjects;
 
         // We only need to pass the first softButtonCapabilities in the array due to the fact that all soft button capabilities are the same (i.e. there is no way to assign a softButtonCapabilities to a specific soft button).
-        SoftButtonReplaceOperation operation = new SoftButtonReplaceOperation(internalInterface, fileManager.get(), softButtonCapabilities, softButtonObjects, getCurrentMainField1());
+        SoftButtonReplaceOperation operation = new SoftButtonReplaceOperation(internalInterface, fileManager.get(), softButtonCapabilities, softButtonObjects, getCurrentMainField1(), isDynamicGraphicSupported);
 
         if (batchUpdates) {
             batchQueue.clear();

base/src/main/java/com/smartdevicelink/managers/screen/SoftButtonReplaceOperation.java

@@ -10,6 +10,7 @@
 import com.smartdevicelink.proxy.rpc.Show;
 import com.smartdevicelink.proxy.rpc.SoftButton;
 import com.smartdevicelink.proxy.rpc.SoftButtonCapabilities;
+import com.smartdevicelink.proxy.rpc.enums.ImageType;
 import com.smartdevicelink.proxy.rpc.enums.SoftButtonType;
 import com.smartdevicelink.proxy.rpc.listeners.OnRPCResponseListener;
 import com.smartdevicelink.util.DebugTool;
@@ -30,14 +31,16 @@ class SoftButtonReplaceOperation extends Task {
     private final SoftButtonCapabilities softButtonCapabilities;
     private final CopyOnWriteArrayList<SoftButtonObject> softButtonObjects;
     private String currentMainField1;
+    private Boolean isDynamicGraphicSupported;
 
-    SoftButtonReplaceOperation(ISdl internalInterface, FileManager fileManager, SoftButtonCapabilities softButtonCapabilities, CopyOnWriteArrayList<SoftButtonObject> softButtonObjects, String currentMainField1) {
+    SoftButtonReplaceOperation(ISdl internalInterface, FileManager fileManager, SoftButtonCapabilities softButtonCapabilities, CopyOnWriteArrayList<SoftButtonObject> softButtonObjects, String currentMainField1, Boolean isDynamicGraphicSupported) {
         super("SoftButtonReplaceOperation");
         this.internalInterface = new WeakReference<>(internalInterface);
         this.fileManager = new WeakReference<>(fileManager);
         this.softButtonCapabilities = softButtonCapabilities;
         this.softButtonObjects = softButtonObjects;
         this.currentMainField1 = currentMainField1;
+        this.isDynamicGraphicSupported = isDynamicGraphicSupported;
     }
 
     @Override
@@ -65,6 +68,18 @@ public void onComplete(boolean success) {
                     onFinished();
                 }
             });
+        } else if (!supportsDynamicSoftButtonImages()) {
+            DebugTool.logInfo(TAG, "Soft button images are not supported. Attempting to send text and static image only soft buttons. If any button does not contain text and/or a static image, no buttons will be sent.");
+            sendCurrentStateStaticImageOnlySoftButtons(new CompletionListener() {
+                @Override
+                public void onComplete(boolean success) {
+                    if (!success) {
+                        DebugTool.logError(TAG, "Buttons will not be sent because the module does not support dynamic images and some of the buttons do not have text or static images");
+                    }
+                    onFinished();
+                }
+            });
+
         } else if (currentStateHasImages() && !allCurrentStateImagesAreUploaded()) {
             // If there are images that aren't uploaded
             // Send text buttons if all the soft buttons have text
@@ -128,6 +143,13 @@ private void uploadInitialStateImages(final CompletionListener completionListene
             }
             return;
         }
+        if (!supportsDynamicSoftButtonImages()) {
+            DebugTool.logInfo(TAG, "Head unit does not support dynamic images, skipping upload");
+            if (completionListener != null) {
+                completionListener.onComplete(false);
+            }
+            return;
+        }
 
         DebugTool.logInfo(TAG, "Uploading soft button initial artworks");
         if (fileManager.get() != null) {
@@ -236,6 +258,59 @@ public void onResponse(int correlationId, RPCResponse response) {
         }
     }
 
+    // Send soft buttons for the current state that only contain text and static images only, if possible.
+    private void sendCurrentStateStaticImageOnlySoftButtons(final CompletionListener completionListener) {
+        if (getState() == Task.CANCELED) {
+            onFinished();
+        }
+
+        DebugTool.logInfo(TAG, "Preparing to send text and static image only soft buttons");
+        List<SoftButton> textButtons = new ArrayList<>();
+        for (SoftButtonObject softButtonObject : softButtonObjects) {
+            SoftButton softButton = softButtonObject.getCurrentStateSoftButton();
+            if (softButton.getText() == null && softButton.getImage() != null && softButton.getImage().getImageType() == ImageType.DYNAMIC) {
+                DebugTool.logWarning(TAG, "Attempted to create text and static image only buttons, but some buttons don't support text and have dynamic images, so no soft buttons will be sent.");
+                if (completionListener != null) {
+                    completionListener.onComplete(false);
+                }
+                return;
+            }
+
+
+            if (softButton.getImage() != null && softButton.getImage().getImageType() == ImageType.DYNAMIC) {
+                // We should create a new softButtonObject rather than modifying the original one
+                SoftButton textAndStaticImageOnlySoftButton = new SoftButton(SoftButtonType.SBT_TEXT, softButton.getSoftButtonID());
+                textAndStaticImageOnlySoftButton.setText(softButton.getText());
+                textAndStaticImageOnlySoftButton.setSystemAction(softButton.getSystemAction());
+                textAndStaticImageOnlySoftButton.setIsHighlighted(softButton.getIsHighlighted());
+                textAndStaticImageOnlySoftButton.setImage(softButton.getImage());
+                textButtons.add(textAndStaticImageOnlySoftButton);
+            } else {
+                textButtons.add(softButton);
+            }
+        }
+
+        Show show = new Show();
+        show.setOnRPCResponseListener(new OnRPCResponseListener() {
+            @Override
+            public void onResponse(int correlationId, RPCResponse response) {
+                if (response.getSuccess()) {
+                    DebugTool.logInfo(TAG, "Finished sending text and static image only soft buttons");
+                } else {
+                    DebugTool.logWarning(TAG, "Failed to update soft buttons with text and static image only buttons");
+                }
+                if (completionListener != null) {
+                    completionListener.onComplete(response.getSuccess());
+                }
+            }
+        });
+        show.setMainField1(currentMainField1);
+        show.setSoftButtons(textButtons);
+        if (internalInterface.get() != null) {
+            internalInterface.get().sendRPC(show);
+        }
+    }
+
 
     // Returns text soft buttons representing the current states of the button objects, or returns if _any_ of the buttons' current states are image only buttons.
     private void sendCurrentStateTextOnlySoftButtons(final CompletionListener completionListener) {
@@ -303,6 +378,10 @@ private boolean allCurrentStateImagesAreUploaded() {
         return true;
     }
 
+    private boolean supportsDynamicSoftButtonImages() {
+        return softButtonCapabilities != null && Boolean.TRUE.equals(isDynamicGraphicSupported) && Boolean.TRUE.equals(softButtonCapabilities.getImageSupported());
+    }
+
     private boolean supportsSoftButtonImages() {
         return softButtonCapabilities != null && Boolean.TRUE.equals(softButtonCapabilities.getImageSupported());
     }

base/src/main/java/com/smartdevicelink/proxy/rpc/AddCommand.java

@@ -113,9 +113,7 @@
  *          <td>Optional secondary image struct for menu cell</td>
  *          <td>N</td>
  *          <td></td>
- *          <td>
- *             @since SmartDeviceLink 7.1.0
- *          </td>
+ *        <td>SmartDeviceLink 7.1.0</td>
  *      </tr>
  *  </table>
  * <p> <b>Response</b></p><p>Indicates that the corresponding request has failed or succeeded, if the response returns with a SUCCESS result code, this means a command was added to the Command Menu successfully.</p>

base/src/main/java/com/smartdevicelink/proxy/rpc/AddSubMenu.java

@@ -112,29 +112,23 @@
  *          <td>Optional secondary text to display</td>
  *          <td>N</td>
  *          <td>{"string_min_length": 1, "string_max_length": 500}</td>
- *          <td>
- *             @since SmartDeviceLink 7.1.0
- *          </td>
+ *          <td>SmartDeviceLink 7.1.0</td>
  *      </tr>
  *      <tr>
  *          <td>tertiaryText</td>
  *          <td>String</td>
  *          <td>Optional tertiary text to display</td>
  *          <td>N</td>
  *          <td>{"string_min_length": 1, "string_max_length": 500}</td>
- *          <td>
- *             @since SmartDeviceLink 7.1.0
- *          </td>
+ *          <td>SmartDeviceLink 7.1.0</td>
  *      </tr>
  *      <tr>
  *          <td>secondaryImage</td>
  *          <td>Image</td>
  *          <td>Optional secondary image struct for sub-menu cell</td>
  *          <td>N</td>
  *          <td></td>
- *          <td>
- *             @since SmartDeviceLink 7.1.0
- *          </td>
+ *          <td>SmartDeviceLink 7.1.0</td>
  *      </tr>
  *  </table>
  *  <b>Response</b>