FIX: Shortcut is not working as expected on Android R.

Also rename the fields "id" to "nid" and "key" to "id" with comments to better reflect their actual roles.

Author: oasisfeng

src/main/java/com/oasisfeng/nevo/decorators/wechat/AgentShortcuts.kt

@@ -7,7 +7,6 @@ import android.content.pm.PackageManager
 import android.content.pm.PackageManager.GET_ACTIVITIES
 import android.content.pm.ShortcutInfo
 import android.content.pm.ShortcutManager
-import android.graphics.drawable.Icon
 import android.graphics.drawable.Icon.TYPE_RESOURCE
 import android.os.Build.VERSION.SDK_INT
 import android.os.Build.VERSION_CODES.N
@@ -21,7 +20,6 @@ import android.util.Log
 import android.util.LruCache
 import androidx.annotation.RequiresApi
 import androidx.core.content.getSystemService
-import androidx.core.graphics.drawable.IconCompat
 import com.oasisfeng.nevo.decorators.wechat.ConversationManager.Conversation
 import com.oasisfeng.nevo.decorators.wechat.WeChatDecorator.AGENT_PACKAGE
 import com.oasisfeng.nevo.decorators.wechat.WeChatDecorator.TAG
@@ -50,8 +48,8 @@ import java.lang.reflect.Method
 		if (count >= sm.maxShortcutCountPerActivity - sm.manifestShortcuts.size)
 			sm.removeDynamicShortcuts(listOf(shortcuts.removeAt(0).id.also { Log.i(TAG, "Evict excess shortcut: $it") }))
 
-		val intent = if (conversation.ext != null) Intent().setClassName(WECHAT_PACKAGE, "com.tencent.mm.ui.LauncherUI")
-				.putExtra("Main_User", conversation.key).putExtra(@Suppress("SpellCheckingInspection") "Intro_Is_Muti_Talker", false)
+		val intent = if (conversation.id != null) Intent().setClassName(WECHAT_PACKAGE, "com.tencent.mm.ui.LauncherUI")
+				.putExtra("Main_User", conversation.id).putExtra(@Suppress("SpellCheckingInspection") "Intro_Is_Muti_Talker", false)
 				.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY)
 		else {
 			val bubbleActivity = (mAgentBubbleActivity
@@ -71,7 +69,7 @@ import java.lang.reflect.Method
 					if (SDK_INT >= Q) @SuppressLint("RestrictedApi") {
 						setLongLived(true).setLocusId(LocusId(id))
 						if (! conversation.isGroupChat) setPerson(conversation.sender().build().toAndroidPerson()) }}.build()
-		if (BuildConfig.DEBUG) { Log.i(TAG, "Updating shortcut \"${shortcut.id}\": ${shortcut.intent.toString()}") }
+		Log.i(TAG, "Updating shortcut \"${shortcut.id}\"${if (BuildConfig.DEBUG) ": " + shortcut.intent.toString() else ""}")
 		return if (sm.addDynamicShortcuts(listOf(shortcut))) true.also { Log.i(TAG, "Shortcut updated: $id") }
 		else false.also { Log.e(TAG, "Unexpected rate limit.") }
 	}

src/main/java/com/oasisfeng/nevo/decorators/wechat/ConversationManager.java

