feat: Add SearchSuggestionsFeature

This reverts commit 70ee5fd.

- feat: WIP Add `TCATextView`
- chore: Add `autoSuggest` higher-order `Reducer`
- feat: Introduce `AutoSuggestList`
- feat: Introduce `.attachedWindow`
- chore: Allow using the attached window corner radius from everywhere
- feat: Use `CustomList` to avoid height computation

Author: RemiBardon

Makefile

@@ -33,7 +33,7 @@ XCBEAUTIFY = ./BuildTools/.build/release/xcbeautify
 XCODEBUILD = set -o pipefail && xcodebuild
 XCPROJ = Prose/Prose.xcodeproj
 XCSCHEME = Prose
-PREVIEW_SCHEMES = ConversationFeaturePreview EditProfileFeaturePreview
+PREVIEW_SCHEMES = ConversationFeaturePreview EditProfileFeaturePreview ProseUIPreview SearchSuggestionsFeaturePreview
 
 preflight: lint test release_build build_preview_apps
 

Prose/Prose.xcodeproj/project.pbxproj

@@ -20,6 +20,7 @@ let package = Package(
       "JoinChatFeature",
       "MainWindowFeature",
       "ProseUI",
+      "SearchSuggestionsFeature",
       "SettingsFeature",
       "SidebarFeature",
       "UnreadFeature",
@@ -102,6 +103,10 @@ let package = Package(
         .product(name: "SwiftUINavigation", package: "swiftui-navigation"),
       ]
     ),
