Merge pull request #8 from adobe/dev-2.0.0

.circleci/config.yml

@@ -44,12 +44,12 @@ jobs:
           command: make unit-test-coverage
 
       - store_test_results:
-          path: code/android-media-library/build/test-results/testPhoneDebugUnitTest
+          path: code/media/build/test-results/testPhoneDebugUnitTest
 
       - run:
           name: Upload unit test coverage
           command: |            
-            bash ./codecov -v -X s3 -c -D "./code/android-media-library/build/reports/coverage/test/phone/debug" -F unit-tests
+            bash ./codecov -v -X s3 -c -D "./code/media/build/reports/coverage/test/phone/debug" -F unit-tests
 
   functional-test:
       executor:
@@ -79,7 +79,7 @@ jobs:
         - run:
             name: Upload coverage report
             command: |                        
-              bash ./codecov -v -X s3 -c -D "./code/android-media-library/build/reports/coverage/androidTest/phone/debug" -F functional-tests
+              bash ./codecov -v -X s3 -c -D "./code/media/build/reports/coverage/androidTest/phone/debug" -F functional-tests
 
 workflows:
   version: 2

docs/Media.md → Documentation/APIReference.md

@@ -720,4 +720,4 @@ tracker.updateQoEObject(qoeObject);
 
 ## Media Constants
 
-Refer [MediaConstants.java](../code/android-media-library/src/phone/java/com/adobe/marketing/mobile/MediaConstants.java) to see the constants exposed by Media extension. 
+Refer [MediaConstants.java](../code/media/src/phone/java/com/adobe/marketing/mobile/MediaConstants.java) to see the constants exposed by Media extension. 

Documentation/README.md

@@ -0,0 +1,4 @@
+# Media extension documentation
+
+## Contents
+- [API reference](APIReference.md)

Makefile

@@ -1,4 +1,4 @@
-EXTENSION-LIBRARY-FOLDER-NAME = android-media-library
+EXTENSION-LIBRARY-FOLDER-NAME = media
 TEST-APP-FOLDER-NAME = testapp
 
 BUILD-ASSEMBLE-LOCATION = ./ci/assemble

code/gradle.properties

@@ -2,13 +2,15 @@ org.gradle.jvmargs=-Xmx2048m
 android.injected.testOnly=false
 org.gradle.configureondemand=false
 
-moduleProjectName=android-media-library
+moduleProjectName=media
 moduleName=media
-moduleAARName=android-media-library-phone-release.aar
+moduleAARName=media-phone-release.aar
 moduleVersion=3.0.0
 
 mavenRepoName=AdobeMobileMediaSdk
 mavenRepoDescription=Android Analytics Extension for Audio and Video.
 mavenUploadDryRunFlag=false
 mavenCoreVersion=2.0.0
-android.useAndroidX=true
+android.useAndroidX=true
+
+android.disableAutomaticComponentCreation=true

code/android-media-library/src/androidTest/java/com/adobe/marketing/mobile/media/MediaDBServiceTests.java → code/media/src/androidTest/java/com/adobe/marketing/mobile/media/internal/MediaDBServiceTests.java

@@ -9,14 +9,16 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import static org.junit.Assert.*;
 
 import android.content.Context;
 import androidx.test.core.app.ApplicationProvider;
 import com.adobe.marketing.mobile.services.MockAppContextService;
 import com.adobe.marketing.mobile.services.ServiceProviderExtension;
+import java.io.File;
+import java.io.IOException;
 import java.util.*;
 import org.junit.Test;
 
@@ -273,4 +275,26 @@ public void test_deleteAllHits_multipleSessionsPresent() {
             assertTrue(hits.isEmpty());
         }
     }
+
+    @Test
+    public void test_deleteDeprecatedDatabaseFile() throws IOException {
+        // Setup
+        Context context = ApplicationProvider.getApplicationContext();
+        final String DEPRECATED_2X_DB_FILE_NAME = "ADBMobileMedia.sqlite";
+        File oldDB = new File(context.getCacheDir(), DEPRECATED_2X_DB_FILE_NAME);
+        oldDB.createNewFile();
+
+        File newDB = context.getDatabasePath(MEDIA_DATABASE);
+        newDB.delete();
+
+        // Before upgrade
+        assertTrue(oldDB.exists());
+        assertFalse(newDB.exists());
+
+        MediaDBService dbService = new MediaDBServiceImpl();
+
+        // After upgrade
+        assertFalse(oldDB.exists());
+        assertTrue(newDB.exists());
+    }
 }

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaCollectionConstants.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaCollectionConstants.java