@@ -38,8 +38,8 @@ public static class Conversation {
 
 		private static final String SCHEME_ORIGINAL_NAME = "ON:";
 
-		final int id;
-		volatile @Nullable String key;       // The user name in WeChat
+		final int nid;                  // The notification ID of conversation (hash code of "id" below)
+		volatile @Nullable String id;   // The unique ID of conversation in WeChat
 		int count;
 		CharSequence title;
 		CharSequence summary;
@@ -54,7 +54,7 @@ int setType(final int type) {
 			if (type == mType) return type;
 			final int previous_type = mType;
 			mType = type;
-			sender = type == TYPE_UNKNOWN || type == TYPE_GROUP_CHAT ? null : sender().setKey(key).setBot(type == TYPE_BOT_MESSAGE);	// Always set key as it may change
+			sender = type == TYPE_UNKNOWN || type == TYPE_GROUP_CHAT ? null : sender().setKey(id).setBot(type == TYPE_BOT_MESSAGE);	// Always set key as it may change
 			if (type != TYPE_GROUP_CHAT) mParticipants.clear();
 			return previous_type;
 		}
@@ -98,7 +98,7 @@ static CharSequence getOriginalName(final Person person) {
 			return uri != null && uri.startsWith(SCHEME_ORIGINAL_NAME) ? uri.substring(SCHEME_ORIGINAL_NAME.length()): person.getName();
 		}
 
-		Conversation(final int id) { this.id = id; }
+		Conversation(final int nid) { this.nid = nid; }
 
 		@ConversationType private int mType;
 		private final Map<String, Person> mParticipants = new ArrayMap<>();

src/main/java/com/oasisfeng/nevo/decorators/wechat/MessagingBuilder.java

@@ -149,11 +149,11 @@ class MessagingBuilder {
 		final RemoteInput remote_input;
 		if (SDK_INT >= N && on_reply != null && (remote_input = ext.getRemoteInput()) != null && conversation.isChat()) {
 			final CharSequence[] input_history = n.extras.getCharSequenceArray(EXTRA_REMOTE_INPUT_HISTORY);
-			final PendingIntent proxy = proxyDirectReply(conversation.id, sbn, on_reply, remote_input, input_history);
+			final PendingIntent proxy = proxyDirectReply(conversation.nid, sbn, on_reply, remote_input, input_history);
 			final RemoteInput.Builder reply_remote_input = new RemoteInput.Builder(remote_input.getResultKey()).addExtras(remote_input.getExtras())
 					.setAllowFreeFormInput(true).setChoices(SmartReply.generateChoices(messages));
 			final String participant = ext.getParticipant();	// No need to getParticipants() due to actually only one participant at most, see CarExtender.Builder().
-			if (BuildConfig.DEBUG && conversation.key != null) reply_remote_input.setLabel(conversation.key);
+			if (BuildConfig.DEBUG && conversation.id != null) reply_remote_input.setLabel(conversation.id);
 			else if (participant != null) reply_remote_input.setLabel(participant);
 
 			final Action.Builder reply_action = new Action.Builder(null, mContext.getString(R.string.action_reply), proxy)
@@ -172,11 +172,11 @@ static void showDebugNotification(final Context context, final Conversation conv
 		final String[] messages = convs.ext != null ? convs.ext.getMessages() : null;
 		if (messages != null) for (final String msg : messages) bigText.append("\n").append(msg);
 		final Builder n = new Builder(context).setSmallIcon(android.R.drawable.stat_sys_warning)
-				.setContentTitle(convs.key).setContentText(convs.ticker).setSubText(summary).setShowWhen(true)
+				.setContentTitle(convs.id).setContentText(convs.ticker).setSubText(summary).setShowWhen(true)
 				.setStyle(new BigTextStyle().setBigContentTitle(convs.title).bigText(bigText.toString()));
 		if (SDK_INT >= O) n.setChannelId("Debug");
 		requireNonNull(context.getSystemService(NotificationManager.class))
-				.notify(convs.key != null ? convs.key.hashCode() : convs.title.hashCode(), n.build());
+				.notify(convs.id != null ? convs.id.hashCode() : convs.title.hashCode(), n.build());
 	}
 
 	private static Message buildMessage(final Conversation conversation, final long when, final @Nullable CharSequence ticker,

src/main/java/com/oasisfeng/nevo/decorators/wechat/WeChatDecorator.java

@@ -188,26 +188,27 @@ public class WeChatDecorator extends NevoDecoratorService {
 		final List<MessagingStyle.Message> messages = messaging.getMessages();
 		if (messages.isEmpty()) return true;
 
-		if (conversation.key == null && mActivityBlocker != null) try {
+		if (conversation.id == null && mActivityBlocker != null) try {
 			final CountDownLatch latch = new CountDownLatch(1);
 			n.contentIntent.send(this, 0, new Intent().putExtra("", mActivityBlocker), (pi, intent, r, d, e) -> {
-				final String key = intent.getStringExtra(EXTRA_USERNAME);
-				if (key == null) { Log.e(TAG, "Unexpected null key received for conversation: " + conversation.title); return; }
-				conversation.key = key;    // setType() below will trigger rebuilding of conversation sender.
+				final String id = intent.getStringExtra(EXTRA_USERNAME);
+				if (id == null) { Log.e(TAG, "Unexpected null ID received for conversation: " + conversation.title); return; }
+				conversation.id = id;    // setType() below will trigger rebuilding of conversation sender.
 				latch.countDown();
+				if (BuildConfig.DEBUG && id.hashCode() != conversation.nid) Log.e(TAG, "NID is not hash code of CID");
 			}, null);
 			try {
 				if (latch.await(100, TimeUnit.MILLISECONDS)) {
-					if (BuildConfig.DEBUG) Log.d(TAG, "Key retrieved: " + conversation.key);
-				} else Log.w(TAG, "Timeout retrieving conversation key");
+					if (BuildConfig.DEBUG) Log.d(TAG, "Conversation ID retrieved: " + conversation.id);
+				} else Log.w(TAG, "Timeout retrieving conversation ID");
 			} catch (final InterruptedException ignored) {}
 		} catch (final PendingIntent.CanceledException ignored) {}
 
-		final String key = conversation.key;
-		if (key != null) {
-			final int type = key.endsWith("@chatroom") || key.endsWith("@im.chatroom"/* WeWork */) ? TYPE_GROUP_CHAT
-					: key.startsWith("gh_") || key.equals(KEY_SERVICE_MESSAGE) ? TYPE_BOT_MESSAGE
-					: key.endsWith("@openim") ? TYPE_DIRECT_MESSAGE : TYPE_UNKNOWN;
+		final String cid = conversation.id;
+		if (cid != null) {
+			final int type = cid.endsWith("@chatroom") || cid.endsWith("@im.chatroom"/* WeWork */) ? TYPE_GROUP_CHAT
+					: cid.startsWith("gh_") || cid.equals(KEY_SERVICE_MESSAGE) ? TYPE_BOT_MESSAGE
+					: cid.endsWith("@openim") ? TYPE_DIRECT_MESSAGE : TYPE_UNKNOWN;
 			conversation.setType(type);
 		} else if (conversation.isTypeUnknown())
 			conversation.setType(WeChatMessage.guessConversationType(conversation));
@@ -219,7 +220,7 @@ public class WeChatDecorator extends NevoDecoratorService {
 		}
 
 		final boolean is_group_chat = conversation.isGroupChat();
-		if (SDK_INT >= P && KEY_SERVICE_MESSAGE.equals(key)) {  // Setting conversation title before Android P will make it a group chat.
+		if (SDK_INT >= P && KEY_SERVICE_MESSAGE.equals(cid)) {  // Setting conversation title before Android P will make it a group chat.
 			messaging.setConversationTitle(getString(R.string.header_service_message)); // A special header for this non-group conversation with multiple senders
 			n.setGroup(GROUP_BOT);
 		} else n.setGroup(is_group_chat ? GROUP_GROUP : conversation.isBotMessage() ? GROUP_BOT : GROUP_DIRECT);
@@ -233,8 +234,8 @@ public class WeChatDecorator extends NevoDecoratorService {
 		MessagingBuilder.flatIntoExtras(messaging, extras);
 		extras.putString(Notification.EXTRA_TEMPLATE, TEMPLATE_MESSAGING);
 
-		if (SDK_INT >= N_MR1 && key != null) {
-			final String shortcut_id = AgentShortcuts.Companion.buildShortcutId(key);
+		if (SDK_INT >= N_MR1 && cid != null) {
+			final String shortcut_id = AgentShortcuts.Companion.buildShortcutId(cid);
 			final boolean shortcut_ready = mAgentShortcuts.updateShortcutIfNeeded(shortcut_id, conversation, profile);
 			if (SDK_INT >= O && shortcut_ready) n.setShortcutId(shortcut_id);
 			if (SDK_INT >= Q) {
@@ -246,15 +247,15 @@ public class WeChatDecorator extends NevoDecoratorService {
 								.addRemoteInput(new RemoteInput.Builder("").setAllowFreeFormInput(false).build());
 						if (n.actions == null) n.actions = new Action[]{ action.build() };
 					}
-				} else if (SDK_INT > Q && shortcut_ready)
-					setBubbleMetadata(n, conversation, conversation.ext != null ? shortcut_id : null);
+				} else if (SDK_INT > Q && shortcut_ready)   // Shortcut does not use conversation ID if it is absent.
+					setBubbleMetadata(n, conversation, conversation.id != null ? shortcut_id : null);
 			}
 		}
 		return true;
 	}
 
 	@RequiresApi(Q) @SuppressWarnings("deprecation")
-	private void setBubbleMetadata(final MutableNotification n, final Conversation conversation, final String shortcut_id) {
+	private void setBubbleMetadata(final MutableNotification n, final Conversation conversation, final @Nullable String shortcut_id) {
 		final BubbleMetadata.Builder builder = SDK_INT > Q && shortcut_id != null ? new BubbleMetadata.Builder(shortcut_id) // WeChat does not met the requirement of bubble on Android Q: "documentLaunchMode=always"
 				: new BubbleMetadata.Builder().setIcon(IconHelper.convertToAdaptiveIcon(this, conversation.icon))
 				.setIntent(SDK_INT > Q ? n.contentIntent : buildBubblePendingIntent(n.contentIntent, shortcut_id));