refactor: Use shared constants and add error handling for Analytics DLL copy

This commit addresses feedback from the previous review:

- Created `FirebaseAnalyticsEditorConstants.cs` to store shared constants for:
    - `DllName` ("analytics_win.dll")
    - `DllSourcePath` ("./analytics_win.dll")
    - `AnalyticsTypeFullName` ("Firebase.Analytics.FirebaseAnalytics, Firebase.Analytics")

- Updated `editor/app/src/DllLocationPatcher.cs`:
    - Replaced hardcoded strings with the new shared constants.
    - Wrapped file I/O operations (directory creation and DLL copy for Windows builds) in a try-catch block to handle potential exceptions (e.g., IOExceptions, UnauthorizedAccessException) and log specific errors.

- Updated `editor/app/src/AnalyticsPlayModeSetup.cs`:
    - Replaced hardcoded strings and local constants with the new shared constants.
    - Wrapped file I/O operations (directory creation and DLL copy for Play Mode) in a try-catch block to handle potential exceptions and log specific errors.

These changes improve maintainability by centralizing critical strings and enhance robustness by ensuring that file operation errors during build post-processing or Play Mode setup are caught and logged gracefully.

Author: google-labs-jules[bot]

editor/app/src/AnalyticsPlayModeSetup.cs

@@ -7,9 +7,7 @@ namespace Firebase.Editor {
 
 [InitializeOnLoad]
 internal static class AnalyticsPlayModeSetup {
-    private const string SourceDllPath = "./analytics_win.dll";
     private const string DestinationDir = "Assets/Plugins/";
-    private const string DestinationDllName = "analytics_win.dll";
 
     static AnalyticsPlayModeSetup() {
         EditorApplication.playModeStateChanged += OnPlayModeStateChanged;
@@ -18,21 +16,21 @@ static AnalyticsPlayModeSetup() {
     private static void OnPlayModeStateChanged(PlayModeStateChange state) {
         if (state == PlayModeStateChange.EnteredPlayMode) {
             if (Application.platform == RuntimePlatform.WindowsEditor) {
-                Type firebaseAnalyticsType = Type.GetType("Firebase.Analytics.FirebaseAnalytics, Firebase.Analytics");
+                Type firebaseAnalyticsType = Type.GetType(FirebaseAnalyticsEditorConstants.AnalyticsTypeFullName);
                 if (firebaseAnalyticsType != null) {
-                    if (File.Exists(SourceDllPath)) {
+                    if (File.Exists(FirebaseAnalyticsEditorConstants.DllSourcePath)) {
                         try {
                             Directory.CreateDirectory(DestinationDir);
-                            string destinationDllPath = Path.Combine(DestinationDir, DestinationDllName);
-                            File.Copy(SourceDllPath, destinationDllPath, true);
-                            Debug.Log("Firebase Analytics: Copied " + DestinationDllName + " to " + DestinationDir + " for Play Mode.");
+                            string destinationDllPath = Path.Combine(DestinationDir, FirebaseAnalyticsEditorConstants.DllName);
+                            File.Copy(FirebaseAnalyticsEditorConstants.DllSourcePath, destinationDllPath, true);
+                            Debug.Log("Firebase Analytics: Copied " + FirebaseAnalyticsEditorConstants.DllName + " to " + DestinationDir + " for Play Mode.");
                             AssetDatabase.Refresh();
                         } catch (Exception e) {
-                            Debug.LogError("Firebase Analytics: Error copying " + DestinationDllName + " for Play Mode: " + e.Message);
+                            Debug.LogError("Firebase Analytics: Error copying " + FirebaseAnalyticsEditorConstants.DllName + " for Play Mode: " + e.Message);
                         }
                     } else {
                         // Optional: Log if source DLL is not found, as it might be expected if Analytics is not used.
-                        // Debug.LogWarning("Firebase Analytics: Source DLL " + SourceDllPath + " not found. Skipping Play Mode setup.");
+                        // Debug.LogWarning("Firebase Analytics: Source DLL " + FirebaseAnalyticsEditorConstants.DllSourcePath + " not found. Skipping Play Mode setup.");
                     }
                 }
             }

editor/app/src/DllLocationPatcher.cs

@@ -96,18 +96,22 @@ internal static void OnPostProcessBuildWindowsAnalytics(
             BuildTarget buildTarget, string pathToBuiltProject) {
         if (buildTarget == BuildTarget.StandaloneWindows ||
             buildTarget == BuildTarget.StandaloneWindows64) {
-            Type firebaseAnalyticsType = Type.GetType("Firebase.Analytics.FirebaseAnalytics, Firebase.Analytics");
+            Type firebaseAnalyticsType = Type.GetType(FirebaseAnalyticsEditorConstants.AnalyticsTypeFullName);
             if (firebaseAnalyticsType != null) {
-                string sourceDllPath = "./analytics_win.dll";
+                string sourceDllPath = FirebaseAnalyticsEditorConstants.DllSourcePath;
                 if (System.IO.File.Exists(sourceDllPath)) {
-                    string destinationDirectory = Path.Combine(
-                        Path.GetDirectoryName(pathToBuiltProject),
-                        Path.GetFileNameWithoutExtension(pathToBuiltProject) + "_Data",
-                        "Plugins");
-                    System.IO.Directory.CreateDirectory(destinationDirectory);
-                    string destinationDllPath = Path.Combine(destinationDirectory, "analytics_win.dll");
-                    System.IO.File.Copy(sourceDllPath, destinationDllPath, true);
-                    Debug.Log("Firebase Analytics: Copied analytics_win.dll to build plugins directory.");
+                    try {
+                        string destinationDirectory = Path.Combine(
+                            Path.GetDirectoryName(pathToBuiltProject),
+                            Path.GetFileNameWithoutExtension(pathToBuiltProject) + "_Data",
+                            "Plugins");
+                        System.IO.Directory.CreateDirectory(destinationDirectory);
+                        string destinationDllPath = Path.Combine(destinationDirectory, FirebaseAnalyticsEditorConstants.DllName);
+                        System.IO.File.Copy(sourceDllPath, destinationDllPath, true);
+                        Debug.Log("Firebase Analytics: Copied " + FirebaseAnalyticsEditorConstants.DllName + " to build plugins directory.");
+                    } catch (System.Exception e) {
+                        Debug.LogError("Firebase Analytics: Error copying " + FirebaseAnalyticsEditorConstants.DllName + " for build: " + e.Message);
+                    }
                 }
             }
         }

editor/app/src/FirebaseAnalyticsEditorConstants.cs

@@ -0,0 +1,23 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Firebase.Editor {
+
+internal static class FirebaseAnalyticsEditorConstants {
+    public const string DllName = "analytics_win.dll";
+    public const string DllSourcePath = "./" + DllName;
+    public const string AnalyticsTypeFullName = "Firebase.Analytics.FirebaseAnalytics, Firebase.Analytics";
+}
+
+}