File: OSLogScraper.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (93 lines) | stat: -rw-r--r-- 3,292 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#if canImport(OSLog)
import OSLog

/// Reads oslog messages to find recent sourcekitd crashes.
struct OSLogScraper {
  /// How far into the past we should search for crashes in OSLog.
  var searchDuration: TimeInterval

  private func getLogEntries(matching predicate: NSPredicate) throws -> [any OSLogEntryWithPayload & OSLogEntry] {
    let logStore = try OSLogStore.local()
    let startPoint = logStore.position(date: Date().addingTimeInterval(-searchDuration))
    return
      try logStore
      .getEntries(
        at: startPoint,
        matching: predicate
      ).compactMap { $0 as? (OSLogEntryWithPayload & OSLogEntry) }
  }

  private func crashedSourceKitLSPRequests() throws -> [(name: String, logCategory: String)] {
    let predicate = NSPredicate(
      format: #"subsystem CONTAINS "sourcekit-lsp" AND composedMessage CONTAINS "sourcekitd crashed (1/""#
    )
    return try getLogEntries(matching: predicate).map {
      (name: "Crash at \($0.date)", logCategory: $0.category)
    }
  }

  /// Get the `RequestInfo` for a crash that was logged in `logCategory`.
  private func requestInfo(for logCategory: String) throws -> RequestInfo {
    let predicate = NSPredicate(
      format:
        #"subsystem CONTAINS "sourcekit-lsp" AND composedMessage CONTAINS "sourcekitd crashed" AND category = %@"#,
      logCategory
    )
    var isInFileContentSection = false
    var request = ""
    var fileContents = ""
    for entry in try getLogEntries(matching: predicate) {
      for line in entry.composedMessage.components(separatedBy: "\n") {
        if line.starts(with: "sourcekitd crashed (") {
          continue
        }
        if line == "Request:" {
          continue
        }
        if line == "File contents:" {
          isInFileContentSection = true
          continue
        }
        if line == "--- End Chunk" {
          continue
        }
        if isInFileContentSection {
          fileContents += line + "\n"
        } else {
          request += line + "\n"
        }
      }
    }

    var requestInfo = try RequestInfo(request: request)
    requestInfo.fileContents = fileContents
    return requestInfo
  }

  /// Get information about sourcekitd crashes that haven logged to OSLog.
  /// This information can be used to reduce the crash.
  ///
  /// Name is a human readable name that identifies the crash.
  func getCrashedRequests() throws -> [(name: String, info: RequestInfo)] {
    let crashedRequests = try crashedSourceKitLSPRequests().reversed()
    return crashedRequests.compactMap { (name: String, logCategory: String) -> (name: String, info: RequestInfo)? in
      guard let requestInfo = try? requestInfo(for: logCategory) else {
        return nil
      }
      return (name, requestInfo)
    }
  }
}
#endif