Merge pull request #618 from bugsnag/next

Release v7.2.0

.buildkite/pipeline.full.yml

@@ -581,7 +581,7 @@ steps:
     key: 'windows-2018-fixture'
     depends_on: 'build-artifacts'
     agents:
-      queue: windows-general-wsl
+      queue: windows-unity-wsl
     env:
       UNITY_VERSION: "2018.4.36f1"
     command:
@@ -603,7 +603,7 @@ steps:
     key: 'windows-2019-fixture'
     depends_on: 'build-artifacts'
     agents:
-      queue: windows-general-wsl
+      queue: windows-unity-wsl
     env:
       UNITY_VERSION: "2019.4.35f1"
     command:
@@ -625,7 +625,7 @@ steps:
     key: 'windows-2021-fixture'
     depends_on: 'build-artifacts'
     agents:
-      queue: windows-general-wsl
+      queue: windows-unity-wsl
     env:
       UNITY_VERSION: "2021.3.3f1"
     commands:

.buildkite/pipeline.yml

@@ -24,7 +24,7 @@ steps:
   - label: Ensure notifier builds on Windows (for development)
     timeout_in_minutes: 30
     agents:
-      queue: windows-general-wsl
+      queue: windows-unity-wsl
     env:
       UNITY_VERSION: "2018.4.36f1"
       WSLENV: UNITY_VERSION
@@ -285,7 +285,7 @@ steps:
     key: 'windows-2020-fixture'
     depends_on: 'build-artifacts'
     agents:
-      queue: windows-general-wsl
+      queue: windows-unity-wsl
     env:
       UNITY_VERSION: "2020.3.32f1"
     plugins:

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 7.2.0 (2022-09-12)
+
+### Enhancements
+
+* Added `BugsnagEvent.FeatureFlags` to allow feature flags to be queried before event delivery.
+  [#613](https://github.com/bugsnag/bugsnag-unity/pull/613)
+
+### Bug fixes
+
+* Reverted the `HideFlags` fix introduced [here](https://github.com/bugsnag/bugsnag-unity/pull/604) as it was causing (harmless) `NullReferenceException`s in the editor.
+  [#617](https://github.com/bugsnag/bugsnag-unity/pull/617)
+
 ## 7.1.1 (2022-09-07)
 
 ### Bug fixes

build.cake

@@ -5,7 +5,7 @@ var target = Argument("target", "Default");
 var solution = File("./BugsnagUnity.sln");
 var configuration = Argument("configuration", "Release");
 var project = File("./src/BugsnagUnity/BugsnagUnity.csproj");
-var version = "7.1.1";
+var version = "7.2.0";
 
 Task("Restore-NuGet-Packages")
     .Does(() => NuGetRestore(solution));

features/android/android_callbacks.feature

@@ -96,6 +96,12 @@ Feature: Callbacks
         And the event "breadcrumbs.0.type" equals "user"
         And the event "breadcrumbs.0.metaData.Custom" equals "Metadata"
 
+        # Feature flags
+        And the event "featureFlags.0.featureFlag" equals "fromStartup"
+        And the event "featureFlags.0.variant" equals "a"
+        And the event "featureFlags.1.featureFlag" equals "fromCallback"
+        And the event "featureFlags.1.variant" equals "a"
+
         # threads
         And the event "threads.0.name" equals "Custom Name"
 

features/desktop/callbacks.feature

@@ -41,6 +41,12 @@ Feature: Callbacks
     And the event "breadcrumbs.0.name" equals "Custom Message"
     And the event "breadcrumbs.0.metaData.test" equals "test"
 
+	# Feature flags
+    And the event "featureFlags.0.featureFlag" equals "fromStartup"
+    And the event "featureFlags.0.variant" equals "a"
+    And the event "featureFlags.1.featureFlag" equals "fromCallback"
+    And the event "featureFlags.1.variant" equals "a"
+
     # Metadata
     And the event "metaData.test1.test" equals "test"
     And the event "metaData.test2" is null

features/fixtures/maze_runner/Assets/Scripts/Main.cs

@@ -475,6 +475,8 @@ void PrepareConfigForScenario(Configuration config, string scenario)
                     @event.AddMetadata("test2", new Dictionary<string, object> { { "test", "test" } });
                     @event.ClearMetadata("test2");
 
+                    @event.AddFeatureFlag("fromCallback", @event.FeatureFlags[0].Variant);
+                    @event.ClearFeatureFlag("deleteMe");
 
                     return true;
                 });
@@ -537,6 +539,8 @@ void RunScenario(string scenario)
                 Invoke("LaunchException",6);
                 break;
             case "EventCallbacks":
+                Bugsnag.AddFeatureFlag("fromStartup", "a");
+                Bugsnag.AddFeatureFlag("deleteMe");
                 DoNotify();
                 break;
             case "BackgroundThreadCrash":
@@ -774,6 +778,9 @@ private IEnumerator NotifyPersistedEvents()
 
     private void ClearBugsnagCache()
     {
+#if UNITY_SWITCH
+        return;
+#endif
         var path = Application.persistentDataPath + "/Bugsnag";
         if(Directory.Exists(path))
         {

features/fixtures/maze_runner/Assets/Scripts/MobileScenarioRunner.cs

@@ -270,6 +270,8 @@ private Configuration PreapareConfigForScenario(string scenarioName)
 
                     @event.AddMetadata("test", "scoop", "dewoop");
 
+                    @event.AddFeatureFlag("fromCallback", @event.FeatureFlags[0].Variant);
+                    @event.ClearFeatureFlag("deleteMe");
 
                     return true;
                 });
@@ -395,6 +397,9 @@ private Configuration PreapareConfigForScenario(string scenarioName)
 
                     @event.Errors[0].Stacktrace[0].Method = "Method";
 
+                    @event.AddFeatureFlag("fromCallback", @event.FeatureFlags[0].Variant);
+                    @event.ClearFeatureFlag("deleteMe");
+
                     return true;
                 });
                 break;
