Merge pull request #147 from agutoli/2.7.0/release

2.7.0/release
agutoli · Oct 18, 2023 · dcb3832 · dcb3832
2 parents f83ed9d + 066ac43
commit dcb3832
Show file tree

Hide file tree

Showing 8 changed files with 124 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -110,6 +110,7 @@ functions:
 | packagePath    |  `string` | package.json | `(DEPRECATED)`: Available for `<= 1.5.0`, for versions `>= 2.x` please use `compatibleRuntimes` |
 | dependenciesPath   |  `string` | package.json | Note: `>= 2.x` versions. You can specify custom path for your package.json |
 | compatibleRuntimes |  `array` | `['nodejs']` | Possible values: nodejs, nodejs10.x, nodejs12.x |
+| layerOptimization.cleanupPatterns | `array` | [check](https://github.com/agutoli/serverless-layers/blob/master/src/runtimes/nodejs.js) | The pattern of files to cleanup in the layer artifact before uploading it. |
 
 ----------------------
 
@@ -126,6 +127,7 @@ functions:
 | packageManager |  `string` |    bundle      | Possible values: bundle |
 | dependenciesPath   |  `string` | Gemfile | Note: Available for `>= 2.x` versions. You can specify custom path for your requirements.txt |
 | compatibleRuntimes |  `array` | `['ruby']` | Possible values: ruby2.5, ruby2.7 |
+| layerOptimization.cleanupPatterns | `array` | [check](https://github.com/agutoli/serverless-layers/blob/master/src/runtimes/ruby.js) | The pattern of files to cleanup in the layer artifact before uploading it. |
 
 ----------------------
 
@@ -140,7 +142,8 @@ functions:
 | -------------- | --------- | ----------- | ----------- |
 | packageManager |  `string` |    pip      | Possible values: pip |
 | dependenciesPath   |  `string` | requirements.txt | Note: Available for `>= 2.x` versions. You can specify custom path for your requirements.txt |
-| compatibleRuntimes |  `array` | `['python']` | Possible values: python2.7, python3.6, python3.7 and python3.8 |
+| compatibleRuntimes |  `array` | `['python']` | Possible values: python2.7, python3.x |
+| layerOptimization.cleanupPatterns | `array` | [check](https://github.com/agutoli/serverless-layers/blob/master/src/runtimes/python.js) | The pattern of files to cleanup in the layer artifact before uploading it. |
 
 ----------------------
 
@@ -151,7 +154,7 @@ This plugin will setup follow options automatically if not specified at `serverl
 |     Option     |    Type   |   Default   |
 | -------------- | --------- | ----------- |
 | package.individually | `bool` | false    |
-| package.exclude | `array` | `['node_modules/**']` |
+| package.patterns | `array` | `['node_modules/**']` |
 | package.excludeDevDependencies | `bool` | false |
 
 ## Mininal Policy permissions for CI/CD IAM users

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "serverless-layers",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "description": "",
   "main": "lib/index.js",
   "bugs": {

diff --git a/src/index.js b/src/index.js
@@ -199,13 +199,11 @@ class ServerlessLayers {
       return false;
     }
 
-    // by pass settings
-    if (!this.settings.localDir) {
-      return false;
-    }
-
     const manifest = '__meta__/manifest-settings.json';
-    const currentSettings = JSON.stringify(this.settings);
+    const currentSettings = JSON.stringify({
+      ...this.settings,
+      patterns: this.service.package.patterns
+    });
 
     // settings checked
     this.hasSettingsVerified = true;
@@ -305,7 +303,7 @@ class ServerlessLayers {
       hasDepsChanges,
       hasFoldersChanges,
       hasSettingsChanges,
-      hasCustomHashChanged
+      hasCustomHashChanged,
     ].some(x => x === true);
 
     // merge package default options
@@ -423,26 +421,26 @@ class ServerlessLayers {
   }
 
   mergePackageOptions() {
-    const { packageExclude, artifact } = this.settings;
+    const { packagePatterns, artifact } = this.settings;
     const pkg = this.service.package;
 
     const opts = {
       individually: false,
       excludeDevDependencies: false,
-      exclude: []
+      patterns: []
     };
 
     this.service.package = {...opts, ...pkg};
 
-    for (const excludeFile of packageExclude) {
-      const hasRule = (this.service.package.exclude || '').indexOf(excludeFile);
+    for (const excludeFile of packagePatterns) {
+      const hasRule = (this.service.package.patterns || '').indexOf(excludeFile);
       if (hasRule === -1) {
-        this.service.package.exclude.push(excludeFile);
+        this.service.package.patterns.push(excludeFile);
       }
     }
 
     if (artifact) {
-      this.service.package.exclude.push(artifact);
+      this.service.package.patterns.push(artifact);
     }
   }
 

diff --git a/src/package/Dependencies.js b/src/package/Dependencies.js
@@ -47,7 +47,7 @@ class Dependencies extends AbstractService {
      *
      * Reference: https://www.serverless.com/framework/docs/providers/aws/guide/packaging
      */
-    for (let pattern of this.plugin.service.package.patterns) {
+    for (let pattern of this.plugin.settings.layerOptimization.cleanupPatterns) {
       if (pattern.startsWith('!')) {
         const resolvedFiles = await resolveFile(pattern.substr(1), {
           cwd: this.layersPackageDir
@@ -65,7 +65,9 @@ class Dependencies extends AbstractService {
     filesToExclude.forEach((filename) => {
       // check if folder or files are being ignored, and shouldn't be removed.
       const shouldBeIgnored = filesToIgnore.filter(x => x.startsWith(filename)).length > 0;
+
       if (!shouldBeIgnored) {
+        this.plugin.warn(`[layerOptimization.cleanupPatterns] Ignored: ${filename}`);
         fs.rmSync(path.join(this.layersPackageDir, filename), {force: true, recursive: true});
       }
     });
@@ -146,7 +148,16 @@ class Dependencies extends AbstractService {
     }
 
     // cleanup files
-    await this.excludePatternFiles();
+    try {
+      await this.excludePatternFiles();
+    } catch(err) {
+      if (!this.plugin.service.package.patterns) {
+        this.plugin.warn(`[warning] package.patterns option is not set. @see https://www.serverless.com/framework/docs/providers/aws/guide/packaging`);
+      } else {
+        console.error(err);
+        process.exit(1);
+      }
+    }
   }
 }
 

