signalapp/Signal-iOS
signalapp/Signal-iOS
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 4 Wiki Activity
520faa95df
Signal-iOS/SignalServiceKit/tests/Storage/SDSDatabaseStorageObservationTest.swift
Evan Hahn 370ff654e7
Change license to AGPL 
Change license to AGPL

This commit:

- Updates the `LICENSE` file

- Start every file with something like:

      // Copyright YEAR_FIRST_PUBLISHED Signal Messenger, LLC
      // SPDX-License-Identifier: AGPL-3.0-only

---

First, I removed existing license headers with this Ruby 3.1.2 script:

    require 'set'

    EXTENSIONS_TO_CHECK = Set['.h', '.hpp', '.cpp', '.m', '.mm', '.pch', '.swift']

    same = 0
    different = 0

    all_files = `git ls-files`.lines.map { |line| line.strip }
    all_files.each do |relative_path|
      if relative_path == 'Pods'
        next
      end

      unless EXTENSIONS_TO_CHECK.include? File.extname(relative_path)
        next
      end

      path = File.expand_path(relative_path)

      contents = File.read(path)
      new_contents = contents.sub(/\/\/\n\/\/  Copyright .*\n\/\/\n\n/, '')

      if contents == new_contents
        same += 1
      else
        different += 1
      end

      File.write(path, new_contents)
    end

    puts "updated #{different} file(s), left #{same} untouched"

I'm sure this script could be improved, but it worked well enough.

Then, I created `Scripts/lint/lint-license-headers` and ran it to auto-
fix a lot of files. This changed the mode of some files, but I think
that's actually desirable. For example,
`SignalServiceKit/src/Util/AppContext.m` previously had a mode of
`0755/-rwxr-xr-x`, and it's now `0644/-rw-r--r--`.

Then I fixed some stragglers and updated the precommit script.

See [a similar change in the Desktop app][0].

[0]: 8bfaf598af
2022-10-13 08:25:37 -05:00

435 lines
18 KiB
Swift
Raw Blame History