@@ -485,6 +490,8 @@ public void DoTestAction(string scenarioName)
                 Invoke("ThrowException", 6);
                 break;
             case "Ios Signal":
+                Bugsnag.AddFeatureFlag("fromStartup", "a");
+                Bugsnag.AddFeatureFlag("deleteMe");
                 MobileNative.DoIosSignal();
                 break;
             case "Check Last Run Info":
@@ -543,6 +550,8 @@ public void DoTestAction(string scenarioName)
             case "Java Background Crash No Threads":
             case "Java Background Crash":
                 AddMetadataForRedaction();
+                Bugsnag.AddFeatureFlag("fromStartup", "a");
+                Bugsnag.AddFeatureFlag("deleteMe");
                 MobileNative.TriggerBackgroundJavaCrash();
                 break;
             case "Native exception":

features/ios/ios_callbacks.feature

@@ -36,4 +36,10 @@ Feature: Callbacks
         And the event "app.inForeground" is false
         And the event "app.isLaunching" is false
 
+        # Feature flags
+        And the event "featureFlags.0.featureFlag" equals "fromStartup"
+        And the event "featureFlags.0.variant" equals "a"
+        And the event "featureFlags.1.featureFlag" equals "fromCallback"
+        And the event "featureFlags.1.variant" equals "a"
+
         And the event "exceptions.0.stacktrace.0.method" equals "Method"

features/steps/unity_steps.rb

@@ -41,6 +41,9 @@ def execute_command(action, scenario_name = '')
     execute_command('clear_cache')
 
   when 'switch'
+
+    `ControlTarget.exe launch-application #{Maze.config.app}`
+
     execute_command('clear_cache')
 
   else
@@ -86,6 +89,9 @@ def execute_command(action, scenario_name = '')
     execute_command('run_scenario', state)
 
   when 'switch'
+
+    `ControlTarget.exe launch-application #{Maze.config.app}`
+
     execute_command('run_scenario', state)
 
   else

