ProjectHelper

3.3.1-preview

include/featureflag.ps1

# Feature Flag
#
# Feature Flags management module
#
# This module will allow set Feature Flags to the module to quicker release
# features with less risk
#
# Include design description
# This module depends on Config Include
# Config module will depend on invokeCommand.helper.ps1, MyWrite.ps1, config.ps1, module.helper.ps1
#
# As you se features keys they will be recorded on a config file.
# Deprecate the FF to have it removed from the config file when the FF is released (aka set functionality to GA with now FF.
# Use Clear-FeatureFlagsRegistered to remove deprecated FF from config


$MODULE_NAME_PATH = ($PSScriptRoot | Split-Path -Parent | Get-ChildItem -Filter *.psd1 | Select-Object -First 1) | Split-Path -Parent
$MODULE_NAME = $MODULE_NAME_PATH | Split-Path -LeafBase

function Get-FeatureFlags{
    [CmdletBinding()]
    param()

    $config = Get-Configuration

    if(! $config){
        return @{}
    }

    if(! $config.FeatureFlags){
        $config.FeatureFlags = @{}
    }

    return $config.FeatureFlags
}

function Save-FeatureFlags{
    [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)][hashtable]$FeatureFlags
    )

    $result = Set-ModuleNameConfigValue -Name "FeatureFlags" -Value $FeatureFlags

    if(! $result){
        throw "Failed to save Feature Flags"
    }
}

function Test-FeatureFlag {
    [CmdletBinding()]
    [Alias("tff")]
    param(
        [Parameter(Mandatory,Position=0)][string]$Key
    )

    $ffs = Get-FeatureFlags

    $value = $ffs.$Key

    if($null -eq $value){
        Set-FeatureFlag -Key $Key -Value $false
        return $false
    }

    return $value
}

function Set-FeatureFlag{
        [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)][string]$Key,
        [Parameter()][bool]$Value = $true

    )

    $featureFlags = Get-FeatureFlags

    $featureFlags.$Key = $Value

    Save-FeatureFlags $featureFlags

}

function Clear-FeatureFlag{
        [CmdletBinding()]
    param(
        [Parameter(Mandatory,Position=0)][string]$Key

    )

    Set-FeatureFlag -Key $Key -Value $false

}

function Clear-FeatureFlagsRegistered{
    [cmdletbinding()]
    param()

    $rffs = Get-ModuleNameRegisteredFeatureFlags
    $ffs = (Get-FeatureFlags).Clone()

    $rffs.deprecated | ForEach-Object {
        $ffs.Remove($_)
    }

    Save-FeatureFlags $ffs

}

######

function Get-ModuleNameRegisteredFeatureFlags{
    [cmdletbinding()]
    param()

    $ffPath = $MODULE_NAME_PATH | Join-Path -ChildPath "featureflags.json"

    if(! ($ffPath | Test-Path)){
        return
    }

    $Json = Get-Content $ffPath 

    $ff = $Json | ConvertFrom-Json

    return $ff

}
$function = "Get-ModuleNameRegisteredFeatureFlags"
$destFunction = $function -replace "ModuleName", $MODULE_NAME
if( -not (Test-Path function:$destFunction )){
    Copy-Item -path Function:$function -Destination Function:$destFunction
    Export-ModuleMember -Function $destFunction
}

function Get-ModuleNameFeatureFlags{
    [cmdletbinding()]
    param()

    $ffs = Get-FeatureFlags

    return $ffs
}
$function = "Get-ModuleNameFeatureFlags"
$destFunction = $function -replace "ModuleName", $MODULE_NAME
if( -not (Test-Path function:$destFunction )){
    Rename-Item -path Function:$function -NewName $destFunction
    Export-ModuleMember -Function $destFunction
}

function Set-ModuleNameFeatureFlag{
    [cmdletbinding()]
    param(
        [Parameter(Mandatory,Position=0)][string]$Key,
        [Parameter()][bool]$Value = $true
    )

    Set-FeatureFlag -Key $Key -Value $Value
}
$function = "Set-ModuleNameFeatureFlag"
$destFunction = $function -replace "ModuleName", $MODULE_NAME
if( -not (Test-Path function:$destFunction )){
    Rename-Item -path Function:$function -NewName $destFunction
    Export-ModuleMember -Function $destFunction
}