@backstage/plugin-techdocs-node 1.4.3-next.0 → 1.4.3-next.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @backstage/plugin-techdocs-node
 
+## 1.4.3-next.1
+
+### Patch Changes
+
+- 0a61aab172: Bump dependency @azure/identity to next minor
+- 37931c33ce: Upgrade to AWS SDK for Javascript v3
+
+  Techdocs support for AWS S3 now requires defining the AWS region to connect to.
+  If `techdocs.publisher.awsS3.region` is missing from the config, the AWS environment variable `AWS_REGION` will be used.
+
+- Updated dependencies
+  - @backstage/backend-common@0.17.0-next.1
+  - @backstage/config@1.0.5-next.1
+  - @backstage/integration@1.4.1-next.1
+  - @backstage/catalog-model@1.1.4-next.1
+  - @backstage/errors@1.1.4-next.1
+  - @backstage/plugin-search-common@1.1.2-next.1
+
 ## 1.4.3-next.0
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -15,7 +15,9 @@ var catalogModel = require('@backstage/catalog-model');
 var mime = require('mime-types');
 var createLimiter = require('p-limit');
 var recursiveReadDir = require('recursive-readdir');
-var aws = require('aws-sdk');
+var clientS3 = require('@aws-sdk/client-s3');
+var credentialProviders = require('@aws-sdk/credential-providers');
+var libStorage = require('@aws-sdk/lib-storage');
 var JSON5 = require('json5');
 var identity = require('@azure/identity');
 var storageBlob = require('@azure/storage-blob');
@@ -34,7 +36,6 @@ var yaml__default = /*#__PURE__*/_interopDefaultLegacy(yaml);
 var mime__default = /*#__PURE__*/_interopDefaultLegacy(mime);
 var createLimiter__default = /*#__PURE__*/_interopDefaultLegacy(createLimiter);
 var recursiveReadDir__default = /*#__PURE__*/_interopDefaultLegacy(recursiveReadDir);
-var aws__default = /*#__PURE__*/_interopDefaultLegacy(aws);
 var JSON5__default = /*#__PURE__*/_interopDefaultLegacy(JSON5);
 var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
@@ -746,19 +747,23 @@ class AwsS3Publish {
       config.getOptionalString("techdocs.publisher.awsS3.bucketRootPath") || ""
     );
     const sse = config.getOptionalString("techdocs.publisher.awsS3.sse");
+    const region = config.getOptionalString("techdocs.publisher.awsS3.region");
     const credentialsConfig = config.getOptionalConfig(
       "techdocs.publisher.awsS3.credentials"
     );
-    const credentials = AwsS3Publish.buildCredentials(credentialsConfig);
-    const region = config.getOptionalString("techdocs.publisher.awsS3.region");
+    const credentials = AwsS3Publish.buildCredentials(
+      credentialsConfig,
+      region
+    );
     const endpoint = config.getOptionalString(
       "techdocs.publisher.awsS3.endpoint"
     );
     const s3ForcePathStyle = config.getOptionalBoolean(
       "techdocs.publisher.awsS3.s3ForcePathStyle"
     );
