All files / lib/backend-operations backend-spec-manager.js

9.39% Statements 17/181
0% Branches 0/74
0% Functions 0/33
9.39% Lines 17/181
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371                          12x 12x 12x 12x 12x 12x   12x 12x 12x 12x 12x 12x 12x 12x 12x 12x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             12x                            
/* 
 * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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.
*/
"use strict";
const fs = require('fs-extra')
const _ = require('lodash')
const util = require('util')
const chalk = require('chalk')
const path = require('path')
const inquirer = require('inquirer')
 
const opsUserSignin = require('./ops-user-signin.js')
const backendFeatures = require('../aws-operations/mobile-features.js')
const awsConfigManager = require('../aws-operations/aws-config-manager')
const awsMobileYamlOps = require('../aws-operations/mobile-yaml-ops.js')
const awsmobileJSConstant = require('../utils/awsmobilejs-constant.js')
const pathManager = require('../utils/awsmobilejs-path-manager.js')
const dfops = require('../utils/directory-file-ops.js')
const objOps = require('../utils/object-ops.js')
const featureYmalNameMapping = require('../utils/feature-yaml-name-mapping.js')
const nameManager = require('../utils/awsmobilejs-name-manager.js')
 
function listEnabledFeatures(projectInfo){
    let featureNames = getEnabledFeatures(projectInfo)
    if(featureNames){
        if(featureNames.length > 0){
            let featureListDisplay = concatFeatureNames(featureNames)
            console.log('backend awsmobile project enabled features:')
            console.log(chalk.green(featureListDisplay))
        }else{
            console.log(chalk.blue('no backend awsmobile feature is selected for this project'))
        }
    }else{
        console.log(chalk.red('local backend specs appear to be corrupted'))
        console.log('please restore the local backend specs to a valid state before continuing')
    }
}
 
function listAllFeatures(projectInfo){
    let featureListDisplay = concatFeatureNames(backendFeatures)
    console.log('awsmobile features:')
    console.log(chalk.blue(featureListDisplay))
}
 
function concatFeatureNames(featureNames){
    let sortedFeatureNames = featureNames.sort()
    let featureListDisplay = ''
    sortedFeatureNames.forEach(function(featureName){
        featureListDisplay += ', ' + featureName
    })
    featureListDisplay = featureListDisplay.substr(2)
    return featureListDisplay
}
 
 
function getEnabledFeatures(projectInfo)
{
    let backendProject = getBackendProjectObject(projectInfo)
    return  getEnabledFeaturesFromObject(backendProject)
}
 
 
function getEnabledFeaturesFromObject(backendProject)
{
    let result
    if(backendProject){
        result = []
        if(backendProject.features){
            let ymlFeatures = _.keys(backendProject.features)
            if(ymlFeatures && ymlFeatures.length > 0){
                ymlFeatures.forEach(function(ymlFeatureName) {
                    let featureName = getFeatureName(ymlFeatureName)
                    if(featureName && !result.includes(featureName)){
                        if(featureName == opsUserSignin.featureName){
                            if(backendProject.features[ymlFeatureName].attributes && 
                                backendProject.features[ymlFeatureName].attributes.enabled){
                                    result.push(featureName)
                            }
                        }else{
                            result.push(featureName)
                        }
                    }
                })
            }
        }
    }
    return result
}
 
function updataFeatureList(projectInfo, oldFeatures, newFeatures){
    let backendProjectSpec = getBackendProjectObject(projectInfo)
    
    if(backendProjectSpec){
        let featuresToAdd = []
        let featuresToRemove = []
 
        oldFeatures.forEach(function(oldFeature) {
            if(!newFeatures.includes(oldFeature)){
                featuresToRemove.push(oldFeature)
            }
        })
 
        newFeatures.forEach(function(newFeature) {
            if(!oldFeatures.includes(newFeature)){
                featuresToAdd.push(newFeature)
            }
        })
 
        removeFeatures(projectInfo, backendProjectSpec, featuresToRemove).then(()=>{
            if(featuresToAdd.length > 0){
                addFeatures(projectInfo, backendProjectSpec, featuresToAdd)
            }
            listEnabledFeatures(projectInfo)
        })
    }else{
        console.log(chalk.red('local backend specs appear to be corrupted'))
        console.log('please restore the local backend specs before continuing')
    }
}
 
