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

Fix Logger - ConfigManager circular reference #1054

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 @@ -62,12 +62,13 @@ enum ConfigSaveStrategy {

public static ConfigManager getInstance() {
if (INSTANCE == null) {
Path rootFolder = PathManager.getInstance().getRootFolder();
switch (m_saveStrat) {
case SQL:
INSTANCE = new ConfigManager(getRootFolder(), new SqlConfigProvider(getRootFolder()));
INSTANCE = new ConfigManager(rootFolder, new SqlConfigProvider(rootFolder));
break;
case LEGACY:
INSTANCE = new ConfigManager(getRootFolder(), new LegacyConfigProvider(getRootFolder()));
INSTANCE = new ConfigManager(rootFolder, new LegacyConfigProvider(rootFolder));
break;
case ATOMIC_ZIP:
// not yet done, fall through
Expand All @@ -78,7 +79,7 @@ public static ConfigManager getInstance() {
return INSTANCE;
}

private static final Logger logger = new Logger(ConfigManager.class, LogGroup.General);
private static final Logger logger = new Logger(ConfigManager.class, LogGroup.Config);

private void translateLegacyIfPresent(Path folderPath) {
if (!(m_provider instanceof SqlConfigProvider)) {
Expand Down Expand Up @@ -167,7 +168,7 @@ public PhotonConfiguration getConfig() {
}

private static Path getRootFolder() {
return Path.of("photonvision_config");
return PathManager.getInstance().getRootFolder();
}

ConfigManager(Path configDirectory, ConfigProvider provider) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/*
* Copyright (C) Photon Vision.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

package org.photonvision.common.configuration;

import java.io.File;
import java.nio.file.Path;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.time.temporal.TemporalAccessor;
import java.util.Date;

public class PathManager {
private static PathManager INSTANCE;

final File configDirectoryFile;

public static PathManager getInstance() {
if (INSTANCE == null) {
INSTANCE = new PathManager();
}
return INSTANCE;
}

private PathManager() {
this.configDirectoryFile = new File(getRootFolder().toUri());
}

public Path getRootFolder() {
return Path.of("photonvision_config");
}

public Path getLogsDir() {
return Path.of(configDirectoryFile.toString(), "logs");
}

public static final String LOG_PREFIX = "photonvision-";
public static final String LOG_EXT = ".log";
public static final String LOG_DATE_TIME_FORMAT = "yyyy-M-d_hh-mm-ss";

public String taToLogFname(TemporalAccessor date) {
var dateString = DateTimeFormatter.ofPattern(LOG_DATE_TIME_FORMAT).format(date);
return LOG_PREFIX + dateString + LOG_EXT;
}

public Path getLogPath() {
var logFile = Path.of(this.getLogsDir().toString(), taToLogFname(LocalDateTime.now())).toFile();
if (!logFile.getParentFile().exists()) logFile.getParentFile().mkdirs();
return logFile.toPath();
}

public Date logFnameToDate(String fname) throws ParseException {
// Strip away known unneeded portions of the log file name
fname = fname.replace(LOG_PREFIX, "").replace(LOG_EXT, "");
DateFormat format = new SimpleDateFormat(LOG_DATE_TIME_FORMAT);
return format.parse(fname);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
* <p>Global has one row per global config file (like hardware settings and network settings)
*/
public class SqlConfigProvider extends ConfigProvider {
private final Logger logger = new Logger(SqlConfigProvider.class, LogGroup.Config);
private static final Logger logger = new Logger(SqlConfigProvider.class, LogGroup.Config);

static class TableKeys {
static final String CAM_UNIQUE_NAME = "unique_name";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
import java.util.*;
import java.util.function.Supplier;
import org.apache.commons.lang3.tuple.Pair;
import org.photonvision.common.configuration.ConfigManager;
// import org.photonvision.common.configuration.ConfigManager;
import org.photonvision.common.configuration.PathManager;
import org.photonvision.common.dataflow.DataChangeService;
import org.photonvision.common.dataflow.events.OutgoingUIEvent;
import org.photonvision.common.util.TimedTaskManager;
Expand Down Expand Up @@ -103,8 +104,8 @@ public static String format(
static {
currentAppenders.add(new ConsoleLogAppender());
currentAppenders.add(uiLogAppender);
addFileAppender(ConfigManager.getInstance().getLogPath());
cleanLogs(ConfigManager.getInstance().getLogsDir());
addFileAppender(PathManager.getInstance().getLogPath());
cleanLogs(PathManager.getInstance().getLogsDir());
}

@SuppressWarnings("ResultOfMethodCallIgnored")
Expand Down Expand Up @@ -133,8 +134,7 @@ public static void cleanLogs(Path folderToClean) {
logFileList.removeIf(
(File arg0) -> {
try {
logFileStartDateMap.put(
arg0, ConfigManager.getInstance().logFnameToDate(arg0.getName()));
logFileStartDateMap.put(arg0, PathManager.getInstance().logFnameToDate(arg0.getName()));
return false;
} catch (ParseException e) {
return true;
Expand Down