diff --git a/src/runtimes/nodejs.js b/src/runtimes/nodejs.js
@@ -19,9 +19,42 @@ class NodeJSRuntime {
         'yarn.lock',
         'package-lock.json'
       ],
-      packageExclude: [
-        'node_modules/**',
-      ]
+      packagePatterns: [
+        '!node_modules/**',
+      ],
+      layerOptimization: {
+        cleanupPatterns: [
+          "node_modules/aws-sdk/**",
+          "node_modules/**/.github",
+          "node_modules/**/.git/*",
+          "node_modules/**/.lint",
+          "node_modules/**/Gruntfile.js",
+          "node_modules/**/.jshintrc",
+          "node_modules/**/.nycrc",
+          "node_modules/**/.nvmrc",
+          "node_modules/**/.editorconfig",
+          "node_modules/**/.npmignore",
+          "node_modules/**/bower.json",
+          "node_modules/**/.eslint*",
+          "node_modules/**/.gitignore",
+          "node_modules/**/README.*",
+          "node_modules/**/LICENSE",
+          "node_modules/**/LICENSE.md",
+          "node_modules/**/CHANGES",
+          "node_modules/**/HISTORY.md",
+          "node_modules/**/CHANGES.md",
+          "node_modules/**/CHANGELOG.md",
+          "node_modules/**/sponsors.md",
+          "node_modules/**/license.txt",
+          "node_modules/**/tsconfig.json",
+          "node_modules/**/*.test.js",
+          "node_modules/**/*.spec.js",
+          "node_modules/**/.travis.y*ml",
+          "node_modules/**/yarn.lock",
+          "node_modules/**/.package-lock.json",
+          "node_modules/**/*.md",
+        ]
+      }
     };
 
     this.commands = {

diff --git a/src/runtimes/python.js b/src/runtimes/python.js
@@ -16,11 +16,17 @@ class PythonRuntime {
       compatibleRuntimes: [runtime],
       compatibleArchitectures: parent.compatibleArchitectures,
       copyBeforeInstall: [],
-      packageExclude: [
-        'package.json',
-        'package-lock.json',
-        'node_modules/**',
-      ]
+      packagePatterns: [
+        '!package.json',
+        '!package-lock.json',
+        '!node_modules/**',
+      ],
+      layerOptimization: {
+        cleanupPatterns: [
+          "node_modules/**/*.pyc",
+          "node_modules/**/*.md",
+        ]
+      }
     };
 
     this.commands = {

diff --git a/src/runtimes/ruby.js b/src/runtimes/ruby.js
@@ -22,13 +22,19 @@ class RubyRuntime {
       copyAfterInstall: [
         { from: 'ruby', to: 'gems' }
       ],
-      packageExclude: [
-        'node_modules/**',
-        'package.json',
-        'package-lock.json',
-        'vendor/**',
-        '.bundle'
-      ]
+      packagePatterns: [
+        '!node_modules/**',
+        '!package.json',
+        '!package-lock.json',
+        '!vendor/**',
+        '!.bundle'
+      ],
+      layerOptimization: {
+        cleanupPatterns: [
+          "node_modules/**/*.pyc",
+          "node_modules/**/*.md",
+        ]
+      }
     };
 
     this.commands = {

diff --git a/tests/fixtures/nodejsConfig.js b/tests/fixtures/nodejsConfig.js
@@ -5,11 +5,44 @@ module.exports = {
   packageManagerExtraArgs: '',
   libraryFolder: 'node_modules',
   dependenciesPath: './fixtures/package.json',
+  layerOptimization: {
+    cleanupPatterns: [
+      "node_modules/aws-sdk/**",
+      "node_modules/**/.github",
+      "node_modules/**/.git/*",
+      "node_modules/**/.lint",
+      "node_modules/**/Gruntfile.js",
+      "node_modules/**/.jshintrc",
+      "node_modules/**/.nycrc",
+      "node_modules/**/.nvmrc",
+      "node_modules/**/.editorconfig",
+      "node_modules/**/.npmignore",
+      "node_modules/**/bower.json",
+      "node_modules/**/.eslint*",
+      "node_modules/**/.gitignore",
+      "node_modules/**/README.*",
+      "node_modules/**/LICENSE",
+      "node_modules/**/LICENSE.md",
+      "node_modules/**/CHANGES",
+      "node_modules/**/HISTORY.md",
+      "node_modules/**/CHANGES.md",
+      "node_modules/**/CHANGELOG.md",
+      "node_modules/**/sponsors.md",
+      "node_modules/**/license.txt",
+      "node_modules/**/tsconfig.json",
+      "node_modules/**/*.test.js",
+      "node_modules/**/*.spec.js",
+      "node_modules/**/.travis.y*ml",
+      "node_modules/**/yarn.lock",
+      "node_modules/**/.package-lock.json",
+      "node_modules/**/*.md"
+    ]
+  },
   compatibleRuntimes: [ 'nodejs' ],
   compatibleArchitectures: [
     "x86_64",
     "arm64"
   ],
   copyBeforeInstall: [ '.npmrc', 'yarn.lock', 'package-lock.json' ],
-  packageExclude: [ 'node_modules/**' ]
+  packagePatterns: [ '!node_modules/**' ]
 }