Merge pull request #136 from bugsnag/stop-sessions

Add stopSession() and resumeSession() to public API

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 4.X.X (TBD)
+
+Add StopSession() and ResumeSession() to public API [#136](https://github.com/bugsnag/bugsnag-unity/pull/136)
+
+Update bugsnag-android dependency to v4.11.0:
+  * Add stopSession() and resumeSession() to Client
+  [#429](https://github.com/bugsnag/bugsnag-android/pull/429)
+
+  * Prevent overwriting config.projectPackages if already set
+    [#428](https://github.com/bugsnag/bugsnag-android/pull/428)
+
+  * Fix incorrect session handledCount when notifying in quick succession
+    [#434](https://github.com/bugsnag/bugsnag-android/pull/434)
+
+Update bugsnag-cocoa dependency to v5.19.0:
+  * Update workspace to recommended settings suggested by XCode 10
+    [#324](https://github.com/bugsnag/bugsnag-cocoa/pull/324)
+  * Add stopSession() and resumeSession() to Bugsnag
+    [#325](https://github.com/bugsnag/bugsnag-cocoa/pull/325)
+  * Capture basic report diagnostics in the file path in case of crash report
+    content corruption
+    [#327](https://github.com/bugsnag/bugsnag-cocoa/pull/327)
+
 ## 4.2.2 (2019-02-26)
 
 ### Bug fixes

Rakefile

@@ -225,41 +225,11 @@ namespace :plugin do
     end
   end
 
-  task :check_package do
-    expected_guids = []
-    package_guids = []
-
-    cd current_directory do
-      Open3.popen2("git", "ls-files", "--", "unity/**/*.meta") do |stdin, stdout, wait_thr|
-        stdout.each_line do |file|
-          File.open(file.gsub("\n", "")).each_line do |line|
-            if match = /guid: ([a-z0-9]+)/.match(line)
-              expected_guids << match[1]
-              break
-            end
-          end
-        end
-      end
-
-      Open3.popen2("tar", "-tf", "Bugsnag.unitypackage", "*/asset.meta") do |stdin, stdout, wait_thr|
-        stdout.each_line do |line|
-          if match = /\.\/([a-z0-9]+)\/asset.meta/.match(line)
-            package_guids << match[1]
-          end
-        end
-      end
-    end
-
-    unless expected_guids.sort == package_guids.sort
-      raise "package contains unknown files"
-    end
-  end
-
   task :export_package do
     export_package
   end
 
-  task export: %w[plugin:build:all export_package check_package]
+  task export: %w[plugin:build:all export_package]
 
   task maze_runner: %w[plugin:export] do
     sh "bundle", "exec", "bugsnag-maze-runner"

example/Assets/Main.cs

@@ -63,7 +63,7 @@ void Start ()
 	private static extern void Crash();
 
 	[DllImport("__Internal")]
-	private static extern void CrashCrashInBackground();
+	private static extern void CrashInBackground();
 #endif
 
 	private void OnNativeCrashClick()
@@ -82,7 +82,7 @@ private void OnNativeCrashClick()
 	private void OnNativeBackgroundCrashClick()
 	{
 #if UNITY_IOS
-		CrashCrashInBackground();
+		CrashInBackground();
 #elif UNITY_ANDROID
 		using (var java = new AndroidJavaObject("BugsnagCrash"))
 		{
@@ -112,17 +112,17 @@ private void OnDivideByZeroClick()
 			int b = 1;
 			int c = b / a;
 		} catch (Exception e) {
-			//BugsnagUnity.Bugsnag.Client.Notify(e);
+			BugsnagUnity.Bugsnag.Client.Notify(e);
 		}
 	}
 
 	private void OnNotifyClick()
 	{
 		Debug.Log ("Notify clicked");
-		// BugsnagUnity.Bugsnag.Client.Notify(new Exception ("Notify clicked!"), report =>
-		// 	{
-		// 		report.Event.Context = "NotifyClicked";
-		// 	});
+		 BugsnagUnity.Bugsnag.Client.Notify(new Exception ("Notify clicked!"), report =>
+		 	{
+		 		report.Context = "NotifyClicked";
+		 	});
 	}
 
 	private void OnManagedCrashClick()

features/fixtures/Main.cs

@@ -106,9 +106,44 @@ void LoadScenario() {
         DoLogWarning();
         UncaughtExceptionAsUnhandled();
         break;
+      case "StoppedSession":
+        Bugsnag.StartSession();
+        Bugsnag.StopSession();
+        DoNotify();
+        break;
+      case "ResumedSession":
+        RunResumedSession();
+        break;
+      case "NewSession":
+        RunNewSession();
+        break;
     }
   }
 
+  void RunResumedSession() {
+    // send 1st exception which should include session info
+    Bugsnag.StartSession();
+    Bugsnag.Notify(new System.Exception("First Error"));
+
+    // send 2nd exception after resuming a session
+    Bugsnag.StopSession();
+    Bugsnag.ResumeSession();
+    Bugsnag.Notify(new System.Exception("Second Error"));
+  }
+
+  void RunNewSession() {
+    // send 1st exception which should include session info
+    Bugsnag.StartSession();
+    Bugsnag.Notify(new System.Exception("First Error"));
+
+    // stop tracking the existing session
+    Bugsnag.StopSession();
+    Bugsnag.StartSession();
+
+    // send 2nd exception which should contain new session info
+    Bugsnag.Notify(new System.Exception("Second Error"));
+  }
+
   void UncaughtExceptionAsUnhandled() {
     Bugsnag.Configuration.ReportUncaughtExceptionsAsHandled = false;
     throw new ExecutionEngineException("Invariant state failure");

features/stopping_sessions.feature

@@ -0,0 +1,32 @@
+Feature: Stopping and resuming sessions
+
+Scenario: When a session is stopped the error has no session information
+    When I run the game in the "StoppedSession" state
+    Then I should receive 2 requests
+    And the request 0 is valid for the session tracking API
+    And the request 1 is valid for the error reporting API
+    And the payload field "events.0.session" is null for request 1
+
+Scenario: When a session is resumed the error uses the previous session information
+    When I run the game in the "ResumedSession" state
+    Then I should receive 3 requests
+    And the request 0 is valid for the session tracking API
+    And the request 1 is valid for the error reporting API
+    And the request 2 is valid for the error reporting API
+    And the payload field "events.0.session.id" of request 1 equals the payload field "events.0.session.id" of request 2
+    And the payload field "events.0.session.startedAt" of request 1 equals the payload field "events.0.session.startedAt" of request 2
+    And the events in requests "1,2" match one of:
+        | message      | handled | unhandled |
+        | First Error  | 1       | 0         |
+        | Second Error | 2       | 0         |
+
+Scenario: When a new session is started the error uses different session information
+    When I run the game in the "NewSession" state
+    Then I should receive 4 requests
+    And the request 0 is valid for the session tracking API
+    And the request 1 is valid for the session tracking API
+    And the request 2 is valid for the error reporting API
+    And the request 3 is valid for the error reporting API
+    And the payload field "events.0.session.events.handled" equals 1 for request 2
+    And the payload field "events.0.session.events.handled" equals 1 for request 3
+    And the payload field "events.0.session.id" of request 2 does not equal the payload field "events.0.session.id" of request 3

src/BugsnagUnity/Bugsnag.cs

@@ -60,6 +60,10 @@ public static void SetUser(string id, string email, string name) {
 
     public static void StartSession() => InternalClient.SessionTracking.StartSession();
 
+    public static void StopSession() => InternalClient.SessionTracking.StopSession();
+
+    public static bool ResumeSession() => InternalClient.SessionTracking.ResumeSession();
+
     /// <summary>
     /// Used to signal to the Bugsnag client that the focused state of the
     /// application has changed. This is used for session tracking and also

src/BugsnagUnity/Client.cs

@@ -7,7 +7,7 @@
 
 namespace BugsnagUnity
 {
-  class Client : IClient
+  internal class Client : IClient
   {
     public IConfiguration Configuration => NativeClient.Configuration;
 

src/BugsnagUnity/INativeClient.cs

@@ -1,5 +1,8 @@
 using BugsnagUnity.Payload;
 using System.Collections.Generic;
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2")]
 
 namespace BugsnagUnity
 {

src/BugsnagUnity/Payload/Session.cs

@@ -11,6 +11,8 @@ public class Session : Dictionary<string, object>
 
     internal SessionEvents Events { get; }
 
+    internal bool Stopped { get; set; }
+
     internal Session() : this(DateTime.UtcNow, 0, 0)
     {
 

src/BugsnagUnity/SessionTracker.cs

@@ -1,11 +1,18 @@
 using BugsnagUnity.Payload;
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("BugsnagUnity.Tests")]
 
 namespace BugsnagUnity
 {
   public interface ISessionTracker
   {
     void StartSession();
 
+    void StopSession();
+
+    bool ResumeSession();
+
     Session CurrentSession { get; }
 
     void AddException(Report report);
@@ -19,7 +26,14 @@ class SessionTracker : ISessionTracker
 
     public Session CurrentSession
     {
-      get => _currentSession?.Copy();
+      get {
+        var session = _currentSession;
+
+        if (session != null && !session.Stopped) {
+          return session?.Copy();
+        }
+        return null;
+      }
       private set => _currentSession = value;
     }
 
@@ -43,6 +57,30 @@ public void StartSession()
 
       Client.Send(payload);
     }
+
+    public void StopSession()
+    {
+      var session = _currentSession;
+
+      if (session != null) {
+        session.Stopped = true;
+      }
+    }
+
+    public bool ResumeSession()
+    {
+      var session = _currentSession;
+      var resumed = false;
+
+      if (session == null) {
+        StartSession();
+        resumed = false;
+      } else {
+        resumed = session.Stopped;
+        session.Stopped = false;
+      }
+      return resumed;
+    }
 
     public void AddException(Report report)
     {

tests/BugsnagUnity.Tests/SessionTrackerTests.cs

@@ -0,0 +1,92 @@
+using NUnit.Framework;
+using System.Linq;
+using System.Threading;
+using UnityEngine;
+
+namespace BugsnagUnity.Payload.Tests
+{
+  [TestFixture]
+  class SessionTrackerTests
+  {
+
+    public SessionTracker Tracker { get; set; }
+
+    public SessionTrackerTests()
+    {
+      Client client = new Client(new NativeClient(new Configuration("api-key")));
+      Tracker = new SessionTracker(client);
+      Assert.IsNotNull(Tracker);
+    }
+
+     /**
+     * Verifies that a session can be resumed after it is stopped
+     */
+    [Test]
+    public void ResumeFromStoppedSession() {
+      Tracker.StartSession();
+      var originalSession = Tracker.CurrentSession;
+      Assert.IsNotNull(originalSession);
+
+      Tracker.StopSession();
+      Assert.IsNull(Tracker.CurrentSession);
+
+      Assert.IsTrue(Tracker.ResumeSession());
+      Assert.AreEqual(originalSession, Tracker.CurrentSession);
+    }
+
+     /**
+     * Verifies that the previous session is resumed when calling SessionTracker.ResumeSession
+     */
+    [Test]
+    public void ResumeWithNoStoppedSession() {
+      Tracker.StartSession();
+      Tracker.StopSession();
+      Assert.IsTrue(Tracker.ResumeSession());
+      Assert.IsFalse(Tracker.ResumeSession());
+    }
+
+     /**
+     * Verifies that a new session can be created after the previous one is stopped
+     */
+    [Test]
+    public void StartNewAfterStoppedSession() {
+      Tracker.StartSession();
+      var originalSession = Tracker.CurrentSession;
+
+      Tracker.StopSession();
+      Tracker.StartSession();
+      Assert.AreNotEqual(originalSession, Tracker.CurrentSession);
+    }
+
+     /**
+     * Verifies that calling SessionTracker.ResumeSession multiple times only starts one session
+     */
+    [Test]
+    public void MultipleResumesHaveNoEffect() {
+      Tracker.StartSession();
+      var original = Tracker.CurrentSession;
+      Tracker.StopSession();
+
+      Assert.IsTrue(Tracker.ResumeSession());
+      Assert.AreEqual(original, Tracker.CurrentSession);
+
+      Assert.IsFalse(Tracker.ResumeSession());
+      Assert.AreEqual(original, Tracker.CurrentSession);
+    }
+
+     /**
+     * Verifies that calling SessionTracker.StopSession multiple times only stops one session
+     */
+    [Test]
+    public void MultipleStopsHaveNoEffect() {
+      Tracker.StartSession();
+      Assert.IsNotNull(Tracker.CurrentSession);
+
+      Tracker.StopSession();
+      Assert.IsNull(Tracker.CurrentSession);
+
+      Tracker.StopSession();
+      Assert.IsNull(Tracker.CurrentSession);
+    }
+  }
+}