add support for serverless.js

Author: pavelvlasov

docs/providers/aws/guide/intro.md

@@ -58,7 +58,7 @@ The Serverless Framework not only deploys your Functions and the Events that tri
 
 ### Services
 
-A **Service** is the Framework's unit of organization.  You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions, the Events that trigger them, and the Resources your Functions use, all in one file entitled `serverless.yml` (or `serverless.json`).  It looks like this:
+A **Service** is the Framework's unit of organization.  You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions, the Events that trigger them, and the Resources your Functions use, all in one file entitled `serverless.yml` (or `serverless.json` or `serverless.js`).  It looks like this:
 
 ```yml
 # serverless.yml

docs/providers/azure/guide/intro.md

@@ -64,7 +64,7 @@ A **Service** is the Framework's unit of organization. You can think of it as a
 project file, though you can have multiple services for a single application.
 It's where you define your Functions, the Events that trigger them, and the
 Resources your Functions use, all in one file entitled `serverless.yml` (or
-`serverless.json`). It looks like this:
+`serverless.json` or `serverless.js`). It looks like this:
 
 ```yml
 # serverless.yml

docs/providers/google/guide/intro.md

@@ -46,7 +46,7 @@ When you define an event for your Google Cloud Function in the Serverless Framew
 
 ### Services
 
-A **Service** is the Framework's unit of organization. You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions, the Events that trigger them, and the Resources your Functions use, all in one file entitled `serverless.yml` (or `serverless.json`). It looks like this:
+A **Service** is the Framework's unit of organization. You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions, the Events that trigger them, and the Resources your Functions use, all in one file entitled `serverless.yml` (or `serverless.json` or `serverless.js`). It looks like this:
 
 ```yml
 # serverless.yml

docs/providers/kubeless/guide/intro.md

@@ -42,7 +42,7 @@ Anything that triggers an Kubeless Event to execute is regarded by the Framework
 
 ### Services
 
-A **Service** is the Serverless Framework's unit of organization (not to be confused with [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service/).  You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions and the Events that trigger them, all in one file entitled `serverless.yml` (or `serverless.json`).  It looks like this:
+A **Service** is the Serverless Framework's unit of organization (not to be confused with [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service/).  You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions and the Events that trigger them, all in one file entitled `serverless.yml` (or `serverless.json` or `serverless.js`).  It looks like this:
 
 ```yml
 # serverless.yml

docs/providers/openwhisk/guide/intro.md

@@ -47,7 +47,7 @@ When you define an event for your Apache OpenWhisk Action in the Serverless Fram
 
 ### Services
 
-A **Service** is the Framework's unit of organization.  You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions, the Events that trigger them, and the Resources your Functions use, all in one file entitled `serverless.yml` (or `serverless.json`).  It looks like this:
+A **Service** is the Framework's unit of organization.  You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions, the Events that trigger them, and the Resources your Functions use, all in one file entitled `serverless.yml` (or `serverless.json` or `serverless.js`).  It looks like this:
 
 ```yml
 # serverless.yml

docs/providers/spotinst/guide/intro.md

@@ -73,7 +73,7 @@ module.exports.main = function main (event, context, callback) {
 
 ### Services
 
-A **Service** is the Framework's unit of organization.  You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions, the Events that trigger them, and the Resources your Functions use, all in one file entitled `serverless.yml` (or `serverless.json`).  It looks like this:
+A **Service** is the Framework's unit of organization.  You can think of it as a project file, though you can have multiple services for a single application.  It's where you define your Functions, the Events that trigger them, and the Resources your Functions use, all in one file entitled `serverless.yml` (or `serverless.json` or `serverless.js`).  It looks like this:
 
 ```yml
 

docs/providers/webtasks/guide/intro.md

@@ -24,7 +24,7 @@ Here are the Framework's main concepts and how they pertain to Auth0 Webtasks...
 
 A **Service** is the Framework's unit of organization. You can think of it as a project file, though you can have multiple services for a single application.  
 
