All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.helidon.config.ConfigSourceRuntimeImpl Maven / Gradle / Ivy

Go to download

Configuration Core module.

There is a newer version: 4.1.1
Show newest version
/*
 * Copyright (c) 2020, 2022 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.helidon.config;

import java.lang.System.Logger.Level;
import java.time.Instant;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;

import io.helidon.common.media.type.MediaType;
import io.helidon.config.spi.ChangeEventType;
import io.helidon.config.spi.ChangeWatcher;
import io.helidon.config.spi.ConfigNode;
import io.helidon.config.spi.ConfigNode.ObjectNode;
import io.helidon.config.spi.ConfigParser;
import io.helidon.config.spi.ConfigSource;
import io.helidon.config.spi.EventConfigSource;
import io.helidon.config.spi.LazyConfigSource;
import io.helidon.config.spi.NodeConfigSource;
import io.helidon.config.spi.ParsableSource;
import io.helidon.config.spi.PollableSource;
import io.helidon.config.spi.PollingStrategy;
import io.helidon.config.spi.WatchableSource;

/**
 * The runtime of a config source. For a single {@link io.helidon.config.Config}, there is one source runtime for each configured
 * config source.
 *
 */
class ConfigSourceRuntimeImpl implements ConfigSourceRuntime {
    private static final System.Logger LOGGER = System.getLogger(ConfigSourceRuntimeImpl.class.getName());

    private final List> listeners = new LinkedList<>();
    private final BuilderImpl.ConfigContextImpl configContext;
    private final ConfigSource configSource;
    private final boolean changesSupported;
    private final Supplier> reloader;
    private final Runnable changesRunnable;
    private final Function> singleNodeFunction;
    private final boolean isLazy;

    // we only want to start change support if somebody listens for changes
    private boolean changesWanted = false;
    // set to true if changes started
    private boolean changesStarted = false;
    // set to true when the content is loaded (to start changes whether the registration for change is before or after load)
    private boolean dataLoaded = false;

    // for eager sources, this is the data we get initially, everything else is handled through change listeners
    private Optional initialData;
    private Map loadedData;

    @SuppressWarnings("unchecked")
    ConfigSourceRuntimeImpl(BuilderImpl.ConfigContextImpl configContext, ConfigSource source) {
        this.configContext = configContext;
        this.configSource = source;

        Supplier> reloader;
        Function> singleNodeFunction;
        boolean lazy = false;

        // content source
        AtomicReference lastStamp = new AtomicReference<>();
        if (configSource instanceof ParsableSource) {
            // eager parsable config source
            reloader = new ParsableConfigSourceReloader(configContext, (ParsableSource) source, lastStamp);
            singleNodeFunction = objectNodeToSingleNode();
        } else if (configSource instanceof NodeConfigSource) {
            // eager node config source
            reloader = new NodeConfigSourceReloader((NodeConfigSource) source, lastStamp);
            singleNodeFunction = objectNodeToSingleNode();
        } else if (configSource instanceof LazyConfigSource) {
            LazyConfigSource lazySource = (LazyConfigSource) source;
            // lazy config source
            reloader = Optional::empty;
            singleNodeFunction = lazySource::node;
            lazy = true;
        } else {
            throw new ConfigException("Config source " + source + ", class: " + source.getClass().getName() + " does not "
                                              + "implement any of required interfaces. A config source must at least "
                                              + "implement one of the following: ParsableSource, or NodeConfigSource, or "
                                              + "LazyConfigSource");
        }

        this.isLazy = lazy;
        this.reloader = reloader;
        this.singleNodeFunction = singleNodeFunction;

        // change support
        boolean changesSupported = false;
        Runnable changesRunnable = null;

        if (configSource instanceof WatchableSource) {
            WatchableSource watchable = (WatchableSource) source;
            Optional> changeWatcher = watchable.changeWatcher();

            if (changeWatcher.isPresent()) {
                changesSupported = true;
                changesRunnable = new WatchableChangesStarter(configContext,
                                                              listeners,
                                                              reloader,
                                                              source,
                                                              watchable,
                                                              changeWatcher.get());
            }
        }

        if (!changesSupported && (configSource instanceof PollableSource)) {
            PollableSource pollable = (PollableSource) source;
            Optional pollingStrategy = pollable.pollingStrategy();

            if (pollingStrategy.isPresent()) {
                changesSupported = true;
                changesRunnable = new PollingStrategyStarter(configContext,
                                                             listeners,
                                                             reloader,
                                                             source,
                                                             pollable,
                                                             pollingStrategy.get(),
                                                             lastStamp);
            }
        }

        if (!changesSupported && (configSource instanceof EventConfigSource)) {
            EventConfigSource event = (EventConfigSource) source;
            changesSupported = true;
            changesRunnable = () -> event.onChange((key, config) -> listeners.forEach(it -> it.accept(key, config)));
        }

        this.changesRunnable = changesRunnable;
        this.changesSupported = changesSupported;
    }

