Merge pull request dougmoscrop#50 from rschick/speedup

Use caching to reduce redundant work

Author: Doug Moscrop

README.md

@@ -63,6 +63,17 @@ package:
 ```
 But be warned: Smaller individual functions can still mean a larger overall deployment. (10 functions that are 3 MB each is more net data tranfer and storage than 1 function that is 6 MB)
 
+## Dependency caching (Experimental)
+
+When building a shared bundle for several functions, execution time can be reduced by enabling dependency caching. Caching is disabled by default and can be enabled using the `enableCaching` option:
+
+```yaml
+custom:
+  includeDependencies:
+    enableCaching: true
+```
+
+
 ## New In 2.0 - Exclusion Support
 
 Rather than including module folders (e.g. `node_modules/foo/**`, it now includes a list of actual files (e.g. `node_modules/foo/package.json`, `node_modules/foo/index.js`) and *uses the serverless package exclude* to filter these files. Excludes *must* start with `node_modules` to be considered by this plugin.

__tests__/fixtures/bar/index.js

@@ -1 +1,2 @@
+require('../babel');
 module.exports = require('./baz');

__tests__/fixtures/foo/index.js

@@ -1 +1,2 @@
+require('../babel');
 module.exports = require('./baz');

__tests__/fixtures/redundancies-1.js

@@ -0,0 +1,3 @@
+require('local/named');
+require('./other/other-thing');
+require('./symlinked/symlinked');

__tests__/fixtures/redundancies-2.js

@@ -0,0 +1,3 @@
+require('local/named');
+require('./thing');
+require('test-dep');

__tests__/fixtures/symlinked/node_modules/test-dep

@@ -0,0 +1,14 @@
+{
+  "name": "sample",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "test-dep": "*"
+  }
+}

__tests__/fixtures/symlinked/package.json

@@ -0,0 +1 @@
+require('test-dep');

__tests__/fixtures/symlinked/symlinked.js

@@ -119,3 +119,20 @@ test('understands local named dependencies', (t) => {
   t.true(list.some(item => item.endsWith('dep-local-named.js')));
   t.true(list.some(item => item.endsWith('local/named/index.js')));
 });
+
+test('caches lookups', (t) => {
+  const fileName = path.join(__dirname, 'fixtures', 'redundancies-1.js');
+  const fileName2 = path.join(__dirname, 'fixtures', 'redundancies-2.js');
+
+  const cache = new Set();
+  const list1 = getDependencyList(fileName, serverless, cache);
+  const list2 = getDependencyList(fileName2, serverless, cache);
+
+  t.true(list1.some(item => item.endsWith('local/named/index.js')));
+  t.true(list1.some(item => item.endsWith('symlinked.js')));
+  t.true(list1.some(item => item.endsWith('node_modules/test-dep/test-dep.js')));
+
+  t.false(list2.some(item => item.endsWith('local/named/index.js')));
+  t.false(list2.some(item => item.endsWith('symlinked.js')));
+  t.false(list2.some(item => item.endsWith('test-dep.js')));
+});

__tests__/get-dependency-list.js

@@ -415,3 +415,21 @@ test('processFunction should handle different runtimes', t => {
 
   t.true(processNode.calledTwice);
 });
+
+test('disables caching by default', t => {
+  const instance = createTestInstance();
+  const file = path.join(__dirname, 'fixtures', 'thing.js');
+  const list1 = instance.getDependencies(file, []);
+  const list2 = instance.getDependencies(file, []);
+  t.deepEqual(list1, list2);
+});
+
+test('enables caching', t => {
+  const instance = createTestInstance({
+    service: { custom: { includeDependencies: { enableCaching: true } } }
+  });
+  const file = path.join(__dirname, 'fixtures', 'thing.js');
+  const list1 = instance.getDependencies(file, []);
+  const list2 = instance.getDependencies(file, []);
+  t.true(list2.length < list1.length);
+});