Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ConfigLoader - add additional params #13

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions Runtime/Snipe.Unity/Config/SnipeConfigLoader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,26 @@ public class SnipeConfigLoader
private readonly string _url;
private readonly IApplicationInfo _appInfo;

private string _requestParamsJson;
public SnipeConfigLoader(string projectID, IApplicationInfo appInfo)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

отделяй методы пустой строкой

{
_projectID = projectID;
_appInfo = appInfo;
_url = "https://config.snipe.dev/api/v1/configStrings";
}

public async UniTask<Dictionary<string, object>> Load()
public void SetRequestParams(string requestParams)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

а тут целый ряд проблем

  • это публичный метод, значит вызвать его может кто угодно с какими угодно параметрами, следовательно, требуется проверка валидности входящих значений
  • насколько я вижу, этот метод вызывается всего один раз и при этом непосредственно перед вызовом Load. в этом случае в данном методе нет никакой необходимости - можно просто передавать аргументы в сам метод Load
  • параметры запроса содежат необходимые значения и дополнительные. нельзя, чтобы какой-то внешний класс мог затереть обязательные параметры. Т.е. метод BuildRequestParamsJson более уместен в этом классе, а не во внешнем сервисе
    итого можно сделать что-то типа такого:
Load(Dictionary<string, object> additionalParams)
{
  string requestParamsJson = BuildRequestParamsJson(additionalParams);
  //...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

а тут целый ряд проблем

  • это публичный метод, значит вызвать его может кто угодно с какими угодно параметрами, следовательно, требуется проверка валидности входящих значений
  • насколько я вижу, этот метод вызывается всего один раз и при этом непосредственно перед вызовом Load. в этом случае в данном методе нет никакой необходимости - можно просто передавать аргументы в сам метод Load
  • параметры запроса содежат необходимые значения и дополнительные. нельзя, чтобы какой-то внешний класс мог затереть обязательные параметры. Т.е. метод BuildRequestParamsJson более уместен в этом классе, а не во внешнем сервисе
    итого можно сделать что-то типа такого:
Load(Dictionary<string, object> additionalParams)
{
  string requestParamsJson = BuildRequestParamsJson(additionalParams);
  //...

Согласен, перенесу BuildRequestParamsJson() в SnipeConfigLoader(), а additionalParams буду передавать в метод Load()

{
string requestParamsJson = "{" +
$"\"project\":\"{_projectID}\"," +
$"\"deviceID\":\"{_appInfo.DeviceIdentifier}\"," +
$"\"identifier\":\"{_appInfo.ApplicationIdentifier}\"," +
$"\"version\":\"{_appInfo.ApplicationVersion}\"," +
$"\"platform\":\"{_appInfo.ApplicationPlatform}\"," +
$"\"packageVersion\":\"{PackageInfo.VERSION_CODE}\"" +
"}";
_requestParamsJson = requestParams;
}

public async UniTask<Dictionary<string, object>> Load()
{
Dictionary<string, object> config = null;

try
{
using var request = UnityWebRequest.Post(_url, requestParamsJson, "application/json");
using var request = UnityWebRequest.Post(_url, _requestParamsJson, "application/json");
request.downloadHandler = new DownloadHandlerBuffer();
var response = await request.SendWebRequest().ToUniTask();

Expand Down
51 changes: 51 additions & 0 deletions Runtime/Snipe.Unity/Config/SnipeConfigLoadingService.cs
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
using System.Collections.Generic;
using System.IO;
using System.Threading;
using Cysharp.Threading.Tasks;
using fastJSON;
using UnityEngine;

namespace MiniIT.Snipe
{
public interface ISnipeConfigLoadingService
{
Dictionary<string, object> Config { get; }
UniTask<Dictionary<string, object>> Load(CancellationToken cancellationToken = default);
void Reset();
}

public class SnipeConfigLoadingService : ISnipeConfigLoadingService
Expand Down Expand Up @@ -53,10 +57,57 @@ await UniTask.WaitUntil(() => SnipeServices.IsInitialized, PlayerLoopTiming.Upda
_loader ??= new SnipeConfigLoader(_projectID, SnipeServices.ApplicationInfo);
}

var loadedAdditionalParams = await LoadAdditionalParamsAsync();

string requestParams = BuildRequestParamsJson(SnipeServices.ApplicationInfo, loadedAdditionalParams);
_loader.SetRequestParams(requestParams);

_config = await _loader.Load();
_loading = false;

return _config;
}

public void Reset()
{
_config = null;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

сначала нужно остановить загрузку (которая теоретически может выполняться в данный момент) через CancellationToken. иначе она завершится в параллельном потоке и присвоит своё значение конфигу вне зависимости от того, что тут ему присваивается null

_loading = false;
}

private string BuildRequestParamsJson(IApplicationInfo appInfo, Dictionary<string, object> additionalParams = null)
{
var requestParams = new Dictionary<string, object>
{
{ "project", _projectID },
{ "deviceID", appInfo.DeviceIdentifier },
{ "identifier", appInfo.ApplicationIdentifier },
{ "version", appInfo.ApplicationVersion },
{ "platform", appInfo.ApplicationPlatform },
{ "packageVersion", PackageInfo.VERSION_CODE }
};

if (additionalParams != null)
{
foreach (var param in additionalParams)
{
requestParams[param.Key] = param.Value;
}
}

return JSON.ToJSON(requestParams);
}

private async UniTask<Dictionary<string, object>> LoadAdditionalParamsAsync()
{
string filePath = Path.Combine(Application.persistentDataPath, string.Format("additionalParams{0}.json", Application.version));

if (!File.Exists(filePath))
{
return new Dictionary<string, object>();
}

string json = await File.ReadAllTextAsync(filePath);
return (Dictionary<string, object>)JSON.Parse(json);
}
}
}