agora-rtm-sdkバージョン2.2.2からダウングレードを行う際の注意点

状況

ステージング環境で突然RTMのログインに失敗するようになった。
本番環境やローカル環境では発生していなかった。

調査を行ったところ下記のことがわかった。

1. ローカルストレージ内に次のようなKeyとValueを持つレコードが含まれていた
   Key: 「_agora_rtm_custom_config」
   Value: 「(base64文字列)」

2. このレコードを削除したところ正常にログインができるようになった

「_agora_rtm_custom_config」というKeyを持つレコードを保存するような実装は、コード上行っていない。

Agoraの担当の方に確認を取ったところ、AgoraRTMSDK（"agora-rtm-sdk": "2.2.2"）内部で追加が行われていた。

一度上記の現象が発生するとlocalStorageをリセットするまでログインができなくなる。

対処法

1. バージョン2.2.2以上を使用する（推奨）
2. _agora_rtm_custom_config を持つKeyがローカルストレージに含まれる場合削除する（2.2.1以下を使用する場合）