eip-s3-deploy 2.2.1 → 2.2.2

package/deploy.js

@@ -9,7 +9,8 @@ const handlebars = require ( 'handlebars' );
 const mime = require ( 'mime' );
 const progress = require ( 'cli-progress' );
 
-const COMMAND_OPTIONS = [ '-f', '--force', '-ff', '--folderFilter', '-e', '--env', '-v', '--verbose' ];
+const COMMAND_OPTIONS = [ '-f', '--force', '-ff', '--folderFilter', '-e', '--env', '-v', '--verbose', '-log' ];
+const logOutputRequested = process.argv.includes ( '-log' ) || process.argv.includes ( '--log' );
 const forceRedeploy = process.argv.includes ( '-f' ) || process.argv.includes ( '--force' );
 const verboseOutput = process.argv.includes ( '-v' ) || process.argv.includes ( '--verbose' );
 
@@ -58,6 +59,48 @@ const calculateMD5 = async ( filePath ) => {
     return crypto.createHash ( 'md5' ).update ( content ).digest ( 'hex' );
 };
 
+const readline = require ( 'readline' );
+
+const getUserConfirmation = async ( env, destinations ) => {
+    const projectName = await getProjectName ();   // returns a promise now ✅
+
+    const rl = readline.createInterface ( {
+        input: process.stdin,
+        output: process.stdout
+    } );
+
+    const intro = projectName
+        ? `🔒  You are about to deploy \x1b[38;5;190m${projectName}\x1b[0m to the \x1b[38;5;190m${env}\x1b[0m environment.\n`
+        : `🔒  You are about to deploy to the \x1b[38;5;190m${env}\x1b[0m environment.\n`;
+
+    const targets =
+        `\nThe project will be deployed to:\n\x1b[38;5;214m→ ${destinations.join ( ',\n→ ' )}\x1b[0m\n\n`;
+
+    return new Promise ( ( resolve ) => {
+        rl.question (
+            `\n${intro}${targets}` +
+            'Press ENTER to proceed or type anything else then ENTER to abort (or Ctrl+C): ',
+            ( answer ) => {
+                rl.close ();
+                resolve ( answer.trim () === '' );
+            }
+        );
+    } );
+};
+
+const getProjectName = () => {
+    const packageJsonPath = path.join ( process.cwd (), 'package.json' );
+    
+    return fs.access ( packageJsonPath )
+        .then ( () => fs.readFile ( packageJsonPath, 'utf8' ) )
+        .then ( ( data ) => {
+            const packageJson = JSON.parse ( data );
+            
+            return packageJson.name || 'Unknown Project';
+        } )
+        .catch ( () => null );
+};
+
 const deploy = async () => {
 
     if ( process.argv.length <= 2 || process.argv.includes ( '--help' ) || process.argv.includes ( '-h' ) || process.argv.includes ( 'help' ) ) {
@@ -154,6 +197,28 @@ const deploy = async () => {
             return;
         }
 
+        if ( logOutputRequested ) {
+            const list = ( forceRedeploy ? scannedFiles : filesToUpload );
+            process.stdout.write ( '\x1b[38;5;245m\nFiles to be deployed:\x1b[0m\n' );
+            list.forEach ( f => process.stdout.write ( `${f.replace ( process.cwd (), '' )}\n` ) );
+            process.stdout.write ( '-------------------\n' );
+        }
+
+        // ------------------------------------------------------------------
+        // Guard-rail: require explicit user confirmation
+        const okToProceed = await getUserConfirmation (
+            environment,
+            config.bucket.map ( ( b, i ) => `${b}/${config.folder[ i ] || ''}` )
+        );
+
+        if ( !okToProceed ) {
+            process.stdout.write ( '\x1b[38;5;196mDeployment cancelled by user.\x1b[0m\n' );
+            
+            return;
+        }
+        // ------------------------------------------------------------------
+
+        process.stdout.write ( '\n' );
         const progressBar = new progress.SingleBar ( {
             format: '\x1b[38;5;214m🚀 Deploying [\x1b[38;5;190m{bar}\x1b[0m\x1b[38;5;214m] {percentage}% | ETA: {eta}s | {value}/{total}',
             barCompleteChar: '#',
@@ -235,7 +300,7 @@ const deploy = async () => {
             environment: environment,
             timestamp: Date.now ()
         } ];
-        if ( deploymentReport.length > 0 ){
+        if ( deploymentReport.length > 0 && config?.deploymentReportEnabled !== false ){
             await fetch ( 'https://tools.eip.telegraph.co.uk/v1/healthcheck/deployment', {
                 method: 'POST',
                 headers: {
@@ -243,6 +308,9 @@ const deploy = async () => {
                 },
                 body: JSON.stringify ( { deployments: deploymentReport } )
             } );
+
+            process.stdout.write ( '-------------------\n' );
+            process.stdout.write ( '✅ \x1b[38;5;190mDeployment report has been sent.\x1b[0m\n' );
         }    
 
         process.stdout.write ( '-------------------\n' );
@@ -260,12 +328,13 @@ const deploy = async () => {
 const showHelp = () => {
     console.log ( 'S3 Deploy Script' );
     console.log ( 'Usage:' );
-    console.log ( '  s3-deploy <environment_name> [-f|--force] [-ff|--folderFilter <folder_filter>] [-e|--env <environment_name>]' );
+    console.log ( '  s3-deploy <environment_name> [-f|--force] [-ff|--folderFilter <folder_filter>] [-e|--env <environment_name>] [-log]' );
     console.log ( 'Options:' );
     console.log ( '  -f,  --force            Force redeployment of files' );
     console.log ( '  -ff, --folderFilter     Specify a single folder to deploy' );
     console.log ( '  -e,  --env              Specify the environment for deployment' );
     console.log ( '  -v,  --verbose          Print more output' );
+    console.log ( '  -log                    List every file that will be uploaded before confirmation' );
     console.log ( 'Examples:' );
     console.log ( '  s3-deploy test' );
     console.log ( '  s3-deploy production --force' );

package/deployment.lock

@@ -12,7 +12,7 @@
     "/test/folder1/file2.txt": "d41d8cd98f00b204e9800998ecf8427e",
     "/test/folder2/file1.txt": "d41d8cd98f00b204e9800998ecf8427e",
     "/test/folder2/file2.txt": "d41d8cd98f00b204e9800998ecf8427e",
-    "/test/example.html": "d3ee67eb6e0f33d59c944fb4786359f3"
+    "/test/example.html": "47caf57861b1dd625f93f21871503582"
   },
   "prod": {
     "/test/file1.txt": "f5b5ed0c72f4e9984c3e7a8b18c08c2b",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "eip-s3-deploy",
-    "version": "2.2.1",
+    "version": "2.2.2",
     "description": "Deploy static websites to S3 - all files will be public",
     "main": "deploy.js",
     "bin": {

package/test/example.html

@@ -26,7 +26,7 @@
       border-radius: 4px;
     }
 
-    /* PrismJS 1.29.0
+    /* PrismJS 1.29
 https://prismjs.com/download.html#themes=prism-tomorrow&languages=markup+css+clike+javascript */
 code[class*=language-],pre[class*=language-]{color:#ccc;background:0 0;font-family:Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#2d2d2d}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.block-comment,.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#999}.token.punctuation{color:#ccc}.token.attr-name,.token.deleted,.token.namespace,.token.tag{color:#e2777a}.token.function-name{color:#6196cc}.token.boolean,.token.function,.token.number{color:#f08d49}.token.class-name,.token.constant,.token.property,.token.symbol{color:#f8c555}.token.atrule,.token.builtin,.token.important,.token.keyword,.token.selector{color:#cc99cd}.token.attr-value,.token.char,.token.regex,.token.string,.token.variable{color:#7ec699}.token.entity,.token.operator,.token.url{color:#67cdcc}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:green}