feat: collect provider errors

Author: aacotroneo

README.md

@@ -60,7 +60,6 @@ CloudGraph will generate this configuration file when you run `cg init aws`. You
     ], // Optional, defaults to the default profile
     "regions": "us-east-1,us-east-2,us-west-2",
     "resources": "alb,apiGatewayResource,apiGatewayRestApi,apiGatewayStage,appSync,asg,billing,cognitoIdentityPool,cognitoUserPool,cloudFormationStack,cloudFormationStackSet,cloudfront,cloudwatch,ebs,ec2Instance,eip,elb,igw,kinesisFirehose,kinesisStream,kms,lambda,nat,networkInterface,route53HostedZone,route53Record,routeTable,sg,vpc,sqs,s3"
-  }
 }
 ```
 

package.json

@@ -38,7 +38,7 @@
     "@aws-sdk/client-ssm": "^3.341.0",
     "@aws-sdk/credential-providers": "^3.256.0",
     "@aws-sdk/shared-ini-file-loader": "^3.254.0",
-    "@cloudgraph/sdk": "^0.22.1",
+    "@cloudgraph/sdk": "^0.23.0",
     "@fast-csv/parse": "^4.3.6",
     "@graphql-tools/load-files": "^6.5.3",
     "@graphql-tools/merge": "^8.2.1",
@@ -88,4 +88,4 @@
     "**/glob-parent": "^5.1.2",
     "**/uri-js": "^3.0.1"
   }
-}
+}

src/services/index.ts

@@ -26,6 +26,7 @@ import { obfuscateSensitiveString } from '../utils/format'
 import { checkAndMergeConnections } from '../utils'
 import { Account, rawDataInterface } from './base'
 import enhancers, { EnhancerConfig } from './base/enhancers'
+import AwsErrorLog from '../utils/errorLog'
 
 const DEFAULT_REGION = 'us-east-1'
 const DEFAULT_RESOURCES = Object.values(services).join(',')
@@ -314,15 +315,16 @@ export default class Provider extends CloudGraph.Client {
                 // MFA token support
                 mfaCodeProvider: async () => {
                   this.logger.debug('MFA token needed, requesting...')
-                  const { mfaToken = '' }: { mfaToken: string } = await this.interface.prompt([
-                    {
-                      type: 'input',
-                      message: `Please enter the MFA token for ${profile}`,
-                      name: 'mfaToken'
-                    },
-                  ])
+                  const { mfaToken = '' }: { mfaToken: string } =
+                    await this.interface.prompt([
+                      {
+                        type: 'input',
+                        message: `Please enter the MFA token for ${profile}`,
+                        name: 'mfaToken',
+                      },
+                    ])
                   return mfaToken
-                }
+                },
               })
               if (creds) {
                 sts = new AWS.STS({ credentials: await credsFunction() })
@@ -454,7 +456,7 @@ export default class Provider extends CloudGraph.Client {
    * getSchema is used to get the schema for provider
    * @returns A string of graphql sub schemas
    */
-   getSchema(): DocumentNode {
+  getSchema(): DocumentNode {
     const typesArray = loadFilesSync(path.join(__dirname), {
       recursive: true,
       extensions: ['graphql'],
@@ -495,7 +497,7 @@ export default class Provider extends CloudGraph.Client {
   }
 
   private async getProfilesFromSharedConfig(): Promise<string[]> {
-    let profiles = []
+    const profiles = []
     try {
       const filesObject = await loadSharedConfigFiles()
       const files = Object.keys(filesObject)
@@ -861,11 +863,12 @@ export default class Provider extends CloudGraph.Client {
       }
     }
 
-    return this.enhanceData({
+    const enhancedData = this.enhanceData({
       accounts: accounts.data[globalRegion],
       configuredRegions,
       rawData: mergedRawData,
       data: result,
     })
+    return { ...enhancedData, errors: AwsErrorLog.errorsHistory }
   }
 }

src/utils/errorLog.ts

@@ -1,4 +1,5 @@
 import CloudGraph from '@cloudgraph/sdk'
+import { ProviderError } from '@cloudgraph/sdk/dist/src/types'
 import { AWSError } from 'aws-sdk'
 
 const notAuthorized = 'not authorized' // part of the error string aws passes back for permissions errors
@@ -7,6 +8,9 @@ const throttling = 'Throttling'
 const { logger } = CloudGraph
 
 export default class AwsErrorLog {
+  // store errors for futher analysis
+  static errorsHistory: ProviderError[] = []
+
   constructor(serviceName: string) {
     this.serviceName = serviceName
   }
@@ -35,6 +39,13 @@ export default class AwsErrorLog {
           logger.warn(
             `There was a problem getting data for service ${this.serviceName}, CG encountered an error calling ${functionName}`
           )
+
+        AwsErrorLog.errorsHistory.push({
+          service: this.serviceName,
+          function: functionName,
+          message: err?.message,
+        })
+
         if (
           err?.message?.includes(notAuthorized) ||
           err?.code === accessDenied

yarn.lock

@@ -3474,10 +3474,10 @@
   resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39"
   integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==
 
-"@cloudgraph/sdk@^0.22.1":
-  version "0.22.1"
-  resolved "https://registry.yarnpkg.com/@cloudgraph/sdk/-/sdk-0.22.1.tgz#bf5c2f263df17b085147a3ca234ac5b0a8806545"
-  integrity sha512-aMrnoTRRIODAVvgtmqGZPB7Z8x1kMgKjFtLjpiHa121o0GCEZCjbxDmU8T3DwmRwI1u4QD5iKbXf9dB0573mJA==
+"@cloudgraph/sdk@^0.23.0":
+  version "0.23.0"
+  resolved "https://registry.yarnpkg.com/@cloudgraph/sdk/-/sdk-0.23.0.tgz#3f6012c0e3573f527da27ebcccb8841bbeffd21b"
+  integrity sha512-c+Ozu8yLK3RlAcKy4d0fdTQc9JkdUJ2ESmrcW7oC5XdIARrDWQ5+Kr8AGPABOK1/UYtFyVR2JmUHnoSJdGAv6Q==
   dependencies:
     "@graphql-tools/load-files" "^6.5.3"
     "@graphql-tools/merge" "^8.2.1"