Add Sentry for error reporting #443

pepicrft · 2019-07-14T08:24:56Z

Short description 📝

Handled bugs and unhandled errors are not being reported at the moment. Therefore, we can only know about them if developers open issues on this repository.

Solution 📦

Create a project on Sentry and set up Tuist to use it.

Implementation 👩‍💻👨‍💻

Add Sentry.framework
Set up the project generation to link the TuistCore target against it.
Change the ErrorHandler logic to report bugs.
Observe unhandled errors and report them using the error handler.
Update the Rake package task to override the linking settings of the tuist and tuistenv binaries to link dynamically against Sentry.framework.
Pass the SentryDSN when building the Package for release.
Update the install logic in TuistEnv to pull the Sentry.framework
Update the install script to place the Sentry.framework next to tuistenv.
Document how to disable tracking.

Setup code

do {
        Client.shared = try Client(dsn: "xxx")
        try Client.shared?.startCrashHandler()
    } catch let error {
        print("\(error)")
    }

tuistbot · 2019-07-14T08:27:55Z

	1 Warning
⚠️	Have you introduced any user-facing changes? If so, please take some time to update the documentation. Keeping the documentation up to date makes it easier for users to learn how to use Tuist.

Rubocop violations

File	Line	Reason
Rakefile	90	Line is too long. [162/120] (https://shopify.github.io/ruby-style-guide/#80-character-limits)
install/install	141	Line is too long. [160/120] (https://shopify.github.io/ruby-style-guide/#80-character-limits)

Generated by 🚫 Danger

codecov · 2019-07-14T08:40:24Z

Codecov Report

Merging #443 into master will decrease coverage by 0.17%.
The diff coverage is 88.33%.

@@            Coverage Diff             @@
##           master     #443      +/-   ##
==========================================
- Coverage   92.23%   92.06%   -0.18%     
==========================================
  Files         319      319              
  Lines       16393    16492      +99     
==========================================
+ Hits        15120    15183      +63     
- Misses       1273     1309      +36

Impacted Files	Coverage Δ
Sources/TuistKit/Commands/CommandRegistry.swift	`0% <0%> (ø)`	⬆️
Sources/TuistCore/Errors/FatalError.swift	`22.22% <0%> (-44.45%)`	⬇️
Sources/TuistEnvKit/Commands/CommandRegistry.swift	`71.73% <100%> (+1.28%)`	⬆️
Sources/TuistEnvKit/Installer/BuildCopier.swift	`100% <100%> (ø)`	⬆️
.../TuistEnvKitTests/Installer/BuildCopierTests.swift	`100% <100%> (ø)`	⬆️
...tEnvKitTests/Installer/Mocks/MockBuildCopier.swift	`100% <100%> (ø)`	⬆️
Sources/TuistEnvKit/Installer/Installer.swift	`84.92% <100%> (-0.16%)`	⬇️
...ces/TuistCoreTesting/Errors/MockErrorHandler.swift	`100% <100%> (ø)`	⬆️
Sources/TuistCore/Errors/ErrorHandler.swift	`57.69% <18.18%> (-29.81%)`	⬇️
...ts/TuistEnvKitTests/Installer/InstallerTests.swift	`98.16% <98.94%> (+0.05%)`	⬆️
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1f8a75a...65f1575. Read the comment docs.

pepicrft · 2019-07-15T16:27:32Z

Rakefile

@@ -100,6 +135,16 @@ def storage
  )
 end

+def with_sentry_dsn


The sentry_dsn is a secret so this piece of code makes sure the value is defined in the SentryDsn.swift file when packaging a new release of Tuist.

pepicrft · 2019-07-15T16:27:57Z

Sources/TuistCore/Errors/ErrorHandler.swift

+    /// Returns true if the user decided to disable the analytics by setting the TUIST_ANALYTICS_DISABLED environment variable.
+    ///
+    /// - Returns: True if the analytics are disabled.
+    func isDisabled() -> Bool {


cc @kwridan do you think this should be enough?

…the executable directory is part of the dynamic linker paths in which it looks for the frameworks to link

…ameworks

pepicrft · 2019-07-17T16:44:11Z

The PR is blocked by this issue. We need the Sentry SDK API to provide an interface to send all the events and subscribe to the completion of the delivery. That'll allow Tuist to wait until the events are reported, otherwise it exits before the events reach the server.

pepicrft · 2019-07-18T08:55:39Z

After some tests, I realized that the Swift Package Manager doesn't export the dSYMs and therefore the stacktraces in Sentry can't be desymbolicated. That complicates debugging the issue.

I suggest taking a different approach here. Instead of reporting the errors to Sentry, use the GitHubClient to report the errors as GitHub issues. What do you think @tuist/core ?

kwridan · 2019-07-19T15:48:41Z

Agreed, I think a simpler alternate is better suited here - from @ollieatkinson suggestions (from slack) we can start by catching / surfacing the errors in the command line that will aid better bug reports.

ollieatkinson · 2019-07-19T20:46:43Z

The suggestion on slack was to create a global function for tagging errors which can be propagated through standard swift error handling.

@discardableResult @inlinable
public func report<T>(_ block: @autoclosure () throws -> T, message: String = "", file: String = #file, line: Int = #line, function: String = #function) throws -> T {

    do {
        return try block()
    } catch let error as ReportedError {
        throw error
    } catch let error as FatalError {
        throw ReportedError(error: error, message: message, file: file, line: line, function: function)
    } catch let error {
        throw ReportedError(error: UnhandledError(error: error), message: message, file: file, line: line, function: function)
    }
    
}

We should expand on this further and provide support for capturing the output of the shell command which failed.

pepicrft · 2019-07-25T14:17:59Z

I'll open a PR following the suggested approach.

pepicrft changed the title ~~[WIPSentry~~ [WIP] Add Sentry for error reporting Jul 14, 2019

pepicrft self-assigned this Jul 14, 2019

pepicrft requested a review from a team July 14, 2019 08:29

pepicrft commented Jul 15, 2019

View reviewed changes

pepicrft changed the title ~~[WIP] Add Sentry for error reporting~~ Add Sentry for error reporting Jul 16, 2019

Pedro Piñera added 14 commits July 17, 2019 18:13

Add Sentry framework

a19b8fb

Add task to generate the Xcode project

bceb942

Update the package task to export the Sentry framework and make sure …

fa5cc87

…the executable directory is part of the dynamic linker paths in which it looks for the frameworks to link

Don't enable crash reporting if TUIST_ANALYTICS_DISABLED is set to true

ce20421

Read the Sentry DSN from the root variable sentryDsn

4c4a4eb

Set the sentryDsn variable when packaging the project

744c731

Update install script to pull the Sentry framework into /usr/local/Fr…

db8f66c

…ameworks

Download Sentry when installing Tuist versions

f358a86

Add unit tests

007bd24

Add documentabion about how to disable the error tracking

b1a3983

Fix path

96a7ef9

Update the CHANGELOG

688509e

Update SENTRY_DSN env variable

0db37d3

Set up the error handler before running the command

906f1c7

pepicrft force-pushed the sentry branch from 3877554 to 906f1c7 Compare July 17, 2019 16:30

pepicrft mentioned this pull request Jul 17, 2019

Send crash reports if the app keeps crashing getsentry/sentry-cocoa#316

Closed

9 tasks

Pedro Piñera added 2 commits July 18, 2019 10:46

Remove Sentry

8165658

Remove Sentry from the installation script

65f1575

pepicrft closed this Jul 25, 2019

pepicrft deleted the sentry branch July 25, 2019 14:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Sentry for error reporting #443

Add Sentry for error reporting #443

pepicrft commented Jul 14, 2019 •

edited

tuistbot commented Jul 14, 2019 •

edited

codecov bot commented Jul 14, 2019 •

edited

pepicrft Jul 15, 2019

pepicrft Jul 15, 2019

pepicrft commented Jul 17, 2019

pepicrft commented Jul 18, 2019

kwridan commented Jul 19, 2019

ollieatkinson commented Jul 19, 2019

pepicrft commented Jul 25, 2019

Add Sentry for error reporting #443

Add Sentry for error reporting #443

Conversation

pepicrft commented Jul 14, 2019 • edited

Short description 📝

Solution 📦

Implementation 👩‍💻👨‍💻

tuistbot commented Jul 14, 2019 • edited

Rubocop violations

codecov bot commented Jul 14, 2019 • edited

Codecov Report

pepicrft Jul 15, 2019

Choose a reason for hiding this comment

pepicrft Jul 15, 2019

Choose a reason for hiding this comment

pepicrft commented Jul 17, 2019

pepicrft commented Jul 18, 2019

kwridan commented Jul 19, 2019

ollieatkinson commented Jul 19, 2019

pepicrft commented Jul 25, 2019

pepicrft commented Jul 14, 2019 •

edited

tuistbot commented Jul 14, 2019 •

edited

codecov bot commented Jul 14, 2019 •

edited