fix(plugins/plugin-s3): null pointer exception in plugin-s3/ibm init

This would result in the ibm s3 provider not initializing itself.

This PR also adds more debug to the ibm s3 provider.

Author: starpit

plugins/plugin-s3/ibm/src/IBMCloudS3Provider.ts

@@ -51,7 +51,7 @@ export default class IBMCloudS3Provider implements S3Provider {
     // e.g. s3.ap.cloud-object-storage.appdomain.cloud -> s3.direct.ap.cloud-object-storage.appdomain.cloud
     this.directEndPoint = this.endPoint.replace(/^s3\./, 's3.direct.')
 
-    const defaultRegion = GeoDefaults[config['Default Region']] || config['Default Region']
+    const defaultRegion = config ? GeoDefaults[config['Default Region']] || config['Default Region'] : undefined
     this.isDefault = config && geo === defaultRegion
 
     // use the closest available endpoint for listBuckets, since it is geo-agnostic

plugins/plugin-s3/ibm/src/controller/local.ts

@@ -14,14 +14,23 @@
  * limitations under the License.
  */
 
+import Debug from 'debug'
 import { REPL, encodeComponent } from '@kui-shell/core'
 import { FStat } from '@kui-shell/plugin-bash-like/fs'
 
 import filepath from './filepath'
 import Config, { hasDefaultRegion, hasEndpoint, isGoodConfigIgnoringEndpoint } from '../model/Config'
 
+const debug = Debug('plugin-s3/ibm/controller/local')
+
 export function isGoodConfig(config: void | Record<string, any>): config is Config {
-  return isGoodConfigIgnoringEndpoint(config) && hasEndpoint(config) && hasDefaultRegion(config)
+  const checkA = isGoodConfigIgnoringEndpoint(config)
+  const checkB = hasEndpoint(config)
+  const checkC = hasDefaultRegion(config)
+  debug('ibm s3 config check a', checkA)
+  debug('ibm s3 config check b', checkB)
+  debug('ibm s3 config check c', checkC)
+  return checkA && checkB && checkC
 }
 
 export default async function findLocal(repl: REPL): Promise<void | Config> {
@@ -32,5 +41,7 @@ export default async function findLocal(repl: REPL): Promise<void | Config> {
     if (isGoodConfig(config)) {
       return config
     }
-  } catch (err) {}
+  } catch (err) {
+    debug('ibm s3 config error reading config', err)
+  }
 }

plugins/plugin-s3/ibm/src/preload.ts

@@ -14,9 +14,19 @@
  * limitations under the License.
  */
 
+import Debug from 'debug'
 import { addProviderInitializer } from '@kui-shell/plugin-s3'
 
 export async function registerCapability() {
-  const ibmcloud = await import('./s3provider').then(_ => _.default)
-  addProviderInitializer(ibmcloud)
+  const debug = Debug('plugin-s3/ibm/register')
+  debug('registering ibm s3 provider 1')
+
+  try {
+    const ibmcloud = await import('./s3provider').then(_ => _.default)
+    debug('registering ibm s3 provider 2', ibmcloud)
+    addProviderInitializer(ibmcloud)
+  } catch (err) {
+    debug('registering ibm s3 provider error', err)
+    return []
+  }
 }

plugins/plugin-s3/ibm/src/s3provider.ts

@@ -55,6 +55,7 @@ async function init(geo: string, mountName: string, repl: REPL, reinit: () => vo
     const config = await fetchConfig(repl)
     listeningAlready = false
     if (!isGoodConfig(config)) {
+      debug('ibm s3 config is incomplete')
       return new IBMCloudS3Provider(
         geo,
         mountName,
@@ -64,7 +65,9 @@ async function init(geo: string, mountName: string, repl: REPL, reinit: () => vo
     } else {
       if (config && !config['Default Region']) {
         // TODO: isn't there a race here?
+        debug('ibm s3 config inferring Default Region')
         config['Default Region'] = await repl.qexec('ibmcloud cos config region default')
+        debug('ibm s3 config inferring Default Region: success', config['Default Region'])
       }
 
       const provider = new IBMCloudS3Provider(geo, mountName, config)
@@ -73,14 +76,15 @@ async function init(geo: string, mountName: string, repl: REPL, reinit: () => vo
       if (provider.isDefault) {
         // e.g. add an /s3/ibm/default mount point
         provider.isDefault = false
-        debug(`adding extra providers for default region in geo ${geo}`)
+        debug(`ibm s3 config adding extra providers for default region in geo ${geo}`)
         return [...(await extraProvidersForDefaultRegion(geo, config)), provider]
       } else {
-        debug(`adding extra providers for all regions in geo ${geo}`)
+        debug(`ibm s3 config adding extra providers for all regions in geo ${geo}`)
         return [...(await extraProvidersForAllRegions(geo, config)), provider]
       }
     }
   } catch (err) {
+    debug(`ibm s3 config fatal error`, err)
     return new IBMCloudS3Provider(geo, mountName, undefined, new UnsupportedS3ProviderError(err.message))
   }
 }