//
// Copyright 2019 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
import Foundation
import XCTest
@testable import SignalServiceKit
class MockObserver {
var updateCount: UInt = 0
var externalUpdateCount: UInt = 0
var resetCount: UInt = 0
var lastChange: DatabaseChanges?
private var expectation: XCTestExpectation?
init() {
AssertIsOnMainThread()
SDSDatabaseStorage.shared.appendDatabaseChangeDelegate(self)
}
func set(expectation: XCTestExpectation) {
AssertIsOnMainThread()
self.expectation = expectation
}
func clear() {
updateCount = 0
externalUpdateCount = 0
resetCount = 0
lastChange = nil
}
}
// MARK: -
extension MockObserver: DatabaseChangeDelegate {
func databaseChangesDidUpdate(databaseChanges: DatabaseChanges) {
AssertIsOnMainThread()
updateCount += 1
lastChange = databaseChanges
expectation?.fulfill()
expectation = nil
}
func databaseChangesDidUpdateExternally() {
AssertIsOnMainThread()
Logger.verbose("")
externalUpdateCount += 1
expectation?.fulfill()
expectation = nil
}
func databaseChangesDidReset() {
AssertIsOnMainThread()
Logger.verbose("")
resetCount += 1
expectation?.fulfill()
expectation = nil
}
}
// MARK: -
class SDSDatabaseStorageObservationTest: SSKBaseTestSwift {
// MARK: - GRDB
func testGRDBSyncWrite() {
try! databaseStorage.grdbStorage.setupDatabaseChangeObserver()
// Make sure there's already at least one thread.
var someThread: TSThread?
self.write { transaction in
let recipient = SignalServiceAddress(phoneNumber: "+1222333444")
someThread = TSContactThread.getOrCreateThread(withContactAddress: recipient, transaction: transaction)
}
// First flush any pending notifications in SDSDatabaseStorageObservation
// from setup.
let flushExpectation = self.expectation(description: "Database Storage Observer")
DispatchQueue.main.async {
DispatchQueue.main.async {
flushExpectation.fulfill()
}
}
self.waitForExpectations(timeout: 1.0, handler: nil)
let mockObserver = MockObserver()
XCTAssertEqual(0, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNil(mockObserver.lastChange)
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
let keyValueStore = SDSKeyValueStore(collection: "test")
let otherKeyValueStore = SDSKeyValueStore(collection: "other")
self.write { transaction in
keyValueStore.setBool(true, key: "test", transaction: transaction)
Logger.verbose("write 1 complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertFalse(lastChange.didUpdateInteractions)
XCTAssertFalse(lastChange.didUpdateThreads)
XCTAssertFalse(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
XCTAssertTrue(lastChange.didUpdate(keyValueStore: keyValueStore))
// Note: For GRDB, didUpdate(keyValueStore:) currently returns true
// if any key value stores was updated.
XCTAssertTrue(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
}
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
self.write { transaction in
let recipient = SignalServiceAddress(phoneNumber: "+15551234567")
_ = TSContactThread.getOrCreateThread(withContactAddress: recipient, transaction: transaction)
Logger.verbose("write 2 complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertFalse(lastChange.didUpdateInteractions)
XCTAssertTrue(lastChange.didUpdateThreads)
XCTAssertTrue(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: keyValueStore))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
}
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
var lastMessage: TSInteraction?
var unsavedMessage: TSInteraction?
self.write { transaction in
let recipient = SignalServiceAddress(phoneNumber: "+12345678900")
let thread = TSContactThread.getOrCreateThread(withContactAddress: recipient, transaction: transaction)
let message = TSOutgoingMessage(in: thread, messageBody: "Hello Alice", attachmentId: nil)
message.anyInsert(transaction: transaction)
message.anyReload(transaction: transaction)
lastMessage = message
unsavedMessage = TSOutgoingMessage(in: thread, messageBody: "Goodbyte Alice", attachmentId: nil)
Logger.verbose("write 3 complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertTrue(lastChange.didUpdateInteractions)
XCTAssertTrue(lastChange.didUpdateThreads)
XCTAssertTrue(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
// Note: For GRDB, didUpdate(keyValueStore:) currently returns true
// if any key value stores was updated.
XCTAssertTrue(lastChange.didUpdate(keyValueStore: keyValueStore))
XCTAssertTrue(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
XCTAssertTrue(lastChange.didUpdate(interaction: lastMessage!))
XCTAssertFalse(lastChange.didUpdate(interaction: unsavedMessage!))
}
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
self.write { transaction in
self.databaseStorage.touch(thread: someThread!, shouldReindex: true, transaction: transaction)
Logger.verbose("Touch complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertFalse(lastChange.didUpdateInteractions)
XCTAssertTrue(lastChange.didUpdateThreads)
XCTAssertTrue(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: keyValueStore))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
XCTAssertFalse(lastChange.didUpdate(interaction: lastMessage!))
XCTAssertFalse(lastChange.didUpdate(interaction: unsavedMessage!))
}
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
self.write { transaction in
self.databaseStorage.touch(interaction: lastMessage!, shouldReindex: true, transaction: transaction)
Logger.verbose("Touch complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertTrue(lastChange.didUpdateInteractions)
XCTAssertTrue(lastChange.didUpdateThreads)
XCTAssertTrue(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: keyValueStore))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
XCTAssertTrue(lastChange.didUpdate(interaction: lastMessage!))
XCTAssertFalse(lastChange.didUpdate(interaction: unsavedMessage!))
}
mockObserver.clear()
}
func testGRDBAsyncWrite() {
try! databaseStorage.grdbStorage.setupDatabaseChangeObserver()
// Make sure there's already at least one thread.
var someThread: TSThread?
self.write { transaction in
let recipient = SignalServiceAddress(phoneNumber: "+1222333444")
someThread = TSContactThread.getOrCreateThread(withContactAddress: recipient, transaction: transaction)
}
// First flush any pending notifications in SDSDatabaseStorageObservation
// from setup.
let flushExpectation = self.expectation(description: "Database Storage Observer")
DispatchQueue.main.async {
DispatchQueue.main.async {
flushExpectation.fulfill()
}
}
self.waitForExpectations(timeout: 1.0, handler: nil)
let mockObserver = MockObserver()
XCTAssertEqual(0, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNil(mockObserver.lastChange)
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
let keyValueStore = SDSKeyValueStore(collection: "test")
let otherKeyValueStore = SDSKeyValueStore(collection: "other")
self.asyncWrite { transaction in
keyValueStore.setBool(true, key: "test", transaction: transaction)
Logger.verbose("write 1 complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertFalse(lastChange.didUpdateInteractions)
XCTAssertFalse(lastChange.didUpdateThreads)
XCTAssertFalse(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
XCTAssertTrue(lastChange.didUpdate(keyValueStore: keyValueStore))
// Note: For GRDB, didUpdate(keyValueStore:) currently returns true
// if any key value stores was updated.
XCTAssertTrue(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
}
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
self.asyncWrite { transaction in
let recipient = SignalServiceAddress(phoneNumber: "+15551234567")
_ = TSContactThread.getOrCreateThread(withContactAddress: recipient, transaction: transaction)
Logger.verbose("write 2 complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertFalse(lastChange.didUpdateInteractions)
XCTAssertTrue(lastChange.didUpdateThreads)
XCTAssertTrue(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: keyValueStore))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
}
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
var lastMessage: TSInteraction?
var unsavedMessage: TSInteraction?
self.asyncWrite { transaction in
let recipient = SignalServiceAddress(phoneNumber: "+12345678900")
let thread = TSContactThread.getOrCreateThread(withContactAddress: recipient, transaction: transaction)
let message = TSOutgoingMessage(in: thread, messageBody: "Hello Alice", attachmentId: nil)
message.anyInsert(transaction: transaction)
message.anyReload(transaction: transaction)
lastMessage = message
unsavedMessage = TSOutgoingMessage(in: thread, messageBody: "Goodbyte Alice", attachmentId: nil)
Logger.verbose("write 3 complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertTrue(lastChange.didUpdateInteractions)
XCTAssertTrue(lastChange.didUpdateThreads)
XCTAssertTrue(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
// Note: For GRDB, didUpdate(keyValueStore:) currently returns true
// if any key value stores was updated.
XCTAssertTrue(lastChange.didUpdate(keyValueStore: keyValueStore))
XCTAssertTrue(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
XCTAssertTrue(lastChange.didUpdate(interaction: lastMessage!))
XCTAssertFalse(lastChange.didUpdate(interaction: unsavedMessage!))
}
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
self.asyncWrite { transaction in
self.databaseStorage.touch(thread: someThread!, shouldReindex: true, transaction: transaction)
Logger.verbose("Touch complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertFalse(lastChange.didUpdateInteractions)
XCTAssertTrue(lastChange.didUpdateThreads)
XCTAssertTrue(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: keyValueStore))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
XCTAssertFalse(lastChange.didUpdate(interaction: lastMessage!))
XCTAssertFalse(lastChange.didUpdate(interaction: unsavedMessage!))
}
mockObserver.clear()
mockObserver.set(expectation: self.expectation(description: "Database Storage Observer"))
self.asyncWrite { transaction in
self.databaseStorage.touch(interaction: lastMessage!, shouldReindex: true, transaction: transaction)
Logger.verbose("Touch complete")
}
self.waitForExpectations(timeout: 1.0, handler: nil)
XCTAssertEqual(1, mockObserver.updateCount)
XCTAssertEqual(0, mockObserver.externalUpdateCount)
XCTAssertEqual(0, mockObserver.resetCount)
XCTAssertNotNil(mockObserver.lastChange)
if let lastChange = mockObserver.lastChange {
XCTAssertTrue(lastChange.didUpdateInteractions)
XCTAssertTrue(lastChange.didUpdateThreads)
XCTAssertTrue(lastChange.didUpdateInteractionsOrThreads)
XCTAssertFalse(lastChange.didUpdateModel(collection: OWSDevice.collection()))
XCTAssertFalse(lastChange.didUpdateModel(collection: "invalid collection name"))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: keyValueStore))
XCTAssertFalse(lastChange.didUpdate(keyValueStore: otherKeyValueStore))
XCTAssertTrue(lastChange.didUpdate(interaction: lastMessage!))
XCTAssertFalse(lastChange.didUpdate(interaction: unsavedMessage!))
}
mockObserver.clear()
}
}
Reference in New Issue View Git Blame Copy Permalink