jets_gem_layer 0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 796fe39c52a3459efb7585c20543607952c5760fbde14cd348172e50d1521fe3
-  data.tar.gz: e9895777617ab674521b57a5d1f43477d9f05aeb3c276fc723b1595b4e8b0fbb
+  metadata.gz: 92ac2b1c7617c7a72a43baa82194bc05193d65d3bcd7cbceebf7609bec9b463d
+  data.tar.gz: 798fd9fe29457d71874ac3a3821383b286122ae29e0bb67a18501a847e0a05a7
 SHA512:
-  metadata.gz: 82457f5266038a4b08424fe518a89aa67f71f15541d6db06435d1e6ae14bc202027fe95044ed70c4d4dc6e6c072c055298464baf8e8257f0eaa23a5c7999fd7c
-  data.tar.gz: 308673cfb04e7ed74bea54fa2dcc4ebbc2773adb5ea2be3dac64b2182d98a3a7a7b9bda9dd74f543a8cb136bac9d8d201a340834f85c273b7e211f48173f8fe3
+  metadata.gz: 4820f54954f93a71919c7fdb75625539c76ecae6938b2af2e926c179fb6350979ab153891c62c4f7a828cd2dc2a49d51c86aaaa610274484f433f90cf06ecd04
+  data.tar.gz: 5d09bad45ce5cc6d4e7714ce7bae33e12e3ab0ff97b53ba127e69188585152c0cad49c5eda2604eaad6b25bb0b5f9a25b009e9c9cbd5f482d46582cbb5af0ae1

data/.gitignore

@@ -6,10 +6,11 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+*.gem
 # rspec failure tracking
 .rspec_status
 .rakeTasks
 
 /.idea/
-tags
+tags
+.DS_Store

data/.rubocop.yml

@@ -1,3 +1,39 @@
+require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 AllCops:
-  NewCops: enable
+  NewCops: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+Lint/MixedRegexpCaptureTypes:
+  Exclude:
+    - 'lib/jets_gem_layer/build_env/build_layer.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/jets_gem_layer/build_env/build_layer.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/jets_gem_layer/build_env/build_layer.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/jets_gem_layer/build_env/build_layer.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/jets_gem_layer/build_env/build_layer.rb'
+
+Metrics/ClassLength:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10

data/.rubocop_todo.yml

@@ -6,31 +6,3 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-Lint/MixedRegexpCaptureTypes:
-  Exclude:
-    - 'lib/jets_gem_layer/build_env/build_layer.rb'
-
-Metrics/AbcSize:
-  Exclude:
-    - 'lib/jets_gem_layer/build_env/build_layer.rb'
-
-Metrics/CyclomaticComplexity:
-  Exclude:
-    - 'lib/jets_gem_layer/build_env/build_layer.rb'
-
-Metrics/MethodLength:
-  Exclude:
-    - 'lib/jets_gem_layer/build_env/build_layer.rb'
-
-Metrics/PerceivedComplexity:
-  Exclude:
-    - 'lib/jets_gem_layer/build_env/build_layer.rb'
-
-# Offense count: 2
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.2

data/Gemfile

@@ -2,11 +2,14 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in s3_gem_host.gemspec
-gemspec
+gem 'jets', '~> 5.0'
+gem 'rake'
 
 group :development, :test do
+  gem 'mysql2', require: false # only included to test building a layer with a named dependency (mysql-devel)
   gem 'rspec'
   gem 'rubocop', require: false
   gem 'rubocop-rspec', require: false
+  gem 'rubyzip'
+  gem 'simplecov', require: false
 end

data/Gemfile.lock

@@ -1,10 +1,3 @@
-PATH
-  remote: .
-  specs:
-    jets_gem_layer (0.1)
-      jets (~> 5.0)
-      rake
-
 GEM
   remote: https://rubygems.org/
   specs:
@@ -61,7 +54,7 @@ GEM
       rainbow
       thor
       zeitwerk
-    aws-partitions (1.875.0)
+    aws-partitions (1.877.0)
     aws-sdk-apigateway (1.90.0)
       aws-sdk-core (~> 3, >= 3.188.0)
       aws-sigv4 (~> 1.1)
