Normalize comment length and structure

Signed-off-by: Elijah Zupancic <[email protected]>

Author: dekobon

common/etc/nginx/include/s3gateway.js

@@ -160,8 +160,8 @@ function _credentialsTempFile() {
  * @param credentials {{accessKeyId: (string), secretAccessKey: (string), sessionToken: (string), expiration: (string)}} AWS instance profile credentials
  */
 function writeCredentials(r, credentials) {
-    // Do not bother writing credentials if we are running in a mode where we
-    // do not need instance credentials.
+    /* Do not bother writing credentials if we are running in a mode where we
+       do not need instance credentials. */
     if (process.env['S3_ACCESS_KEY_ID'] && process.env['S3_SECRET_KEY']) {
         return;
     }
@@ -205,7 +205,7 @@ function _writeCredentialsToFile(credentials) {
  * Get the instance profile credentials needed to authenticated against S3 from
  * a backend cache. If the credentials cannot be found, then return undefined.
  * @param r {Request} HTTP request object (not used, but required for NGINX configuration)
- * @returns {undefined|{accessKeyId: (string), secretAccessKey: (string), sessionToken: (string), expiration: (string)}} AWS instance profile credentials or undefined
+ * @returns {undefined|{accessKeyId: (string), secretAccessKey: (string), sessionToken: (string|null), expiration: (string|null)}} AWS instance profile credentials or undefined
  */
 function readCredentials(r) {
     if (process.env['S3_ACCESS_KEY_ID'] && process.env['S3_SECRET_KEY']) {
@@ -382,7 +382,8 @@ function _s3DirQueryParams(uriPath, method) {
         return '';
     }
 
-    // return if static website. We don't want to list the files in the directory, we want to append the index page and get the fil.
+    /* Return if static website. We don't want to list the files in the
+       directory, we want to append the index page and get the fil. */
     if (provide_index_page){
         return '';
     }
@@ -917,8 +918,8 @@ var maxValidityOffsetMs = 4.5 * 60 * 1000;
  * @returns {Promise<void>}
  */
 async function fetchCredentials(r) {
-    // If we are not using an AWS instance profile to set our credentials we
-    // exit quickly and don't write a credentials file.
+    /* If we are not using an AWS instance profile to set our credentials we
+       exit quickly and don't write a credentials file. */
     if (process.env['S3_ACCESS_KEY_ID'] && process.env['S3_SECRET_KEY']) {
         r.return(200);
         return;
@@ -1025,9 +1026,10 @@ async function _fetchEC2RoleCredentials() {
             'x-aws-ec2-metadata-token': token,
         },
     });
-    // This _might_ get multiple possible roles in other scenarios, however, EC2 supports attaching one role only.
-    // It should therefore be safe to take the whole output, even given IMDS _might_ (?) be able to return multiple
-    // roles.
+    /* This _might_ get multiple possible roles in other scenarios, however,
+       EC2 supports attaching one role only.It should therefore be safe to take
+       the whole output, even given IMDS _might_ (?) be able to return multiple
+       roles. */
     var credName = await resp.text();
     if (credName === "") {
         throw 'No credentials available for EC2 instance';
@@ -1060,16 +1062,18 @@ async function _fetchWebIdentityCredentials(r) {
 
     var sts_endpoint = process.env['STS_ENDPOINT'];
     if (!sts_endpoint) {
-        // On EKS, the ServiceAccount can be annotated with 'eks.amazonaws.com/sts-regional-endpoints' to control
-        // the usage of regional endpoints. We are using the same standard environment variable here as
-        // the AWS SDK. This is with the exception of replacing the value `legacy` with `global` to match
-        // what EKS sets the variable to.
-        // https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
-        // https://docs.aws.amazon.com/eks/latest/userguide/configure-sts-endpoint.html
+        /* On EKS, the ServiceAccount can be annotated with
+           'eks.amazonaws.com/sts-regional-endpoints' to control
+           the usage of regional endpoints. We are using the same standard
+           environment variable here as the AWS SDK. This is with the exception
+           of replacing the value `legacy` with `global` to match what EKS sets
+           the variable to.
+           See: https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
+           See: https://docs.aws.amazon.com/eks/latest/userguide/configure-sts-endpoint.html */
         var sts_regional = process.env['AWS_STS_REGIONAL_ENDPOINTS'] || 'global';
         if (sts_regional === 'regional') {
-            // STS regional endpoints can be derived from the region's name.
-            // https://docs.aws.amazon.com/general/latest/gr/sts.html
+            /* STS regional endpoints can be derived from the region's name.
+               See: https://docs.aws.amazon.com/general/latest/gr/sts.html */
             var region = process.env['AWS_REGION'];
             if (region) {
                 sts_endpoint = `https://sts.${region}.amazonaws.com`;