midudev/s3-folder-upload

Upload easily a folder to Amazon Simple Storage Service (S3)

s3 folder upload

A little script to upload statics to a S3 bucket by using the official Amazon SDK.

AWS Credentials

In order to use this module, you'll need to have AWS Credentials. You can load them, two ways:

• By passing directly to the method as second parameter.
• By having a ENV variable with the path to a file with the credentials. The ENV variable is AWS_CREDENTIALS_PATH and it should have accessKeyId, secretAccessKey, region and bucket.

Install

npm install s3-folder-upload -D

In case you want to use the CLI, you can install it globally:

npx s3-folder-upload

Require

const s3FolderUpload = require('s3-folder-upload')
// or the ES6 way
// import s3FolderUpload from 's3-folder-upload'

const directoryName = 'statics'
// I strongly recommend to save your credentials on a JSON or ENV variables, or command line args
const credentials = {
  "accessKeyId": "<Your Access Key Id>",
  "secretAccessKey": "<Your Secret Access Key>",
  "region": "<Your Aimed Region>",
  "bucket": "<Your Bucket Name>"
}

// optional options to be passed as parameter to the method
const options = {
  useFoldersForFileTypes: false,
  useIAMRoleCredentials: false
}

// optional cloudfront invalidation rule
const invalidation = {
  awsDistributionId: "<Your CloudFront Distribution Id>",
  awsInvalidationPath: "<The Path to Invalidate>"
}

s3FolderUpload(directoryName, credentials, options, invalidation)

Options

• useFoldersForFileTypes (default: true): Upload files to a specific subdirectory according to its file type.
• useIAMRoleCredentials (default: false): It will ignore all the credentials passed via parameters or environment variables in order to use the instance IAM credentials profile.
• uploadFolder (default: undefined): If it's specified, the statics will be uploaded to the folder, so if you upload static.js to https://statics.s3.eu-west-1.amazonaws.com with a uploadFolder with value my-statics the file will be uploaded to: https://statics.s3.eu-west-1.amazonaws.com/my-statics/static.js.
• ACL (default: public-read): It defines which AWS accounts or groups are granted access and the type of access.
• CacheControl (default: public, max-age=31536000): HTTP header holds directives (instructions) for caching in both requests and responses.
• Expires (default: 31536000): Header contains the date/time after which the response is considered stale. If there is a Cache-Control header with the max-age or s-maxage directive in the response, the Expires header is ignored.

If you use programatically the library, you could overwrite the ACL, CacheControl and Expires values to file level.

const options = {
  useFoldersForFileTypes: false,
  useIAMRoleCredentials: false,
}

const filesOptions = {
  'index.html': {
    CacheControl: 'public, max-age=300',
    Expires: new Date("Fri, 01 Jan 1971 00:00:00 GMT")
  }
}

s3FolderUpload(directoryName, credentials, options, filesOptions)

CLI

s3-folder-upload <folder>

Example:
s3-folder-upload statics

For the AWS Credentials

• you can define a ENV variable called AWS_CREDENTIALS_PATH with the path of the file with the needed info.
• you can pass the needed info via command line parameters:

  s3-folder-upload <folder> --accessKeyId=<your access key id> --bucket=<destination bucket> --region=<region> --secretAccessKey=<your secret access key>

• you can use useIAMRoleCredentials option in order to rely on IAM Profile instance instead any passed by variables and environment

For Options

• you can pass the needed info via command line parameters:

  s3-folder-upload <folder> <credentials parameters> --useFoldersForFileTypes=false

For CloudFront invalidation

• you can pass the needed info via command line parameters, the invalidation needs both parameters:

  s3-folder-upload <folder> <credentials parameters> --awsDistributionId=<distributionId> --awsInvalidationPath="/js/*"
  

Environment Variables

S3_FOLDER_UPLOAD_LOG: You could specify the level of logging for the library.

• none: No logging output
• only_errors: Only errors are logged
• all (default): Errors, progress and useful messages are logged.

Example of use:

S3_FOLDER_UPLOAD_LOG=only_errors s3-folder-upload <folder>

If you use the library programatically, this ENVIRONEMNT_VARIABLE will be read as well. For example:

S3_FOLDER_UPLOAD_LOG=only_errors node upload-script.js

Wish list