@@ -120,6 +113,7 @@ GEM
     crass (1.0.6)
     date (3.3.4)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     dotenv (2.8.1)
     dsl_evaluator (0.3.1)
       activesupport
@@ -197,6 +191,7 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.5)
     minitest (5.20.0)
+    mysql2 (0.5.5)
     net-imap (0.4.9)
       date
       net-protocol
@@ -261,15 +256,22 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.19.0)
+    rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.24.0)
+    rubocop-factory_bot (2.25.0)
       rubocop (~> 1.33)
-    rubocop-rspec (2.25.0)
+    rubocop-rspec (2.26.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     text-table (1.2.4)
     thor (1.3.0)
     timeout (0.4.1)
@@ -282,10 +284,14 @@ PLATFORMS
   arm64-darwin-23
 
 DEPENDENCIES
-  jets_gem_layer!
+  jets (~> 5.0)
+  mysql2
+  rake
   rspec
   rubocop
   rubocop-rspec
+  rubyzip
+  simplecov
 
 BUNDLED WITH
    2.5.3

data/README.md

@@ -14,7 +14,7 @@ is correctly set for your project.
 
 ## Installation
 
-1. Jets Pro would typically be disabled when using this gem so as to not generate multiple Lambda Layers.
+1. Jets Pro would typically be disabled when using this gem so as to not generate duplicative Lambda Layers.
 
 ```ruby
 # config/application.rb
@@ -55,10 +55,12 @@ JetsGemLayer.load_tasks
 3. After running `bundle install`, run `rake -T` and you should see this Gem's tasks available for use.
 ```
 ➜ rake -T
-rake gem_layer:build_and_publish   # Build, publish, and clean
-rake gem_layer:build               # Build the gem layer zip file
-rake gem_layer:publish             # Publish the built gem laye zip to AWS
-rake gem_layer:clean               # Clean up the gem's tmp files
+rake gem_layer:build_and_publish            # Build and publish a gem layer version, if necessary
+rake gem_layer:build                        # Build a gem layer zip file
+rake gem_layer:publish                      # Publish the already built layer zip file
+rake gem_layer:clean                        # Clean jets_gem_layer tmp files
+rake gem_layer:cleanup_published            # Delete old layer versions from AWS (for use after deployment)
+rake gem_layer:delete_all_published         # Delete all published versions of the gem layer from AWS
 ```
 
 ## Configuration
@@ -72,9 +74,13 @@ specific to your Gemfile. For example, to build the `mysql2` gem you will need t
 Dependencies will be installed within the build container and copied into the published Lambda Layer.
 
 ## Deployment
-Within your project directory (example for development environment):
-1. run `JETS_ENV=development rake gem_layer:build_and_publish`
-2. run `JETS_ENV=development jets deploy`
+Within your project directory (example for development environment) or through your CI/CD platform:
+1. `JETS_ENV=development rake gem_layer:build_and_publish`
+   * If needed, builds and publishes a new gem layer version based on the current Jets namespace, Gemfile.lock and Gemfile
+2. `JETS_ENV=development JETS_AGREE=no jets deploy`
+   * Deploy your application
+3. `JETS_ENV=development rake gem_layer:cleanup_published`
+   * After a successful deploy, you may run this to cleanup the old gem layer version(s) no longer in use
 
 ## Acknowledgements
 A big thank you to the authors of [Lambda Layer Cake](https://github.com/loganb/lambda-layer-cake), which served as a reference.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/jets_gem_layer/build_env/build_layer.rb

@@ -6,6 +6,8 @@ require 'English'
 require 'open3'
 require 'fileutils'
 
+# This script runs in the public.ecr.aws/sam/build-ruby docker container
+# to build native gems and libs which end up in the layer zip file
 def main
   warn('Installing yum package manager...')
   unless system('yum', 'install', '-y', 'yum-utils')

data/lib/jets_gem_layer/task_helper.rb

@@ -1,23 +1,30 @@
 # frozen_string_literal: true
 
 module JetsGemLayer
+  # All methods that run in the app environment, including rake tasks
   class TaskHelper
     include Rake::DSL
     include Jets::AwsServices
 
     # Files used to generate the gem layer
     INPUT_FILES = Rake::FileList.new(
-      ['Gemfile', 'Gemfile.lock'].collect { |f| File.join(Jets.root, f) }
+      %w[Gemfile Gemfile.lock].map { |f| File.join(Jets.root, f) }
     )
-    LOCAL_TMP_DIR = 'tmp/jets_gem_layer'
-    OUTPUT_DIR = File.expand_path(File.join(Jets.root, "#{LOCAL_TMP_DIR}/"))
+    OUTPUT_DIR = File.expand_path(File.join(Jets.root, 'tmp/jets_gem_layer/'))
+
+    def self.instance
+      @instance ||= new
+    end
 
     def self.install
-      new.install
+      return if @installed
+
+      instance.install
+      @installed = true
     end
 
     def self.arn
-      @arn ||= new.arn
+      instance.arn
     end
 
     def arn
@@ -34,69 +41,129 @@ module JetsGemLayer
 
     def install
       namespace :gem_layer do
-        install_build_and_publish
+        install_clean
         install_build
         install_publish
-        install_clean
+        install_build_and_publish
+        install_cleanup_published
+        install_delete_all_published
       end
+      true
     end
 
     def install_build_and_publish
-      desc 'Build and publish a gem layer version'
+      desc 'Build and publish a gem layer version, if necessary'
       task :build_and_publish do
+        if published?
+          puts "#{layer_name} already published for #{layer_version_description}. Not doing anything!"
+          next
+        end
         Rake::Task['gem_layer:build'].invoke
         Rake::Task['gem_layer:publish'].invoke
-        Rake::Task['gem_layer:clean'].invoke
       end
     end
 
     def install_build
-      desc 'Build the gem layer zip file'
-      task :build do
-        Rake::Task['gem_layer:clean'].invoke
+      desc 'Build a gem layer zip file'
+      task build: :clean do
         build_layer
         zip_layer
       end
     end
 
     def install_publish
-      desc 'Publish a built layer zip file'
+      desc 'Publish the already built layer zip file'
       task :publish do
         publish_layer
       end
     end
 
     def install_clean
-      desc 'Clean tmp files'
+      desc 'Clean jets_gem_layer tmp files'
       task :clean do
-        FileUtils.rm_r(working_dir) if File.exist?(working_dir)
+        clean_working_dir
       end
     end
 
-    def build_layer
-      FileUtils.mkdir_p(inputs_dir)
-      FileUtils.cp(INPUT_FILES.existing, inputs_dir)
-      system(*docker_run_cmd) or raise
+    def install_cleanup_published
+      desc 'Delete old layer versions from AWS (for use after deployment)'
+      task :cleanup_published do
+        cleanup_published
+      end
     end
 
-    def zip_layer
-      pwd = Dir.pwd
-      begin
-        Dir.chdir(outputs_dir)
-        system(*%W[zip -r #{File.join(working_dir, "#{layer_name}.zip")} lib ruby], out: File::NULL) or raise
-        puts 'Layer zipped successfully...'
-      ensure
-        Dir.chdir(pwd)
+    def install_delete_all_published
+      desc 'Delete all published versions of the gem layer from AWS'
+      task :delete_all_published do
+        delete_all_published
       end
     end
 
+    def build_layer
+      FileUtils.mkdir_p(inputs_dir)
+      FileUtils.cp(INPUT_FILES.existing, inputs_dir)
+      system(*docker_run_cmd) or raise $CHILD_STATUS.to_s
+      zip_layer
+    end
+
     def publish_layer
       aws_lambda.publish_layer_version(
         layer_name:, # required
         description: layer_version_description,
         content: { zip_file: File.read(zip_file_path) }
       )
-      puts "#{layer_name} published for #{layer_version_description}..."
+      puts "#{layer_name} published for #{layer_version_description}!"
+    end
+
+    def clean_working_dir
+      FileUtils.rm_rf(working_dir)
+    end
+
+    def cleanup_published
+      all_layer_versions.each_with_index do |layer_version, i|
+        next if i.zero? # skips the current version
+
+        aws_lambda.delete_layer_version(layer_name:, version_number: layer_version.version)
+        puts "Deleted #{layer_version.layer_version_arn}"
+      end
+      puts 'Deleted all prior versions!'
+    end
+
+    def delete_all_published
+      all_layer_versions.each do |layer_version|
+        aws_lambda.delete_layer_version(layer_name:, version_number: layer_version.version)
+        puts "Deleted #{layer_version.layer_version_arn}"
+      end
+      puts 'Deleted all published versions!'
+    end
+
+    # paginate through all layer versions to get them all (but it's unlikely there will be more than 1 page)
+    def all_layer_versions
+      all_versions = []
+      marker = nil
+      loop do
+        page = aws_lambda.list_layer_versions(layer_name:, max_items: 50, marker:)
+        all_versions.concat page.layer_versions
+        marker = page.next_marker
+        break if marker.nil?
+      end
+      all_versions
+    end
+
+    def published_layer_version
+      @published_layer_version ||= aws_lambda.list_layer_versions(layer_name:, max_items: 1).layer_versions.first
+    end
+
+    def published?
+      published_layer_version&.description == layer_version_description
+    end
+
+    def published_arn
+      return nil unless published?
+
+      published_layer_version.layer_version_arn
+    rescue StandardError
+      'error-fetching-gem-layer-arn'
     end
 
     private
@@ -150,30 +217,24 @@ module JetsGemLayer
                -v #{outputs_dir}:/tmp/outputs
                -v #{File.expand_path("#{__dir__}/build_env")}:/var/task]
 
-      ENV.fetch('GEM_LAYER_ENV').split(',').each { |env| cmd.push "-e#{env}" } if ENV['GEM_LAYER_ENV']
+      ENV.fetch('GEM_LAYER_ENV').split(',').each { |env| cmd.push "-e#{env}" } if ENV.key?('GEM_LAYER_ENV')
 
-      if ENV['GEM_LAYER_PACKAGE_DEPENDENCIES']
+      if ENV.key?('GEM_LAYER_PACKAGE_DEPENDENCIES')
         cmd.push "-eGEM_LAYER_PACKAGE_DEPENDENCIES=#{ENV.fetch('GEM_LAYER_PACKAGE_DEPENDENCIES')}"
       end
 
       cmd.push(*%W[public.ecr.aws/sam/build-ruby#{docker_tag} ruby build_layer.rb])
     end
 
-    def published_arn
-      return nil unless published?
-
-      published_layer_version.layer_version_arn
-    rescue StandardError
-      Jets.logger.error('Could not resolve lambda layer arn')
-      'error-fetching-gem-layer-arn'
-    end
-
-    def published?
-      published_layer_version&.description == layer_version_description
-    end
-
-    def published_layer_version
-      @published_layer_version ||= aws_lambda.list_layer_versions({ layer_name: }).layer_versions&.first
+    def zip_layer
+      pwd = Dir.pwd
+      begin
+        Dir.chdir(outputs_dir)
+        system(*%W[zip -r #{File.join(working_dir, "#{layer_name}.zip")} lib ruby], out: File::NULL) or raise
+        puts 'Layer zipped successfully!'
+      ensure
+        Dir.chdir(pwd)
+      end
     end
   end
 end

data/lib/jets_gem_layer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JetsGemLayer
-  VERSION = '0.1'
+  VERSION = '1.0.1'
 end

data/lib/jets_gem_layer.rb

@@ -5,8 +5,10 @@ require 'digest'
 require 'fileutils'
 require 'rake'
 
+require 'jets_gem_layer/version'
 require 'jets_gem_layer/task_helper'
 
+# Base module with helper methods
 module JetsGemLayer
   def self.load_tasks
     JetsGemLayer::TaskHelper.install

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets_gem_layer
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 1.0.1
 platform: ruby
 authors:
 - DocGo Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-29 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jets
@@ -49,10 +49,12 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- Rakefile
 - jets_gem_layer.gemspec
 - lib/jets_gem_layer.rb
 - lib/jets_gem_layer/build_env/build_layer.rb