Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wc/1291 revert notifs constraint #1292

Merged
merged 3 commits into from
Jun 21, 2019
Merged

Wc/1291 revert notifs constraint #1292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fde8bb
Revert foreign key constraint added in a recent PR
AmandaRiu Jun 20, 2019
9680ce8
Add migration strategy to onUpgrade to remove foreign key constraint
AmandaRiu Jun 20, 2019
f000172
Fix lint warnings and update a test to properly use correct site id
AmandaRiu Jun 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 111 additions & 106 deletions example/src/test/java/org/wordpress/android/fluxc/notifications/NotificationSqlUtilsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import org.wordpress.android.fluxc.model.notification.NoteIdSet
import org.wordpress.android.fluxc.network.rest.wpcom.notifications.NotificationApiResponse
import org.wordpress.android.fluxc.persistence.NotificationSqlUtils
import org.wordpress.android.fluxc.persistence.NotificationSqlUtils.NotificationModelBuilder
import org.wordpress.android.fluxc.persistence.SiteSqlUtils
import org.wordpress.android.fluxc.tools.FormattableContentMapper
import kotlin.test.assertEquals
import kotlin.test.assertNotNull
Expand All @@ -26,33 +25,27 @@ import kotlin.test.assertNull
@Config(manifest = Config.NONE)
@RunWith(RobolectricTestRunner::class)
class NotificationSqlUtilsTest {
// All notifications require a matching [SiteModel] in the database in order to save
// to the database due to a foreign key constraint
private val site = SiteModel().apply {
name = "Unit Test Site"
url = "https://www.mytestsite.com"
}

@Before
fun setUp() {
val appContext = RuntimeEnvironment.application.applicationContext
val config = SingleStoreWellSqlConfigForTests(
appContext,
listOf(NotificationModelBuilder::class.java, SiteModel::class.java),
"")
val config = SingleStoreWellSqlConfigForTests(appContext, listOf(NotificationModelBuilder::class.java))
WellSql.init(config)
config.reset()

// Save the test [SiteModel] to the db
saveSiteToDb(site)
}

@Test
fun testInsertOrUpdateNotifications() {
// Test inserting notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val notesList = notificationSqlUtils.getNotifications()
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val notesList = apiResponse.notes?.map {
NotificationApiResponse.notificationResponseToNotificationModel(it, 0)
} ?: emptyList()

// Test inserting notifications
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Test updating notifications
val newNote = notesList[0].copy(noteId = -1, remoteNoteId = 333)
Expand All @@ -68,7 +61,14 @@ class NotificationSqlUtilsTest {
fun testGetNotifications() {
// Insert notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val notesList = apiResponse.notes?.map {
NotificationApiResponse.notificationResponseToNotificationModel(it, 0)
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Get notifications
val notifications = notificationSqlUtils.getNotifications(SelectQuery.ORDER_DESCENDING)
Expand All @@ -79,11 +79,20 @@ class NotificationSqlUtilsTest {
fun testGetNotificationsForSite() {
// Insert notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val site = SiteModel().apply { id = 153482281 }
val notesList = apiResponse.notes?.map {
val siteId = NotificationApiResponse.getRemoteSiteId(it)
NotificationApiResponse.notificationResponseToNotificationModel(it, siteId!!.toInt())
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Get notifications
val notifications = notificationSqlUtils.getNotificationsForSite(site, SelectQuery.ORDER_DESCENDING)
assertEquals(6, notifications.size)
assertEquals(3, notifications.size)
}

@Test
Expand All @@ -93,6 +102,7 @@ class NotificationSqlUtilsTest {
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/store-order-notification.json")
val apiResponse = NotificationTestUtils.parseNotificationApiResponseFromJsonString(jsonString)
val site = SiteModel().apply { id = 141286411 }
val notesList = listOf(NotificationApiResponse.notificationResponseToNotificationModel(apiResponse, site.id))
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(1, inserted)
Expand All @@ -105,7 +115,7 @@ class NotificationSqlUtilsTest {
val note = notifications[0]
assertEquals(note.title, "New Order")
assertEquals(note.noteHash, 2064099309)
assertEquals(note.localSiteId, site.id)
assertEquals(note.localSiteId, 141286411)
assertEquals(note.remoteNoteId, 3604874081)
assertEquals(note.type, NotificationModel.Kind.STORE_ORDER)
assertEquals(note.read, true)
Expand Down Expand Up @@ -172,6 +182,7 @@ class NotificationSqlUtilsTest {
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/store-review-notification.json")
val apiResponse = NotificationTestUtils.parseNotificationApiResponseFromJsonString(jsonString)
val site = SiteModel().apply { id = 153482281 }
val notesList = listOf(NotificationApiResponse.notificationResponseToNotificationModel(apiResponse, site.id))
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(1, inserted)
Expand All @@ -186,7 +197,7 @@ class NotificationSqlUtilsTest {
val note = notifications[0]
assertEquals(note.noteHash, 1543255567)
assertEquals(note.title, "Product Review")
assertEquals(note.localSiteId, site.id)
assertEquals(note.localSiteId, 153482281)
assertEquals(note.remoteNoteId, 3617558725)
assertEquals(note.type, NotificationModel.Kind.COMMENT)
assertEquals(note.read, true)
Expand All @@ -205,7 +216,14 @@ class NotificationSqlUtilsTest {
fun testGetNotifications_filterBy() {
// Insert notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val notesList = apiResponse.notes?.map {
NotificationApiResponse.notificationResponseToNotificationModel(it, 0)
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Get notifications of type "store_order"
val newOrderNotifications = notificationSqlUtils.getNotifications(
Expand All @@ -226,43 +244,40 @@ class NotificationSqlUtilsTest {

@Test
fun testGetNotificationsForSite_filterBy() {
// Insert notifications for main test site
// Insert notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)

// Insert notifications for additional test site
val site2 = SiteModel().apply {
name = "Test Site 2"
url = "https://someothertestsite.com"
}
saveSiteToDb(site2)
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site2)

// Verify we have 12 total notifications in the db
val allNotifs = notificationSqlUtils.getNotifications()
assertEquals(12, allNotifs.size)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val site = SiteModel().apply { id = 153482281 }
val notesList = apiResponse.notes?.map {
val siteId = NotificationApiResponse.getRemoteSiteId(it)
NotificationApiResponse.notificationResponseToNotificationModel(it, siteId!!.toInt())
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Get notifications of type "store_order".
//
// Note: FOUR store_order notifications were inserted into the db, but they belong to two
// different sites so only 2 should be returned.
// Note: TWO store_order notifications were inserted into the db, but they belong to two
// different sites so only 1 should be returned.
val newOrderNotifications = notificationSqlUtils.getNotificationsForSite(
site2,
site,
filterByType = listOf(NotificationModel.Kind.STORE_ORDER.toString()))
assertEquals(2, newOrderNotifications.size)
assertEquals(1, newOrderNotifications.size)

// Get notifications of subtype "store_review"
val storeReviewNotifications = notificationSqlUtils.getNotificationsForSite(
site2,
site,
filterBySubtype = listOf(NotificationModel.Subkind.STORE_REVIEW.toString()))
assertEquals(2, storeReviewNotifications.size)

// Get notifications of type "store_order" or subtype "store_review"
val combinedNotifications = notificationSqlUtils.getNotificationsForSite(
site2,
site,
filterByType = listOf(NotificationModel.Kind.STORE_ORDER.toString()),
filterBySubtype = listOf(NotificationModel.Subkind.STORE_REVIEW.toString()))
assertEquals(4, combinedNotifications.size)
assertEquals(3, combinedNotifications.size)
}

@Test
Expand All @@ -271,17 +286,24 @@ class NotificationSqlUtilsTest {

// Insert notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val site = SiteModel().apply { id = 153482281 }
val notesList = apiResponse.notes?.map {
val siteId = NotificationApiResponse.getRemoteSiteId(it)
NotificationApiResponse.notificationResponseToNotificationModel(it, siteId!!.toInt())
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Fetch a single notification using the noteIdSet
val idSet = NoteIdSet(-1, noteId, site.id)
val notification = notificationSqlUtils.getNotificationByIdSet(idSet)
assertNotNull(notification)

with(notification) {
assertEquals(remoteNoteId, noteId)
assertEquals(localSiteId, site.id)
}
assertEquals(notification.remoteNoteId, noteId)
assertEquals(notification.localSiteId, site.id)
}

@Test
Expand All @@ -290,23 +312,37 @@ class NotificationSqlUtilsTest {

// Insert notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val site = SiteModel().apply { id = 153482281 }
val notesList = apiResponse.notes?.map {
val siteId = NotificationApiResponse.getRemoteSiteId(it)
NotificationApiResponse.notificationResponseToNotificationModel(it, siteId!!.toInt())
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Fetch a single notification using the remoteNoteId
val notification = notificationSqlUtils.getNotificationByRemoteId(noteId)
assertNotNull(notification)

with(notification) {
assertEquals(remoteNoteId, noteId)
assertEquals(localSiteId, site.id)
}
assertEquals(notification.remoteNoteId, noteId)
assertEquals(notification.localSiteId, site.id)
}

@Test
fun testGetNotificationCount() {
// Insert notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val notesList = apiResponse.notes?.map {
NotificationApiResponse.notificationResponseToNotificationModel(it, 0)
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Get notifications
val count = notificationSqlUtils.getNotificationsCount()
Expand All @@ -316,8 +352,16 @@ class NotificationSqlUtilsTest {
@Test
fun testHasUnreadNotifications() {
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val notesList = apiResponse.notes?.map {
NotificationApiResponse.notificationResponseToNotificationModel(it, 0)
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

val site = SiteModel().apply { id = 0 }
val hasUnread = notificationSqlUtils.hasUnreadNotificationsForSite(site)
assertEquals(hasUnread, true)
}
Expand All @@ -328,7 +372,16 @@ class NotificationSqlUtilsTest {

// Insert notifications
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val site = SiteModel().apply { id = 153482281 }
val notesList = apiResponse.notes?.map {
val siteId = site.id
NotificationApiResponse.notificationResponseToNotificationModel(it, siteId)
} ?: emptyList()
val inserted = notesList.sumBy { notificationSqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)

// Fetch a single notification
val notification = notificationSqlUtils.getNotificationByRemoteId(noteId)
Expand All @@ -341,52 +394,4 @@ class NotificationSqlUtilsTest {
// Verify notification not in database
assertNull(notificationSqlUtils.getNotificationByRemoteId(noteId))
}

@Test
fun testDeleteSiteCascadesToNotificationTable() {
// Assemble:
// - Insert notifications for main test site
// - Insert notifications for additional test site
// - Verify we have 12 total notifications in the db
val notificationSqlUtils = NotificationSqlUtils(FormattableContentMapper(Gson()))
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site)

val site2 = SiteModel().apply {
name = "Test Site 2"
url = "https://someothertestsite.com"
}
saveSiteToDb(site2)
generateAndSaveTestNotificationsToDb(notificationSqlUtils, site2)

val allNotifs = notificationSqlUtils.getNotifications()
assertEquals(12, allNotifs.size)

// Act:
// - Delete the site from the database
SiteSqlUtils.deleteSite(site2)

// Assert:
// - Verify all the notifications for site2 have also been deleted from the database
val savedNotifs = notificationSqlUtils.getNotifications()
assertEquals(6, savedNotifs.size)
}

private fun generateAndSaveTestNotificationsToDb(sqlUtils: NotificationSqlUtils, siteModel: SiteModel) {
val jsonString = UnitTestUtils
.getStringFromResourceFile(this.javaClass, "notifications/notifications-api-response.json")
val apiResponse = NotificationTestUtils.parseNotificationsApiResponseFromJsonString(jsonString)
val notesList = apiResponse.notes?.map {
NotificationApiResponse.notificationResponseToNotificationModel(it, siteModel.id)
} ?: emptyList()
val inserted = notesList.sumBy { sqlUtils.insertOrUpdateNotification(it) }
assertEquals(6, inserted)
}

private fun saveSiteToDb(siteModel: SiteModel) {
val siteRowsAffected = SiteSqlUtils.insertOrUpdateSite(siteModel)
assertEquals(1, siteRowsAffected)
val savedSite = SiteSqlUtils.getSitesByNameOrUrlMatching(siteModel.name).firstOrNull()
assertNotNull(savedSite)
assertEquals(siteModel.name, savedSite.name)
}
}
5 changes: 0 additions & 5 deletions fluxc/src/main/java/org/wordpress/android/fluxc/persistence/NotificationSqlUtils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import com.yarolegovich.wellsql.WellSql
import com.yarolegovich.wellsql.core.Identifiable
import com.yarolegovich.wellsql.core.annotation.Column
import com.yarolegovich.wellsql.core.annotation.PrimaryKey
import com.yarolegovich.wellsql.core.annotation.RawConstraints
import com.yarolegovich.wellsql.core.annotation.Table
import org.wordpress.android.fluxc.model.SiteModel
import org.wordpress.android.fluxc.model.notification.NoteIdSet
Expand Down Expand Up @@ -208,10 +207,6 @@ class NotificationSqlUtils @Inject constructor(private val formattableContentMap
}

@Table(name = "NotificationModel")
@RawConstraints(
"FOREIGN KEY(LOCAL_SITE_ID) REFERENCES SiteModel(_id) ON DELETE CASCADE",
"UNIQUE (REMOTE_NOTE_ID, LOCAL_SITE_ID) ON CONFLICT REPLACE"
)
data class NotificationModelBuilder(
@PrimaryKey @Column private var mId: Int = -1,
@Column var remoteNoteId: Long,
Expand Down
Loading