Release 1.2.0

Improved Windows asset serving & stability

Handle non-existent asset file on request (Fixes ArekSredzki#55)
Extended file upload timeout (Fixes ArekSredzki#47)
Use correct platform for 'osx' (Fixes ArekSredzki#31)
Fixed multi-arch windows asset serving (Fixes ArekSredzki#17) (Fixes ArekSredzki#45)
No longer caches dynamic update resources (Fixes ArekSredzki#46)

Author: ArekSredzki

README.md

@@ -6,24 +6,24 @@
 
 [![Electron Release Server Demo](https://j.gifs.com/wpyY1X.gif)](https://youtu.be/lvT7rfB01iA)
 
-_Note: Despite being advertised as release server for Electron applications, it would work for **any application using Squirrel**._
+_Note: Despite being advertised as a release server for Electron applications, it would work for **any application using Squirrel**._
 
-If you host your project on your Github and do not need a UI for your app, then [Nuts](https://github.com/GitbookIO/nuts) is probably what you're looking for. Otherwise, you're in the same boat as I was, and you've found the right place!
+If you host your project on your Github **and** do not need a UI for your app, then [Nuts](https://github.com/GitbookIO/nuts) is probably what you're looking for. Otherwise, you're in the same boat as I was, and you've found the right place!
 
 ## Features
 - :sparkles: Awesome release management interface powered by [AngularJS](https://angularjs.org)
     - Authenticates with LDAP, easy to modify to another authentication method if needed
 - :sparkles: Store assets on server disk, or Amazon S3 (with minor modifications)
     - Use pretty much any database for persistence, thanks to [Sails](http://sailsjs.org) & [Waterline](http://waterlinejs.org)
-- :sparkles: Simple but powerful download urls(**NOTE:** when no assets are uploaded, server returns `404` by default):
+- :sparkles: Simple but powerful download urls (**NOTE:** when no assets are uploaded, server returns `404` by default):
     - `/download/latest`
     - `/download/latest/:os`
     - `/download/:version`
     - `/download/:version/:os`
     - `/download/channel/:channel`
     - `/download/channel/:channel/:os`
 - :sparkles: Support pre-release channels (`beta`, `alpha`, ...)
-- :sparkles: Auto-updates with [Squirrel](https://github.com/Squirrel): 
+- :sparkles: Auto-updates with [Squirrel](https://github.com/Squirrel):
     - Update URLs provided: `/update/:platform/:version[/:channel]`
     - Mac uses `*.dmg` and `*.zip`
     - Windows uses `*.exe` and `*.nuget`

api/controllers/AssetController.js

@@ -25,9 +25,13 @@ module.exports = {
   /**
    * Download a release artifact
    *
+   * Note: if a filename is specified, nothing but the filetype is used.
+   * This is because Squirrel.Windows does a poor job of parsing the filename,
+   * and so we must fake the filenames of x32 and x64 versions to be the same.
+   *
    * (GET /download/channel/:channel/:platform?)
    * (GET /download/version/:version/:platform?)
-   * (GET /download/:version/:filename)
+   * (GET /download/:platform/:version/:filename)
    * (GET /download/:platform?)
    */
   download: function(req, res) {
@@ -46,28 +50,30 @@ module.exports = {
     // Normalize filetype by prepending with period
     if (_.isString(filetype) && filetype[0] !== '.') {
       filetype = '.' + filetype;
+    } else if (filename) {
+      filetype = filename.substr(filename.lastIndexOf('.'));
     }
 
-    // When serving a specific file, platform is not required
-    if (!filename) {
-      // Detect platform from useragent
-      if (!platforms) {
-        platforms = PlatformService.detectFromRequest(req);
+    // Detect platform from useragent
+    if (!platforms) {
+      platforms = PlatformService.detectFromRequest(req);
 
-        if (!platforms) {
-          return res.serverError('No platform specified and impossible to detect one');
-        }
+      if (!platforms) {
+        return res.serverError(
+          'No platform specified and detecting one was unsuccessful.'
+        );
       }
+    } else {
+      platforms = PlatformService.sanitize(platforms);
+    }
 
+    if (!version) {
       channel = channel || 'stable';
-    } else {
-      platforms = undefined;
     }
 
     var assetPromise = new Promise(function(resolve, reject) {
         var assetOptions = UtilityService.getTruthyObject({
           platform: platforms,
-          name: filename,
           filetype: filetype
         });
 
@@ -95,8 +101,8 @@ module.exports = {
                 return resolve();
               }
 
-              // Sorting filename in ascending order prioritizes other files over
-              // zip archives is both are available and matched.
+              // Sorting filename in ascending order prioritizes other files
+              // over zip archives is both are available and matched.
               return resolve(_.orderBy(
                 version.assets, ['filetype', 'createdAt'], ['asc', 'desc']
               )[0]);
@@ -162,13 +168,17 @@ module.exports = {
       return res.badRequest('Invalid version provided.');
     }
 
+    // Set upload request timeout to 10 minutes
+    req.setTimeout(10 * 60 * 1000);
+
     req.file('file').upload(sails.config.files,
       function whenDone(err, uploadedFiles) {
         if (err) {
           return res.negotiate(err);
         }
 
-        // If an unexpected number of files were uploaded, respond with an error.
+        // If an unexpected number of files were uploaded, respond with an
+        // error.
         if (uploadedFiles.length !== 1) {
           return res.badRequest('No file was uploaded');
         }
@@ -182,7 +192,8 @@ module.exports = {
         var hashPromise;
 
         if (fileExt === '.nupkg') {
-          // Calculate the hash of the file, as it is necessary for windows files
+          // Calculate the hash of the file, as it is necessary for windows
+          // files
           hashPromise = AssetService.getHash(uploadedFile.fd);
         } else {
           hashPromise = Promise.resolve('');
@@ -206,8 +217,8 @@ module.exports = {
                 // validation error is encountered, w/ validation info.
                 if (err) return res.negotiate(err);
 
-                // If we have the pubsub hook, use the model class's publish method
-                // to notify all subscribers about the created item
+                // If we have the pubsub hook, use the model class's publish
+                // method to notify all subscribers about the created item.
                 if (req._sails.hooks.pubsub) {
                   if (req.isSocket) {
                     Asset.subscribe(req, newInstance);
@@ -231,7 +242,9 @@ module.exports = {
     query.populate('version');
     query
       .then(function foundRecord(record) {
-        if (!record) return res.notFound('No record found with the specified `name`.');
+        if (!record) return res.notFound(
+          'No record found with the specified `name`.'
+        );
 
         // Delete the file & remove from db
         return Promise.join(

api/controllers/VersionController.js

@@ -99,7 +99,7 @@ module.exports = {
               newerVersions,
               function(prevNotes, newVersion) {
 
-                newVersion.assets = _.filter(newVersion.assets, function (asset) {
+                newVersion.assets = _.filter(newVersion.assets, function(asset) {
                   return asset.filetype === '.zip';
                 });
 
@@ -221,7 +221,9 @@ module.exports = {
                 _.remove(newVersion.assets, function(o) {
                   return o.filetype !== '.nupkg' || !o.hash;
                 });
-                return newVersion.assets.length && semver.lte(version, newVersion.name);
+                return newVersion.assets.length && semver.lte(
+                  version, newVersion.name
+                );
               });
 
             if (!latestVersion) {
@@ -233,8 +235,11 @@ module.exports = {
 
             // Change asset name to use full download link
             assets = _.map(latestVersion.assets, function(asset) {
-              asset.name = url.resolve(sails.config.appUrl,
-                '/download/' + latestVersion.name + '/' + asset.name);
+              asset.name = url.resolve(
+                sails.config.appUrl,
+                '/download/' + asset.platform + '/' + latestVersion.name + '/' +
+                latestVersion.channel + '/' + asset.name
+              );
 
               return asset;
             });

api/policies/noCache.js

@@ -0,0 +1,10 @@
+/**
+ * Sets no-cache header in response.
+ */
+module.exports = function (req, res, next) {
+    sails.log.info("Applying disable cache policy");
+    res.header('Cache-Control', 'private, no-cache, no-store, must-revalidate');
+    res.header('Expires', '-1');
+    res.header('Pragma', 'no-cache');
+    next();
+};

api/services/AssetService.js

@@ -22,7 +22,8 @@ AssetService.serveFile = function(req, res, asset) {
   // Stream the file to the user
   var fileStream = fileAdapter.read(asset.fd)
     .on('error', function(err) {
-      throw err;
+      sails.log.error('An error occurred while accessing update asset.', err);
+      res.serverError('An error occurred while accessing update asset.');
     })
     .on('end', function complete() {
       // After we have sent the file, log analytics, failures experienced at this

api/services/PlatformService.js

@@ -94,11 +94,26 @@ PlatformService.detect = function(platformName, strictMatch) {
   }
 
   var result = [];
-  _.forEach(suffixes, function (suffix) {
+  _.forEach(suffixes, function(suffix) {
     result.push(prefix + '_' + suffix);
   });
 
   return result;
 };
 
+PlatformService.sanitize = function(platforms) {
+  var self = this;
+  return _.map(platforms, function(platform) {
+    switch (platform) {
+      case self.OSX:
+      case self.OSX_32:
+        platform = self.OSX_64;
+        break;
+      default:
+    }
+
+    return platform;
+  });
+}
+
 module.exports = PlatformService;

bower.json

@@ -2,13 +2,13 @@
   "name": "electron-release-server",
   "private": true,
   "dependencies": {
-    "angular": "^1.5.6",
+    "angular": "^1.5.7",
     "bootstrap-sass-official": "^3.3.6",
-    "angular-animate": "^1.5.6",
-    "angular-messages": "^1.5.6",
-    "angular-route": "^1.5.6",
-    "angular-sanitize": "^1.5.6",
-    "angular-xeditable": "~0.1.12",
+    "angular-animate": "^1.5.7",
+    "angular-messages": "^1.5.7",
+    "angular-route": "^1.5.7",
+    "angular-sanitize": "^1.5.7",
+    "angular-xeditable": "~0.2.0",
     "lodash": "~4.13.1",
     "angular-ui-notification": "~0.2.0",
     "angular-bootstrap": "~1.3.3",
@@ -22,10 +22,10 @@
     "ng-file-upload": "^12.0.4",
     "angular-PubSub": "angular.pubsub#*",
     "ng-device-detector": "^3.0.1",
-    "compare-versions": "^2.0.1"
+    "compare-versions": "^2.0.2"
   },
   "devDependencies": {
-    "angular-mocks": "^1.5.6"
+    "angular-mocks": "^1.5.7"
   },
   "appPath": "app",
   "overrides": {
@@ -39,5 +39,8 @@
         "assets/stylesheets/_bootstrap.scss"
       ]
     }
+  },
+  "resolutions": {
+    "angular": "^1.5.7"
   }
 }

config/policies.js

@@ -31,7 +31,8 @@ module.exports.policies = {
   AssetController: {
     create: 'authToken',
     update: 'authToken',
-    delete: 'authToken'
+    delete: 'authToken',
+    download: 'noCache'
   },
 
   ChannelController: {
@@ -43,6 +44,10 @@ module.exports.policies = {
   VersionController: {
     create: 'authToken',
     update: 'authToken',
-    delete: 'authToken'
+    delete: 'authToken',
+    redirect: 'noCache',
+    general: 'noCache',
+    windows: 'noCache',
+    releaseNotes: 'noCache'
   }
 };

config/routes.js

@@ -28,7 +28,7 @@ module.exports.routes = {
 
   'GET /download/channel/:channel/:platform?': 'AssetController.download',
   'GET /download/version/:version/:platform?': 'AssetController.download',
-  'GET /download/:version/:filename': 'AssetController.download',
+  'GET /download/:platform/:version/:filename': 'AssetController.download',
   'GET /download/:platform?': 'AssetController.download',
 
   'GET /update': 'VersionController.redirect',

package.json

@@ -1,10 +1,10 @@
 {
   "name": "electron-release-server",
   "private": true,
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "A version server for hosting and serving the your electron desktop app releases.",
   "dependencies": {
-    "bluebird": "^3.4.0",
+    "bluebird": "^3.4.1",
     "bower": "^1.7.9",
     "express-useragent": "^0.2.4",
     "fs-extra": "^0.30.0",
@@ -17,26 +17,26 @@
     "grunt-contrib-jst": "~1.0.0",
     "grunt-contrib-less": "1.3.0",
     "grunt-contrib-pug": "^1.0.0",
-    "grunt-contrib-uglify": "~1.0.1",
+    "grunt-contrib-uglify": "~2.0.0",
     "grunt-contrib-watch": "~1.0.0",
     "grunt-sails-linker": "~0.10.1",
     "grunt-sass": "^1.2.0",
     "grunt-sync": "~0.5.2",
     "grunt-wiredep": "^3.0.1",
     "include-all": "~0.1.6",
-    "jsonwebtoken": "^7.0.0",
+    "jsonwebtoken": "^7.1.6",
     "ldapauth-fork": "^2.5.2",
     "lodash": "^4.13.1",
     "mime": "^1.3.4",
     "passport": "^0.3.2",
     "passport-ldapauth": "^0.5.0",
-    "pug": "^2.0.0-beta3",
+    "pug": "^2.0.0-beta4",
     "rc": "~1.1.6",
     "sails": "~0.12.3",
-    "sails-disk": "^0.10.9",
+    "sails-disk": "^0.10.10",
     "sails-pg-session": "^1.0.1",
     "sails-postgresql": "^0.12.1",
-    "semver": "^5.1.0",
+    "semver": "^5.3.0",
     "skipper-disk": "^0.5.4",
     "strip-bom": "^3.0.0",
     "url": "^0.11.0"