js/plugins/features_manager.js

// NPM IMPORTS
import assert from 'assert'

// COMMON IMPORTS
import T from 'devapt-core-common/dist/js/utils/types'

// SERVER IMPORTS
import PluginsManager from './plugins_manager'


let context = 'server/plugins/features_manager'



/**
 * @file Features manager class.
 * @author Luc BORIES
 * @license Apache-2.0
 */
export default class FeaturesManager extends PluginsManager
{
	/**
	 * Create a features manager instance.
	 * @extends PluginsManager
	 * 
	 * @param {string|undefined} arg_log_context - optional.
	 * @param {LoggerManager} arg_logger_manager - logger manager object (optional).
	 * 
	 * @returns {nothing}
	 */
	constructor(arg_runtime, arg_log_context, arg_logger_manager)
	{
		super(arg_runtime, arg_log_context ? arg_log_context : context, arg_logger_manager)
		
		this.is_features_manager = true
		
		this.instances = { 'all':{} }
	}


	/**
	 * Get class name.
	 * 
	 * @return {string}
	 */
	get_class()
	{
		return 'FeaturesManager'
	}
	
	
    
	/**
     * Create a feature instance by lookup on self contained plugins.
	 * 
     * @param {string} arg_class_name - type or class feature name.
     * @param {string} arg_name - feature name.
     * @param {object} arg_settings - feature settings plain object.
     * @param {object} arg_state - feature initial state plain object (optional).
	 * 
     * @returns {object} feature instance.
     */
	create(arg_class_name, arg_name, arg_settings, arg_state)
	{
		this.enter_group('create')

		assert( T.isString(arg_class_name), context + ':bad class string')
		assert( T.isString(arg_name), context + ':bad name string for class [' + arg_class_name + ']')
		assert( T.isObject(arg_settings), context + ':bad settings object [' + arg_class_name + '] for name [' + arg_name + ']')
		if (arg_state)
		{
			assert( T.isObject(arg_state), context + ':bad state object')
		}
		this.debug('create:name=[' + arg_name + '] class=[' + arg_class_name + ']')
		// console.log(context + ':create:name=[' + arg_name + '] class=[' + arg_class_name + ']')

		arg_settings = arg_settings.set('runtime', this.get_runtime())
		arg_settings = arg_settings.set('logger_manager', this.get_logger_manager())
		
		const found_plugin = this.registered_plugins.find_by_filter( (plugin) => plugin.has(arg_class_name) )
		
		if (found_plugin)
		{
			// console.log(context + ':create:loop on plugin ' + found_plugin.get_name() + ' found with type=' + arg_class_name + ' name=' + arg_name)

			const instance = found_plugin.create(arg_class_name, arg_name, arg_settings, arg_state)
			// console.log(context + ':create:loop on plugin ' + found_plugin.get_name() + ' found with type=' + arg_class_name + ' name=' + arg_name + ':CREATED')

			// this.instances[arg_class_name] = this.instances[arg_class_name] ? this.instances[arg_class_name] : {}
			// this.instances[arg_class_name][arg_name] = instance
			// this.instances['all'][arg_name] = instance
			
			this.add_instance(instance)
			
			this.leave_group('create:instance [' + arg_name + '] of class [' + arg_class_name + '] created with plugin [' + found_plugin.get_name() + ']')
			return instance
		}
		
		console.error(context + ':create:feature not found with type=' + arg_class_name + ' name=' + arg_name)
		
		this.leave_group('create:class [' + arg_class_name + '] not found for [' + arg_name + ']')
		return undefined
	}
	
	
	
	/**
	 * Register an instance which is created outside this plugins manager.
	 * 
     * @param {object} arg_instance - feature instance.
	 * 
	 * @returns {nothing}
	 */
	add_instance(arg_instance)
	{
		const arg_class_name = arg_instance.get_class()
		const arg_name = arg_instance.get_name()
		
		this.instances[arg_class_name] = this.instances[arg_class_name] ? this.instances[arg_class_name] : {}
		this.instances[arg_class_name][arg_name] = arg_instance
		this.instances['all'][arg_name] = arg_instance
	}
	
	
	
	/**
	 * Has an instance?
	 * 
     * @param {string} arg_class_name - type or class feature name.
	 * @param {string} arg_name - feature instance name.
	 * 
	 * @returns {boolean} - feature instance found ?
	 */
	has_instance(arg_class_name, arg_name)
	{
		if (! T.isString(arg_class_name) )
		{
			return false
		}
		
		if (! T.isString(arg_name) )
		{
			arg_name = arg_class_name
			arg_class_name = 'all'
		}
		
		return arg_name in this.instances[arg_class_name]
	}
	
	
	
	/**
	 * Get an instance.
	 * 
     * @param {string} arg_class_name - type or class feature name.
	 * @param {string} arg_name - feature instance name.
	 * 
	 * @returns {object} - feature instance
	 */
	get_instance(arg_class_name, arg_name)
	{
		if (! T.isString(arg_class_name) )
		{
			return undefined
		}
		
		if (! T.isString(arg_name) )
		{
			arg_name = arg_class_name
			arg_class_name = 'all'
		}
		
		if (arg_class_name in this.instances)
		{
			if (arg_name in this.instances[arg_class_name])
			{
				return this.instances[arg_class_name][arg_name]
			}
		}
		
		
		return undefined
	}
	
	
	
	/**
	 * Remove an instance.
	 * 
     * @param {string} arg_class_name - type or class feature name.
	 * @param {string} arg_name - feature instance name.
	 * 
	 * @returns {nothing}
	 */
	remove_instance(arg_class_name, arg_name)
	{
		if (arg_class_name in this.instances)
		{
			if (arg_name in this.instances[arg_class_name])
			{
				delete this.instances[arg_class_name][arg_name]
			}
		}
	}
	
	
    
	/**
     * Test if a feature class is known into self contained plugins.
     * @param {string} arg_class_name - feature class name.
     * @returns {boolean} feature class found or not.
     */
	has(arg_class_name)
	{
		assert( T.isString(arg_class_name), context + ':has:bad class string')
		
		// const plugin = this.enabled_plugins.find_by_filter( (plugin) => plugin.has(arg_class_name) )
		const plugin = this.registered_plugins.find_by_filter( (plugin) => plugin.has(arg_class_name) )
		
		return plugin != undefined
	}
	
	
    
	/**
     * Get a feature class.
     * @param {string} arg_class_name - feature class name.
     * @returns {boolean} feature class found or not.
     */
	get_feature_class(arg_class_name)
	{
		assert( T.isString(arg_class_name), context + ':get_class:bad class string')
		
		// const plugin = this.enabled_plugins.find_by_filter( (plugin) => plugin.has(arg_class_name) )
		const plugin = this.registered_plugins.find_by_filter( (plugin) => plugin.has(arg_class_name) )
		
		return plugin ? plugin.get_feature_class(arg_class_name) : undefined
	}
}