-The Auth0 Webtasks platform was designed to be simple and easy to use with minimal configuration. Therefore, services that uses Auth0 Webtasks are just a few lines of configuration in a single file, entitled `serverless.yml` (or `serverless.json`). It looks like this:
+The Auth0 Webtasks platform was designed to be simple and easy to use with minimal configuration. Therefore, services that uses Auth0 Webtasks are just a few lines of configuration in a single file, entitled `serverless.yml` (or `serverless.json` or `serverless.js`). It looks like this:
 
 ```yml
 # serverless.yml

lib/classes/Service.js

@@ -46,6 +46,7 @@ class Service {
       'serverless.yaml',
       'serverless.yml',
       'serverless.json',
+      'serverless.js',
     ];
 
     const serviceFilePaths = _.map(serviceFilenames, filename => path.join(servicePath, filename));
@@ -61,65 +62,77 @@ class Service {
       serviceFilenames[serviceFileIndex] :
       _.first(serviceFilenames);
 
-    return that.serverless.yamlParser
-      .parse(serviceFilePath)
-      .then((serverlessFileParam) => {
-        const serverlessFile = serverlessFileParam;
-        // basic service level validation
-        const version = this.serverless.utils.getVersion();
-        const ymlVersion = serverlessFile.frameworkVersion;
-        if (ymlVersion && !semver.satisfies(version, ymlVersion)) {
-          const errorMessage = [
-            `The Serverless version (${version}) does not satisfy the`,
-            ` "frameworkVersion" (${ymlVersion}) in ${serviceFilename}`,
-          ].join('');
-          throw new ServerlessError(errorMessage);
-        }
-        if (!serverlessFile.service) {
-          throw new ServerlessError(`"service" property is missing in ${serviceFilename}`);
-        }
-        if (_.isObject(serverlessFile.service) && !serverlessFile.service.name) {
-          throw new ServerlessError(`"service" is missing the "name" property in ${serviceFilename}`);   // eslint-disable-line max-len
-        }
-        if (!serverlessFile.provider) {
-          throw new ServerlessError(`"provider" property is missing in ${serviceFilename}`);
-        }
+    if (serviceFilename === 'serverless.js') {
+      return new BbPromise((resolve) => {
+        resolve(that.loadServiceFileParam(serviceFilename, require(serviceFilePath)));
+      });
+    } else {
+      return that.serverless.yamlParser
+        .parse(serviceFilePath)
+        .then((serverlessFileParam) => {
+          return that.loadServiceFileParam(serviceFilename, serverlessFileParam);
+        });
+    }
+  }
 
-        if (typeof serverlessFile.provider !== 'object') {
-          const providerName = serverlessFile.provider;
-          serverlessFile.provider = {
-            name: providerName,
-          };
-        }
+  loadServiceFileParam(serviceFilename, serverlessFileParam) {
+    const that = this;
 
-        if (_.isObject(serverlessFile.service)) {
-          that.serviceObject = serverlessFile.service;
-          that.service = serverlessFile.service.name;
-        } else {
-          that.serviceObject = { name: serverlessFile.service };
-          that.service = serverlessFile.service;
-        }
+    const serverlessFile = serverlessFileParam;
+    // basic service level validation
+    const version = this.serverless.utils.getVersion();
+    const ymlVersion = serverlessFile.frameworkVersion;
+    if (ymlVersion && !semver.satisfies(version, ymlVersion)) {
+      const errorMessage = [
+        `The Serverless version (${version}) does not satisfy the`,
+        ` "frameworkVersion" (${ymlVersion}) in ${serviceFilename}`,
+      ].join('');
+      throw new ServerlessError(errorMessage);
+    }
+    if (!serverlessFile.service) {
+      throw new ServerlessError(`"service" property is missing in ${serviceFilename}`);
+    }
+    if (_.isObject(serverlessFile.service) && !serverlessFile.service.name) {
+      throw new ServerlessError(`"service" is missing the "name" property in ${serviceFilename}`);   // eslint-disable-line max-len
+    }
+    if (!serverlessFile.provider) {
+      throw new ServerlessError(`"provider" property is missing in ${serviceFilename}`);
+    }
 
-        that.custom = serverlessFile.custom;
-        that.plugins = serverlessFile.plugins;
-        that.resources = serverlessFile.resources;
-        that.functions = serverlessFile.functions || {};
-
-        // merge so that the default settings are still in place and
-        // won't be overwritten
-        that.provider = _.merge(that.provider, serverlessFile.provider);
-
-        if (serverlessFile.package) {
-          that.package.individually = serverlessFile.package.individually;
-          that.package.path = serverlessFile.package.path;
-          that.package.artifact = serverlessFile.package.artifact;
-          that.package.exclude = serverlessFile.package.exclude;
-          that.package.include = serverlessFile.package.include;
-          that.package.excludeDevDependencies = serverlessFile.package.excludeDevDependencies;
-        }
+    if (typeof serverlessFile.provider !== 'object') {
+      const providerName = serverlessFile.provider;
+      serverlessFile.provider = {
+        name: providerName,
+      };
+    }
 
-        return this;
-      });
+    if (_.isObject(serverlessFile.service)) {
+      that.serviceObject = serverlessFile.service;
+      that.service = serverlessFile.service.name;
+    } else {
+      that.serviceObject = { name: serverlessFile.service };
+      that.service = serverlessFile.service;
+    }
+
+    that.custom = serverlessFile.custom;
+    that.plugins = serverlessFile.plugins;
+    that.resources = serverlessFile.resources;
+    that.functions = serverlessFile.functions || {};
+
+    // merge so that the default settings are still in place and
+    // won't be overwritten
+    that.provider = _.merge(that.provider, serverlessFile.provider);
+
+    if (serverlessFile.package) {
+      that.package.individually = serverlessFile.package.individually;
+      that.package.path = serverlessFile.package.path;
+      that.package.artifact = serverlessFile.package.artifact;
+      that.package.exclude = serverlessFile.package.exclude;
+      that.package.include = serverlessFile.package.include;
+      that.package.excludeDevDependencies = serverlessFile.package.excludeDevDependencies;
+    }
+
+    return this;
   }
 
   setFunctionNames(rawOptions) {

lib/classes/Service.test.js

@@ -287,6 +287,61 @@ describe('Service', () => {
       });
     });
 
+    it('should load serverless.js from filesystem', () => {
+      const SUtils = new Utils();
+      const serverlessJSON = {
+        service: 'new-service',
+        provider: {
+          name: 'aws',
+          stage: 'dev',
+          region: 'us-east-1',
+          variableSyntax: '\\${{([ ~:a-zA-Z0-9._\'",\\-\\/\\(\\)]+?)}}',
+        },
+        plugins: ['testPlugin'],
+        functions: {
+          functionA: {},
+        },
+        resources: {
+          aws: {
+            resourcesProp: 'value',
+          },
+          azure: {},
+          google: {},
+        },
+        package: {
+          exclude: ['exclude-me'],
+          include: ['include-me'],
+          artifact: 'some/path/foo.zip',
+        },
+      };
+
+      SUtils.writeFileSync(path.join(tmpDirPath, 'serverless.js'),
+        `module.exports = ${JSON.stringify(serverlessJSON)};`);
+
+      const serverless = new Serverless();
+      serverless.config.update({ servicePath: tmpDirPath });
+      serviceInstance = new Service(serverless);
+
+      return expect(serviceInstance.load()).to.eventually.be.fulfilled
+      .then(() => {
+        expect(serviceInstance.service).to.be.equal('new-service');
+        expect(serviceInstance.provider.name).to.deep.equal('aws');
+        expect(serviceInstance.provider.variableSyntax).to.equal(
+          '\\${{([ ~:a-zA-Z0-9._\'",\\-\\/\\(\\)]+?)}}'
+        );
+        expect(serviceInstance.plugins).to.deep.equal(['testPlugin']);
+        expect(serviceInstance.resources.aws).to.deep.equal({ resourcesProp: 'value' });
+        expect(serviceInstance.resources.azure).to.deep.equal({});
+        expect(serviceInstance.resources.google).to.deep.equal({});
+        expect(serviceInstance.package.exclude.length).to.equal(1);
+        expect(serviceInstance.package.exclude[0]).to.equal('exclude-me');
+        expect(serviceInstance.package.include.length).to.equal(1);
+        expect(serviceInstance.package.include[0]).to.equal('include-me');
+        expect(serviceInstance.package.artifact).to.equal('some/path/foo.zip');
+        expect(serviceInstance.package.excludeDevDependencies).to.equal(undefined);
+      });
+    });
+
     it('should load YAML in favor of JSON', () => {
       const SUtils = new Utils();
       const serverlessJSON = {

lib/classes/Utils.js

@@ -105,6 +105,8 @@ class Utils {
       servicePath = process.cwd();
     } else if (fileExistsSync(path.join(process.cwd(), 'serverless.json'))) {
       servicePath = process.cwd();
+    } else if (fileExistsSync(path.join(process.cwd(), 'serverless.js'))) {
+      servicePath = process.cwd();
     }
 
     return servicePath;

lib/classes/Utils.test.js

@@ -281,6 +281,18 @@ describe('Utils', () => {
       expect(servicePath).to.not.equal(null);
     });
 
+    it('should detect if the CWD is a service directory when using Serverless .js files', () => {
+      const tmpDirPath = testUtils.getTmpDirPath();
+      const tmpFilePath = path.join(tmpDirPath, 'serverless.js');
+
+      serverless.utils.writeFileSync(tmpFilePath, 'foo');
+      process.chdir(tmpDirPath);
+
+      const servicePath = serverless.utils.findServicePath();
+
+      expect(servicePath).to.not.equal(null);
+    });
+
     it('should detect if the CWD is not a service directory', () => {
       // just use the root of the tmpdir because findServicePath will
       // also check parent directories (and may find matching tmp dirs

lib/plugins/package/lib/packageService.js

@@ -14,6 +14,7 @@ module.exports = {
     'serverless.yml',
     'serverless.yaml',
     'serverless.json',
+    'serverless.js',
     '.serverless/**',
     '.serverless_plugins/**',
   ],

lib/plugins/package/lib/packageService.test.js

@@ -82,7 +82,7 @@ describe('#packageService()', () => {
       expect(exclude).to.deep.equal([
         '.git/**', '.gitignore', '.DS_Store',
         'npm-debug.log', 'serverless.yml',
-        'serverless.yaml', 'serverless.json',
+        'serverless.yaml', 'serverless.json', 'serverless.js',
         '.serverless/**', '.serverless_plugins/**',
         'dir', 'file.js',
       ]);
@@ -102,7 +102,7 @@ describe('#packageService()', () => {
       expect(exclude).to.deep.equal([
         '.git/**', '.gitignore', '.DS_Store',
         'npm-debug.log', 'serverless.yml',
-        'serverless.yaml', 'serverless.json',
+        'serverless.yaml', 'serverless.json', 'serverless.js',
         '.serverless/**', '.serverless_plugins/**',
         'dir', 'file.js', 'lib', 'other.js',
       ]);

lib/plugins/plugin/install/install.js

@@ -109,6 +109,14 @@ class PluginInstall {
 
   addPluginToServerlessFile() {
     return this.getServerlessFilePath().then(serverlessFilePath => {
+      if (_.last(_.split(serverlessFilePath, '.')) === 'js') {
+        this.serverless.cli.log(`
+          Can't automatically add plugin into "serverless.js" file.
+          Please make it manually.
+        `);
+        return new BbPromise((resolve) => resolve());
+      }
+
       if (_.last(_.split(serverlessFilePath, '.')) === 'json') {
         return fse.readJsonAsync(serverlessFilePath).then(serverlessFileObj => {
           const newServerlessFileObj = serverlessFileObj;

lib/plugins/plugin/install/install.test.js

@@ -357,6 +357,21 @@ describe('PluginInstall', () => {
         });
       });
     });
+
+    it('should not modify serverless .js file', () => {
+      const serverlessJsFilePath = path.join(servicePath, 'serverless.js');
+      const serverlessJson = {
+        service: 'plugin-service',
+        provider: 'aws',
+      };
+      serverless.utils
+        .writeFileSync(serverlessJsFilePath, serverlessJson);
+      pluginInstall.options.pluginName = 'serverless-plugin-1';
+      return expect(pluginInstall.addPluginToServerlessFile()).to.be.fulfilled.then(() => {
+        expect(serverless.utils.readFileSync(serverlessJsFilePath, 'utf8').plugins)
+          .to.be.undefined;
+      })
+    });
   });
 
   describe('#installPeerDependencies()', () => {

lib/plugins/plugin/lib/utils.js

@@ -22,14 +22,21 @@ module.exports = {
     const serverlessYmlFilePath = path.join(servicePath, 'serverless.yml');
     const serverlessYamlFilePath = path.join(servicePath, 'serverless.yaml');
     const serverlessJsonFilePath = path.join(servicePath, 'serverless.json');
+    const serverlessJsFilePath = path.join(servicePath, 'serverless.js');
 
     return fileExists(serverlessYmlFilePath)
     .then(ymlExists => {
       if (!ymlExists) {
         return fileExists(serverlessYamlFilePath)
         .then(yamlExists => {
           if (!yamlExists) {
-            return serverlessJsonFilePath;
+            return fileExists(serverlessJsonFilePath).then((jsonExists) => {
+              if (jsonExists) {
+                return serverlessJsonFilePath;
+              } else {
+                return serverlessJsFilePath;
+              }
+            });
           }
           return serverlessYamlFilePath;
         });

lib/plugins/plugin/lib/utils.test.js

@@ -99,6 +99,16 @@ describe('PluginUtils', () => {
         expect(serverlessFilePath).to.equal(serverlessJsonFilePath);
       });
     });
+
+    it('should return the correct serverless file path for a .js file', () => {
+      const serverlessJsFilePath = path.join(servicePath, 'serverless.js');
+      fse.ensureFileSync(serverlessJsFilePath);
+
+      return expect(pluginUtils.getServerlessFilePath()).to.be.fulfilled
+      .then(serverlessFilePath => {
+        expect(serverlessFilePath).to.equal(serverlessJsFilePath);
+      });
+    });
   });
 
   describe('#getPlugins()', () => {