-    const storageClient = new aws__default["default"].S3({
-      credentials,
+    const storageClient = new clientS3.S3Client({
+      customUserAgent: "backstage-aws-techdocs-s3-publisher",
+      credentialDefaultProvider: () => credentials,
       ...region && { region },
       ...endpoint && { endpoint },
       ...s3ForcePathStyle && { s3ForcePathStyle }
@@ -775,34 +780,39 @@ class AwsS3Publish {
       sse
     });
   }
-  static buildCredentials(config) {
-    if (!config) {
-      return void 0;
-    }
-    const accessKeyId = config.getOptionalString("accessKeyId");
-    const secretAccessKey = config.getOptionalString("secretAccessKey");
-    let explicitCredentials;
-    if (accessKeyId && secretAccessKey) {
-      explicitCredentials = new aws.Credentials({
+  static buildStaticCredentials(accessKeyId, secretAccessKey) {
+    return async () => {
+      return Promise.resolve({
         accessKeyId,
         secretAccessKey
       });
+    };
+  }
+  static buildCredentials(config, region) {
+    if (!config) {
+      return credentialProviders.fromNodeProviderChain();
     }
+    const accessKeyId = config.getOptionalString("accessKeyId");
+    const secretAccessKey = config.getOptionalString("secretAccessKey");
+    const explicitCredentials = accessKeyId && secretAccessKey ? AwsS3Publish.buildStaticCredentials(accessKeyId, secretAccessKey) : credentialProviders.fromNodeProviderChain();
     const roleArn = config.getOptionalString("roleArn");
     if (roleArn) {
-      return new aws__default["default"].ChainableTemporaryCredentials({
+      return credentialProviders.fromTemporaryCredentials({
         masterCredentials: explicitCredentials,
         params: {
           RoleSessionName: "backstage-aws-techdocs-s3-publisher",
           RoleArn: roleArn
-        }
+        },
+        clientConfig: { region }
       });
     }
     return explicitCredentials;
   }
   async getReadiness() {
     try {
-      await this.storageClient.headBucket({ Bucket: this.bucketName }).promise();
+      await this.storageClient.send(
+        new clientS3.HeadBucketCommand({ Bucket: this.bucketName })
+      );
       this.logger.info(
         `Successfully connected to the AWS S3 bucket ${this.bucketName}.`
       );
@@ -861,7 +871,11 @@ class AwsS3Publish {
             ...sse && { ServerSideEncryption: sse }
           };
           objects.push(params.Key);
-          return this.storageClient.upload(params).promise();
+          const upload = new libStorage.Upload({
+            client: this.storageClient,
+            params
+          });
+          return upload.done();
         },
         absoluteFilesToUpload,
         { concurrencyLimit: 10 }
@@ -886,10 +900,12 @@ class AwsS3Publish {
       const staleFiles = getStaleFiles(relativeFilesToUpload, existingFiles);
       await bulkStorageOperation(
         async (relativeFilePath) => {
-          return await this.storageClient.deleteObject({
-            Bucket: this.bucketName,
-            Key: relativeFilePath
-          }).promise();
+          return await this.storageClient.send(
+            new clientS3.DeleteObjectCommand({
+              Bucket: this.bucketName,
+              Key: relativeFilePath
+            })
+          );
         },
         staleFiles,
         { concurrencyLimit: 10 }
@@ -909,12 +925,16 @@ class AwsS3Publish {
         const entityTriplet = `${entityName.namespace}/${entityName.kind}/${entityName.name}`;
         const entityDir = this.legacyPathCasing ? entityTriplet : lowerCaseEntityTriplet(entityTriplet);
         const entityRootDir = path__default["default"].posix.join(this.bucketRootPath, entityDir);
-        const stream = this.storageClient.getObject({
-          Bucket: this.bucketName,
-          Key: `${entityRootDir}/techdocs_metadata.json`
-        }).createReadStream();
         try {
-          const techdocsMetadataJson = await streamToBuffer$1(stream);
+          const resp = await this.storageClient.send(
+            new clientS3.GetObjectCommand({
+              Bucket: this.bucketName,
+              Key: `${entityRootDir}/techdocs_metadata.json`
+            })
+          );
+          const techdocsMetadataJson = await streamToBuffer$1(
+            resp.Body
+          );
           if (!techdocsMetadataJson) {
             throw new Error(
               `Unable to parse the techdocs metadata file ${entityRootDir}/techdocs_metadata.json.`
@@ -941,14 +961,16 @@ class AwsS3Publish {
       const filePath = path__default["default"].posix.join(this.bucketRootPath, filePathNoRoot);
       const fileExtension = path__default["default"].extname(filePath);
       const responseHeaders = getHeadersForFileExtension(fileExtension);
-      const stream = this.storageClient.getObject({ Bucket: this.bucketName, Key: filePath }).createReadStream();
       try {
+        const resp = await this.storageClient.send(
+          new clientS3.GetObjectCommand({ Bucket: this.bucketName, Key: filePath })
+        );
         for (const [headerKey, headerValue] of Object.entries(
           responseHeaders
         )) {
           res.setHeader(headerKey, headerValue);
         }
-        res.send(await streamToBuffer$1(stream));
+        res.send(await streamToBuffer$1(resp.Body));
       } catch (err) {
         errors.assertError(err);
         this.logger.warn(
@@ -963,10 +985,12 @@ class AwsS3Publish {
       const entityTriplet = `${entity.metadata.namespace}/${entity.kind}/${entity.metadata.name}`;
       const entityDir = this.legacyPathCasing ? entityTriplet : lowerCaseEntityTriplet(entityTriplet);
       const entityRootDir = path__default["default"].posix.join(this.bucketRootPath, entityDir);
-      await this.storageClient.headObject({
-        Bucket: this.bucketName,
-        Key: `${entityRootDir}/index.html`
-      }).promise();
+      await this.storageClient.send(
+        new clientS3.HeadObjectCommand({
+          Bucket: this.bucketName,
+          Key: `${entityRootDir}/index.html`
+        })
+      );
       return Promise.resolve(true);
     } catch (e) {
       return Promise.resolve(false);
@@ -994,16 +1018,20 @@ class AwsS3Publish {
           }
           try {
             this.logger.verbose(`Migrating ${file}`);
-            await this.storageClient.copyObject({
-              Bucket: this.bucketName,
-              CopySource: [this.bucketName, file].join("/"),
-              Key: newPath
-            }).promise();
-            if (removeOriginal) {
-              await this.storageClient.deleteObject({
+            await this.storageClient.send(
+              new clientS3.CopyObjectCommand({
                 Bucket: this.bucketName,
-                Key: file
-              }).promise();
+                CopySource: [this.bucketName, file].join("/"),
+                Key: newPath
+              })
+            );
+            if (removeOriginal) {
+              await this.storageClient.send(
+                new clientS3.DeleteObjectCommand({
+                  Bucket: this.bucketName,
+                  Key: file
+                })
+              );
             }
           } catch (e) {
             errors.assertError(e);
@@ -1018,11 +1046,13 @@ class AwsS3Publish {
     let nextContinuation;
     let allObjects;
     do {
-      allObjects = await this.storageClient.listObjectsV2({
-        Bucket: this.bucketName,
-        ContinuationToken: nextContinuation,
-        ...prefix ? { Prefix: prefix } : {}
-      }).promise();
+      allObjects = await this.storageClient.send(
+        new clientS3.ListObjectsV2Command({
+          Bucket: this.bucketName,
+          ContinuationToken: nextContinuation,
+          ...prefix ? { Prefix: prefix } : {}
+        })
+      );
       objects.push(
         ...(allObjects.Contents || []).map((f) => f.Key || "").filter((f) => !!f)
       );