lamoda/multi-env

Library that provides classes to work with envs in multitenant environment

1.0.0 2022-10-14 13:06 UTC

Requires

• php: ^7.4 || ^8.0
• ulrichsg/getopt-php: ^4.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ~v3.12.0
• phpunit/phpunit: ^9.5
• vlucas/phpdotenv: v3.6.10

Suggests

• vlucas/phpdotenv: Required for DotEnvFileReaderAdapter

MIT

README

Library that provides classes to work with envs in multitenant environment

Library based on params passed to it on initialization stage will decide which env variable should be used for current request.

Installation

1. Install library with composer:

composer require lamoda/multi-env

Usage

Library usage examples to work in not multitenant environment (could be useful in development mode)

<?php

use \Lamoda\MultiEnv\Strategy\RawEnvResolvingStrategy;
use \Lamoda\MultiEnv\Decorator\EnvProviderDecorator;

// RawEnvResolvingStrategy - just wrap native PHP get_env function call
$strategy = new RawEnvResolvingStrategy();
EnvProviderDecorator::init($strategy);

// Will be search original TEST_ENV env variable
EnvProviderDecorator::getEnv('TEST_ENV');

Library usage examples to work in multitenant environment

<?php

use \Lamoda\MultiEnv\Strategy\HostBasedEnvResolvingStrategy;
use \Lamoda\MultiEnv\Strategy\FileBasedEnvResolvingStrategy;
use \Lamoda\MultiEnv\Decorator\EnvProviderDecorator;

/*
 * Pass as first param one of available HostDetectorInterface implementations
 * Pass as second param one of available EnvNameFormatterInterface implementations
 */
$strategy = new HostBasedEnvResolvingStrategy($hostDetector, $envFormatter);
EnvProviderDecorator::init($strategy);

/*
 * Will search env with some specific prefix/suffix resolved by HostDetectorInterface
 * For example host_id__TEST_ENV
 */
EnvProviderDecorator::getEnv('TEST_ENV');

/*
 * Pass as first param one of available HostDetectorInterface implementations which detect HostId for current request
 * Pass as second param one of available EnvFileReaderInterface (for now available only DotEnvV2FileReaderAdapter) which load specific env file
 * Pass as third param another EnvResolvingStrategy which find specific env variable from loaded envs
 */
$strategy = new FileBasedEnvResolvingStrategy($hostDetector, $envFileReader, $envResolvingStrategy);
EnvProviderDecorator::init($strategy);
EnvProviderDecorator::getEnv('TEST_ENV');

Library set up by build in factory

1. Library set up for work with env in file stored in different directories

<?php

use \Lamoda\MultiEnv\Builder\FileBasedEnvResolvingStrategyBuilder;
use \Lamoda\MultiEnv\Decorator\EnvProviderDecorator;

/*
 * Result strategy resolve hostId from server headers or cli args
 * Then load all envs from .env file stored by path /var/envs/*hostId*
 * Read TEST_ENV env variable    
 */
$strategy = FileBasedEnvResolvingStrategyBuilder::buildStrategy('HTTP_X_HOST_ID', 'host_id', '.env', '/var/envs');
EnvProviderDecorator::init($strategy);

EnvProviderDecorator::getEnv('TEST_ENV');

1. Library set up for work with env with prefixes

<?php

use \Lamoda\MultiEnv\Builder\HostBasedEnvResolvingStrategyBuilder;
use \Lamoda\MultiEnv\Decorator\EnvProviderDecorator;

/*
 * Result strategy resolve hostId from server headers or cli args
 * Add prefix to original env name. Result be like *hostId*___TEST_ENV
 * Replace all '-' char to '_' case '-' illegal in env variable name
 * Read *host_id*___TEST_ENV env variable
 */
$strategy = HostBasedEnvResolvingStrategyBuilder::buildStrategy('HTTP_X_HOST_ID', 'host_id', '___');
EnvProviderDecorator::init($strategy);

EnvProviderDecorator::getEnv('TEST_ENV');

Library set up with multiple strategy

<?php

use \Lamoda\MultiEnv\Strategy\FirstSuccessfulEnvResolvingStrategy;
use \Lamoda\MultiEnv\Strategy\RawEnvResolvingStrategy;
use \Lamoda\MultiEnv\Strategy\HostBasedEnvResolvingStrategy;
use \Lamoda\MultiEnv\HostDetector\FirstSuccessfulHostDetector;
use \Lamoda\MultiEnv\HostDetector\CliArgsBasedHostDetector;
use \Lamoda\MultiEnv\HostDetector\ServerHeadersBasedHostDetector;
use \Lamoda\MultiEnv\Formatter\PrefixAppendFormatter;
use \Lamoda\MultiEnv\HostDetector\Factory\GetOptAdapterFactory;
use \Lamoda\MultiEnv\Decorator\EnvProviderDecorator;

$rawEnvResolvingStrategy = new RawEnvResolvingStrategy();
$hostBasedEnvResolvingStrategy = new HostBasedEnvResolvingStrategy(
    new FirstSuccessfulHostDetector([
        new ServerHeadersBasedHostDetector('HTTP_X_TEST_HEADER'),
        new CliArgsBasedHostDetector('host_id', GetOptAdapterFactory::build())    
    ]),
    new PrefixAppendFormatter('___')
);

$firstSuccessfulStrategy = new FirstSuccessfulEnvResolvingStrategy([
    $rawEnvResolvingStrategy,
    $hostBasedEnvResolvingStrategy
]);
EnvProviderDecorator::init($firstSuccessfulStrategy);