+    .target(name: "SearchSuggestionsFeature", dependencies: [
+      "AutoSuggestClient",
+      .featureBase,
+    ]),
     .target(
       name: "UnreadFeature",
       dependencies: [
@@ -112,6 +117,8 @@ let package = Package(
 
     // MARK: Dependencies
 
+    .target(name: "AutoSuggestClient", dependencies: [.base]),
+
     .target(name: "CredentialsClient", dependencies: [.base]),
     .testTarget(name: "CredentialsClientTests", dependencies: ["CredentialsClient"]),
 

Prose/ProseLib/Package.swift

@@ -0,0 +1,47 @@
+//
+// This file is part of prose-app-macos.
+// Copyright (c) 2022 Prose Foundation
+//
+
+import ComposableArchitecture
+import Foundation
+
+public extension AutoSuggestClient {
+  static func chooseFrom(
+    _ suggestions: [AutoSuggestSection<T>],
+    on searchFields: @escaping (T) -> Set<String>,
+    delay: DispatchQueue.SchedulerTimeType.Stride = 0.125,
+    mainQueue: AnySchedulerOf<DispatchQueue> = .main
+  ) -> AutoSuggestClient<T> {
+    AutoSuggestClient(
+      loadSuggestions: { searchQuery, excluded in
+        if searchQuery.isEmpty { return Effect(value: []) }
+
+        let filteredSuggestions: [AutoSuggestSection<T>] = suggestions.compactMap { section in
+          let filteredItems: [T] = section.items.filter { suggestion -> Bool in
+            let fields: Set<String> = searchFields(suggestion)
+
+            // Make sure no term is excluded (e.g. already in search field token)
+            guard fields.intersection(excluded).isEmpty else { return false }
+
+            // Search for a match in the fields (e.g. search in the JID and the full name)
+            return fields.contains { string -> Bool in
+              // NOTE: "The search is locale-aware, case and diacritic insensitive."
+              string.localizedStandardContains(searchQuery)
+            }
+          }
+
+          return filteredItems.isEmpty ? nil : AutoSuggestSection(
+            title: section.title,
+            items: filteredItems
+          )
+        }
+
+        return Effect(value: filteredSuggestions)
+          // A small delay pretend there was a network call
+          .delay(for: delay, scheduler: mainQueue)
+          .eraseToEffect()
+      }
+    )
+  }
+}

Prose/ProseLib/Sources/AutoSuggestClient/AutoSuggestClient+Static.swift

@@ -0,0 +1,50 @@
+//
+// This file is part of prose-app-macos.
+// Copyright (c) 2022 Prose Foundation
+//
+
+import Combine
+import ComposableArchitecture
+import Foundation
+import IdentifiedCollections
+
+public typealias SuggestionLoader<T: Hashable> = (
+  _ searchQuery: String,
+  _ excludedTerms: Set<String>
+) -> Effect<[AutoSuggestSection<T>], Error>
+
+public struct AutoSuggestClient<T: Hashable> {
+  public var loadSuggestions: SuggestionLoader<T>
+
+  public init(loadSuggestions: @escaping SuggestionLoader<T>) {
+    self.loadSuggestions = loadSuggestions
+  }
+}
+
+public struct AutoSuggestSection<T: Hashable> {
+  public var title: String
+  public var items: [T]
+
+  public var isEmpty: Bool { self.items.isEmpty }
+
+  public init(title: String, items: [T]) {
+    self.title = title
+    self.items = items
+  }
+}
+
+public extension AutoSuggestSection where T: Identifiable {
+  var identifiedItems: IdentifiedArrayOf<T> {
+    IdentifiedArray(uniqueElements: self.items)
+  }
+}
+
+extension AutoSuggestSection: Identifiable {
+  public var id: String { self.title }
+}
+
+extension AutoSuggestSection: Comparable {
+  public static func < (lhs: Self, rhs: Self) -> Bool {
+    lhs.title < rhs.title
+  }
+}

Prose/ProseLib/Sources/AutoSuggestClient/AutoSuggestClient.swift

@@ -0,0 +1,45 @@
+//
+// This file is part of prose-app-macos.
+// Copyright (c) 2022 Prose Foundation
+//
+
+import AppKit
+import SwiftUI
+
+final class AttachedViewController<Content: View>: NSViewController {
+  var content: Content
+
+  lazy var hc = NSHostingController(rootView: self.content)
+
+  init(content: Content) {
+    self.content = content
+    super.init(nibName: nil, bundle: nil)
+  }
+
+  @available(*, unavailable)
+  required init?(coder _: NSCoder) {
+    fatalError("init(coder:) has not been implemented")
+  }
+
+  override func loadView() {
+    // Set `self.view` so AppKit doesn't try to load a `nib` file
+    self.view = NSView()
+  }
+
+  override func viewDidLoad() {
+    super.viewDidLoad()
+
+    // Add the hosted view
+    self.addChild(self.hc)
+    self.view.addSubview(self.hc.view)
+
+    // Make sure the hosted view always fills the full view
+    self.hc.view.translatesAutoresizingMaskIntoConstraints = false
+    NSLayoutConstraint.activate([
+      self.hc.view.topAnchor.constraint(equalTo: self.view.topAnchor),
+      self.hc.view.leadingAnchor.constraint(equalTo: self.view.leadingAnchor),
+      self.hc.view.trailingAnchor.constraint(equalTo: self.view.trailingAnchor),
+      self.hc.view.bottomAnchor.constraint(equalTo: self.view.bottomAnchor),
+    ])
+  }
+}

Prose/ProseLib/Sources/SearchSuggestionsFeature/BetterImplementation/AttachedViewController.swift

@@ -0,0 +1,71 @@
+//
+// This file is part of prose-app-macos.
+// Copyright (c) 2022 Prose Foundation
+//
+
+import Combine
+import ComposableArchitecture
+import SwiftUI
+
+public extension View {
+  func attachedWindow<Content: View>(
+    isPresented: Bool,
+    @ViewBuilder content: () -> Content
+  ) -> some View {
+    AttachedWindow(root: self, content: content, showWindow: isPresented)
+  }
+}
+
+private struct AttachedWindow<Root: View, Content: View>: NSViewRepresentable {
+  let root: Root
+  let content: Content
+  let showWindow: Bool
+
+  public init(
+    root: Root,
+    @ViewBuilder content: () -> Content,
+    showWindow: Bool
+  ) {
+    self.root = root
+    self.content = content()
+    self.showWindow = showWindow
+  }
+
+  public func makeNSView(context _: Context) -> NSHostingView<Root> {
+    let view = NSHostingView(rootView: self.root)
+
+    // Prevent the view from filling up the whole screen
+    view.translatesAutoresizingMaskIntoConstraints = false
+
+    return view
+  }
+
+  public func updateNSView(_ view: NSHostingView<Root>, context: Context) {
+    view.rootView = self.root
+    view.invalidateIntrinsicContentSize()
+
+    DispatchQueue.main.async {
+      if self.showWindow {
+        context.coordinator.wc.showWindow(self.content, on: view)
+      } else {
+        context.coordinator.wc.orderOut()
+      }
+    }
+  }
+
+  public func makeCoordinator() -> Coordinator {
+    Coordinator(
+      wc: { AttachedWindowController(vc: AttachedViewController(content: self.content)) }
+    )
+  }
+
+  public final class Coordinator: NSObject {
+    let _wc: () -> AttachedWindowController<Content>
+
+    lazy var wc: AttachedWindowController<Content> = self._wc()
+
+    init(wc: @escaping () -> AttachedWindowController<Content>) {
+      self._wc = wc
+    }
+  }
+}

Prose/ProseLib/Sources/SearchSuggestionsFeature/BetterImplementation/AttachedWindow.swift

@@ -0,0 +1,95 @@
+//
+// This file is part of prose-app-macos.
+// Copyright (c) 2022 Prose Foundation
+//
+
+import Cocoa
+import SwiftUI
+
+public let attachedWindowControllerCornerRadius: CGFloat = 8
+
+class AttachedWindowController<Content: View>: NSWindowController {
+  let vc: AttachedViewController<Content>
+
+  init(vc: AttachedViewController<Content>) {
+    self.vc = vc
+
+    let window = NSWindow(contentViewController: vc)
+
+    // Remove the title bar
+    window.styleMask.remove(.titled)
+    // Disable window resizing
+    window.styleMask.remove(.resizable)
+    // Remove the default background
+    window.backgroundColor = .clear
+
+    let background = NSVisualEffectView()
+    // Set the background to the system material used for HUDs
+    background.material = .hudWindow
+    // Activate the effect
+    background.state = .active
+    // Allow corner clipping (otherwise the radius won't apply)
+    background.wantsLayer = true
+    // Set the corner radius
+    background.layer?.cornerRadius = attachedWindowControllerCornerRadius
+
+    let contentView = window.contentView!
+    // Add the background under the hosted view
+    contentView.addSubview(background, positioned: .below, relativeTo: vc.hc.view)
+
+    // Make sure the background always fills the full view
+    background.translatesAutoresizingMaskIntoConstraints = false
+    NSLayoutConstraint.activate([
+      background.leadingAnchor.constraint(equalTo: contentView.leadingAnchor),
+      background.trailingAnchor.constraint(equalTo: contentView.trailingAnchor),
+      background.topAnchor.constraint(equalTo: contentView.topAnchor),
+      background.bottomAnchor.constraint(equalTo: contentView.bottomAnchor),
+    ])
+
+    super.init(window: window)
+  }
+
+  @available(*, unavailable)
+  required init?(coder _: NSCoder) {
+    fatalError("init(coder:) has not been implemented")
+  }
+
+  func orderOut() {
+    if let window = self.window, window.isVisible {
+      window.orderOut(self)
+      logger.trace("Window removed from screen")
+    }
+  }
+
+  func showWindow(_ content: Content, on view: NSView) {
+    // Fail gracefully if we cannot show the window
+    guard let viewWindow = view.window else {
+      return logger.error("`view` has no `window`")
+    }
+    guard let window = self.window else {
+      return logger.error("`window` is `nil`")
+    }
+
+    // Show the window if needed
+    if !window.isVisible {
+      // Move the window under the text field
+      var viewRect = view.convert(view.bounds, to: nil)
+      viewRect = viewWindow.convertToScreen(viewRect)
+      window.setFrameTopLeftPoint(viewRect.origin)
+
+      // Make the window a little bigger than the text field
+      var frame = window.frame
+      frame.size.width = view.frame.width + 16
+      frame.origin.x -= 8
+      window.setFrame(frame, display: false)
+
+      // Add the window on screen
+      viewWindow.addChildWindow(window, ordered: .above)
+
+      logger.trace("Window added on screen")
+    }
+
+    // Update the view
+    self.vc.hc.rootView = content
+  }
+}