Skip to content

fix(logging): Fixes issue of logging category not initializing properly using gen2 config #3022

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

Merged
merged 4 commits into from
Apr 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -149,13 +149,13 @@ public synchronized CategoryInitializationResult initialize(@NonNull Context con
if (!State.CONFIGURED.equals(state.get())) {
for (P plugin : getPlugins()) {
InitializationResult result = InitializationResult.failure(new AmplifyException(
"Tried to init before category was not configured.",
"Tried to init before category was configured.",
"Call configure() on category, first."
));
pluginInitializationResults.put(plugin.getPluginKey(), result);
}
} else {
state.set(State.CONFIGURING);
state.set(State.INITIALIZING);
for (P plugin : getPlugins()) {
InitializationResult result;
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ public synchronized void configure(@NonNull CategoryConfiguration configuration,
@InternalAmplifyApi
public synchronized void configure(@NonNull AmplifyOutputsData configuration, @NonNull Context context)
throws AmplifyException {
super.configure(configuration, context);
// Logging plugin config is read from a separate file
configure(context);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,16 @@

import com.amplifyframework.AmplifyException;
import com.amplifyframework.core.category.CategoryConfiguration;
import com.amplifyframework.core.category.CategoryInitializationResult;
import com.amplifyframework.core.configuration.AmplifyOutputsData;
import com.amplifyframework.testutils.random.RandomString;

import org.json.JSONException;
import org.json.JSONObject;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.robolectric.RobolectricTestRunner;

import java.util.List;
Expand Down Expand Up @@ -135,6 +138,28 @@ public void configuredPluginUsedWhenProvided() throws AmplifyException {
firstLog.assertEquals(LogLevel.WARN, message, issue);
}

/**
* Category should initialize as normal when using a Gen2 configuration.
* @throws AmplifyException Not expected; possible from addPlugin() call
*/
@Test
public void initializationSucceedsForGen2() throws AmplifyException {
FakeLogger userLogger = FakeLogger.instance(RandomString.string(), LogLevel.VERBOSE);
FakeLoggingPlugin<Void> userPlugin = FakeLoggingPlugin.instance(userLogger);
realLoggingCategory.addPlugin(userPlugin);

AmplifyOutputsData data = Mockito.mock(AmplifyOutputsData.class);
realLoggingCategory.configure(data, getApplicationContext());

// Ensure initialization succeeds
CategoryInitializationResult result = realLoggingCategory.initialize(getApplicationContext());
assertTrue(result.isSuccess());

// Ensure we can fetch the plugin
LoggingPlugin<?> plugin = realLoggingCategory.getPlugin(userPlugin.getPluginKey());
assertEquals(userPlugin, plugin);
}

private static LoggingCategoryConfiguration loggingConfiguration() {
LoggingCategoryConfiguration configuration = new LoggingCategoryConfiguration();
try {
Expand Down