    @Override
    public synchronized void onChange(BiConsumer change) {
        if (!changesSupported) {
            return;
        }

        this.listeners.add(change);
        this.changesWanted = true;
        startChanges();
    }

    @Override
    public synchronized Optional load() {
        if (dataLoaded) {
            throw new ConfigException("Attempting to load a single config source multiple times. This is a bug.");
        }

        initialLoad();

        return this.initialData;
    }

    @Override
    public boolean isLazy() {
        return isLazy;
    }

    boolean changesSupported() {
        return changesSupported;
    }

    @Override
    public String toString() {
        return "Runtime for " + configSource;
    }

    @Override
    public int hashCode() {
        return Objects.hash(configSource);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if ((o == null) || (getClass() != o.getClass())) {
            return false;
        }
        ConfigSourceRuntimeImpl that = (ConfigSourceRuntimeImpl) o;
        return configSource.equals(that.configSource);
    }

    private synchronized void initialLoad() {
        if (dataLoaded) {
            return;
        }

        configSource.init(configContext);

        Optional loadedData = configSource.retryPolicy()
                .map(policy -> policy.execute(reloader))
                .orElseGet(reloader);

        if (loadedData.isEmpty() && !configSource.optional()) {
            throw new ConfigException("Cannot load data from mandatory source: " + configSource);
        }

        // we may have media type mapping per node configured as well
        if (configSource instanceof AbstractConfigSource) {
            loadedData = loadedData.map(it -> ((AbstractConfigSource) configSource)
                    .processNodeMapping(configContext::findParser, ConfigKeyImpl.of(), it));
        }

        this.initialData = loadedData;

        this.loadedData = new HashMap<>();

        initialData.ifPresent(data -> {
            Map keyToNodeMap = ConfigHelper.createFullKeyToNodeMap(data);

            keyToNodeMap.forEach((key, value) -> this.loadedData.put(key.toString(), value));
        });

        dataLoaded = true;
        startChanges();
    }

    @Override
    public Optional node(String key) {
        return singleNodeFunction.apply(key);
    }


    @Override
    public String description() {
        return configSource.description();
    }

    /*
     Runtime impl base
     */

    private Function> objectNodeToSingleNode() {
        return key -> {
            if (null == loadedData) {
                throw new IllegalStateException("Single node of an eager source requested before load method was called."
                                                        + " This is a bug.");
            }

            return Optional.ofNullable(loadedData.get(key));
        };
    }

    private void startChanges() {
        if (!changesStarted && dataLoaded && changesWanted) {
            changesStarted = true;
            changesRunnable.run();
        }
    }

    private static void triggerChanges(BuilderImpl.ConfigContextImpl configContext,
                                       List> listeners,
                                       Optional objectNode) {

        configContext.changesExecutor()
                .execute(() -> {
                    for (BiConsumer listener : listeners) {
                        listener.accept("", objectNode.orElse(ObjectNode.empty()));
                    }
                });

    }

    private static final class PollingStrategyStarter implements Runnable {
        private final PollingStrategy pollingStrategy;
        private final PollingStrategyListener listener;

        private PollingStrategyStarter(BuilderImpl.ConfigContextImpl configContext,
                                       List> listeners,
                                       Supplier> reloader,
                                       ConfigSource source,
                                       PollableSource pollable,
                                       PollingStrategy pollingStrategy,
                                       AtomicReference lastStamp) {

            this.pollingStrategy = pollingStrategy;
            this.listener = new PollingStrategyListener(configContext, listeners, reloader, source, pollable, lastStamp);
        }

        @Override
        public void run() {
            pollingStrategy.start(listener);
        }
    }

    private static final class PollingStrategyListener implements PollingStrategy.Polled {

        private final BuilderImpl.ConfigContextImpl configContext;
        private final List> listeners;
        private final Supplier> reloader;
        private final ConfigSource source;
        private final PollableSource pollable;
        private final AtomicReference lastStamp;

        private PollingStrategyListener(BuilderImpl.ConfigContextImpl configContext,
                                        List> listeners,
                                        Supplier> reloader,
                                        ConfigSource source,
                                        PollableSource pollable,
                                        AtomicReference lastStamp) {

            this.configContext = configContext;
            this.listeners = listeners;
            this.reloader = reloader;
            this.source = source;
            this.pollable = pollable;
            this.lastStamp = lastStamp;
        }

