cz.xprees.event-logging 1.0.0

package/Runtime/Api/EventLoggingApi.cs

@@ -0,0 +1,64 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using Cysharp.Threading.Tasks;
+using UnityEngine;
+using UnityEngine.Networking;
+using Xprees.EventLogging.Api.Model;
+using Xprees.EventLogging.Extensions;
+
+namespace Xprees.EventLogging.Api
+{
+    public class EventLoggingApi : IEventLoggingApi
+    {
+        public const string DefaultEndpoint = "https://eventlog-service-phkfk465ha-ew.a.run.app";
+
+        private readonly string _baseUrl;
+        private string LogsUri => $"{_baseUrl}/logs";
+        private string LogsBatchUri => $"{_baseUrl}/logs/batch";
+
+        public EventLoggingApi(string baseUrl = DefaultEndpoint)
+        {
+            if (!Uri.TryCreate(baseUrl, UriKind.Absolute, out _))
+            {
+                Debug.LogError($"{nameof(EventLoggingApi)} - Created with invalid URL: \"{baseUrl}\"\n"
+                               + $"Fallback to default Endpoint: \"{DefaultEndpoint}\"");
+                baseUrl = DefaultEndpoint; // Fall back to default Endpoint
+            }
+
+            _baseUrl = baseUrl;
+        }
+
+        public async UniTask<bool> Warmup(CancellationToken cancellationToken = default)
+        {
+            try
+            {
+                var request = UnityWebRequest.Get(_baseUrl);
+                await request.SendWebRequestAsync(cancellationToken);
+                return request.result == UnityWebRequest.Result.Success;
+            }
+            catch
+            {
+                // ignore
+            }
+
+            return false;
+        }
+
+        public async UniTask<bool> SendEventLog(EventLog log, CancellationToken cancellationToken = default)
+        {
+            var request = new UnityWebRequest(LogsUri, UnityWebRequest.kHttpVerbPOST);
+            request.AddJsonBody(log);
+            await request.SendWebRequestAsync(cancellationToken);
+            return request.result == UnityWebRequest.Result.Success;
+        }
+
+        public async UniTask<bool> SendEventLogsBatch(List<EventLog> logs, CancellationToken cancellationToken = default)
+        {
+            var batchRequest = new UnityWebRequest(LogsBatchUri, UnityWebRequest.kHttpVerbPOST);
+            batchRequest.AddJsonBody(logs);
+            await batchRequest.SendWebRequestAsync(cancellationToken);
+            return batchRequest.result == UnityWebRequest.Result.Success;
+        }
+    }
+}

package/Runtime/Api/EventLoggingApi.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: fd34413abc7046d5b998358c126e4ba8
+timeCreated: 1678722796

package/Runtime/Api/IEventLoggingApi.cs

@@ -0,0 +1,20 @@
+using System.Collections.Generic;
+using System.Threading;
+using Cysharp.Threading.Tasks;
+using Xprees.EventLogging.Api.Model;
+
+namespace Xprees.EventLogging.Api
+{
+    public interface IEventLoggingApi
+    {
+        /// <summary>
+        /// Call this method before logging start to warm up the connection (otherwise the first log will be slow)
+        /// </summary>
+        /// <returns>Success</returns>
+        UniTask<bool> Warmup(CancellationToken cancellationToken = default);
+
+        UniTask<bool> SendEventLog(EventLog log, CancellationToken cancellationToken = default);
+
+        UniTask<bool> SendEventLogsBatch(List<EventLog> logs, CancellationToken cancellationToken = default);
+    }
+}

package/Runtime/Api/IEventLoggingApi.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 0b922702b1d040efa873d2c7e01cdfe8
+timeCreated: 1678721541

package/Runtime/Api/Model/EventLog.cs