function enableFeature(projectInfo, featureName, ifUsePrompt){ 
    let backendProjectSpec = getBackendProjectObject(projectInfo)
    if(backendProjectSpec){
        let enabledFeatures = getEnabledFeaturesFromObject(backendProjectSpec)
        if(enabledFeatures.includes(featureName)){
            console.log(featureName + ' is already enabled')
            console.log(chalk.gray('# to configure the feature'))
            console.log('    $ awsmobile ' + featureName + ' configure')
        }else if(ifUsePrompt){
            const featureOpsFilePath = pathManager.getOpsFeatureFilePath(featureName)
            const featureOps = require(featureOpsFilePath)
            featureOps.specify(projectInfo)
        }else{
            addFeatures(projectInfo, backendProjectSpec, [featureName])
            listEnabledFeatures(projectInfo)
        }
    }else{
        console.log(chalk.red('local backend specs appear to be corrupted'))
        console.log('please restore the local backend specs before continuing')
    }
}
 
function disableFeature(projectInfo, featureName){ 
    let backendProjectSpec = getBackendProjectObject(projectInfo)
    if(backendProjectSpec){
        let enabledFeatures = getEnabledFeaturesFromObject(backendProjectSpec)
        if(!enabledFeatures.includes(featureName)){
            console.log(chalk.red(featureName + ' is not currently enabled'))
        }else{
            removeFeatures(projectInfo, backendProjectSpec, [featureName]).then(function(){
                listEnabledFeatures(projectInfo)
            })
        }
    }else{
        console.log(chalk.red('local backend specs appear to be corrupted'))
        console.log('please restore the local backend specs to a valid state before continuing')
    }
}
 
function configureFeature(projectInfo, featureName){ 
    let backendProjectSpec = getBackendProjectObject(projectInfo)
    if(backendProjectSpec){
        let enabledFeatures = getEnabledFeaturesFromObject(backendProjectSpec)
        if(!enabledFeatures.includes(featureName)){
            console.log(chalk.red(featureName + ' is not currently enabled'))
            console.log(chalk.gray('# to enable the feature'))
            console.log('    $ awsmobile ' + featureName + ' enable')
        }else{
            const featureOpsFilePath = pathManager.getOpsFeatureFilePath(featureName)
            const featureOps = require(featureOpsFilePath)
            featureOps.specify(projectInfo)
        }
    }else{
        console.log(chalk.red('local backend specs appear to be corrupted'))
        console.log('please restore the local backend specs to a valid state before continuing')
    }
}
 
//happens with delete or detach backend project
function onClearBackend(projectInfo){
    let backendProject = getBackendProjectObject(projectInfo)
    if(backendProject){
        backendProject.name = ''
        setBackendProjectObject(backendProject, projectInfo)
    }
}
 
function getBackendProjectObject(projectInfo)
{
    let backendProject
 
    let backendProjectYamlFilePath = pathManager.getBackendSpecProjectYmlFilePath(projectInfo.ProjectPath)
 
    if(fs.existsSync(backendProjectYamlFilePath)){
        backendProject = awsMobileYamlOps.readYamlFileSync(backendProjectYamlFilePath)
    }else{
        console.log(chalk.red('can not locate mobile-hub-project file inside ' + pathManager.getBackendDirPath_relative(projectInfo.ProjectPath)))
    }
 
    return backendProject
}
 
function setBackendProjectObject(backendProject, projectInfo)
{
    if(projectInfo && backendProject){
        let backendProjectYamlFilePath = pathManager.getBackendSpecProjectYmlFilePath(projectInfo.ProjectPath)
        awsMobileYamlOps.writeYamlFileSync(backendProject, backendProjectYamlFilePath)
    }
}
 
function getLastModificationTime(projectInfo){
 
    let result 
    if(projectInfo){
 
        let backendProjectYamlFilePath = pathManager.getBackendSpecProjectYmlFilePath(projectInfo.ProjectPath)
    
        if(fs.existsSync(backendProjectYamlFilePath)){
            result = fs.lstatSync(backendProjectYamlFilePath).mtime
        }else{
            console.log(chalk.red('can not locate mobile-hub-project file inside ' + pathManager.getBackendDirPath_relative(projectInfo.ProjectPath)))
        }
    }
    return result
}
 
function getYmlFeatureName(featureName){
    return featureYmalNameMapping[featureName]
}
 
function getFeatureName(ymlFeatureName){
    let result 
    backendFeatures.forEach(function(featureName) {
        if(featureYmalNameMapping[featureName].includes(ymlFeatureName)){
            result = featureName
        }
    })
    return result
}
 