        @Override
        public ChangeEventType poll(Instant when) {
            Object lastStampValue = lastStamp.get();
            if ((null == lastStampValue) || pollable.isModified(lastStampValue)) {
                Optional objectNode = reloader.get();
                if (objectNode.isEmpty()) {
                    if (source.optional()) {
                        // this is a valid change
                        triggerChanges(configContext, listeners, objectNode);
                    } else {
                        LOGGER.log(Level.INFO, "Mandatory config source is not available, ignoring change.");
                    }
                    return ChangeEventType.DELETED;
                } else {
                    triggerChanges(configContext, listeners, objectNode);
                    return ChangeEventType.CHANGED;
                }
            }
            return ChangeEventType.UNCHANGED;
        }
    }

    private static final class WatchableChangesStarter implements Runnable {
        private final WatchableSource watchable;
        private final WatchableListener listener;
        private final ChangeWatcher changeWatcher;

        private WatchableChangesStarter(BuilderImpl.ConfigContextImpl configContext,
                                        List> listeners,
                                        Supplier> reloader,
                                        ConfigSource configSource,
                                        WatchableSource watchable,
                                        ChangeWatcher changeWatcher) {
            this.watchable = watchable;
            this.changeWatcher = changeWatcher;
            this.listener = new WatchableListener(configContext, listeners, reloader, configSource);
        }

        @Override
        public void run() {
            Object target = watchable.target();
            changeWatcher.start(target, listener);
        }
    }

    private static final class WatchableListener implements Consumer> {
        private final BuilderImpl.ConfigContextImpl configContext;
        private final List> listeners;
        private final Supplier> reloader;
        private final ConfigSource configSource;

        private WatchableListener(BuilderImpl.ConfigContextImpl configContext,
                                  List> listeners,
                                  Supplier> reloader,
                                  ConfigSource configSource) {

            this.configContext = configContext;
            this.listeners = listeners;
            this.reloader = reloader;
            this.configSource = configSource;
        }

        @Override
        public void accept(ChangeWatcher.ChangeEvent change) {
            try {
                Optional objectNode = reloader.get();
                if (objectNode.isEmpty()) {
                    if (configSource.optional()) {
                        // this is a valid change
                        triggerChanges(configContext, listeners, objectNode);
                    } else {
                        LOGGER.log(Level.INFO, "Mandatory config source is not available, ignoring change.");
                    }
                } else {
                    triggerChanges(configContext, listeners, objectNode);
                }
            } catch (Exception e) {
                LOGGER.log(Level.INFO, "Failed to reload config source "
                                    + configSource
                                    + ", exception available in finest log level. "
                                    + "Change that triggered this event: "
                                    + change);
                LOGGER.log(Level.TRACE, "Failed to reload config source", e);
            }
        }
    }

    private static final class NodeConfigSourceReloader implements Supplier> {
        private final NodeConfigSource configSource;
        private final AtomicReference lastStamp;

        private NodeConfigSourceReloader(NodeConfigSource configSource,
                                         AtomicReference lastStamp) {
            this.configSource = configSource;
            this.lastStamp = lastStamp;
        }

        @Override
        public Optional get() {
            return configSource.load()
                    .map(content -> {
                        lastStamp.set(content.stamp().orElse(null));
                        return content.data();
                    });
        }
    }

    private static final class ParsableConfigSourceReloader implements Supplier> {
        private final BuilderImpl.ConfigContextImpl configContext;
        private final ParsableSource configSource;
        private final AtomicReference lastStamp;

        private ParsableConfigSourceReloader(BuilderImpl.ConfigContextImpl configContext,
                                             ParsableSource configSource,
                                             AtomicReference lastStamp) {

            this.configContext = configContext;
            this.configSource = configSource;
            this.lastStamp = lastStamp;
        }

        @Override
        public Optional get() {
            return configSource.load()
                    .map(content -> {
                        lastStamp.set(content.stamp().orElse(null));
                        Optional parser = configSource.parser();

                        if (parser.isPresent()) {
                            return parser.get().parse(content, configSource.relativeResolver());
                        }

                        // media type should either be configured on config source, or in content
                        Optional mediaType = configSource.mediaType().or(content::mediaType);

                        if (mediaType.isPresent()) {
                            parser = configContext.findParser(mediaType.get());
                            if (parser.isEmpty()) {
                                throw new ConfigException("Cannot find suitable parser for '" + mediaType
                                        .get() + "' media type for config source " + configSource.description());
                            }
                            return parser.get().parse(content, configSource.relativeResolver());
                        }

                        throw new ConfigException("Could not find media type of config source " + configSource.description());
                    });
        }
    }
}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy