eip-cloud-services 1.0.4 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eip-cloud-services",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Houses a collection of helpers for connecting with Cloud services.",
   "main": "index.js",
   "scripts": {
@@ -22,4 +22,4 @@
     "mysql": "^2.18.1",
     "redis": "^4.6.7"
   }
-}
+}

package/src/cdn.js

@@ -3,6 +3,7 @@ const { GoogleAuth } = require ( 'google-auth-library' );
 const { initialiseGoogleAuth } = require ( './gcp' );
 const config = require ( 'config' );
 const packageJson = require ( '../package.json' );
+const { log } = config.s3.logsFunction ? require ( `${  cwd ()}/${config.s3.logsFunction}` ) : console;
 
 /**
  * Create a CDN invalidation for the specified key(s) and environment.
@@ -37,6 +38,9 @@ exports.createInvalidation = async ( cdn, key, environment = 'production' ) => {
         throw new Error ( 'Invalid key argument. Expected a string or an array of strings.' );
     }
 
+    if ( config.cdn.log )
+        log ( `CDN [INVALIDATE]: ${paths.map ( path => `https://${cdn}${environment !== 'production' ? '-test' : ''}.eip.telegraph.co.uk/${path}` ).join ( ', ' )}\n` );
+
     switch ( cdnSettings.type ) {
         case 'google':
             await invalidateGoogleCDN ( cdnSettings, paths );

package/src/s3.js

@@ -42,7 +42,8 @@ const { S3Client, HeadObjectCommand, GetObjectCommand, PutObjectCommand, DeleteO
 const config = require ( 'config' );
 const zlib = require ( 'zlib' );
 const crypto = require ( 'crypto' );
-
+const { cwd } = require ( 'process' );
+const { log } = config.s3.logsFunction ? require ( `${  cwd ()}/${config.s3.logsFunction}` ) : console;
 const S3 = new S3Client ( { region: 'eu-west-1' } );
 
 /**
@@ -61,10 +62,16 @@ exports.exists = async ( key, bucket = config.s3.Bucket ) => {
         } );
   
         await S3.send ( command );
+
+        if ( config.s3.logs === 'verbose' )
+            log ( `S3 [EXISTS]: ${key} on ${bucket} - Exists` );
         
         return true;
     }
     catch ( error ) {
+        if ( config.s3.logs === 'verbose' )
+            log ( `S3 [EXISTS]: ${key} on ${bucket} - Does not exist` );
+        
         return false;
     }
 };
@@ -73,24 +80,35 @@ exports.exists = async ( key, bucket = config.s3.Bucket ) => {
  * Get an object from S3.
  *
  * @param {string} key - The object key.
+ * @param {string} [bucket=config.s3.Bucket] - The bucket name. Defaults to the configured bucket.
  * @returns {Promise} A promise that resolves to the retrieved object.
  * @description Retrieves an object from S3 based on the provided key.
  */
-exports.get = async ( key ) => {
+exports.get = async ( key, bucket = config.s3.Bucket ) => {
     try {
         const command = new GetObjectCommand ( {
-            Bucket: config.s3.Bucket,
+            Bucket: bucket,
             Key: key
         } );
 
+        if ( config.s3.logs === 'verbose' )
+            log ( `S3 [GET]: Getting ${bucket}/${key}.` );
+            
         const response = await S3.send ( command );
         let data = await streamToBuffer ( response.Body );
 
         if ( response.ContentEncoding && response.ContentEncoding === 'gzip' ) {
+
+            if ( config.s3.logs === 'verbose' )
+                log ( `S3 [GET]: ${key} on ${bucket} was unzipped (was gzipped).` );
+
             data = zlib.unzipSync ( data );
         }
 
         if ( response.ContentType !== 'application/json' ) {
+            if ( config.s3.logs === 'output' )
+                log ( `S3 [GET]: Returned ${response.ContentType} from ${bucket}/${key}.` );
+            
             return data.toString ( 'utf8' );
         }
         
@@ -108,9 +126,16 @@ exports.get = async ( key ) => {
                 key,
                 Buffer.from ( data.toString (), 'base64' )
             );
+
             data = Buffer.from ( decryptedArrayBuffer ).toString ( 'utf8' );
+
+            if ( config.s3.logs === 'verbose' )
+                log ( `S3 [GET]: ${key} on ${bucket} - JSON content was decrypted.` );
         }
 
+        if ( config.s3.logs === 'output' )
+            log ( `S3 [GET]: ${bucket}/${key} - JSON content was returned.` );
+
         return JSON.parse ( data.toString ( 'utf8' ) );
     }
     catch ( error ) {
@@ -148,6 +173,10 @@ exports.set = async ( key, body, options = {} ) => {
     } = options;
     
     if ( encrypt && contentType === 'application/json' ) {
+
+        if ( config.s3.logs === 'verbose' )
+            log ( `S3 [SET]: ${bucket}/${key} - Encrypting.` );
+
         const encoder = new TextEncoder ();
         const data = encoder.encode ( body );
 
@@ -182,6 +211,9 @@ exports.set = async ( key, body, options = {} ) => {
         } );
   
         const data = await S3.send ( command );
+
+        if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' )
+            log ( `S3 [SET]: ${bucket}/${key} - Stored.` );
   
         return data;
     }
@@ -208,6 +240,9 @@ exports.del = async ( key, bucket = config.s3.Bucket ) => {
 
         const data = await S3.send ( command );
 
+        if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' )
+            log ( `S3 [DELETE]: ${key} on ${bucket} - Deleted.` );
+
         return data;
     }
     catch ( error ) {
@@ -250,6 +285,15 @@ exports.move = async ( sourceKey, destinationKey, sourceBucket = config.s3.Bucke
         } );
   
         await S3.send ( deleteCommand );
+
+        if ( config.s3.logs === 'outputs' || config.s3.logs === 'verbose' ){
+            if ( sourceBucket === destinationBucket ){
+                log ( `S3 [MOVE]: ${sourceKey} moved to ${destinationKey} on ${sourceBucket}.` );
+            }
+            else {
+                log ( `S3 [MOVE]: ${sourceKey} on ${sourceBucket} moved to ${destinationKey} on ${destinationBucket}.` );
+            }
+        }
     }
     catch ( error ) {
         throw error;

package/src/util/log.js

@@ -0,0 +1,3 @@
+exports.log = log => {
+    console.log ( log );
+};