@@ -0,0 +1,17 @@
+using System;
+
+namespace Xprees.EventLogging.Api.Model
+{
+    [Serializable]
+    public class EventLog
+    {
+        public long? id = null;
+        public string scenario;
+        public DateTime timestamp;
+
+        public string @event;
+        public string eventData = null;
+
+        public User user;
+    }
+}

package/Runtime/Api/Model/EventLog.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: b51d2313275b43a08a18706acc45d1bd
+timeCreated: 1678721725

package/Runtime/Api/Model/User.cs

@@ -0,0 +1,20 @@
+using System;
+using UnityEngine;
+
+namespace Xprees.EventLogging.Api.Model
+{
+    [Serializable]
+    public class User
+    {
+        public long? id = null;
+
+        [Tooltip("Can be left blank and be filled individually later by the UserSetupService.")]
+        public string formId;
+
+        [HideInInspector]
+        public bool formSubmitted = false;
+
+        public string name;
+        public string email = null;
+    }
+}

package/Runtime/Api/Model/User.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 102b46811ee146388f2daa04a5dc616c
+timeCreated: 1678721742

package/Runtime/Api/Model.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: b6bd40d80c3849698f9686c74c59bdc1
+timeCreated: 1678721711

package/Runtime/Api/eventlogger_openapi.yaml

@@ -0,0 +1,201 @@
+---
+openapi: 3.0.3
+info:
+  title: '"event-log-collector-service" API'
+  version: "1"
+paths:
+  /export/{scenario}:
+    get:
+      tags:
+      - Event Log Export Resource
+      summary: Export logs of scenario to CSV
+      parameters:
+      - name: scenario
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        "200":
+          description: OK
+  /logs:
+    get:
+      tags:
+      - Event Log Resource
+      summary: Get all EventLogs
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/EventLogEntity'
+    post:
+      tags:
+      - Event Log Resource
+      summary: Add new EventLog
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/EventLogEntity'
+      responses:
+        "201":
+          description: Event log created
+        "409":
+          description: Event log already exists
+  /logs/scenarios:
+    get:
+      tags:
+      - Event Log Resource
+      summary: Get all scenarios
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+  /logs/{id}:
+    get:
+      tags:
+      - Event Log Resource
+      summary: Get EventLog by id
+      parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          format: int64
+          type: integer
+      responses:
+        "200":
+          description: OK
+    delete:
+      tags:
+      - Event Log Resource
+      summary: Delete EventLog by id
+      parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          format: int64
+          type: integer
+      responses:
+        "200":
+          description: OK
+  /users:
+    get:
+      tags:
+      - User Resource
+      summary: Get all users
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserEntity'
+  /users/count:
+    get:
+      tags:
+      - User Resource
+      summary: Get user count
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                format: int64
+                type: integer
+  /users/{id}:
+    get:
+      tags:
+      - User Resource
+      summary: Get user by id
+      parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          format: int64
+          type: integer
+      responses:
+        "200":
+          description: OK
+    put:
+      tags:
+      - User Resource
+      summary: Update user by id
+      parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          format: int64
+          type: integer
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserEntity'
+      responses:
+        "200":
+          description: OK
+components:
+  schemas:
+    EventLogEntity:
+      required:
+      - timestamp
+      - scenario
+      - event
+      - user
+      type: object
+      properties:
+        id:
+          format: int64
+          type: integer
+          nullable: true
+        timestamp:
+          $ref: '#/components/schemas/Instant'
+        scenario:
+          type: string
+        event:
+          type: string
+        eventData:
+          type: string
+          nullable: true
+        user:
+          $ref: '#/components/schemas/UserEntity'
+    Instant:
+      format: date-time
+      type: string
+      example: 2022-03-10T16:15:50Z
+    UserEntity:
+      required:
+      - formId
+      - name
+      type: object
+      properties:
+        id:
+          format: int64
+          type: integer
+          nullable: true
+        formId:
+          type: string
+        formSubmitted:
+          type: boolean
+          nullable: true
+        name:
+          type: string
+        email:
+          type: string
+          nullable: true

