ember-cli-deploy-s3-index 1.3.1 → 4.0.0-0

package/.github/workflows/ci.yaml

@@ -0,0 +1,40 @@
+name: Continuous Integration
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x, 20.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'yarn'
+    - run: yarn install
+    - run: yarn test
+
+  test-floating:
+    name: Floating Dependencies
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x, 20.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'yarn'
+    - name: install dependencies
+      run: yarn install --no-lockfile
+    - name: test
+      run: yarn test

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+
+## 4.0.0-0 (2023-08-28)
+
+## 3.0.0 (2023-05-16)
+
+#### :boom: Breaking Change
+* [#133](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index/pull/133) Update node version requirements and dependencies ([@lukemelia](https://github.com/lukemelia))
+* [#113](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index/pull/113) [breaking] Switch to Github Actions for CI ([@jrjohnson](https://github.com/jrjohnson))
+
+#### :rocket: Enhancement
+* [#130](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index/pull/130) Add support for didDeployMessage ([@jkeen](https://github.com/jkeen))
+* [#119](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index/pull/119) Optimise activation speed ([@vitch](https://github.com/vitch))
+
+#### Committers: 4
+- Jeff Keen ([@jkeen](https://github.com/jkeen))
+- Jon Johnson ([@jrjohnson](https://github.com/jrjohnson))
+- Kelvin Luck ([@vitch](https://github.com/vitch))
+- Luke Melia ([@lukemelia](https://github.com/lukemelia))
+
+## 2.0.0 There was no 2.0
+
 ## [v1.0.1](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index/tree/v1.0.1)
 [Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index/compare/v1.0.0...v1.0.1)
 

package/README.md

@@ -140,9 +140,9 @@ A flag to specify whether the revision should be overwritten if it already exist
 
 The underlying S3 library used to upload the files to S3. This allows the user to use the default upload client provided by this plugin but switch out the underlying library that is used to actually send the files.
 
-The client specified MUST implement functions called `getObject` and `putObject`.
+The client specified MUST implement functions called `getObject` and `putObject`. See [Using V2 API] (https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html#using_v2_commands).
 
-*Default:* the default S3 library is `aws-sdk`
+*Default:* the default S3 library is `@aws-sdk/s3-client` (AWS JS SDK v3). Please use this addon version < 3.0.0 if you want to use AWS JS SDK 2.0 
 
 ### endpoint
 
@@ -170,6 +170,22 @@ If you are using DigitalOcean spaces you need to set this setting to `false`.
 
 *Default:* `true`
 
+### didDeployMessage
+
+A message that will be displayed after the index file has been successfully uploaded to S3. By default this message will only display if the revision for `revisionData.revisionKey` of the deployment context has been activated.
+
+*Default:*
+
+```javascript
+if (context.revisionData.revisionKey && !context.revisionData.activatedRevisionKey) {
+  return "Deployed but did not activate revision " + context.revisionData.revisionKey + ". "
+       + "To activate, run: "
+       + "ember deploy:activate " + context.revisionData.revisionKey + " --environment=" + context.deployEnvironment + "\n";
+}
+```
+
+
+
 ### How do I activate a revision?
 
 A user can activate a revision by either:
@@ -318,4 +334,4 @@ If you'd like to be able to preview a deployed revision before activation, you'l
 [4]: https://github.com/ember-cli-deploy/ember-cli-deploy-build "ember-cli-deploy-build"
 [5]: https://github.com/ember-cli/ember-cli-deploy "ember-cli-deploy"
 [6]: https://github.com/ember-cli-deploy/ember-cli-deploy-revision-data "ember-cli-deploy-revision-data"
-[7]: https://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Setting_AWS_Credentials "Setting AWS Credentials"
+[7]: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html "Setting AWS Credentials"

package/RELEASE.md

@@ -0,0 +1,60 @@
+# Release Process
+
+Releases are mostly automated using
+[release-it](https://github.com/release-it/release-it/) and
+[lerna-changelog](https://github.com/lerna/lerna-changelog/).
+
+## Preparation
+
+Since the majority of the actual release process is automated, the primary
+remaining task prior to releasing is confirming that all pull requests that
+have been merged since the last release have been labeled with the appropriate
+`lerna-changelog` labels and the titles have been updated to ensure they
+represent something that would make sense to our users. Some great information
+on why this is important can be found at
+[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
+guiding principle here is that changelogs are for humans, not machines.
+
+When reviewing merged PR's the labels to be used are:
+
+* breaking - Used when the PR is considered a breaking change.
+* enhancement - Used when the PR adds a new feature or enhancement.
+* bug - Used when the PR fixes a bug included in a previous release.
+* documentation - Used when the PR adds or updates documentation.
+* internal - Used for internal changes that still require a mention in the
+  changelog/release notes.
+
+## Release
+
+Once the prep work is completed, the actual release is straight forward:
+
+* First, ensure that you have installed your projects dependencies:
+
+```sh
+yarn install
+```
+
+* Second, ensure that you have obtained a
+  [GitHub personal access token][generate-token] with the `repo` scope (no
+  other permissions are needed). Make sure the token is available as the
+  `GITHUB_AUTH` environment variable.
+
+  For instance:
+
+  ```bash
+  export GITHUB_AUTH=abc123def456
+  ```
+
+[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
+
+* And last (but not least 😁) do your release.
+
+```sh
+npx release-it
+```
+
+[release-it](https://github.com/release-it/release-it/) manages the actual
+release process. It will prompt you to to choose the version number after which
+you will have the chance to hand tweak the changelog to be used (for the
+`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
+pushing the tag and commits, etc.

package/index.js

@@ -34,6 +34,15 @@ module.exports = {
         brotliCompressedFiles: function(context) {
           return context.brotliCompressedFiles || [];
         },
+        didDeployMessage: function(context){
+          var revisionKey = context.revisionData && context.revisionData.revisionKey;
+          var activatedRevisionKey = context.revisionData && context.revisionData.activatedRevisionKey;
+          if (revisionKey && !activatedRevisionKey) {
+            return "Deployed but did not activate revision " + revisionKey + ". "
+                 + "To activate, run: "
+                 + "ember deploy:activate " + context.deployTarget + " --revision=" + revisionKey + "\n";
+          }
+        },
         allowOverwrite: false
       },
 
@@ -103,7 +112,22 @@ module.exports = {
         this.log('preparing to activate `' + revisionKey + '`', { verbose: true });
 
         var s3 = new this.S3({ plugin: this });
-        return s3.activate(options);
+        return s3.activate(options).then(() => {
+          this.log(`✔ Activated revision \`${revisionKey}\``, {});
+
+          return {
+            revisionData: {
+              activatedRevisionKey: revisionKey
+            }
+          }
+        });
+      },
+
+      didDeploy: function(/* context */){
+        var didDeployMessage = this.readConfig('didDeployMessage');
+        if (didDeployMessage) {
+          this.log(didDeployMessage);
+        }
       },
 
       fetchRevisions: function(context) {

package/lib/s3.js

@@ -1,6 +1,7 @@
 'use strict';
 
-var AWS             = require('aws-sdk');
+var { fromIni } = require('@aws-sdk/credential-providers');
+var { S3 } = require('@aws-sdk/client-s3');
 var CoreObject      = require('core-object');
 var RSVP            = require('rsvp');
 var fs              = require('fs');
@@ -31,20 +32,31 @@ module.exports = CoreObject.extend({
     var config = plugin.pluginConfig;
     var profile = plugin.readConfig('profile');
     var endpoint = plugin.readConfig('endpoint');
+    var credentials;
 
     this._plugin = plugin;
 
-    if (profile && !this._plugin.readConfig('s3Client')) {
-      this._plugin.log('Using AWS profile from config', { verbose: true });
-      AWS.config.credentials = new AWS.SharedIniFileCredentials({ profile: profile });
+    var providedS3Client = plugin.readConfig("s3Client");
+    
+
+    if (profile && !providedS3Client) {
+      this._plugin.log("Using AWS profile from config", { verbose: true });
+      credentials = fromIni({ profile: profile });
     }
 
     if (endpoint) {
-      this._plugin.log('Using endpoint from config', { verbose: true });
-      AWS.config.endpoint = new AWS.Endpoint(endpoint);
+      this._plugin.log('Using endpoint from config', { verbose: true });      
     }
 
-    this._client = plugin.readConfig('s3Client') || new AWS.S3(config);
+    this._client = providedS3Client || new S3(config);
+  
+    if (endpoint) {
+      this._client.config.endpoint = endpoint;
+    }
+    if (credentials) {
+      this._client.config.credentials = credentials;
+    }
+    
   },
 
   upload: function(options) {
@@ -62,6 +74,7 @@ module.exports = CoreObject.extend({
     var isGzipped                 = gzippedFilePaths.indexOf(options.filePattern) !== -1;
     var isBrotliCompressed        = brotliCompressedFilePaths.indexOf(options.filePattern) !== -1;
     var serverSideEncryption      = options.serverSideEncryption;
+    var checkForOverwrite         = RSVP.resolve();
 
     var params = {
       Bucket: bucket,
@@ -83,14 +96,17 @@ module.exports = CoreObject.extend({
       params.ContentEncoding = 'br';
     }
 
-    return this.fetchRevisions(options)
-      .then(function(revisions) {
-        var found = revisions.map(function(element) { return element.revision; }).indexOf(options.revisionKey);
-        if (found >= 0 && !allowOverwrite) {
-          return RSVP.reject("REVISION ALREADY UPLOADED! (set `allowOverwrite: true` if you want to support overwriting revisions)");
-        }
-        return RSVP.resolve();
-      })
+    if (!allowOverwrite) {
+      checkForOverwrite = this.findRevision(options)
+        .then(function(found) {
+          if (found !== undefined) {
+            return RSVP.reject("REVISION ALREADY UPLOADED! (set `allowOverwrite: true` if you want to support overwriting revisions)");
+          }
+          return RSVP.resolve();
+        })
+    }
+
+    return checkForOverwrite
       .then(readFile.bind(this, options.filePath))
       .then(function(fileContents) {
         params.Body = fileContents;
@@ -131,9 +147,8 @@ module.exports = CoreObject.extend({
       params.ServerSideEncryption = serverSideEncryption;
     }
 
-    return this.fetchRevisions(options).then(function(revisions) {
-      var found = revisions.map(function(element) { return element.revision; }).indexOf(options.revisionKey);
-      if (found >= 0) {
+    return this.findRevision(options).then(function(found) {
+      if (found !== undefined) {
         return copyObject(params).then(function() {
           plugin.log('✔  ' + revisionKey + " => " + indexKey);
         });
@@ -143,6 +158,17 @@ module.exports = CoreObject.extend({
     });
   },
 
+  findRevision: function(options) {
+    var client         = this._client;
+    var listObjects    = RSVP.denodeify(client.listObjects.bind(client));
+    var bucket         = options.bucket;
+    var prefix         = options.prefix;
+    var revisionPrefix = joinUriSegments(prefix, options.filePattern + ":" + options.revisionKey);
+
+    return listObjects({ Bucket: bucket, Prefix: revisionPrefix })
+      .then((response) => response.Contents.find((element) => element.Key === revisionPrefix));
+  },
+
   fetchRevisions: function(options) {
     var client         = this._client;
     var bucket         = options.bucket;

package/package.json

@@ -1,7 +1,14 @@
 {
   "name": "ember-cli-deploy-s3-index",
-  "version": "1.3.1",
+  "version": "4.0.0-0",
   "description": "Ember CLI Deploy plugin to deploy ember-cli's bootstrap index file to S3.",
+  "keywords": [
+    "ember-addon",
+    "ember-cli-deploy-plugin"
+  ],
+  "repository": "https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index",
+  "license": "MIT",
+  "author": "",
   "directories": {
     "doc": "doc",
     "test": "tests"
@@ -10,40 +17,43 @@
     "release": "release-it",
     "test": "node tests/runner.js && ./node_modules/.bin/eslint index.js lib/* tests/**/*.js"
   },
-  "repository": "https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index",
-  "engines": {
-    "node": ">= 4"
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.385.0",
+    "@aws-sdk/credential-providers": "^3.391.0",
+    "core-object": "^3.0.0",
+    "ember-cli-deploy-plugin": "^0.2.9",
+    "mime-types": "^2.1.27",
+    "rsvp": "^4.8.5"
   },
-  "author": "",
-  "license": "MIT",
   "devDependencies": {
-    "github": "^0.2.4",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "ember-cli": "~3.18.0",
     "eslint": "^7.0.0",
     "glob": "^7.1.6",
     "mocha": "^7.1.2",
-    "release-it": "*"
+    "release-it": "^14.2.1",
+    "release-it-lerna-changelog": "^3.1.0"
   },
-  "keywords": [
-    "ember-addon",
-    "ember-cli-deploy-plugin"
-  ],
-  "dependencies": {
-    "aws-sdk": "^2.667.0",
-    "core-object": "^3.0.0",
-    "ember-cli-deploy-plugin": "^0.2.9",
-    "mime-types": "^2.1.27",
-    "rsvp": "^4.8.5"
+  "engines": {
+    "node": "14.* || 16.* || 18.* || >= 20"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
   },
   "release-it": {
     "git": {
-      "changelog": "./bin/changelog",
       "requireCleanWorkingDir": false
     },
     "github": {
-      "release": true
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
+    },
+    "plugins": {
+      "release-it-lerna-changelog": {
+        "infile": "CHANGELOG.md",
+        "launchEditor": true
+      }
     }
   }
 }

package/bin/changelog

@@ -1,84 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-
-/*
- * This script generates the template a changelog by comparing a current version
- * with master. Run this, copy what's logged into the `CHANGELOG.md` and update
- * the top section based on the changes listed in "Community Contributions"
- *
- * Usage:
- *
- * bin/changelog
- */
-
-var EOL       = require('os').EOL;
-var RSVP      = require('rsvp');
-var GitHubApi = require('github');
-
-var github         = new GitHubApi({version: '3.0.0'});
-var compareCommits = RSVP.denodeify(github.repos.compareCommits);
-var currentVersion = 'v' + require('../package').version;
-
-var user = 'ember-cli-deploy';
-
-var repo = 'ember-cli-deploy-s3-index';
-compareCommits({
-  user: user,
-  repo: repo,
-  base: currentVersion,
-  head: 'master'
-}).then(function(res) {
-  return res.commits.map(function(commitInfo) {
-    return commitInfo.commit.message
-
-  }).filter(function(message) {
-    return message.indexOf('Merge pull request #') > -1;
-
-  }).map(function(message) {
-    var numAndAuthor = message.match(/#(\d+) from (.*)\//).slice(1,3);
-    var title        = message.split('\n\n')[1];
-
-    return {
-      number:  +numAndAuthor[0],
-      author:  numAndAuthor[1],
-      title:   title
-    };
-
-  }).sort(function(a, b) {
-    return a.number > b.number;
-  }).map(function(pr) {
-    var link   = '[#' + pr.number + ']' +
-                 '(https://github.com/' + user + '/' + repo + '/pull/' + pr.number + ')';
-    var title  = pr.title;
-    var author = '[@' + pr.author + ']' +
-                 '(https://github.com/' + pr.author +')';
-
-    return '- ' + link + ' ' + title + ' ' + author;
-
-  }).join('\n');
-
-}).then(function(contributions) {
-  var changelog = generateChangelog(contributions);
-
-  console.log(changelog);
-}).catch(function(err) {
-  console.error(err);
-})
-
-function generateChangelog(contributions) {
-  var header = `
-The following changes are required if you are upgrading from the previous
-version:
-- Users
-  + Upgrade your project's ember-cli version - [docs](http://www.ember-cli.com/#project-update)
-- Addon Developers
-  + No changes required
-- Core Contributors
-  + No changes required
-#### Community Contributions
-`;
-
-  var footer = 'Thank you to all who took the time to contribute!';
-
- return header + EOL + EOL + contributions + EOL + EOL + footer;
-}