features/support/env.rb

@@ -65,9 +65,8 @@
     # This is to get around a strange macos bug where clearing prefs does not work 
     $logger.info 'Killing defaults service'
     Maze::Runner.run_command("killall -u #{ENV['USER']} cfprefsd")
-  elsif Maze.config.os == 'switch'
-    # Launch the app
-    `ControlTarget.exe launch-application #{Maze.config.app}`
+
+
   end
 end
 

src/BugsnagUnity.m

@@ -31,15 +31,13 @@ void bugsnag_startBugsnagWithConfiguration(const void *configuration, char *noti
   // Memory introspection is unused in a C/C++ context
 }
 
-const char * getMetadataJson(NSDictionary* dictionary){
-
-    if (!dictionary) {
+static const char * getJson(id obj) {
+    if (!obj) {
         return NULL;
     }
-
     @try {
         NSError *error = nil;
-        NSData *data = [NSJSONSerialization dataWithJSONObject:dictionary options:0 error:&error];
+        NSData *data = [NSJSONSerialization dataWithJSONObject:obj options:0 error:&error];
         if (data) {
             return strndup((const char *)data.bytes, data.length);
         } else {
@@ -83,7 +81,7 @@ void bugsnag_clearMetadataWithKey(const char * section, const char * key){
 
 const char * bugsnag_getEventMetaData(const void *event, const char *tab) {
     NSDictionary* sectionDictionary = [((__bridge BugsnagEvent *)event) getMetadataFromSection:@(tab)];
-    return getMetadataJson(sectionDictionary);
+    return getJson(sectionDictionary);
 }
 
 void bugsnag_clearEventMetadataWithKey(const void *event, const char *section, const char *key){
@@ -208,9 +206,20 @@ void bugsnag_getBreadcrumbsFromEvent(const void *event,const void *instance, voi
     free(c_array);
 }
 
+const char * bugsnag_getFeatureFlagsFromEvent(BugsnagEvent *event) {
+    NSMutableArray *array = [NSMutableArray array];
+    for (BugsnagFeatureFlag *flag in event.featureFlags) {
+        [array addObject:[NSDictionary dictionaryWithObjectsAndKeys:
+                          flag.name, @"featureFlag",
+                          flag.variant, @"variant",
+                          nil]];
+    }
+    return getJson(array);
+}
+
 const char * bugsnag_getBreadcrumbMetadata(const void *breadcrumb) {
     NSDictionary* sectionDictionary = ((__bridge BugsnagBreadcrumb *)breadcrumb).metadata;
-    return getMetadataJson(sectionDictionary);
+    return getJson(sectionDictionary);
 }
 
 void bugsnag_setBreadcrumbMetadata(const void *breadcrumb, const char *jsonString) {
@@ -679,7 +688,7 @@ void bugsnag_setMetadata(const char *section, const char *jsonString) {
 }
 
 const char * bugsnag_retrieveMetaData() {
-    return getMetadataJson([Bugsnag.client metadata].dictionary);
+    return getJson([Bugsnag.client metadata].dictionary);
 }
 
 void bugsnag_removeMetadata(const void *configuration, const char *tab) {
@@ -703,7 +712,7 @@ void bugsnag_retrieveBreadcrumbs(const void *managedBreadcrumbs, void (*breadcru
     const char *type = [BSGBreadcrumbTypeValue(crumb.type) UTF8String];
 
     NSDictionary *metadata = crumb.metadata;
-    breadcrumb(managedBreadcrumbs, message, timestamp, type, getMetadataJson(metadata));
+    breadcrumb(managedBreadcrumbs, message, timestamp, type, getJson(metadata));
 
   }];
 }

src/BugsnagUnity/Configuration.cs

@@ -6,9 +6,27 @@
 
 namespace BugsnagUnity
 {
-    public partial class Configuration : IMetadataEditor, IFeatureFlagStore
+
+    public enum SwitchCacheType
+    {
+        None,
+        R,
+        I
+    }
+
+    public class Configuration : IMetadataEditor, IFeatureFlagStore
     {
 
+        // Nintendo switch specifics ----------
+        public SwitchCacheType SwitchCacheType = SwitchCacheType.R;
+
+        public string SwitchCacheMountName = "BugsnagCache";
+
+        public int SwitchCacheIndex = 0;
+
+        public int SwitchMaxCacheSize = 10485760; //10MiB in Bytes
+        // ----------
+
         public string AppType;
 
         public string BundleVersion;

src/BugsnagUnity/MainThreadDispatchBehaviour.cs

@@ -39,8 +39,6 @@ public static MainThreadDispatchBehaviour Instance()
             if (_instance == null)
             {
                 _instance = new GameObject("Bugsnag main thread dispatcher").AddComponent<MainThreadDispatchBehaviour>();
-                DontDestroyOnLoad(_instance.gameObject);
-                _instance.gameObject.hideFlags = HideFlags.DontSave;
             }
             return _instance;
         }
@@ -96,5 +94,10 @@ private IEnumerator DelayAction(Action action, float delay)
             action.Invoke();
         }
 
+        private void Awake()
+        {
+            DontDestroyOnLoad(gameObject);
+        }
+
     }
 }

src/BugsnagUnity/Native/Android/NativeEvent.cs

@@ -171,5 +171,23 @@ public void ClearFeatureFlags()
         {
             NativePointer.Call("clearFeatureFlags");
         }
+
+        public ReadOnlyCollection<FeatureFlag> FeatureFlags
+        {
+            get
+            {
+                var objects = new List<FeatureFlag>();
+                var list = NativePointer.Call<AndroidJavaObject>("getFeatureFlags");
+                var iterator = list.Call<AndroidJavaObject>("iterator");
+                while (iterator.Call<bool>("hasNext"))
+                {
+                    var javaObject = iterator.Call<AndroidJavaObject>("next");
+                    var name = javaObject.Call<String>("getName");
+                    var variant = javaObject.Call<String>("getVariant");
+                    objects.Add(new FeatureFlag(name, variant));
+                }
+                return new ReadOnlyCollection<FeatureFlag>(objects);
+            }
+        }
     }
 }

src/BugsnagUnity/Native/Cocoa/NativeCode.cs

@@ -281,7 +281,8 @@ partial class NativeCode
 
         [DllImport(Import)]
         internal static extern void bugsnag_clearFeatureFlagsOnEvent(IntPtr @event);
+
+        [DllImport(Import)]
+        internal static extern string bugsnag_getFeatureFlagsFromEvent(IntPtr @event);
     }
 }
-
-

src/BugsnagUnity/Native/Cocoa/NativeEvent.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.IO;
+using System.Linq;
 using System.Runtime.InteropServices;
 using System.Text;
 using AOT;
@@ -201,7 +202,18 @@ public void ClearFeatureFlag(string name)
         public void ClearFeatureFlags()
         {
             NativeCode.bugsnag_clearFeatureFlagsOnEvent(NativePointer);
+        }
 
+        public ReadOnlyCollection<FeatureFlag> FeatureFlags
+        {
+            get
+            {
+                var jsonString = NativeCode.bugsnag_getFeatureFlagsFromEvent(NativePointer);
+                var jsonArray = (JsonArray)SimpleJson.DeserializeObject(jsonString);
+                var objects = jsonArray.Select((item)
+                    => new FeatureFlag(((JsonObject)item).GetDictionary()));
+                return new ReadOnlyCollection<FeatureFlag>(objects.ToList());
+            }
         }
     }
 }

src/BugsnagUnity/Payload/Event.cs

@@ -341,5 +341,10 @@ public void ClearFeatureFlags()
         {
             _featureFlags.Clear();
         }
+
+        public ReadOnlyCollection<FeatureFlag> FeatureFlags
+        {
+            get => new ReadOnlyCollection<FeatureFlag>(_featureFlags);
+        }
     }
 }