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.

Sign up for GitHub

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

Improved onboarding flow based on blog spot #27

Merged
merged 8 commits into from
Sep 2, 2024
Merged

Improved onboarding flow based on blog spot #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2ee9ce0
fixed compilation for blueprint based projects
pasotee Aug 28, 2024
080c3f2
replaced ensure with error
pasotee Aug 28, 2024
28cd0f9
added more visible error
pasotee Aug 28, 2024
a6b0575
added missing SDK key error message
pasotee Aug 28, 2024
0d15e15
refactor error printing
pasotee Aug 31, 2024
8bd7efd
added formatting corrections
pasotee Aug 31, 2024
f4061ec
added missing include
pasotee Aug 31, 2024
c391ecf
version bump
pasotee Sep 2, 2024
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
2 changes: 1 addition & 1 deletion ConfigCat.uplugin
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"FileVersion": 3,
"VersionName": "2.1.6",
"VersionName": "2.1.7",
"EngineVersion": "5.4",
"FriendlyName": "ConfigCat",
"Description": "ConfigCat is a hosted service for feature flag and configuration management. It lets you decouple feature releases from code deployments.",
Expand Down
44 changes: 27 additions & 17 deletions Source/ConfigCat/Private/ConfigCatSubsystem.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#include <Logging/LogVerbosity.h>
#include <Misc/ConfigCacheIni.h>
#include <Engine/GameInstance.h>
#include <Engine/Engine.h>

#include "ConfigCat.h"
#include "ConfigCatLog.h"
Expand All @@ -27,21 +28,30 @@ using namespace configcat;

namespace
{
void PrintError(const FString& ErrorMessage)
{
if (GEngine)
{
GEngine->AddOnScreenDebugMessage(-1, 5.0f, FColor::Red, FString::Printf(TEXT("[ConfigCat] %s"), *ErrorMessage));
}
UE_LOG(LogConfigCat, Error, TEXT("%s"), *ErrorMessage);
}

bool EnsureConfigCatClient(const std::shared_ptr<configcat::ConfigCatClient>& Client)
{
if (ensure(Client))
if (Client)
{
return true;
}

UE_LOG(LogConfigCat, Warning, TEXT("Trying to access the ConfigCatClient before initialization or after shutdown."));
PrintError(TEXT("Trying to access the client before initialization or after shutdown."));
return false;
}

template <typename T>
T GetValue(const std::shared_ptr<ConfigCatClient>& Client, FString Key, T DefaultValue, const UConfigCatUserWrapper* User)
{
if(!EnsureConfigCatClient(Client))
if (!EnsureConfigCatClient(Client))
{
return DefaultValue;
}
Expand All @@ -54,7 +64,7 @@ namespace
template <typename T>
UConfigCatEvaluationWrapper* GetEvaluationDetails(const std::shared_ptr<ConfigCatClient>& Client, FString Key, T DefaultValue, const UConfigCatUserWrapper* User)
{
if(!EnsureConfigCatClient(Client))
if (!EnsureConfigCatClient(Client))
{
return {};
}
Expand Down Expand Up @@ -98,7 +108,7 @@ FString UConfigCatSubsystem::GetStringValue(const FString& Key, const FString& D

UConfigCatValueWrapper* UConfigCatSubsystem::GetConfigValue(const FString& Key, const UConfigCatUserWrapper* User) const
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return {};
}
Expand Down Expand Up @@ -132,7 +142,7 @@ UConfigCatEvaluationWrapper* UConfigCatSubsystem::GetStringValueDetails(const FS

TArray<FString> UConfigCatSubsystem::GetAllKeys() const
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return {};
}
Expand All @@ -150,7 +160,7 @@ TArray<FString> UConfigCatSubsystem::GetAllKeys() const

bool UConfigCatSubsystem::GetKeyAndValue(const FString& VariationId, FString& OutKey, UConfigCatValueWrapper*& OutValue) const
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return false;
}
Expand All @@ -171,7 +181,7 @@ bool UConfigCatSubsystem::GetKeyAndValue(const FString& VariationId, FString& Ou

TMap<FString, UConfigCatValueWrapper*> UConfigCatSubsystem::GetAllValues(const UConfigCatUserWrapper* User) const
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return {};
}
Expand All @@ -189,7 +199,7 @@ TMap<FString, UConfigCatValueWrapper*> UConfigCatSubsystem::GetAllValues(const U

TArray<UConfigCatEvaluationWrapper*> UConfigCatSubsystem::GetAllValueDetails(const UConfigCatUserWrapper* User) const
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return {};
}
Expand All @@ -207,7 +217,7 @@ TArray<UConfigCatEvaluationWrapper*> UConfigCatSubsystem::GetAllValueDetails(con

void UConfigCatSubsystem::ForceRefresh()
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return;
}
Expand All @@ -217,7 +227,7 @@ void UConfigCatSubsystem::ForceRefresh()

void UConfigCatSubsystem::SetDefaultUser(const UConfigCatUserWrapper* User)
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return;
}
Expand All @@ -232,7 +242,7 @@ void UConfigCatSubsystem::SetDefaultUser(const UConfigCatUserWrapper* User)

void UConfigCatSubsystem::ClearDefaultUser()
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return;
}
Expand All @@ -242,7 +252,7 @@ void UConfigCatSubsystem::ClearDefaultUser()

void UConfigCatSubsystem::SetOnline()
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return;
}
Expand All @@ -252,7 +262,7 @@ void UConfigCatSubsystem::SetOnline()

void UConfigCatSubsystem::SetOffline()
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return;
}
Expand All @@ -262,7 +272,7 @@ void UConfigCatSubsystem::SetOffline()

bool UConfigCatSubsystem::IsOffline() const
{
if(!EnsureConfigCatClient(ConfigCatClient))
if (!EnsureConfigCatClient(ConfigCatClient))
{
return true;
}
Expand All @@ -279,7 +289,7 @@ void UConfigCatSubsystem::Initialize(FSubsystemCollectionBase& Collection)
const UConfigCatSettings* ConfigCatSettings = GetDefault<UConfigCatSettings>();
if (!ConfigCatSettings || ConfigCatSettings->SdkKey.IsEmpty())
{
UE_LOG(LogConfigCat, Warning, TEXT("Empty SdkKey detected. Please set your SdkKey in the Project Settings."));
PrintError(TEXT("SdkKey missing. Please set your SdkKey in the Project Settings."));
return;
}

Expand Down Expand Up @@ -336,7 +346,7 @@ void UConfigCatSubsystem::Initialize(FSubsystemCollectionBase& Collection)
ConfigCatClient = ConfigCatClient::get(SdkKey, &Options);

#ifdef CONFIGCAT_HTTPTHREAD_WORKAROUND
if(ConfigCatSettings->PollingMode == EPollingMode::Auto)
if (ConfigCatSettings->PollingMode == EPollingMode::Auto)
{
ForceRefresh();
}
Expand Down
2 changes: 2 additions & 0 deletions Source/ConfigCat/Public/ConfigCatNetworkAdapter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
#include <ConfigCatCppSDK/Include/httpsessionadapter.h>
#include <Interfaces/IHttpRequest.h>

#include <memory>

namespace configcat
{
class PollingMode;
Expand Down
Loading