Issue 15828 - Notification comment support in the new comment editor

RELEASE-NOTES.txt

@@ -2,7 +2,7 @@
 
 19.3
 -----
-
+* [*] Comment editor: Notification comments support in the new editor [https://github.com/wordpress-mobile/WordPress-Android/pull/15884]
 
 19.2
 -----

WordPress/src/main/java/org/wordpress/android/ui/comments/CommentDetailFragment.java

@@ -72,6 +72,10 @@
 import org.wordpress.android.ui.ViewPagerFragment;
 import org.wordpress.android.ui.comments.CommentActions.OnCommentActionListener;
 import org.wordpress.android.ui.comments.CommentActions.OnNoteCommentActionListener;
+import org.wordpress.android.ui.comments.unified.CommentIdentifier;
+import org.wordpress.android.ui.comments.unified.CommentIdentifier.NotificationCommentIdentifier;
+import org.wordpress.android.ui.comments.unified.CommentIdentifier.SiteCommentIdentifier;
+import org.wordpress.android.ui.comments.unified.CommentSource;
 import org.wordpress.android.ui.comments.unified.CommentsStoreAdapter;
 import org.wordpress.android.ui.comments.unified.UnifiedCommentsEditActivity;
 import org.wordpress.android.ui.notifications.NotificationEvents;
@@ -101,7 +105,6 @@
 import org.wordpress.android.util.ViewUtilsKt;
 import org.wordpress.android.util.WPLinkMovementMethod;
 import org.wordpress.android.util.analytics.AnalyticsUtils;
-import org.wordpress.android.util.analytics.AnalyticsUtils.AnalyticsCommentActionSource;
 import org.wordpress.android.util.config.UnifiedCommentsCommentEditFeatureConfig;
 import org.wordpress.android.util.image.ImageManager;
 import org.wordpress.android.util.image.ImageType;
@@ -137,22 +140,6 @@ public class CommentDetailFragment extends ViewPagerFragment implements Notifica
 
     private static final int INTENT_COMMENT_EDITOR = 1010;
 
-    enum CommentSource {
-        NOTIFICATION,
-        SITE_COMMENTS;
-
-        AnalyticsCommentActionSource toAnalyticsCommentActionSource() {
-            switch (this) {
-                case NOTIFICATION:
-                    return AnalyticsCommentActionSource.NOTIFICATIONS;
-                case SITE_COMMENTS:
-                    return AnalyticsCommentActionSource.SITE_COMMENTS;
-            }
-            throw new IllegalArgumentException(
-                    this + " CommentSource is not mapped to corresponding AnalyticsCommentActionSource");
-        }
-    }
-
     private CommentModel mComment;
     private SiteModel mSite;
 
@@ -683,12 +670,10 @@ private void editComment() {
         // IMPORTANT: don't use getActivity().startActivityForResult() or else onActivityResult()
         // won't be called in this fragment
         // https://code.google.com/p/android/issues/detail?id=15394#c45
-        if (mUnifiedCommentsCommentEditFeatureConfig.isEnabled() && mCommentSource == CommentSource.SITE_COMMENTS) {
-            Intent intent = new Intent(getActivity(), UnifiedCommentsEditActivity.class);
-            intent.putExtra(WordPress.SITE, mSite);
-            if (mComment != null) {
-                intent.putExtra(UnifiedCommentsEditActivity.KEY_COMMENT_ID, mComment.getId());
-            }
+        if (mUnifiedCommentsCommentEditFeatureConfig.isEnabled()) {
+            final CommentIdentifier commentIdentifier = mapCommentIdentifier();
+            final Intent intent =
+                    UnifiedCommentsEditActivity.createIntent(requireActivity(), commentIdentifier, mSite);
             startActivityForResult(intent, INTENT_COMMENT_EDITOR);
         } else {
             Intent intent = new Intent(getActivity(), EditCommentActivity.class);
@@ -701,6 +686,19 @@ private void editComment() {
         }
     }
 
+    // TODO [RenanLukas] handle Reader CommentSource when it's ready
+    @Nullable
+    private CommentIdentifier mapCommentIdentifier() {
+        switch (mCommentSource) {
+            case SITE_COMMENTS:
+                return new SiteCommentIdentifier(mComment.getId(), mComment.getRemoteCommentId());
+            case NOTIFICATION:
+                return new NotificationCommentIdentifier(mNote.getCommentId());
+            default:
+                return null;
+        }
+    }
+
     /*
      * display the current comment
      */

WordPress/src/main/java/org/wordpress/android/ui/comments/unified/CommentEssentials.kt

@@ -0,0 +1,19 @@
+package org.wordpress.android.ui.comments.unified
+
+data class CommentEssentials(
+    val commentId: Long = DEFAULT_COMMENT_ID,
+    val userName: String = "",
+    val commentText: String = "",
+    val userUrl: String = "",
+    val userEmail: String = ""
+) {
+    /**
+     * Checks if this instance of CommentEssentials is valid. An invalid instance should not be used to display data.
+     * @return true if the instance is valid or false if it's not
+     */
+    fun isValid(): Boolean = commentId > DEFAULT_COMMENT_ID
+
+    companion object {
+        private const val DEFAULT_COMMENT_ID = -1L
+    }
+}

WordPress/src/main/java/org/wordpress/android/ui/comments/unified/CommentIdentifier.kt

@@ -0,0 +1,26 @@
+package org.wordpress.android.ui.comments.unified
+
+import android.os.Parcelable
+import kotlinx.parcelize.Parcelize
+
+sealed class CommentIdentifier : Parcelable {
+    abstract val remoteCommentId: Long
+
+    @Parcelize
+    data class SiteCommentIdentifier(
+        val localCommentId: Int,
+        override val remoteCommentId: Long
+    ) : CommentIdentifier()
+
+    @Parcelize
+    data class ReaderCommentIdentifier(
+        val blogId: Long,
+        val postId: Long,
+        override val remoteCommentId: Long
+    ) : CommentIdentifier()
+
+    @Parcelize
+    data class NotificationCommentIdentifier(
+        override val remoteCommentId: Long
+    ) : CommentIdentifier()
+}

WordPress/src/main/java/org/wordpress/android/ui/comments/unified/CommentSource.kt

@@ -0,0 +1,13 @@
+package org.wordpress.android.ui.comments.unified
+
+import org.wordpress.android.util.analytics.AnalyticsUtils.AnalyticsCommentActionSource
+
+enum class CommentSource {
+    NOTIFICATION, SITE_COMMENTS;
+
+    fun toAnalyticsCommentActionSource(): AnalyticsCommentActionSource =
+            when (this) {
+                NOTIFICATION -> AnalyticsCommentActionSource.NOTIFICATIONS
+                SITE_COMMENTS -> AnalyticsCommentActionSource.SITE_COMMENTS
+            }
+}

WordPress/src/main/java/org/wordpress/android/ui/comments/unified/UnifiedCommentsEditActivity.kt

@@ -1,5 +1,7 @@
 package org.wordpress.android.ui.comments.unified
 
+import android.content.Context
+import android.content.Intent
 import android.os.Bundle
 import org.wordpress.android.R
 import org.wordpress.android.WordPress
@@ -16,24 +18,34 @@ class UnifiedCommentsEditActivity : LocaleAwareActivity() {
         }
 
         val site = intent.getSerializableExtra(WordPress.SITE) as SiteModel
-        val commentId: Int = intent.getIntExtra(KEY_COMMENT_ID, 0)
+        val commentIdentifier = requireNotNull(intent.getParcelableExtra<CommentIdentifier>(KEY_COMMENT_IDENTIFIER))
 
         val fm = supportFragmentManager
         var editCommentFragment = fm.findFragmentByTag(
                 TAG_UNIFIED_EDIT_COMMENT_FRAGMENT
         ) as? UnifiedCommentsEditFragment
 
         if (editCommentFragment == null) {
-            editCommentFragment = UnifiedCommentsEditFragment.newInstance(site, commentId)
+            editCommentFragment = UnifiedCommentsEditFragment.newInstance(site, commentIdentifier)
             fm.beginTransaction()
                     .add(R.id.fragment_container, editCommentFragment, TAG_UNIFIED_EDIT_COMMENT_FRAGMENT)
                     .commit()
         }
     }
 
     companion object {
-        const val KEY_COMMENT_ID = "key_comment_id"
-
+        @JvmStatic
+        fun createIntent(
+            context: Context,
+            commentIdentifier: CommentIdentifier,
+            siteModel: SiteModel
+        ): Intent =
+                Intent(context, UnifiedCommentsEditActivity::class.java).apply {
+                    putExtra(KEY_COMMENT_IDENTIFIER, commentIdentifier)
+                    putExtra(WordPress.SITE, siteModel)
+                }
+
+        private const val KEY_COMMENT_IDENTIFIER = "key_comment_identifier"
         private const val TAG_UNIFIED_EDIT_COMMENT_FRAGMENT = "tag_unified_edit_comment_fragment"
     }
 }

WordPress/src/main/java/org/wordpress/android/ui/comments/unified/UnifiedCommentsEditFragment.kt

@@ -55,11 +55,15 @@ class UnifiedCommentsEditFragment : Fragment(R.layout.unified_comments_edit_frag
         super.onViewCreated(view, savedInstanceState)
 
         val site = requireArguments().getSerializable(WordPress.SITE) as SiteModel
-        val commentId = requireArguments().getInt(KEY_COMMENT_ID)
+        val commentIdentifier = requireNotNull(
+                requireArguments().getParcelable<CommentIdentifier>(
+                        KEY_COMMENT_IDENTIFIER
+                )
+        )
 
         UnifiedCommentsEditFragmentBinding.bind(view).apply {
             setupToolbar()
-            setupObservers(site, commentId)
+            setupObservers(site, commentIdentifier)
         }
     }
 
@@ -89,7 +93,10 @@ class UnifiedCommentsEditFragment : Fragment(R.layout.unified_comments_edit_frag
         ActivityUtils.hideKeyboardForced(view)
     }
 
-    private fun UnifiedCommentsEditFragmentBinding.setupObservers(site: SiteModel, commentId: Int) {
+    private fun UnifiedCommentsEditFragmentBinding.setupObservers(
+        site: SiteModel,
+        commentIdentifier: CommentIdentifier
+    ) {
         viewModel.uiActionEvent.observeEvent(viewLifecycleOwner, {
             when (it) {
                 CLOSE -> {
@@ -144,7 +151,7 @@ class UnifiedCommentsEditFragment : Fragment(R.layout.unified_comments_edit_frag
             }
         })
 
-        viewModel.start(site, commentId)
+        viewModel.start(site, commentIdentifier)
     }
 
     private fun UnifiedCommentsEditFragmentBinding.showSnackbar(holder: SnackbarMessageHolder) {
@@ -210,13 +217,13 @@ class UnifiedCommentsEditFragment : Fragment(R.layout.unified_comments_edit_frag
     }
 
     companion object {
-        private const val KEY_COMMENT_ID = "key_comment_id"
+        private const val KEY_COMMENT_IDENTIFIER = "key_comment_identifier"
 
-        fun newInstance(site: SiteModel, commentId: Int): UnifiedCommentsEditFragment {
+        fun newInstance(site: SiteModel, commentIdentifier: CommentIdentifier): UnifiedCommentsEditFragment {
             val args = Bundle()
 
             args.putSerializable(WordPress.SITE, site)
-            args.putInt(KEY_COMMENT_ID, commentId)
+            args.putParcelable(KEY_COMMENT_IDENTIFIER, commentIdentifier)
 
             val fragment = UnifiedCommentsEditFragment()