f844ed9931
This commit redesigns the Ndb.swift interface with a focus on build-time safety against crashes. It removes the external usage of NdbTxn and SafeNdbTxn, restricting it to be used only in NostrDB internal code. This prevents dangerous and crash prone usages throughout the app, such as holding transactions in a variable in an async function (which can cause thread-based reference counting to incorrectly deinit inherited transactions in use by separate callers), as well as holding unsafe unowned values longer than the lifetime of their corresponding transactions. Closes: https://github.com/damus-io/damus/issues/3364 Changelog-Fixed: Fixed several crashes throughout the app Signed-off-by: Daniel D’Aquino <daniel@daquino.me>
250 lines
8.2 KiB
Swift
250 lines
8.2 KiB
Swift
//
|
|
// NDBIterTests.swift
|
|
// damusTests
|
|
//
|
|
// Created by William Casarin on 2023-07-21.
|
|
//
|
|
|
|
import XCTest
|
|
@testable import damus
|
|
|
|
func test_ndb_dir() -> String? {
|
|
do {
|
|
let fileManager = FileManager.default
|
|
let tempDir = fileManager.temporaryDirectory.appendingPathComponent(UUID().uuidString)
|
|
try fileManager.createDirectory(at: tempDir, withIntermediateDirectories: true, attributes: nil)
|
|
return remove_file_prefix(tempDir.absoluteString)
|
|
} catch {
|
|
return nil
|
|
}
|
|
}
|
|
|
|
final class NdbTests: XCTestCase {
|
|
var db_dir: String = ""
|
|
|
|
override func setUpWithError() throws {
|
|
guard let db = test_ndb_dir() else {
|
|
XCTFail("Could not create temp directory")
|
|
return
|
|
}
|
|
db_dir = db
|
|
}
|
|
|
|
override func tearDownWithError() throws {
|
|
// Put teardown code here. This method is called after the invocation of each test method in the class.
|
|
}
|
|
|
|
func test_decode_eose() throws {
|
|
let json = "[\"EOSE\",\"DC268DBD-55DA-458A-B967-540925AF3497\"]"
|
|
let resp = decode_nostr_event(txt: json)
|
|
XCTAssertNotNil(resp)
|
|
}
|
|
|
|
func test_decode_command_result() throws {
|
|
let json = "[\"OK\",\"b1d8f68d39c07ce5c5ea10c235100d529b2ed2250140b36a35d940b712dc6eff\",true,\"\"]"
|
|
let resp = decode_nostr_event(txt: json)
|
|
XCTAssertNotNil(resp)
|
|
|
|
}
|
|
|
|
func test_profile_creation() {
|
|
let profile = make_test_profile()
|
|
XCTAssertEqual(profile.name, "jb55")
|
|
}
|
|
|
|
func test_ndb_init() {
|
|
|
|
do {
|
|
let ndb = Ndb(path: db_dir)!
|
|
let ok = ndb.process_events(test_wire_events)
|
|
XCTAssertTrue(ok)
|
|
}
|
|
|
|
do {
|
|
let ndb = Ndb(path: db_dir)!
|
|
let id = NoteId(hex: "d12c17bde3094ad32f4ab862a6cc6f5c289cfe7d5802270bdf34904df585f349")!
|
|
guard let txn = NdbTxn(ndb: ndb) else { return XCTAssert(false) }
|
|
let note = ndb.lookup_note_and_copy(id)
|
|
XCTAssertNotNil(note)
|
|
guard let note else { return }
|
|
let pk = Pubkey(hex: "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245")!
|
|
XCTAssertEqual(note.pubkey, pk)
|
|
|
|
let profile = ndb.lookup_profile_and_copy(pk)
|
|
let lnurl = ndb.lookup_profile_lnurl(pk)
|
|
XCTAssertNotNil(profile)
|
|
guard let profile else { return }
|
|
|
|
XCTAssertEqual(profile.name, "jb55")
|
|
XCTAssertEqual(lnurl, nil)
|
|
}
|
|
|
|
|
|
}
|
|
|
|
func test_ndb_search() throws {
|
|
do {
|
|
let ndb = Ndb(path: db_dir)!
|
|
let ok = ndb.process_events(test_wire_events)
|
|
XCTAssertTrue(ok)
|
|
}
|
|
|
|
do {
|
|
let ndb = Ndb(path: db_dir)!
|
|
let note_ids = ndb.text_search(query: "barked")
|
|
XCTAssertEqual(note_ids.count, 1)
|
|
let expected_note_id = NoteId(hex: "b17a540710fe8495b16bfbaf31c6962c4ba8387f3284a7973ad523988095417e")!
|
|
guard note_ids.count > 0 else {
|
|
XCTFail("Expected at least one note to be found")
|
|
return
|
|
}
|
|
let note_id = ndb.lookup_note_by_key(note_ids[0], borrow: { maybeUnownedNote -> NoteId? in
|
|
switch maybeUnownedNote {
|
|
case .none: return nil
|
|
case .some(let unownedNote): return unownedNote.id
|
|
}
|
|
})
|
|
XCTAssertEqual(note_id, .some(expected_note_id))
|
|
}
|
|
}
|
|
|
|
func test_ndb_note() throws {
|
|
let note = NdbNote.owned_from_json(json: test_contact_list_json)
|
|
XCTAssertNotNil(note)
|
|
guard let note else { return }
|
|
|
|
let id = NoteId(hex: "20d0ff27d6fcb13de8366328c5b1a7af26bcac07f2e558fbebd5e9242e608c09")!
|
|
let pubkey = Pubkey(hex: "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245")!
|
|
|
|
XCTAssertEqual(note.id, id)
|
|
XCTAssertEqual(note.pubkey, pubkey)
|
|
|
|
XCTAssertEqual(note.count, 34328)
|
|
XCTAssertEqual(note.kind, 3)
|
|
XCTAssertEqual(note.created_at, 1689904312)
|
|
|
|
let expected_count: UInt16 = 786
|
|
XCTAssertEqual(note.tags.count, expected_count)
|
|
XCTAssertEqual(note.tags.reduce(0, { sum, _ in sum + 1 }), expected_count)
|
|
|
|
var tags = 0
|
|
var total_count_stored = 0
|
|
var total_count_iter = 0
|
|
//let tags = note.tags()
|
|
for tag in note.tags {
|
|
total_count_stored += Int(tag.count)
|
|
|
|
if tags == 0 || tags == 1 || tags == 2 {
|
|
XCTAssertEqual(tag.count, 3)
|
|
}
|
|
|
|
if tags == 6 {
|
|
XCTAssertEqual(tag.count, 2)
|
|
}
|
|
|
|
if tags == 7 {
|
|
XCTAssertEqual(tag[2].string(), "wss://nostr-pub.wellorder.net")
|
|
}
|
|
|
|
for elem in tag {
|
|
print("tag[\(tags)][\(elem.index)]")
|
|
total_count_iter += 1
|
|
}
|
|
|
|
tags += 1
|
|
}
|
|
|
|
XCTAssertEqual(tags, 786)
|
|
XCTAssertEqual(total_count_stored, total_count_iter)
|
|
}
|
|
|
|
/// Based on https://github.com/damus-io/damus/issues/1468
|
|
/// Tests whether a JSON with optional escaped slash characters is correctly unescaped (In accordance to https://datatracker.ietf.org/doc/html/rfc8259#section-7)
|
|
func test_decode_json_with_escaped_slashes() {
|
|
let testJSONWithEscapedSlashes = "{\"tags\":[],\"pubkey\":\"f8e6c64342f1e052480630e27e1016dce35fc3a614e60434fef4aa2503328ca9\",\"content\":\"https:\\/\\/cdn.nostr.build\\/i\\/5c1d3296f66c2630131bf123106486aeaf051ed8466031c0e0532d70b33cddb2.jpg\",\"created_at\":1691864981,\"kind\":1,\"sig\":\"fc0033aa3d4df50b692a5b346fa816fdded698de2045e36e0642a021391468c44ca69c2471adc7e92088131872d4aaa1e90ea6e1ad97f3cc748f4aed96dfae18\",\"id\":\"e8f6eca3b161abba034dac9a02bb6930ecde9fd2fb5d6c5f22a05526e11382cb\"}"
|
|
let testNote = NdbNote.owned_from_json(json: testJSONWithEscapedSlashes)!
|
|
XCTAssertEqual(testNote.content, "https://cdn.nostr.build/i/5c1d3296f66c2630131bf123106486aeaf051ed8466031c0e0532d70b33cddb2.jpg")
|
|
}
|
|
|
|
func test_inherited_transactions() throws {
|
|
let ndb = Ndb(path: db_dir)!
|
|
do {
|
|
guard let txn1 = NdbTxn(ndb: ndb) else { return XCTAssert(false) }
|
|
|
|
let ntxn = (Thread.current.threadDictionary.value(forKey: "ndb_txn") as? ndb_txn)!
|
|
XCTAssertEqual(txn1.txn.lmdb, ntxn.lmdb)
|
|
XCTAssertEqual(txn1.txn.mdb_txn, ntxn.mdb_txn)
|
|
|
|
guard let txn2 = NdbTxn(ndb: ndb) else { return XCTAssert(false) }
|
|
|
|
XCTAssertEqual(txn1.inherited, false)
|
|
XCTAssertEqual(txn2.inherited, true)
|
|
}
|
|
|
|
let ndb_txn = Thread.current.threadDictionary.value(forKey: "ndb_txn")
|
|
XCTAssertNil(ndb_txn)
|
|
}
|
|
|
|
func test_decode_perf() throws {
|
|
// This is an example of a performance test case.
|
|
self.measure {
|
|
_ = NdbNote.owned_from_json(json: test_contact_list_json)
|
|
}
|
|
}
|
|
|
|
func test_perf_old_decoding() {
|
|
self.measure {
|
|
let event = decode_nostr_event_json(test_contact_list_json)
|
|
XCTAssertNotNil(event)
|
|
}
|
|
}
|
|
|
|
func test_perf_old_iter() {
|
|
self.measure {
|
|
let event = decode_nostr_event_json(test_contact_list_json)
|
|
XCTAssertNotNil(event)
|
|
}
|
|
}
|
|
|
|
func longer_iter(_ n: Int = 1000) -> XCTMeasureOptions {
|
|
let opts = XCTMeasureOptions()
|
|
opts.iterationCount = n
|
|
return opts
|
|
}
|
|
|
|
func test_iteration_perf() throws {
|
|
guard let note = NdbNote.owned_from_json(json: test_contact_list_json) else {
|
|
XCTAssert(false)
|
|
return
|
|
}
|
|
|
|
|
|
self.measure {
|
|
var count = 0
|
|
var char_count = 0
|
|
|
|
for tag in note.tags {
|
|
for elem in tag {
|
|
print("iter_elem \(elem.string())")
|
|
for c in elem {
|
|
if char_count == 0 {
|
|
let ac = AsciiCharacter(c)
|
|
XCTAssertEqual(ac, "p")
|
|
} else if char_count == 0 {
|
|
XCTAssertEqual(c, 0x6c)
|
|
}
|
|
char_count += 1
|
|
}
|
|
}
|
|
count += 1
|
|
}
|
|
|
|
XCTAssertEqual(count, 786)
|
|
XCTAssertEqual(char_count, 24370)
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|