package/Runtime/Api/eventlogger_openapi.yaml.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: d356127a998312d43859c2288eeca78f
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Api.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 7d010b3b8a084e2aa9365ba3586c990f
+timeCreated: 1678702037

package/Runtime/Extensions/EventLoggingApiExtension.cs

@@ -0,0 +1,18 @@
+using System;
+using Xprees.EventLogging.Api.Model;
+using Xprees.EventLogging.ScriptableObjects;
+
+namespace Xprees.EventLogging.Extensions
+{
+    public static class EventLoggingApiExtension
+    {
+        public static EventLog GenerateEventLog(this EventSO @event, User user, DateTime timestamp) => new()
+        {
+            timestamp = timestamp,
+            user = user,
+            scenario = @event.scenario?.Trim(),
+            @event = @event.eventName.Trim(),
+            eventData = @event.eventData?.Trim(),
+        };
+    }
+}

package/Runtime/Extensions/EventLoggingApiExtension.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: af3476fe77b344d5a737a21a375f22e0
+timeCreated: 1678722511

package/Runtime/Extensions/UnityWebRequestExtensions.cs

@@ -0,0 +1,73 @@
+using System;
+using System.Text;
+using System.Threading;
+using Cysharp.Threading.Tasks;
+using Newtonsoft.Json;
+using UnityEngine;
+using UnityEngine.Networking;
+
+namespace Xprees.EventLogging.Extensions
+{
+    public static class UnityWebRequestExtensions
+    {
+        public async static UniTask SendWebRequestAsync(
+            this UnityWebRequest request,
+            CancellationToken cancellationToken = default,
+            IProgress<float> progress = null
+        )
+        {
+            try
+            {
+                await request.SendWebRequest().ToUniTask(cancellationToken: cancellationToken, progress: progress);
+            }
+            catch (OperationCanceledException)
+            {
+                // ignore
+            }
+            catch (UnityWebRequestException e)
+            {
+                if (e.Result == UnityWebRequest.Result.ConnectionError)
+                {
+                    Debug.LogError($"Connection error: {e.Message} - URL: {e.UnityWebRequest.url}");
+                    return;
+                }
+
+                Debug.LogError($"Web request failed: {e.Message} with code {e.ResponseCode}");
+            }
+        }
+
+        public static void AddJsonBody(this UnityWebRequest request, object body)
+        {
+            var json = JsonConvert.SerializeObject(body);
+            var jsonBytes = Encoding.UTF8.GetBytes(json);
+
+            request.uploadHandler = new UploadHandlerRaw(jsonBytes);
+            request.downloadHandler = new DownloadHandlerBuffer();
+            request.SetRequestHeader("Content-Type", "application/json");
+        }
+
+        public async static UniTask<UnityWebRequest.Result> TestConnection(CancellationToken cancellationToken = default)
+        {
+            var request = UnityWebRequest.Get("http://neverssl.com");
+            try
+            {
+                await request.SendWebRequest().WithCancellation(cancellationToken);
+            }
+            catch (OperationCanceledException)
+            {
+                // ignore
+            }
+            catch (UnityWebRequestException e)
+            {
+                Debug.LogError($"Webex: {e.Message}");
+                throw;
+            }
+            catch (Exception e)
+            {
+                Debug.LogError(e);
+            }
+
+            return request.result;
+        }
+    }
+}

package/Runtime/Extensions/UnityWebRequestExtensions.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: c4d9c209ae324826ba1e6974a97f15d0
+timeCreated: 1678745693

package/Runtime/Extensions.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 321dca0e204e41c288a2548d8477aea6
+timeCreated: 1679505964

package/Runtime/IEventSenderService.cs

@@ -0,0 +1,12 @@
+using System.Threading;
+using Cysharp.Threading.Tasks;
+using Xprees.EventLogging.ScriptableObjects;
+
+namespace Xprees.EventLogging
+{
+    public interface IEventSenderService
+    {
+        void LogEvent(EventSO loggedEvent);
+        UniTask<bool> UploadEvents(CancellationToken cancellationToken = default);
+    }
+}