/*
 * Try find original env 'TEST_ENV' first. 
 * If original env not found than try to find env with some specific prefix/suffix resolved by HostDetectorInterface.
 * For example host_id__TEST_ENV
 */
EnvProviderDecorator::getEnv('TEST_ENV');

Available HostDetectorInterface implementations

1. \Lamoda\MultiEnv\HostDetector\ServerHeadersBasedHostDetector - use to identificate host via HTTP request

   <?php
   
   use \Lamoda\MultiEnv\HostDetector\ServerHeadersBasedHostDetector;
   use \Lamoda\MultiEnv\HostDetector\Exception\HostDetectorException;
   
   /*
    * Search passed needle in $_SERVER header. Use found value to identify current host
    * Throw HostDetectorException when passed empty needle
    */
   $headerBasedHostDetector = new ServerHeadersBasedHostDetector('HTTP_X_SOME_HEADER');
   $hostId = $headerBasedHostDetector->getCurrentHost();

2. \Lamoda\MultiEnv\HostDetector\CliArgsBasedHostDetector - use to identificate host via Cli script run

   <?php
   
   use \Lamoda\MultiEnv\HostDetector\CliArgsBasedHostDetector;
   use \Lamoda\MultiEnv\HostDetector\Factory\GetOptAdapterFactory;
   use \Lamoda\MultiEnv\HostDetector\Exception\HostDetectorException;
   
   /*
    * Search passed needle in CLI args. Use found value to identify current host
    * Throw HostDetectorException when passed empty needle
    */
   $cliArgsBasedHostDetector = new CliArgsBasedHostDetector('needle', GetOptAdapterFactory::build());
   $hostId = $cliArgsBasedHostDetector->getCurrentHost();

3. \Lamoda\MultiEnv\HostDetector\FirstSuccessfulHostDetector - use to aggregate multiple HostDetector's

   <?php
   
   use \Lamoda\MultiEnv\HostDetector\ServerHeadersBasedHostDetector;
   use \Lamoda\MultiEnv\HostDetector\CliArgsBasedHostDetector;
   use \Lamoda\MultiEnv\HostDetector\Factory\GetOptAdapterFactory;
   use \Lamoda\MultiEnv\HostDetector\FirstSuccessfulHostDetector;
   
   // Iterate through passed HostDetector's and return first not empty HostId
   $firstSuccessfulHostDetector = new FirstSuccessfulHostDetector([
       new CliArgsBasedHostDetector('some_host_id', GetOptAdapterFactory::build()),
       new ServerHeadersBasedHostDetector('HTTP_HOST_ID')
   ]);
   $hostId = $firstSuccessfulHostDetector->getCurrentHost();

Available FormatterInterface implementations

1. \Lamoda\MultiEnv\Formatter\PrefixAppendFormatter - append prefix and delimiter to original string. Combine original string, delimiter,host id in order *host id*, *delimiter*, *original string*

   <?php 
   
   use \Lamoda\MultiEnv\Formatter\PrefixAppendFormatter;
   use \Lamoda\MultiEnv\Model\HostId;
   use \Lamoda\MultiEnv\Formatter\Exception\FormatterException;
   
   $formatter = new PrefixAppendFormatter('__');
   // Throw FormatterException if passed empty originalName
   $formatterName = $formatter->formatName('originalEnvName', new HostId('test_host'));

2. \Lamoda\MultiEnv\Formatter\SuffixAppendFormatter - append suffix and delimiter to original string. Combine original string, delimiter,host id in order *original string*, *delimiter*, *host id*

   <?php
   
   use \Lamoda\MultiEnv\Formatter\SuffixAppendFormatter;
   use \Lamoda\MultiEnv\Model\HostId;
   use \Lamoda\MultiEnv\Formatter\Exception\FormatterException;
   
   $formatter = new SuffixAppendFormatter('___');
   // Throw FormatterException if passed empty originalName
   $formattedName = $formatter->formatName('originalEnvName', new HostId('test_host'));

3. \Lamoda\MultiEnv\Formatter\CharReplaceFormatter - act like str_replace in PHP. Could be useful to replace illegal char '-' to '_' when you access to env variable

   <?php
   
   use \Lamoda\MultiEnv\Formatter\CharReplaceFormatter;
   use \Lamoda\MultiEnv\Model\HostId;
   use \Lamoda\MultiEnv\Formatter\Exception\FormatterException;
   
   $formatter = new CharReplaceFormatter('-', '_');
   /*
    * Throw FormatterException if passed empty originalName
    * return 'original_env_name'     
    */
   $formattedName = $formatter->formatName('original-env-name', new HostId('testHost'));

4. \Lamoda\MultiEnv\Formatter\FormatterPipeline - aggregate few formatters. Iterate through them and apply each to original stirng

   <?php 
   
   use \Lamoda\MultiEnv\Formatter\FormatterPipeline;
   use \Lamoda\MultiEnv\Formatter\SuffixAppendFormatter;
   use \Lamoda\MultiEnv\Formatter\CharReplaceFormatter;
   use \Lamoda\MultiEnv\Model\HostId;
   
   $formatter = new FormatterPipeline([
      new SuffixAppendFormatter('-'),
      new CharReplaceFormatter('-', '_')
   ]);
   
   // return 'originalEnvName_test_host_id'
   $formattedName = $formatter->formatName('originalEnvName', new HostId('test-host-id'));