• Upload a entire folder to S3 instead file
• Async upload of files to improve time
• Detect automatically the content type of (limited support)
• Return the list of files uploaded with the final URL
• Better support for parameters with the CLI
• Improve content type function in order to get more and better types of files
• Avoid to re-upload files if they didn't change
• Check if cache is blocking updates of statics on website.
• Map uploaded paths to create a default invalidation paths rule in CloudFront.

s3-folder-upload's Issues

Cannot find files inside a dir with parenthesis

If a directory has parenthesis in it's name than no file will be uploaded. The log says "[fs] Got 0 files to upload"
For example: "Test(copy)"

path.resolve does not compatible with globby on windows

Basically, it is all about the backslash path only happening on Windows
the path.resolve() returns "C:\Users\User\myproject"
which cause globby does not find any files under it and the remove folder path does not work too.

My suggestion is simply add .replace(/\/g, "/") after the path
i.e.
globby([`${directoryPath}/**/*`.replace(/\\/g, "/")], {onlyFiles: true}) file.replace(`${directoryPath}/`.replace(/\\/g, "/"), '')

Exclude file/folder

I want to exclude file and folder for specific path. For example:
Exclude app.js and fonts folder from 'C://workstation/test/2022-11-17T13_03_00.519Z/'

Feature Request: Make ACL configurable

I noticed that the ACL in upload config is hardcoded ACL: 'public-read'.

I need the uploaded files to have configurable ACL.

Please make this configurable.

Error [TypeError]: Cannot read property 'Location' of undefined

Error [TypeError]: Cannot read property 'Location' of undefined

doesn't overwrite files

i need to overwrite, and it would be better if i could delete, files that already exist, but this doesn't support it apparently

Async / Callback

Hi, Can you may implement an async/callback way of doing this job?

Debug option

Hi,

could you add a debug option to the logging so it can be turned off when not needed? Or maybe use the debug npm module?
Thank you!

.

.

Passing uploadFolder as a parameter to cli does nothing

when I try to upload folder using cli it always uploads it in the root of aws s3. I set parameter like
--uploadFolder=myFolder

Use S3 API instead SDK to shave megabytes

So, now, installing this package is like 50MB. Instead of using the SDK, that's huge, we could try to use directly the API of S3 in order to upload the files.

Or at least check things like https://docs.min.io/docs/javascript-client-quickstart-guide.html

Feature Request: Make the folder name the name of the folder you're uploading.

I noticed that if the folder you are uploading to S3 is not within the path, the name of the folder defaults to other.

The feature request would be to simply parse the given folder path input in order to grab the folder name.

E.g.
If I run: s3folderUpload('path/to/myFolder', credentials)
the folder name that is created on s3 would be myFolder and not other.

Even handlers so as to listen for upload progress

How do i know if my folder has uploaded completely?

useIAMRoleCredentials does not seem working in CLI mode

Has useIAMRoleCredentials option been carefully tested?

I didn't manage to make it working. Credentials from IAM role are attached and available if checking with curl:

curl http://169.254.169.254/latest/meta-data/iam/security-credentials/my_role
... creds ...

But if I run the task using npx:

npx s3-folder-upload test --region=eu-west-1 --bucket=my.bucket --useIAMRoleCredentials=true --uploadFolder=test/1234567

I keep getting error:

root/aws-credentials.json
[warn] Impossible load credentials from /root/aws-credentials.json
[error] Invalid credentials

Cannot upload files to a bucket that has ACL disabled

We can´t upload files to a bucket that has ACL disabled. This is due to the fact that we can´t set ACL option to undefined since it'll be overwritten in this line.

This is the output when trying to upload to the bucket:

Uploading files from "dist/apps/**** to "s3://***"
[credentials] Checking credentials from parameters...
[credentials] Using credentials passed by parameters
[config] Directory to upload:
         /home/**************
[aws] Initialize AWS Client...
[config] Load config credentials and start AWS Client
[s3] Amazon S3 initialized
[fs] Reading directory...
[fs] Got 15 files to upload

[network] Upload 15 files...
- Uploading 679.f108534251926380.esm.js.LICENSE.txt...
AccessControlListNotSupported: The bucket does not allow ACLs

Please Clarify Enpoint Values

for Oregan its "dualstack.us-west-2"
since your code goes s3..amazonaws.com

region names can be found here:
http://docs.aws.amazon.com/general/latest/gr/rande.html

NOTE: Only choose the ones with "s3." the "s3-" won't work due to this developers
use of parsing... and logic....