function addFeatures(projectInfo, backendProjectSpec, featuresToAdd){ //featuresToAdd is an array that's already validated and cleansed
    if(backendProjectSpec){
        if(!backendProjectSpec.features){
            //user might have accidently removed features property, but yml is still valid
            //awsmobile-cli will be tolerant in this scenario
            backendProjectSpec.features = {} 
        }
        let featuresTurnedOn = []
 
        featuresToAdd.forEach(function(newFeature) {
            let featureYmlFilePath = pathManager.getFeatureYmlTemplateFilePath(newFeature)
            let featureObject = awsMobileYamlOps.readYamlFileSync(featureYmlFilePath)
            Object.assign(backendProjectSpec.features, featureObject.features)
            featuresTurnedOn.push(newFeature)
        })
 
        backendProjectSpec.features = objOps.sortByPropertyKey(backendProjectSpec.features)
        setBackendProjectObject(backendProjectSpec, projectInfo)
 
        if(featuresTurnedOn.length > 0){
            featuresTurnedOn = featuresTurnedOn.sort()
            let featureListDisplay = ''
            featuresTurnedOn.forEach(function(featureName){
                onFeatureTurnOn(projectInfo, backendProjectSpec, featureName)
                featureListDisplay += ', ' + featureName
            })
    
            featureListDisplay = featureListDisplay.substr(2)
            console.log('enabled: ' + chalk.green(featureListDisplay))
        }
    }
}
 
function removeFeatures(projectInfo, backendProjectSpec, featuresToRemove){
    return new Promise(function (resolve, reject) {
        if(featuresToRemove.length > 0){
            console.log(chalk.bgYellow.bold('Warning:') + ' disabled feature can not be recovered locally, even if you enable it again' )
            inquirer.prompt([
                {
                    type: 'confirm',
                    name: 'disableFeatures',
                    message: 'please confirm to disable: ' + concatFeatureNames(featuresToRemove),
                    default: false
                }
            ]).then(function (answers) {
                if(answers.disableFeatures){
                    if(!backendProjectSpec.features){
                        //user might have accidently removed features property, but yml is still valid
                        //awsmobile-cli will be tolerant in this scenario
                        backendProjectSpec.features = {} 
                    }
                    let featuresTurnedOff = []
            
                    featuresToRemove.forEach(function(oldFeature) {
                        let ymlFeatureNames = getYmlFeatureName(oldFeature)
                        if(ymlFeatureNames){
                            ymlFeatureNames.forEach(function(ymlFeatureName) {
                                delete backendProjectSpec.features[ymlFeatureName]
                            })
                            featuresTurnedOff.push(oldFeature)
                        }
                    })
            
                    backendProjectSpec.features = objOps.sortByPropertyKey(backendProjectSpec.features)
                    setBackendProjectObject(backendProjectSpec, projectInfo)
            
                    if(featuresTurnedOff.length > 0){
                        featuresTurnedOff = featuresTurnedOff.sort()
                        let featureListDisplay = ''
                        featuresTurnedOff.forEach(function(featureName){
                            onFeatureTurnOff(projectInfo, backendProjectSpec, featureName)
                            featureListDisplay += ', ' + featureName
                        })
                        featureListDisplay = featureListDisplay.substr(2)
                        console.log('disabled: ' + chalk.red(featureListDisplay))
                    }
                    resolve()
                }else{
                    resolve()
                }
            })
        }else{
            resolve()
        }
    })
}
 
function onFeatureTurnOn(projectInfo, backendProjectSpec, featureName){
    try{
        const featureOpsFilePath = pathManager.getOpsFeatureFilePath(featureName)
        const featureOps = require(featureOpsFilePath)
        featureOps.onFeatureTurnOn(projectInfo)
    }catch(e){
        console.log(e)
    }
}
 
function onFeatureTurnOff(projectInfo, backendProjectSpec, featureName){
    try{
        const featureOpsFilePath = pathManager.getOpsFeatureFilePath(featureName)
        const featureOps = require(featureOpsFilePath)
        featureOps.onFeatureTurnOff(projectInfo)
    }catch(e){
        console.log(e)
    }
}
 
module.exports = {
    listEnabledFeatures,
    listAllFeatures,
    getEnabledFeatures,
    getEnabledFeaturesFromObject,
    updataFeatureList,
    enableFeature,
    disableFeature,
    configureFeature,
    onClearBackend,
    getBackendProjectObject,
    setBackendProjectObject,
    getLastModificationTime
}