3.0.0

[kherock]

Working changelog:

Breaking changes:

• You must now specify a specific set of credentials for signed request work. Use S3RVER for both the Access Key ID and Secret Access Key.
• The underlying app returned by new S3rver(opts) is now a Koa instance. (Koa rewrite #391, resolves Use Koa instead of Express #107)
  • Additionally, some constructor options have been renamed and moved.
• s3rver.run([callback]) no longer returns a HTTP server instance. The HTTP server created is set at s3rver.httpServer.
• s3rver.getMiddleware() was renamed to just s3rver.middleware()
• The RxJS Observable s3rver.s3Event has been removed in interest of keeping the library lightweight. Use s3rver.on('event', handler) instead.
• Bucket features are no longer globally configured. CORS and static website configurations can be set through S3's API or in custom bucket configurations initialized at server startup.

Features:

• You can now have preconfigured buckets created at server startup via opts.configureBuckets (or --configure-bucket in the CLI). Existing buckets will have their configurations updated with a warning.
• Support the S3 cors and website REST APIs
  • This comes with per-bucket configuration of these features (and any others implemented in the future) (Separate bucket configs for CORS and website policies #397, resolves Index document, Error document, and CORS config should all be per-bucket options #115)
• Support for following redirects specified by x-amz-website-redirect-location metadata (Separate bucket configs for CORS and website policies #397)
• Stubs for most other bucket actions (they now report 501 Unimplemented)
• Signature verification and presigned URLs (Support verification of signed requests and other special presigned request behavior #419)
• Support specifying custom metadata through query parameters (Support verification of signed requests and other special presigned request behavior #419, resolves Support actions via presigned urls #153)
• Overriding response headers in presigned requests via response-* query params (Support verification of signed requests and other special presigned request behavior #419)
• Support ListParts API
• Support specifying a custom storage backend via opts.store

Fixes:

• Support more regions for buckets specified via subdomain
  • For example, eu-west-1 only offers an endpoint at s3.eu-west-1.amazonaws.com (with a period instead of a hyphen after .s3)
• Buckets operating in "website mode" behave more predictably and should always serve XML-formatted API responses. Real S3 accomplishes this by having totally separate listeners at the DNS/server level, we reconcile this with a single listener by inpecting the Host header and accepted content type.
  • This fixes the "Unexpected token ..." errors reported by the AWS SDK
  • More specifically, S3rver will prioritize Host and fall back to the Accept header. For example, when applicable, requests with
    Host: <bucket-name>.s3[.<region>].amazonaws.com
    will always have XML-formatted responses, but requests with
    Host: <bucket-name>.s3-website.<region>.amazonaws.com
    will always have HTML-formatted responses. Otherwise, S3rver will return HTML when Accept: text/html is present.
• Virtual Host-style requests (specifying Host: <bucket-name>) should work regardless of static website configuration
• Metadata missing from multipart uploads (Separate bucket configs for CORS and website policies #397, fixes PUT large object doesn't create custom metadata #306)
• Querying an object for a key stored without a trailing slash would incorrectly match keys stored with one (Separate bucket configs for CORS and website policies #397)
• Can't store keys using reserved characters under Windows (Escape invalid path characters in win32 envs #420, fixes BUG & FIX: Windows path bugfix for "Error: ... contains invalid WIN32 path characters."  #390)
• All error responses reported by S3rver have been revisited and revised to look nearly identical to real S3

[kherock]

(btw tests are passing on Node 8, but it looks like Node 10 breaks our app so this release is a bit overdue)

This is working up to be a pretty big release. I do want to also address #110, #153, #306, and #330 before cutting 3.0 since I think those are all pretty essential features. Working with the old code was a pain and didn't leave much room for fixing/adding new features, so I'm not personally up for maintaining the 2.x branch while Node v6 still has a couple months of maintenance before EOL.

@leontastic what are your thoughts on making a new major release without Node 6 support?

[wilson208]

@kherock thanks for your work on this, I find this to be a really useful tool and use it in a couple of different projects currently. I have came across scenario where I need to use pre-signed urls, so seeing this feature go in would be great for next release!

Thanks

[leontastic]

@kherock I am OK without Node 6 support in next major release.

[kherock]

@leontastic I'm planning on having everything I want for 3.0 finished by the weekend - in the meantime can we get 2.2.9 published?

[jamhall]

@kherock - Hi! Thank you for all of your hard work! I have added you as a maintainer to s3rver on npm. You should be able to push releases now :-)

[leontastic]

@jamhall Thanks!!

@kherock please feel free to publish/merge without my approval, I trust that you'll be responsible!

[kherock]

Sorry that this hadn't seen any updates in a while, I got really busy the past few weeks (should be starting a new job next week 🤞). In the meantime I finally got v2.2.9 published.

I don't have an ETA for this release, but I think I might patch out the last outstanding bug (#390) and cut it there. I'll try to have everything else show up in v3.1. Thanks for being patient.

[kherock]

3.0.1 is published! The CLI script had a bad path in the initial 3.0.0 release and was fixed for 3.0.1. ListParts and POST uploads are planned for 3.1.