package/Runtime/IEventSenderService.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: d4724818fc954803bfe427cbf18a58ae
+timeCreated: 1679318392

package/Runtime/IEventUserSetupService.cs

@@ -0,0 +1,12 @@
+using Xprees.EventLogging.Api.Model;
+
+namespace Xprees.EventLogging
+{
+    public interface IEventUserSetupService
+    {
+        User CurrentUser { get; set; }
+        void SetFormId(string formId);
+        void SetName(string username);
+        void SetEmail(string email);
+    }
+}

package/Runtime/IEventUserSetupService.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 85bdd3c6e0554e6381fd5bda79c58f7a
+timeCreated: 1679319340

package/Runtime/ScriptableObjects/EventSO.cs

@@ -0,0 +1,28 @@
+using UnityEngine;
+using Xprees.Core;
+
+namespace Xprees.EventLogging.ScriptableObjects
+{
+    [CreateAssetMenu(menuName = "EventLogging/New Event", fileName = "Event")]
+    public class EventSO : DescriptionBaseSO
+    {
+        [Tooltip("Scenario name")]
+        public string scenario;
+
+        [Tooltip("Name of the event.")]
+        public string eventName;
+
+        [Tooltip("Event data/arguments (optional)")]
+        public string eventData;
+
+#if UNITY_EDITOR
+        private void OnValidate()
+        {
+            if (string.IsNullOrEmpty(eventName))
+            {
+                Debug.LogWarning($"{nameof(EventSO)} - {name} has null/empty {nameof(eventName)}", this);
+            }
+        }
+#endif
+    }
+}

package/Runtime/ScriptableObjects/EventSO.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 8139761af4654f9e8b1b522ed64d2347
+timeCreated: 1678719413

package/Runtime/ScriptableObjects.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 61750183ed1749519e2c87c2b84075a1
+timeCreated: 1678700781

package/Runtime/cz.xprees.event-logging.asmdef

@@ -0,0 +1,17 @@
+{
+  "name": "cz.xprees.event-logging",
+  "rootNamespace": "Xprees.EventLogging",
+  "references": [
+    "GUID:f51ebe6a0ceec4240a699833d6309b23",
+    "GUID:999c2ca78ab34358a1222750376a501c"
+  ],
+  "includePlatforms": [],
+  "excludePlatforms": [],
+  "allowUnsafeCode": false,
+  "overrideReferences": false,
+  "precompiledReferences": [],
+  "autoReferenced": true,
+  "defineConstraints": [],
+  "versionDefines": [],
+  "noEngineReferences": false
+}

package/Runtime/cz.xprees.event-logging.asmdef.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 2bc606c18a1a4f2cb45a7c51038804cf
+timeCreated: 1679505773

package/Runtime.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 4ceb1d8111a54a6d803686b1b632ff94
+timeCreated: 1679505735

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "cz.xprees.event-logging",
+  "displayName": "Event Logging",
+  "version": "1.0.0",
+  "unity": "2021.3",
+  "description": "This package provides a simple way to log events in your game.",
+  "license": "MIT",
+  "category": "Core",
+  "dependencies": {
+    "com.cysharp.unitask": "2.5.10",
+    "cz.xprees.core": "^1.0.0"
+  },
+  "keywords": [
+    "Event Logging",
+    "ScriptableObjects"
+  ],
+  "author": {
+    "name": "xprees",
+    "email": "xprees.developer@gmail.com",
+    "url": "https://xprees.com"
+  },
+  "bugs": {
+    "url": "https://github.com/xprees/unity-event-logging/issues"
+  },
+  "repository": {
+    "url": "https://github.com/xprees/unity-event-logging"
+  }
+}

package/package.json.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: d9c9e5db5936479985b7dc0248e9f992
+timeCreated: 1684880940