mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-04-20 22:23:37 +00:00
feat: Improve channel migration logic and add tests (#4294)
This commit is contained in:
James Rich
GitHub
parent
2cdfababe5
commit
d8c7a51a84
3 changed files with 270 additions and 4 deletions
|
|
@ -45,6 +45,10 @@ dependencies {
|
|||
|
||||
testImplementation(libs.junit)
|
||||
testImplementation(libs.kotlinx.coroutines.test)
|
||||
testImplementation(libs.robolectric)
|
||||
testImplementation(libs.androidx.test.core)
|
||||
testImplementation(libs.androidx.test.ext.junit)
|
||||
testImplementation(libs.androidx.room.testing)
|
||||
|
||||
androidTestImplementation(libs.androidx.test.runner)
|
||||
androidTestImplementation(libs.androidx.test.ext.junit)
|
||||
|
|
|
|||
|
|
@ -452,13 +452,39 @@ interface PacketDao {
|
|||
*/
|
||||
@Transaction
|
||||
suspend fun migrateChannelsByPSK(oldSettings: List<ChannelSettings>, newSettings: List<ChannelSettings>) {
|
||||
val pskToNewIndex = newSettings.mapIndexed { idx, ch -> ch.psk to idx }.toMap()
|
||||
// Pre-calculate mapping from old index to new index
|
||||
val indexMap =
|
||||
oldSettings
|
||||
.mapIndexed { oldIndex, oldChannel ->
|
||||
val pskMatches =
|
||||
newSettings.mapIndexedNotNull { index, channel ->
|
||||
if (channel.psk == oldChannel.psk) index to channel else null
|
||||
}
|
||||
|
||||
val newIndex =
|
||||
when {
|
||||
pskMatches.isEmpty() -> null
|
||||
pskMatches.size == 1 -> pskMatches.first().first
|
||||
else -> {
|
||||
// Multiple matches with same PSK. Disambiguate by Name.
|
||||
val nameMatches = pskMatches.filter { it.second.name == oldChannel.name }
|
||||
if (nameMatches.size == 1) {
|
||||
nameMatches.first().first
|
||||
} else {
|
||||
// Still ambiguous. Prefer keeping same index.
|
||||
pskMatches.find { it.first == oldIndex }?.first ?: pskMatches.first().first
|
||||
}
|
||||
}
|
||||
}
|
||||
oldIndex to newIndex
|
||||
}
|
||||
.toMap()
|
||||
|
||||
val allPackets = getAllUserPacketsForMigration()
|
||||
for (packet in allPackets) {
|
||||
val oldIndex = packet.data.channel
|
||||
val oldPSK = oldSettings.getOrNull(oldIndex)?.psk
|
||||
val newIndex = if (oldPSK != null) pskToNewIndex[oldPSK] else null
|
||||
if (oldPSK != null && newIndex != null && oldIndex != newIndex) {
|
||||
val newIndex = indexMap[oldIndex]
|
||||
if (newIndex != null && oldIndex != newIndex) {
|
||||
// Rebuild contact_key with the new index, keeping the rest unchanged
|
||||
val oldKeySuffix = packet.contact_key.dropWhile { it.isDigit() }
|
||||
val newContactKey = "$newIndex$oldKeySuffix"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,236 @@
|
|||
/*
|
||||
* Copyright (c) 2026 Meshtastic LLC
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package org.meshtastic.core.database.dao
|
||||
|
||||
import androidx.room.Room
|
||||
import androidx.test.ext.junit.runners.AndroidJUnit4
|
||||
import androidx.test.platform.app.InstrumentationRegistry
|
||||
import com.google.protobuf.ByteString
|
||||
import kotlinx.coroutines.flow.first
|
||||
import kotlinx.coroutines.runBlocking
|
||||
import org.junit.After
|
||||
import org.junit.Assert.assertEquals
|
||||
import org.junit.Before
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import org.meshtastic.core.database.MeshtasticDatabase
|
||||
import org.meshtastic.core.database.entity.MyNodeEntity
|
||||
import org.meshtastic.core.database.entity.Packet
|
||||
import org.meshtastic.core.model.DataPacket
|
||||
import org.meshtastic.proto.Portnums
|
||||
import org.meshtastic.proto.channelSettings
|
||||
|
||||
@RunWith(AndroidJUnit4::class)
|
||||
class MigrationTest {
|
||||
private lateinit var database: MeshtasticDatabase
|
||||
private lateinit var packetDao: PacketDao
|
||||
private lateinit var nodeInfoDao: NodeInfoDao
|
||||
|
||||
private val myNodeInfo: MyNodeEntity =
|
||||
MyNodeEntity(
|
||||
myNodeNum = 42424242,
|
||||
model = null,
|
||||
firmwareVersion = null,
|
||||
couldUpdate = false,
|
||||
shouldUpdate = false,
|
||||
currentPacketId = 1L,
|
||||
messageTimeoutMsec = 5 * 60 * 1000,
|
||||
minAppVersion = 1,
|
||||
maxChannels = 8,
|
||||
hasWifi = false,
|
||||
)
|
||||
|
||||
@Before
|
||||
fun createDb(): Unit = runBlocking {
|
||||
val context = InstrumentationRegistry.getInstrumentation().targetContext
|
||||
database = Room.inMemoryDatabaseBuilder(context, MeshtasticDatabase::class.java).build()
|
||||
nodeInfoDao = database.nodeInfoDao().apply { setMyNodeInfo(myNodeInfo) }
|
||||
packetDao = database.packetDao()
|
||||
}
|
||||
|
||||
@After
|
||||
fun closeDb() {
|
||||
database.close()
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testMigrateChannelsByPSK_duplicatePSK() = runBlocking {
|
||||
// PSK "AQ==" is base64 for single byte 0x01
|
||||
val pskBytes = ByteString.copyFrom(byteArrayOf(0x01))
|
||||
|
||||
// Create packets for Channel 0
|
||||
insertPacket(channel = 0, text = "Message Ch0")
|
||||
|
||||
// Old settings: Channel 0 has PSK_A
|
||||
val oldSettings =
|
||||
listOf(
|
||||
channelSettings {
|
||||
psk = pskBytes
|
||||
name = "LongFast"
|
||||
},
|
||||
)
|
||||
|
||||
// New settings: Channel 0 has PSK_A, Channel 1 has PSK_A
|
||||
val newSettings =
|
||||
listOf(
|
||||
channelSettings {
|
||||
psk = pskBytes
|
||||
name = "LongFast"
|
||||
},
|
||||
channelSettings {
|
||||
psk = pskBytes
|
||||
name = "NewChan"
|
||||
},
|
||||
)
|
||||
|
||||
// Perform migration
|
||||
packetDao.migrateChannelsByPSK(oldSettings, newSettings)
|
||||
|
||||
// Check packet channel
|
||||
val p = getFirstPacket()
|
||||
assertEquals("Packet should remain on channel 0", 0, p.data.channel)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testMigrateChannelsByPSK_reorder() = runBlocking {
|
||||
val pskA = ByteString.copyFrom(byteArrayOf(0x01))
|
||||
val pskB = ByteString.copyFrom(byteArrayOf(0x02))
|
||||
|
||||
insertPacket(channel = 0, text = "Msg A")
|
||||
insertPacket(channel = 1, text = "Msg B")
|
||||
|
||||
val oldSettings =
|
||||
listOf(
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A"
|
||||
},
|
||||
channelSettings {
|
||||
psk = pskB
|
||||
name = "B"
|
||||
},
|
||||
)
|
||||
|
||||
val newSettings =
|
||||
listOf(
|
||||
channelSettings {
|
||||
psk = pskB
|
||||
name = "B"
|
||||
},
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A"
|
||||
},
|
||||
)
|
||||
|
||||
packetDao.migrateChannelsByPSK(oldSettings, newSettings)
|
||||
|
||||
val packets = getAllPackets()
|
||||
assertEquals(1, packets.find { it.data.text == "Msg A" }?.data?.channel)
|
||||
assertEquals(0, packets.find { it.data.text == "Msg B" }?.data?.channel)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testMigrateChannelsByPSK_disambiguateByName() = runBlocking {
|
||||
val pskA = ByteString.copyFrom(byteArrayOf(0x01))
|
||||
|
||||
insertPacket(channel = 0, text = "Msg A1")
|
||||
insertPacket(channel = 1, text = "Msg A2")
|
||||
|
||||
val oldSettings =
|
||||
listOf(
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A1"
|
||||
},
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A2"
|
||||
},
|
||||
)
|
||||
|
||||
// Swap positions but keep names and PSKs
|
||||
val newSettings =
|
||||
listOf(
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A2"
|
||||
},
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A1"
|
||||
},
|
||||
)
|
||||
|
||||
packetDao.migrateChannelsByPSK(oldSettings, newSettings)
|
||||
|
||||
val packets = getAllPackets()
|
||||
assertEquals("Msg A1 should move to index 1", 1, packets.find { it.data.text == "Msg A1" }?.data?.channel)
|
||||
assertEquals("Msg A2 should move to index 0", 0, packets.find { it.data.text == "Msg A2" }?.data?.channel)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testMigrateChannelsByPSK_preferSameIndexIfStillAmbiguous() = runBlocking {
|
||||
val pskA = ByteString.copyFrom(byteArrayOf(0x01))
|
||||
|
||||
insertPacket(channel = 0, text = "Msg A")
|
||||
|
||||
val oldSettings =
|
||||
listOf(
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A"
|
||||
},
|
||||
)
|
||||
|
||||
// New settings has two identical channels (same PSK, same Name)
|
||||
val newSettings =
|
||||
listOf(
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A"
|
||||
},
|
||||
channelSettings {
|
||||
psk = pskA
|
||||
name = "A"
|
||||
},
|
||||
)
|
||||
|
||||
packetDao.migrateChannelsByPSK(oldSettings, newSettings)
|
||||
|
||||
val p = getFirstPacket()
|
||||
assertEquals("Should prefer keeping same index 0", 0, p.data.channel)
|
||||
}
|
||||
|
||||
private suspend fun insertPacket(channel: Int, text: String) {
|
||||
packetDao.insert(
|
||||
Packet(
|
||||
uuid = 0L,
|
||||
myNodeNum = 42424242,
|
||||
port_num = Portnums.PortNum.TEXT_MESSAGE_APP_VALUE,
|
||||
contact_key = "$channel!broadcast",
|
||||
received_time = System.currentTimeMillis(),
|
||||
read = false,
|
||||
data = DataPacket(to = DataPacket.ID_BROADCAST, channel = channel, text = text),
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
private suspend fun getAllPackets() = packetDao.getAllPackets(Portnums.PortNum.TEXT_MESSAGE_APP_VALUE).first()
|
||||
|
||||
private suspend fun getFirstPacket() = getAllPackets().first()
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue