8000 Remove extended APOC config from core by Lojjs · Pull Request #166 · neo4j/apoc · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Remove extended APOC config from core #166

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

Merged
merged 7 commits into from
Sep 8, 2022
Merged

Remove extended APOC config from core #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1ea6e40
Remove unused APOC Json config
Lojjs Aug 29, 2022
a318477
Remove ApocConfig only used from extended.
Lojjs Sep 1, 2022
289ed9b
Delete SimpleRateLimiter
Lojjs Sep 1, 2022
fd981d1
Delete TTLConfig
Lojjs Sep 1, 2022
d94ce2d
Re-add test setup line needed for Load Json
Lojjs Sep 2, 2022
ee0c5c2
Use apocConfig() instead of legacy way in tests.
Lojjs Sep 5, 2022
c924bf0
Get rid of APOCSettings.java
Lojjs Sep 6, 2022
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
95 changes: 20 additions & 75 deletions common/src/main/java/apoc/ApocConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package apoc;

import apoc.export.util.ExportConfig;
import apoc.util.SimpleRateLimiter;
import inet.ipaddr.IPAddressString;
import java.util.Map;
import org.apache.commons.configuration2.Configuration;
import org.apache.commons.configuration2.PropertiesConfiguration;
import org.apache.commons.configuration2.builder.combined.CombinedConfigurationBuilder;
Expand Down Expand Up @@ -30,7 +30,6 @@
import java.time.ZoneId;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.stream.Stream;

Expand All @@ -46,30 +45,27 @@
import static org.neo4j.configuration.GraphDatabaseSettings.transaction_logs_root_path;

