feat(plugins/plugin-s3): add support for public ibmcloud s3 (COS) buckets

part of #7896

Author: starpit

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

@@ -36,7 +36,7 @@ export default class IBMCloudS3Provider implements S3Provider {
   public constructor(
     private readonly geo: string,
     public readonly mountName: string,
-    config?: Config,
+    config?: Pick<Config, 'AccessKeyID' | 'SecretAccessKey' | 'endpointForKui'>,
     public readonly error?: Error
   ) {
     const accessKey = config ? config.AccessKeyID : undefined

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

@@ -24,7 +24,7 @@ import { isGoodConfig } from './controller/local'
 
 import baseMountName from './baseMountName'
 import IBMCloudS3Provider from './IBMCloudS3Provider'
-import extraProvidersForDefaultRegion from './specialMounts'
+import { extraProvidersForDefaultRegion, extraProvidersForAllRegions } from './specialMounts'
 
 /** Listening for reconfigs? */
 let listeningAlready = false
@@ -72,22 +72,26 @@ async function init(geo: string, mountName: string, repl: REPL, reinit: () => vo
         provider.isDefault = false
         return [...(await extraProvidersForDefaultRegion(geo, config)), provider]
       } else {
-        return provider
+        return [...(await extraProvidersForAllRegions(geo, config)), provider]
       }
     }
   } catch (err) {
     return new IBMCloudS3Provider(geo, mountName, undefined, new UnsupportedS3ProviderError(err.message))
   }
 }
 
+export function mountNameForGeo(geo: string, ...extra: string[]) {
+  return [baseMountName, geo.replace(/-/g, '/'), ...extra].join('/')
+}
+
 /**
  * We want one ProviderInitializer per geo
  *
  */
 const initializer: ProviderInitializer[] = Object.keys(Geos)
   // .filter(_ => !/-geo$/.test(_)) // don't manifest geo endpoints in the VFS
   .map(geo => {
-    const mountName = `${baseMountName}/${geo.replace(/-/g, '/')}`
+    const mountName = mountNameForGeo(geo)
     return {
       mountName,
       init: init.bind(undefined, geo, mountName)

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

@@ -19,6 +19,7 @@ import { getOrSetPreference } from '@kui-shell/core'
 
 import Config from './model/Config'
 import baseMountName from './baseMountName'
+import { mountNameForGeo } from './s3provider'
 import IBMCloudS3Provider from './IBMCloudS3Provider'
 
 /** The /s3/ibm/default mount point */
@@ -28,6 +29,15 @@ function defaultProvider(geo: string, config: Config) {
   return provider
 }
 
+/** The /s3/ibm/public mount point */
+function publicProvider(geo: string, { endpointForKui }: Pick<Config, 'endpointForKui'>) {
+  return new IBMCloudS3Provider(geo, mountNameForGeo(geo, 'public'), {
+    AccessKeyID: '',
+    SecretAccessKey: '',
+    endpointForKui
+  })
+}
+
 /** A "bind" mount that points to a subdirectory of a given mount */
 class BindMount extends IBMCloudS3Provider {
   public constructor(geo: string, mountName: string, config: Config, public readonly subdir: string) {
@@ -45,6 +55,17 @@ async function bindProvider(geo: string, config: Config, pseudo: string) {
   return provider
 }
 
-export default function extraProvidersForDefaultRegion(geo: string, config: Config) {
-  return Promise.all([defaultProvider(geo, config), bindProvider(geo, config, 'bin'), bindProvider(geo, config, 'tmp')])
+export function extraProvidersForDefaultRegion(geo: string, config: Config) {
+  return Promise.all([
+    defaultProvider(geo, config), // /s3/ibm/default
+    publicProvider(geo, config), // /s3/ibm/public (i.e. access to public buckets without credentials)
+    bindProvider(geo, config, 'bin'), // s3/ibm/bin
+    bindProvider(geo, config, 'tmp') // s3/ibm/tmp
+  ])
+}
+
+export function extraProvidersForAllRegions(geo: string, config: Config) {
+  return [
+    publicProvider(geo, config) // /s3/ibm/public (i.e. access to public buckets without credentials)
+  ]
 }