@@ -9,12 +9,15 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 class MediaCollectionConstants {
 
     private MediaCollectionConstants() {}
 
+    static final String MEDIA_LIBRARY_VERSION =
+            "android-media-" + com.adobe.marketing.mobile.Media.extensionVersion();
+
     static final class EventType {
         private EventType() {}
 

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaCollectionHelper.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaCollectionHelper.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import java.util.HashMap;
 import java.util.Map;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaCollectionHitGenerator.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaCollectionHitGenerator.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import com.adobe.marketing.mobile.services.Log;
 import com.adobe.marketing.mobile.util.DataReader;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaCollectionTracker.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaCollectionTracker.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import androidx.annotation.VisibleForTesting;
 import com.adobe.marketing.mobile.Event;
@@ -270,6 +270,12 @@ String getError(final Map<String, Object> context) {
                 return info != null && StateInfo.fromObjectMap(info) != null;
             };
 
+    IMediaRuleCallback isValidErrorInfo =
+            (rule, context) -> {
+                String errorId = getError(context);
+                return errorId != null && !errorId.isEmpty();
+            };
+
     IMediaRuleCallback isDifferentAdBreakInfo =
             (rule, context) -> {
                 if (!mediaContext.isInAdBreak()) {
@@ -753,7 +759,9 @@ void setUpMediaRules() {
 
         // MediaRule::trackError
         MediaRule error = new MediaRule(MediaRuleName.Error.ordinal(), "API::trackError");
-        error.addPredicate(isInMedia, true, ErrorMessage.ErrNotInMedia).addAction(cmdError);
+        error.addPredicate(isInMedia, true, ErrorMessage.ErrNotInMedia)
+                .addPredicate(isValidErrorInfo, true, ErrorMessage.ErrInvalidErrorId)
+                .addAction(cmdError);
 
         ruleEngine.addRule(error);
 
@@ -1233,6 +1241,9 @@ class ErrorMessage {
             "Media tracker is not tracking the State passed into 'API:trackEvent(StateEnd)'.";
     static final String ErrTrackedStatesLimitReached =
             "Media tracker is already tracking maximum allowed states (10) per session.";
+    static final String ErrInvalidErrorId =
+            "ErrorId passed into 'API:trackError' is invalid. Please pass valid non-empty non-null"
+                    + " string for ErrorId.";
 }
 
 class PrerollQueuedRule {

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaContext.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaContext.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import com.adobe.marketing.mobile.services.Log;
 import java.util.ArrayList;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaDBService.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaDBService.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import java.util.List;
 import java.util.Set;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaDBServiceImpl.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaDBServiceImpl.java

@@ -9,11 +9,12 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import com.adobe.marketing.mobile.services.Log;
 import com.adobe.marketing.mobile.util.DataReader;
 import com.adobe.marketing.mobile.util.JSONUtils;
+import com.adobe.marketing.mobile.util.SQLiteUtils;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -25,6 +26,9 @@
 
 class MediaDBServiceImpl implements MediaDBService {
     private static final String LOG_TAG = "MediaDBService";
+    private static final String MEDIA_DB_FILE_NAME = MediaInternalConstants.Media.SHARED_STATE_NAME;
+    private static final String DEPRECATED_2X_DB_FILE_NAME = "ADBMobileMedia.sqlite";
+
     private MediaDatabase database;
 
     private static final String KEY_EVENT_TYPE = "eventtype";
@@ -36,7 +40,16 @@ class MediaDBServiceImpl implements MediaDBService {
 
     MediaDBServiceImpl() {
         try {
-            database = new MediaDatabase();
+            // Delete deprecated 2X database from cache directory.
+            if (SQLiteUtils.deleteDBFromCacheDir(DEPRECATED_2X_DB_FILE_NAME)) {
+                Log.debug(
+                        MediaInternalConstants.EXTENSION_LOG_TAG,
+                        LOG_TAG,
+                        "Media 2.x database file (%s) deleted.",
+                        DEPRECATED_2X_DB_FILE_NAME);
+            }
+
+            database = new MediaDatabase(MEDIA_DB_FILE_NAME);
         } catch (Exception ex) {
             Log.trace(
                     MediaInternalConstants.EXTENSION_LOG_TAG,
@@ -47,7 +60,7 @@ class MediaDBServiceImpl implements MediaDBService {
         }
     }
 
-    String serializeHit(final MediaHit mediaHit) {
+    private String serializeHit(final MediaHit mediaHit) {
         if (mediaHit == null) {
             return null;
         }
@@ -62,7 +75,7 @@ String serializeHit(final MediaHit mediaHit) {
         return new JSONObject(mediaHitMap).toString();
     }
 
-    MediaHit deserializeHit(final String mediaHitStr) {
+    private MediaHit deserializeHit(final String mediaHitStr) {
         try {
             Map<String, Object> mediaHitMap = JSONUtils.toMap(new JSONObject(mediaHitStr));
 

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaDatabase.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaDatabase.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import android.content.ContentValues;
 import android.content.Context;
@@ -28,7 +28,6 @@
 
 class MediaDatabase {
     private static final String LOG_TAG = "MediaDatabase";
-    private static final String MEDIA_DB_FILE_NAME = MediaInternalConstants.Media.SHARED_STATE_NAME;
     private static final String MEDIA_TABLE_NAME = "MEDIAHITS";
 
     private static final String TB_KEY_ID = "id";
@@ -38,13 +37,13 @@ class MediaDatabase {
     private final String dbPath;
     private final Object dbMutex;
 
-    MediaDatabase() {
+    MediaDatabase(final String dbName) {
         Context context =
                 ServiceProvider.getInstance().getAppContextService().getApplicationContext();
         if (context == null) {
             throw new IllegalStateException("Context is null");
         }
-        File database = context.getDatabasePath(MEDIA_DB_FILE_NAME);
+        File database = context.getDatabasePath(dbName);
         dbPath = database.getPath();
         dbMutex = new Object();
         createTableIfNotExist();

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaExtension.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaExtension.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaHit.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaHit.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import java.util.HashMap;
 import java.util.Map;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaHitProcessor.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaHitProcessor.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 interface MediaHitProcessor {
     String startSession();

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaInternalConstants.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaInternalConstants.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 final class MediaInternalConstants {
     static final String EXTENSION_LOG_TAG = "Media";

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaObject.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaObject.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import com.adobe.marketing.mobile.Media;
 import com.adobe.marketing.mobile.services.Log;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaOfflineService.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaOfflineService.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import com.adobe.marketing.mobile.MobilePrivacyStatus;
 import com.adobe.marketing.mobile.services.HttpMethod;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaRealTimeService.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaRealTimeService.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import com.adobe.marketing.mobile.MobilePrivacyStatus;
 import com.adobe.marketing.mobile.services.Log;

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaReportHelper.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaReportHelper.java

@@ -9,9 +9,8 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
-import com.adobe.marketing.mobile.Media;
 import com.adobe.marketing.mobile.MobilePrivacyStatus;
 import com.adobe.marketing.mobile.VisitorID;
 import com.adobe.marketing.mobile.services.DeviceInforming;
@@ -155,7 +154,8 @@ static Map<String, Object> mediaHitToEventData(
             }
 
             params.put(
-                    MediaCollectionConstants.Session.MEDIA_VERSION.key, Media.extensionVersion());
+                    MediaCollectionConstants.Session.MEDIA_VERSION.key,
+                    MediaCollectionConstants.MEDIA_LIBRARY_VERSION);
 
             // Remove sessionID from params
             params.remove(MediaInternalConstants.EventDataKeys.Tracker.SESSION_ID);

code/android-media-library/src/main/java/com/adobe/marketing/mobile/media/MediaRuleEngine.java → code/media/src/main/java/com/adobe/marketing/mobile/media/internal/MediaRuleEngine.java

@@ -9,7 +9,7 @@
   governing permissions and limitations under the License.
 */
 
-package com.adobe.marketing.mobile.media;
+package com.adobe.marketing.mobile.media.internal;
 
 import com.adobe.marketing.mobile.services.Log;
 import java.util.HashMap;