public class ApocConfig extends LifecycleAdapter {
public static final String SUN_JAVA_COMMAND = "sun.java.command";
protected static final String SUN_JAVA_COMMAND = "sun.java.command";
public static final String APOC_IMPORT_FILE_ENABLED = "apoc.import.file.enabled";
public static final String APOC_EXPORT_FILE_ENABLED = "apoc.export.file.enabled";
public static final String APOC_IMPORT_FILE_USE_NEO4J_CONFIG = "apoc.import.file.use_neo4j_config";
public static final String APOC_TTL_SCHEDULE = "apoc.ttl.schedule";
public static final String APOC_TTL_ENABLED = "apoc.ttl.enabled";
public static final String APOC_TTL_LIMIT = "apoc.ttl.limit";
public static final String APOC_TTL_SCHEDULE_DB = "apoc.ttl.schedule.%s";
public static final String APOC_TTL_ENABLED_DB = "apoc.ttl.enabled.%s";
public static final String APOC_TTL_LIMIT_DB = "apoc.ttl.limit.%s";
public static final String APOC_TRIGGER_ENABLED = "apoc.trigger.enabled";
public static final String APOC_UUID_ENABLED = "apoc.uuid.enabled";
public static final String APOC_UUID_ENABLED_DB = "apoc.uuid.enabled.%s";
public static final String APOC_UUID_FORMAT = "apoc.uuid.format";
public enum UuidFormatType { hex, base64 }
public static final String APOC_JSON_ZIP_URL = "apoc.json.zip.url"; // TODO: check if really needed
public static final String APOC_JSON_SIMPLE_JSON_URL = "apoc.json.simpleJson.url"; // TODO: check if really needed
public static final String APOC_IMPORT_FILE_ALLOW__READ__FROM__FILESYSTEM = "apoc.import.file.allow_read_from_filesystem";
public static final String APOC_CONFIG_JOBS_SCHEDULED_NUM_THREADS = "apoc.jobs.scheduled.num_threads";
public static final String APOC_CONFIG_JOBS_POOL_NUM_THREADS = "apoc.jobs.pool.num_threads";
public static final String APOC_CONFIG_JOBS_QUEUE_SIZE = "apoc.jobs.queue.size";
public static final String APOC_CONFIG_INITIALIZER = "apoc.initializer";
public static final String LOAD_FROM_FILE_ERROR = "Import from files not enabled, please set apoc.import.file.enabled=true in your apoc.conf";

// These were earlier added via the Neo4j config using the ApocSettings.java class
private static final Map<String,Object> configDefaultValues =
Map.of(
APOC_EXPORT_FILE_ENABLED, false,
APOC_IMPORT_FILE_ENABLED, false,
APOC_IMPORT_FILE_USE_NEO4J_CONFIG, true,
APOC_TRIGGER_ENABLED, false
);

private static final List<Setting> NEO4J_DIRECTORY_CONFIGURATION_SETTING_NAMES = new ArrayList<>(Arrays.asList(
data_directory,
load_csv_file_url_root,
Expand All @@ -93,17 +89,10 @@ public enum UuidFormatType { hex, base64 }
private Configuration config;

private static ApocConfig theInstance;
private LoggingType loggingType;
private SimpleRateLimiter rateLimiter;
private GraphDatabaseService systemDb;

private List<IPAddressString> blockedIpRanges = List.of();

/**
* keep track if this instance is already initialized so dependent class can wait if needed
*/
private boolean initialized = false;

public ApocConfig(Config neo4jConfig, LogService log, GlobalProcedures globalProceduresRegistry, DatabaseManagementService databaseManagementService) {
this.neo4jConfig = neo4jConfig;
this.blockedIpRanges = neo4jConfig.get(GraphDatabaseInternalSettings.cypher_ip_blocklist);
Expand All @@ -130,18 +119,13 @@ public Configuration getConfig() {
}

@Override
public void init() throws Exception {
public void init() {
log.debug("called init");
// grab NEO4J_CONF from environment. If not set, calculate it from sun.java.command system property
String neo4jConfFolder = System.getenv().getOrDefault("NEO4J_CONF", determineNeo4jConfFolder());
System.setProperty("NEO4J_CONF", neo4jConfFolder);
log.info("system property NEO4J_CONF set to %s", neo4jConfFolder);
loadConfiguration();
initialized = true;
}

public boolean isInitialized() {
return initialized;
}

protected String determineNeo4jConfFolder() {
Expand Down Expand Up @@ -178,14 +162,14 @@ protected void loadConfiguration() {
.configure(new Parameters().fileBased().setURL(resource));
config = builder.getConfiguration();

// copy apoc settings from neo4j.conf for legacy support
neo4jConfig.getDeclaredSettings().entrySet().stream()
.filter(e -> !config.containsKey(e.getKey()))
.filter(e -> e.getKey().startsWith("apoc."))
.forEach(e -> {
log.info("setting from neo4j.conf: " + e.getKey() + "=" + neo4jConfig.get(e.getValue()));
config.setProperty(e.getKey(), neo4jConfig.get(e.getValue()));
});
// set config settings not explicitly set in apoc.conf to their default value
configDefaultValues.forEach((k,v) -> {
if (!config.containsKey(k))
{
config.setProperty(k, v);
log.info("setting APOC config to default value: " + k + "=" + v);
}
});

addDbmsDirectoriesMetricsSettings();
for (Setting s : NEO4J_DIRECTORY_CONFIGURATION_SETTING_NAMES) {
Expand All @@ -201,8 +185,6 @@ protected void loadConfiguration() {
// todo - evaluate default timezone here [maybe is reusable], otherwise through db.execute('CALL dbms.listConfig()')
final Setting<ZoneId> db_temporal_timezone = GraphDatabaseSettings.db_temporal_timezone;
config.setProperty(db_temporal_timezone.name(), neo4jConfig.get(db_temporal_timezone));

initLogging();
} catch (ConfigurationException e) {
throw new RuntimeException(e);
}
Expand All @@ -219,22 +201,6 @@ private void addDbmsDirectoriesMetricsSettings() {
}
}

public LoggingType getLoggingType() {
return loggingType;
}

public SimpleRateLimiter getRateLimiter() {
return rateLimiter;
}

public void setLoggingType(LoggingType loggingType) {
this.loggingType = loggingType;
}

public void setRateLimiter(SimpleRateLimiter rateLimiter) {
this.rateLimiter = rateLimiter;
}

public GraphDatabaseService getSystemDb() {
if (systemDb == null) {
try {
Expand All @@ -246,13 +212,6 @@ public GraphDatabaseService getSystemDb() {
return systemDb;
}

public enum LoggingType {none, safe, raw}

private void initLogging() {
loggingType = LoggingType.valueOf(getString("apoc.user.log.type", "safe").trim());
rateLimiter = new SimpleRateLimiter(getInt( "apoc.user.log.window.time", 10000), getInt("apoc.user.log.window.ops", 10));
}

// added because with binary file there isn't an url
public void isImportFileEnabled() {
if (!config.getBoolean(APOC_IMPORT_FILE_ENABLED)) {
Expand Down Expand Up @@ -296,10 +255,6 @@ public static ApocConfig apocConfig() {
* delegate methods for Configuration
*/

public Iterator<String> getKeys(String prefix) {
return getConfig().getKeys(prefix);
}

public boolean containsKey(String key) {
return getConfig().containsKey(key);
}
Expand Down Expand Up @@ -328,16 +283,6 @@ public boolean getBoolean(String key, boolean defaultValue) {
return getConfig().getBoolean(key, defaultValue);
}

public <T extends Enum<T>> T getEnumProperty(String key, Class<T> cls, T defaultValue) {
var value = getConfig().getString(key, defaultValue.toString()).trim();
try {
return T.valueOf(cls, value);
} catch (IllegalArgumentException e) {
log.error("Wrong value '{}' for parameter '{}' is provided. Default value is used: '{}'", value, key, defaultValue);
return defaultValue;
}
}

public boolean isImportFolderConfigured() {
// in case we're test database import path is TestDatabaseManagementServiceBuilder.EPHEMERAL_PATH

Expand Down
4 changes: 0 additions & 4 deletions common/src/main/java/apoc/ApocExtensionFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ public interface Dependencies {
AvailabilityGuard availabilityGuard();
DatabaseManagementService databaseManagementService();
ApocConfig apocConfig();
TTLConfig ttlConfig();
GlobalProcedures globalProceduresRegistry();
RegisterComponentFactory.RegisterComponentLifecycle registerComponentLifecycle();
Pools pools();
Expand All @@ -69,8 +68,6 @@ public Lifecycle newInstance(ExtensionContext context, Dependencies dependencies
}

public static class ApocLifecycle extends LifecycleAdapter {

private final LogService log;
private final Log userLog;
private final GraphDatabaseAPI db;
private final Dependencies dependencies;
Expand All @@ -83,7 +80,6 @@ public static class ApocLifecycle extends LifecycleAdapter {


public ApocLifecycle(LogService log, GraphDatabaseAPI db, Dependencies dependencies) {
this.log = log;
this.db = db;
this.dependencies = dependencies;
this.userLog = log.getUserLog(ApocExtensionFactory.class);
Expand Down
55 changes: 0 additions & 55 deletions common/src/main/java/apoc/ApocSettings.java
View file
Open in desktop

This file was deleted.

57 changes: 0 additions & 57 deletions common/src/main/java/apoc/TTLConfig.java
View file
Open in desktop

This file was deleted.

30 changes: 0 additions & 30 deletions common/src/main/java/apoc/TTLConfigExtensionFactory.java
View file
Open in desktop

This file was deleted.

27 changes: 0 additions & 27 deletions common/src/main/java/apoc/util/SimpleRateLimiter.java
View file
Open in desktop

This file was deleted.

Loading
0