Files
conjure/Tests/ConjureKitTests/NotesEditingTests.swift
T
2026-10-19 11:14:54 +02:00

325 lines
18 KiB
Swift

import AppKit
import ConjureKit
import Testing
@testable import Conjure
@Test @MainActor
func notesSwitchWithoutLeakingEditsUndoOrAttachmentsAndRestoreSelection() throws {
_ = NSApplication.shared
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
let suite = "NotesEditing.\(UUID().uuidString)"
let defaults = try #require(UserDefaults(suiteName: suite))
defer {
try? FileManager.default.removeItem(at: directory)
defaults.removePersistentDomain(forName: suite)
}
let controller = NotesController(defaults: defaults, directory: directory)
let window = NSWindow(contentRect: NSRect(x: 0, y: 0, width: 750, height: 390), styleMask: [.borderless], backing: .buffered, defer: false)
window.contentViewController = controller
defer { _ = controller.close(); window.orderOut(nil) }
func descendants(_ view: NSView) -> [NSView] { [view] + view.subviews.flatMap(descendants) }
let views = descendants(controller.view)
let editor = try #require(views.compactMap { $0 as? NSTextView }.first)
let browse = try #require(views.compactMap { $0 as? NSButton }.first { $0.title == "Browse Notes" })
#expect(browse.keyEquivalent == "p")
#expect(!views.compactMap { $0 as? NSButton }.contains { $0.title == "New Note" })
func selectedID() throws -> UUID { try #require(defaults.string(forKey: "selectedNote").flatMap(UUID.init(uuidString:))) }
func picker(_ tool: NotesController) throws -> NSSearchField {
try #require(descendants(tool.view).compactMap { $0 as? NSSearchField }.first { $0.accessibilityLabel() == "Search notes" })
}
func filter(_ field: NSSearchField, _ query: String) {
field.stringValue = query
field.delegate?.controlTextDidChange?(Notification(name: NSControl.textDidChangeNotification, object: field))
field.window?.contentView?.layoutSubtreeIfNeeded()
}
let firstID = try selectedID()
// Empty notes have duplicate titles; UUID identity must survive the shared picker.
window.makeFirstResponder(editor)
let newNoteKey = try #require(NSEvent.keyEvent(with: .keyDown, location: .zero,
modifierFlags: .command, timestamp: 1, windowNumber: window.windowNumber, context: nil,
characters: "n", charactersIgnoringModifiers: "n", isARepeat: false, keyCode: 45))
#expect(window.performKeyEquivalent(with: newNoteKey))
let secondID = try selectedID()
#expect(secondID != firstID)
for expectedID in [firstID, secondID] {
browse.performClick(nil)
_ = try picker(controller)
let table = try #require(descendants(controller.view).compactMap { $0 as? NSTableView }.first)
#expect(table.numberOfRows == 2)
#expect(controller.handleControlKey(table.selectedRow == 0 ? "j" : "k"))
#expect(controller.handle(#selector(NSResponder.insertNewline(_:))))
#expect(try selectedID() == expectedID)
#expect(window.firstResponder === editor)
}
#expect(!controller.handleControlKey("j"))
#expect(!controller.handle(#selector(NSResponder.insertNewline(_:))))
editor.insertText("# Second 🦊\n**bold** and `code`", replacementRange: editor.selectedRange())
#expect((editor.textStorage?.attribute(.font, at: 0, effectiveRange: nil) as? NSFont)?.pointSize == 17)
let codeRange = (editor.string as NSString).range(of: "`code`")
let codeFont = try #require(editor.textStorage?.attribute(.font, at: codeRange.location, effectiveRange: nil) as? NSFont)
#expect(codeFont.isFixedPitch)
browse.performClick(nil)
filter(try picker(controller), "nttld")
#expect(controller.handle(#selector(NSResponder.insertNewline(_:))))
#expect(try selectedID() == firstID)
#expect(editor.string.isEmpty)
#expect(editor.undoManager?.canUndo != true)
editor.insertText("First note", replacementRange: editor.selectedRange())
let bitmap = try #require(NSBitmapImageRep(bitmapDataPlanes: nil, pixelsWide: 1, pixelsHigh: 1, bitsPerSample: 8, samplesPerPixel: 4, hasAlpha: true, isPlanar: false, colorSpaceName: .deviceRGB, bytesPerRow: 0, bitsPerPixel: 0))
bitmap.setColor(.red, atX: 0, y: 0)
let imageURL = directory.appendingPathComponent("image.png")
let png = try #require(bitmap.representation(using: .png, properties: [:]))
try png.write(to: imageURL)
let pasteboard = NSPasteboard.withUniqueName()
defer { pasteboard.releaseGlobally() }
pasteboard.setData(png, forType: .png)
#expect(editor.readSelection(from: pasteboard))
pasteboard.clearContents()
pasteboard.writeObjects([imageURL as NSURL])
#expect(editor.readSelection(from: pasteboard))
#expect(controller.save())
let returnKey = try #require(NSEvent.keyEvent(with: .keyDown, location: .zero,
modifierFlags: [], timestamp: 2, windowNumber: window.windowNumber, context: nil,
characters: "\r", charactersIgnoringModifiers: "\r", isARepeat: false, keyCode: 36))
editor.keyDown(with: returnKey)
#expect(editor.string == "First note\u{fffc}\u{fffc}\n")
#expect(try selectedID() == firstID)
let restored = try NotesStore(directory: directory)
let first = try #require(restored.notes.first { $0.id == firstID })
#expect(first.contents.string == "First note\u{fffc}\u{fffc}\n")
#expect(first.contents.attribute(.attachment, at: 10, effectiveRange: nil) is NSTextAttachment)
#expect(first.contents.attribute(.attachment, at: 11, effectiveRange: nil) is NSTextAttachment)
#expect(restored.notes.first { $0.id == secondID }?.contents.string == "# Second 🦊\n**bold** and `code`")
let reopened = NotesController(defaults: defaults, directory: directory)
let reopenedWindow = NSWindow(contentRect: window.frame, styleMask: [.borderless], backing: .buffered, defer: false)
reopenedWindow.contentViewController = reopened
defer { _ = reopened.close(); reopenedWindow.orderOut(nil) }
let reopenedViews = descendants(reopened.view)
let reopenedEditor = try #require(reopenedViews.compactMap { $0 as? NSTextView }.first)
#expect(reopenedEditor.string == first.contents.string)
// Removing Markdown must also remove its previous visual style without changing the source.
reopenedEditor.insertText("Plain text", replacementRange: NSRange(location: 0, length: reopenedEditor.string.utf16.count))
#expect((reopenedEditor.textStorage?.attribute(.font, at: 0, effectiveRange: nil) as? NSFont)?.pointSize == 14)
#expect(reopenedEditor.string == "Plain text")
let backup = directory.appendingPathExtension("backup")
defer { try? FileManager.default.removeItem(at: backup) }
try FileManager.default.moveItem(at: directory, to: backup)
try Data("Blocked storage".utf8).write(to: directory)
reopenedEditor.insertText("Unsaved", replacementRange: NSRange(location: 0, length: reopenedEditor.string.utf16.count))
var closed = false
reopened.closed = { closed = true }
reopened.goBack()
#expect(!closed)
#expect(!reopened.save())
reopened.browseNotes()
filter(try picker(reopened), "scnd")
#expect(reopened.handle(#selector(NSResponder.insertNewline(_:))))
#expect(reopenedEditor.string == "Unsaved")
#expect(try selectedID() == firstID)
reopened.browseNotes()
#expect(!reopened.close())
#expect(!closed)
#expect(try picker(reopened).window === reopenedWindow)
try FileManager.default.removeItem(at: directory)
try FileManager.default.moveItem(at: backup, to: directory)
#expect(reopened.save())
#expect(reopened.close())
#expect(closed)
#expect(!descendants(reopened.view).contains { ($0 as? NSSearchField)?.accessibilityLabel() == "Search notes" })
}
@Test @MainActor
func notesLauncherRoutesShortcutsAndTearsDownPickersWithoutTakingEditorNavigation() throws {
_ = NSApplication.shared
let suite = "NotesShortcuts.\(UUID().uuidString)"
let defaults = try #require(UserDefaults(suiteName: suite))
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(suite)
defer {
defaults.removePersistentDomain(forName: suite)
try? FileManager.default.removeItem(at: directory)
}
let store = try NotesStore(directory: directory)
let atlas = try store.create()
let journal = try store.create()
try store.update(id: atlas, contents: NSAttributedString(string: "Project Atlas"))
try store.update(id: journal, contents: NSAttributedString(string: "Weekend journal"))
defaults.set(atlas.uuidString, forKey: "selectedNote")
let launcher = LauncherWindowController(
history: LaunchHistory(defaults: defaults, now: { Date(timeIntervalSinceReferenceDate: 12_000) }),
defaults: defaults, notesDirectory: directory)
let window = try #require(launcher.window)
defer { launcher.dismiss(restoringFocus: false) }
let content = try #require(window.contentView)
func descendants(_ view: NSView) -> [NSView] { [view] + view.subviews.flatMap(descendants) }
func search(_ label: String) throws -> NSSearchField {
try #require(descendants(content).compactMap { $0 as? NSSearchField }.first { $0.accessibilityLabel() == label })
}
func key(_ text: String, code: UInt16, flags: NSEvent.ModifierFlags = []) throws -> NSEvent {
let characters = flags == .control && text == "k" ? "\u{b}" : text
return try #require(NSEvent.keyEvent(with: .keyDown, location: .zero, modifierFlags: flags,
timestamp: 1, windowNumber: window.windowNumber, context: nil, characters: characters,
charactersIgnoringModifiers: text, isARepeat: false, keyCode: code))
}
func command(_ text: String, code: UInt16) throws {
#expect(window.performKeyEquivalent(with: try key(text, code: code, flags: .command)))
}
func filter(_ field: NSSearchField, _ text: String) {
field.stringValue = text
field.delegate?.controlTextDidChange?(Notification(name: NSControl.textDidChangeNotification, object: field))
content.layoutSubtreeIfNeeded()
}
let launcherSearch = try #require(descendants(content).compactMap { $0 as? NSSearchField }.first)
launcherSearch.stringValue = "notes"
launcher.controlTextDidChange(Notification(name: NSControl.textDidChangeNotification, object: launcherSearch))
#expect(launcher.control(launcherSearch, textView: NSTextView(), doCommandBy: #selector(NSResponder.insertNewline(_:))))
window.makeKeyAndOrderFront(nil)
let browse = try #require(descendants(content).compactMap { $0 as? NSButton }.first { $0.title == "Browse Notes" })
let tool = try #require(browse.target as? NotesController)
let editor = try #require(descendants(content).compactMap { $0 as? NSTextView }.first { $0.accessibilityLabel() == "Note editor" })
window.makeFirstResponder(editor)
try command("p", code: 35)
let picker = try search("Search notes")
let table = try #require(descendants(content).compactMap { $0 as? NSTableView }.first { $0.accessibilityLabel() == "Notes" })
#expect(window.firstResponder === picker.currentEditor())
#expect(browse.superview?.isAccessibilityHidden() == true)
#expect(tool.handle(#selector(NSResponder.moveUp(_:))))
window.sendEvent(try key("j", code: 38, flags: .control))
#expect(table.selectedRow == 1)
window.sendEvent(try key("k", code: 40, flags: .control))
#expect(table.selectedRow == 0)
filter(picker, "wkndjrnl")
#expect(table.numberOfRows == 1)
#expect(tool.handle(#selector(NSResponder.insertNewline(_:))))
#expect(defaults.string(forKey: "selectedNote") == journal.uuidString)
#expect(editor.string == "Weekend journal")
#expect(window.firstResponder === editor)
try command("p", code: 35)
_ = try search("Search notes")
try command("p", code: 35)
#expect(window.firstResponder === editor)
try command("k", code: 40)
filter(try search("Search notes actions"), "Browse Notes")
#expect(tool.handle(#selector(NSResponder.insertNewline(_:))))
_ = try search("Search notes")
window.sendEvent(try key("\u{1b}", code: 53))
#expect(window.isVisible && window.firstResponder === editor)
try command("k", code: 40)
filter(try search("Search notes actions"), "New Note")
#expect(tool.handle(#selector(NSResponder.insertNewline(_:))))
#expect(editor.string.isEmpty)
let actionCreatedID = defaults.string(forKey: "selectedNote")
try command("n", code: 45)
#expect(defaults.string(forKey: "selectedNote") != actionCreatedID)
let editorCreatedID = defaults.string(forKey: "selectedNote")
try command("p", code: 35)
_ = try search("Search notes")
try command("n", code: 45)
#expect(defaults.string(forKey: "selectedNote") != editorCreatedID)
#expect(window.firstResponder === editor)
#expect(!tool.handle(#selector(NSResponder.moveDown(_:))))
#expect(!tool.handleControlKey("k"))
editor.insertText("Navigation", replacementRange: editor.selectedRange())
editor.setSelectedRange(NSRange(location: 0, length: 0))
window.sendEvent(try key("k", code: 40, flags: .control))
#expect(editor.string.isEmpty)
editor.insertText("Editable", replacementRange: editor.selectedRange())
editor.keyDown(with: try key("\r", code: 36))
#expect(editor.string == "Editable\n")
try command("p", code: 35)
#expect(tool.close())
#expect(!descendants(content).compactMap { $0 as? NSSearchField }.contains { $0.accessibilityLabel() == "Search notes" })
#expect(launcherSearch.isHidden == false)
}
@Test @MainActor
func markdownListReturnContinuesExitsAndUndoesAtArbitraryDepths() throws {
_ = NSApplication.shared
let suite = "NotesLists.\(UUID().uuidString)"
let defaults = try #require(UserDefaults(suiteName: suite))
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(suite)
defer {
defaults.removePersistentDomain(forName: suite)
try? FileManager.default.removeItem(at: directory)
}
let controller = NotesController(defaults: defaults, directory: directory)
let window = NSWindow(contentRect: NSRect(x: 0, y: 0, width: 750, height: 390),
styleMask: .borderless, backing: .buffered, defer: false)
window.contentViewController = controller
defer { _ = controller.close(); window.orderOut(nil) }
func descendants(_ view: NSView) -> [NSView] { [view] + view.subviews.flatMap(descendants) }
let editor = try #require(descendants(controller.view).compactMap { $0 as? NSTextView }.first)
window.makeFirstResponder(editor)
let enter = try #require(NSEvent.keyEvent(with: .keyDown, location: .zero, modifierFlags: [],
timestamp: 1, windowNumber: window.windowNumber, context: nil, characters: "\r",
charactersIgnoringModifiers: "\r", isARepeat: false, keyCode: 36))
func reset(_ text: String) {
editor.insertText(text, replacementRange: NSRange(location: 0, length: editor.string.utf16.count))
editor.breakUndoCoalescing()
editor.undoManager?.removeAllActions()
}
let examples = [
("- fox 🦊", "- fox 🦊\n- "),
(" * nested", " * nested\n * "),
("\t+ nested", "\t+ nested\n\t+ "),
("9. ninth", "9. ninth\n10. "),
(" 12) nested", " 12) nested\n 13) "),
("- [x] finished", "- [x] finished\n- [ ] "),
("- ", ""), ("+ \t ", ""), ("4. ", ""), ("- [ ] ", ""),
("- parent\n - ", "- parent\n- "),
("1. parent\n * ", "1. parent\n2. "),
("- parent\n\t+ child\n\t\t3) ", "- parent\n\t+ child\n\t+ "),
("- first\n - child\n - ", "- first\n - child\n- "),
("- parent\n continuation\n - ", "- parent\n continuation\n- "),
("- parent\nparagraph\n - ", "- parent\nparagraph\n"),
("- parent\n + ", "- parent\n- "),
("- parent\r\n - ", "- parent\r\n- "),
("prose", "prose\n"), ("* * *", "* * *\n"),
("```md\n- literal", "```md\n- literal\n"),
("~~~\n 1. literal", "~~~\n 1. literal\n"),
("```\n- literal\n```\n- real", "```\n- literal\n```\n- real\n- "),
]
for (before, after) in examples {
reset(before)
editor.keyDown(with: enter)
#expect(editor.string == after, "Return in \(before.debugDescription)")
#expect(editor.selectedRange() == NSRange(location: after.utf16.count, length: 0))
}
reset("- ab🦊cd")
editor.setSelectedRange((editor.string as NSString).range(of: "🦊"))
editor.keyDown(with: enter)
#expect(editor.string == "- ab\n- cd")
#expect(editor.selectedRange() == NSRange(location: 7, length: 0))
reset("- parent\n - child\n - leaf")
editor.keyDown(with: enter)
#expect(editor.string == "- parent\n - child\n - leaf\n - ")
editor.keyDown(with: enter)
#expect(editor.string == "- parent\n - child\n - leaf\n - ")
editor.keyDown(with: enter)
#expect(editor.string == "- parent\n - child\n - leaf\n- ")
editor.keyDown(with: enter)
#expect(editor.string == "- parent\n - child\n - leaf\n")
// Nesting follows actual ancestor indentation, not a fixed depth or indent size.
let ancestors = (0..<80).map { String(repeating: " ", count: $0 * 2) + "- level \($0)" }.joined(separator: "\n")
let before = ancestors + "\n" + String(repeating: " ", count: 160) + "- leaf"
reset(before)
editor.keyDown(with: enter)
#expect(editor.string == before + "\n" + String(repeating: " ", count: 160) + "- ")
for depth in stride(from: 79, through: 0, by: -1) {
editor.keyDown(with: enter)
#expect(editor.string == before + "\n" + String(repeating: " ", count: depth * 2) + "- ")
}
editor.keyDown(with: enter)
#expect(editor.string == before + "\n")
reset("7. saved")
editor.keyDown(with: enter)
editor.breakUndoCoalescing()
#expect(editor.string == "7. saved\n8. ")
editor.undoManager?.undo()
#expect(editor.string == "7. saved")
editor.undoManager?.redo()
#expect(editor.string == "7. saved\n8. ")
let restored = try NotesStore(directory: directory)
let id = try #require(defaults.string(forKey: "selectedNote").flatMap(UUID.init(uuidString:)))
#expect(restored.notes.first { $0.id == id }?.contents.string == "7. saved\n8. ")
}