brut 0.15.0 → 0.16.0.pre

data/mkbrut/templates/segments/Heroku/deploy/Dockerfile

@@ -37,7 +37,8 @@ WORKDIR /brut-app
 # - lsb-release is used to generically access information for this OS's version
 # - wget allows us to copy/paste commands from vendors about how to install
 #   software even though it does the same thing as curl
-RUN apt-get update --quiet --yes && \
+RUN --mount=type=cache,target=/var/cache/apt \
+    apt-get update --quiet --yes && \
     apt-get install --no-install-recommends --quiet --yes \
       ca-certificates \
       curl \
@@ -62,8 +63,7 @@ RUN /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -y && \
 ENV RACK_ENV="production" \
     BUNDLE_DEPLOYMENT="1" \
     BUNDLE_PATH="/usr/local/bundle" \
-    BUNDLE_WITHOUT="development" \
-    APP_GIT_SHA1="${app_git_sha1}"
+    BUNDLE_WITHOUT="development"
 
 # This makes a new image that we'll throw away after building
 # needed artifacts.
@@ -74,30 +74,29 @@ FROM base AS build
 # - libpq-dev is needed by postgres
 # - pkg-config is, I guess, not considered "essential" (as in build-essential),
 #   but still needed to install downstream stuff
-RUN apt-get update --quiet --yes && \
+RUN --mount=type=cache,target=/var/cache/apt \
+    apt-get update --quiet --yes && \
     apt-get install --no-install-recommends --quiet --yes \
 			build-essential \
 			git \
       libpq-dev \
 			pkg-config
 
-# Install NodeJS, per https://nodejs.org/en/download
-RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash && \
-    \. "$HOME/.nvm/nvm.sh" && \
-    nvm install 22 && \
-    node -v && nvm current && npm -v
+# Install NodeJS from their Docker image
+COPY --from=node:22-slim /usr/local /usr/local
 
-# Copy the app into the file, excluding the contents of .dockerignore
-COPY . .
+COPY Gemfile Gemfile.lock .
 
 # Install RubyGems from app's Gemfile
-RUN bundle install --verbose && \
+RUN --mount=type=cache,target=${BUNDLE_PATH}/cache \
+    bundle install --verbose && \
     rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git
 
+COPY package.json package-lock.json ./
 # Install Node Modules from package.json
-RUN \. "$HOME/.nvm/nvm.sh" && \
-    nvm use default && \
-    npm clean-install --no-audit --no-fund --verbose
+RUN npm clean-install --no-audit --no-fund --verbose
+
+COPY . .
 
 # Build all assets
 RUN \. "$HOME/.nvm/nvm.sh" && \
@@ -118,6 +117,7 @@ RUN groupadd --system --gid 1000 brut && \
     chown -R brut:brut logs tmp
 USER 1000:1000
 
+ENV APP_GIT_SHA1="${app_git_sha1}"
 # This is used to execute other commands.  When the app is run in production,
 # this script is used to run it.
 ENTRYPOINT ["/brut-app/deploy/docker-entrypoint"]

data/mkbrut/templates/segments/Heroku/deploy/heroku_config.rb

@@ -8,8 +8,8 @@ class HerokuConfig
   # The format of this Hash is:
   #
   # {
-  #   "«image name» => {
-  #     cmd: "«command line for Dockerfile RUN directive»",
+  #   *image name* => {
+  #     cmd: *command line for Dockerfile RUN directive*,
   #   }
   # }
   #
@@ -21,6 +21,7 @@ class HerokuConfig
   #     cmd: "bin/run-sidekiq",
   #   }
   # }
-  def self.additional_images = {}
+  #
+  def self.additional_images
+  end
 end
-

data/mkbrut/templates/segments/Sidekiq/app/boot_sidekiq.rb

@@ -0,0 +1,2 @@
+require_relative "bootstrap"
+bootstrap = Bootstrap.new.bootstrap!

data/mkbrut/templates/segments/Sidekiq/app/config/sidekiq.yml

@@ -0,0 +1,4 @@
+:concurrency: <%= ENV.fetch("SIDEKIQ_CONCURRENCY") { 5 } %>
+:timeout: <%= ENV.fetch("SIDEKIQ_TIMEOUT_SECONDS") { 25 } %>
+:queues:
+  - default

data/mkbrut/templates/segments/Sidekiq/app/src/back_end/jobs/app_job.rb

@@ -0,0 +1,3 @@
+class AppJob
+  include Sidekiq::Job
+end

data/mkbrut/templates/segments/Sidekiq/app/src/back_end/jobs/example_job.rb

@@ -0,0 +1,12 @@
+# This is entirely to allow the integration test to run
+# that verifies you have Sidekqi working and the segment was
+# installed correctly.  Once you have created a real job for
+# your app and done whatever testing you need, please delete
+# this job and the integration test.
+class ExampleJob < AppJob
+  def perform(path_to_file, contents)
+    File.open(path_to_file, "w") do |f|
+      f.puts(contents)
+    end
+  end
+end

data/mkbrut/templates/segments/Sidekiq/app/src/back_end/segments/sidekiq_segment.rb

@@ -0,0 +1,56 @@
+require "sidekiq"
+# Encapsulates all Sidekiq configuraiton beyond what can be done in
+# app/config/sidekiq.yml.  You can edit this as needed.
+class SidekiqSegment
+
+  def initialize
+    Brut.container.store(
+      "flush_spans_in_sidekiq?",
+      "Boolean",
+      "True if sidekiq jobs should flush all OTel spans after the job completes"
+    ) do |project_env|
+      if ENV["FLUSH_SPANS_IN_SIDEKIQ"] == "true"
+        true
+      elsif ENV["FLUSH_SPANS_IN_SIDEKIQ"] == "false"
+        false
+      else
+        project_env.development?
+      end
+    end
+  end
+
+  def boot!
+    Sidekiq.configure_server do |config|
+      config.redis = {
+        # Per https://devcenter.heroku.com/articles/connecting-heroku-redis#connecting-in-ruby
+        ssl_params: {
+          verify_mode: OpenSSL::SSL::VERIFY_NONE,
+        },
+      }
+      config.logger = SemanticLogger["Sidekiq:server"]
+      if Brut.container.flush_spans_in_sidekiq?
+        SemanticLogger[self.class].info("Sidekiq jobs will flush spans")
+        config.server_middleware do |chain|
+          if defined? OpenTelemetry::Instrumentation::Sidekiq::Middlewares::Server::TracerMiddleware
+            chain.insert_before OpenTelemetry::Instrumentation::Sidekiq::Middlewares::Server::TracerMiddleware,
+                                Brut::BackEnd::Sidekiq::Middlewares::Server::FlushSpans
+          else
+            SemanticLogger["Sidekiq:server"].warn("OpenTelemetry::Instrumentation::Sidekiq::Middlewares::Server::TracerMiddleware not defined")
+          end
+        end
+      else
+        SemanticLogger[self.class].info("Sidekiq jobs will not flush spans")
+      end
+    end
+
+    Sidekiq.configure_client do |config|
+      config.redis = {
+        # Per https://devcenter.heroku.com/articles/connecting-heroku-redis#connecting-in-ruby
+        ssl_params: {
+          verify_mode: OpenSSL::SSL::VERIFY_NONE,
+        },
+      }
+      config.logger = SemanticLogger["Sidekiq:client"]
+    end
+  end
+end

data/mkbrut/templates/segments/Sidekiq/bin/run.sidekiq

@@ -0,0 +1,4 @@
+PIDFILE="${SCRIPT_DIR}/../tmp/pidfile.sidekiq"
+CMD_MAP[sidekiq]="bin/sidekiq --config ${SCRIPT_DIR}/../app/config/sidekiq.yml  --require ${SCRIPT_DIR}/../app/boot_sidekiq.rb --verbose"
+PIDFILE_MAP[sidekiq]="${PIDFILE}"
+CREATES_PIDFILE_MAP[sidekiq]="false"

data/mkbrut/templates/segments/Sidekiq/specs/back_end/jobs/example_job.spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+RSpec.describe ExampleJob do
+  implementation_is_trivial
+end

data/mkbrut/templates/segments/Sidekiq/specs/integration/sidekiq_works.spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+require "timeout"
+
+# This test will ensure that Sidekiq segment was installed
+# correctly and your app can use Sidekiq. Once you have
+# created a real job for your app, delete ExampleJob and this test.
+RSpec.describe "Sidekiq is working", e2e: true do
+  it "processes jobs using the real Sidekiq server" do
+    # ExampleJob will write contents to a file.  This 
+    # test will delete that fail, queue the job, then
+    # wait up to 5 seconds for the job to run and create
+    # the file with the contents.  This should be more than
+    # enough time.
+    file = Brut.container.tmp_dir / "sidekiq_test.txt"
+    if file.exist?
+      file.delete
+    end
+
+    # If the file still exists at this point, the test
+    # will pass even if Sidekiq is not working.
+    confidence_check { expect(file.exist?).to eq(false) }
+
+    ExampleJob.perform_async(file.to_s, "test content for file")
+    queue_name = ExampleJob.sidekiq_options["queue"]
+    expect {
+      Timeout.timeout(5) do
+        loop do
+          if file.exist?
+            break
+          end
+          sleep 0.1
+        end
+      end
+    }.not_to raise_error
+    content = File.read(file)
+    expect(content).to eq("test content for file\n")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brut
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0.pre
 platform: ruby
 authors:
 - David Bryant Copeland
@@ -706,6 +706,7 @@ files:
 - brutrb.com/recipes/alternate-layouts.md
 - brutrb.com/recipes/authentication.md
 - brutrb.com/recipes/custom-flash.md
+- brutrb.com/recipes/dev-env-secrets.md
 - brutrb.com/recipes/form-errors.md
 - brutrb.com/recipes/indexed-forms.md
 - brutrb.com/recipes/migrations.md
@@ -965,25 +966,25 @@ files:
 - docs/assets/adrs.md.YglbWtQe.lean.js
 - docs/assets/ai.md.ChLnvDAX.js
 - docs/assets/ai.md.ChLnvDAX.lean.js
-- docs/assets/app.B0X8upRm.js
+- docs/assets/app.Dm7v_ouO.js
 - docs/assets/assets.md.BEF6Oz6K.js
 - docs/assets/assets.md.BEF6Oz6K.lean.js
 - docs/assets/basic-form-with-violations.Cv6Y9-Q_.png
 - docs/assets/basic-form.DbHnu0oW.png
-- docs/assets/brut-js.md.CbJAe2Ky.js
-- docs/assets/brut-js.md.CbJAe2Ky.lean.js
+- docs/assets/brut-js.md.BMz0X1Rz.js
+- docs/assets/brut-js.md.BMz0X1Rz.lean.js
 - docs/assets/business-logic.md.DbuaOYGU.js
 - docs/assets/business-logic.md.DbuaOYGU.lean.js
-- docs/assets/chunks/@localSearchIndexroot.C0s1k0UQ.js
-- docs/assets/chunks/VPLocalSearchBox.jLmhant1.js
+- docs/assets/chunks/@localSearchIndexroot.BiNFswvo.js
+- docs/assets/chunks/VPLocalSearchBox.DQK6jQou.js
 - docs/assets/chunks/framework.C4nOkCZI.js
-- docs/assets/chunks/theme.CtVUdCdt.js
+- docs/assets/chunks/theme.BuExsdM9.js
 - docs/assets/cli.md.DDMar_51.js
 - docs/assets/cli.md.DDMar_51.lean.js
-- docs/assets/components.md.C6nWgDP0.js
-- docs/assets/components.md.C6nWgDP0.lean.js
-- docs/assets/configuration.md.CpbYHWPb.js
-- docs/assets/configuration.md.CpbYHWPb.lean.js
+- docs/assets/components.md.Dfd3w6UW.js
+- docs/assets/components.md.Dfd3w6UW.lean.js
+- docs/assets/configuration.md.DTYoV2Ea.js
+- docs/assets/configuration.md.DTYoV2Ea.lean.js
 - docs/assets/css.md.K5rOCOQY.js
 - docs/assets/css.md.K5rOCOQY.lean.js
 - docs/assets/custom-element-tests.md.DiLe-eFw.js
@@ -1009,10 +1010,10 @@ files:
 - docs/assets/flash-and-session.md.CUsMxoNl.lean.js
 - docs/assets/form-constraints.md.KlfXSKm2.js
 - docs/assets/form-constraints.md.KlfXSKm2.lean.js
-- docs/assets/forms.md.Bii91k3E.js
-- docs/assets/forms.md.Bii91k3E.lean.js
-- docs/assets/getting-started.md.ChAvueK7.js
-- docs/assets/getting-started.md.ChAvueK7.lean.js
+- docs/assets/forms.md.DEkmJUvb.js
+- docs/assets/forms.md.DEkmJUvb.lean.js
+- docs/assets/getting-started.md.DO-4eoGW.js
+- docs/assets/getting-started.md.DO-4eoGW.lean.js
 - docs/assets/handlers.md.C5tUwmmo.js
 - docs/assets/handlers.md.C5tUwmmo.lean.js
 - docs/assets/hooks.md.CoiYCKRc.js
@@ -1078,8 +1079,8 @@ files:
 - docs/assets/tutorial.md.BX6f6l00.lean.js
 - docs/assets/tutorials_01-intro.md.CzZ3kpF_.js
 - docs/assets/tutorials_01-intro.md.CzZ3kpF_.lean.js
-- docs/assets/tutorials_02-dialog.md.De6iTsWX.js
-- docs/assets/tutorials_02-dialog.md.De6iTsWX.lean.js
+- docs/assets/tutorials_02-dialog.md.D2vSjDVf.js
+- docs/assets/tutorials_02-dialog.md.D2vSjDVf.lean.js
 - docs/assets/unit-tests.md.vDsdBbO_.js
 - docs/assets/unit-tests.md.vDsdBbO_.lean.js
 - docs/assets/welcome-to-brut.VSWzl17-.png
@@ -1149,6 +1150,8 @@ files:
 - docs/brut-js/api/RichString.js.html
 - docs/brut-js/api/Tabs.html
 - docs/brut-js/api/Tabs.js.html
+- docs/brut-js/api/Toast.html
+- docs/brut-js/api/Toast.js.html
 - docs/brut-js/api/Tracing.html
 - docs/brut-js/api/Tracing.js.html
 - docs/brut-js/api/external-CustomElementRegistry.html
@@ -1231,6 +1234,7 @@ files:
 - docs/why.html
 - dx/bash_customizations
 - dx/build
+- dx/build.pre
 - dx/docker-compose.env
 - dx/dx.sh.lib
 - dx/exec
@@ -1404,6 +1408,8 @@ files:
 - mkbrut/dx
 - mkbrut/exe/mkbrut
 - mkbrut/lib/mkbrut.rb
+- mkbrut/lib/mkbrut/add_segment.rb
+- mkbrut/lib/mkbrut/add_segment_options.rb
 - mkbrut/lib/mkbrut/app.rb
 - mkbrut/lib/mkbrut/app_id.rb
 - mkbrut/lib/mkbrut/app_name.rb
@@ -1421,6 +1427,7 @@ files:
 - mkbrut/lib/mkbrut/ops/base_op.rb
 - mkbrut/lib/mkbrut/ops/copy_file.rb
 - mkbrut/lib/mkbrut/ops/insert_code_in_method.rb
+- mkbrut/lib/mkbrut/ops/insert_into_file.rb
 - mkbrut/lib/mkbrut/ops/insert_route.rb
 - mkbrut/lib/mkbrut/ops/mkdir.rb
 - mkbrut/lib/mkbrut/ops/prism_parsing_op.rb
@@ -1489,6 +1496,7 @@ files:
 - mkbrut/templates/Base/bin/dev
 - mkbrut/templates/Base/bin/release
 - mkbrut/templates/Base/bin/run
+- mkbrut/templates/Base/bin/run.run
 - mkbrut/templates/Base/bin/scaffold
 - mkbrut/templates/Base/bin/setup
 - mkbrut/templates/Base/bin/startup-message
@@ -1543,6 +1551,14 @@ files:
 - mkbrut/templates/segments/Heroku/deploy/Dockerfile
 - mkbrut/templates/segments/Heroku/deploy/docker-entrypoint
 - mkbrut/templates/segments/Heroku/deploy/heroku_config.rb
+- mkbrut/templates/segments/Sidekiq/app/boot_sidekiq.rb
+- mkbrut/templates/segments/Sidekiq/app/config/sidekiq.yml
+- mkbrut/templates/segments/Sidekiq/app/src/back_end/jobs/app_job.rb
+- mkbrut/templates/segments/Sidekiq/app/src/back_end/jobs/example_job.rb
+- mkbrut/templates/segments/Sidekiq/app/src/back_end/segments/sidekiq_segment.rb
+- mkbrut/templates/segments/Sidekiq/bin/run.sidekiq
+- mkbrut/templates/segments/Sidekiq/specs/back_end/jobs/example_job.spec.rb
+- mkbrut/templates/segments/Sidekiq/specs/integration/sidekiq_works.spec.rb
 - specs/brut/front_end/forms/input.spec.rb
 - specs/brut/front_end/forms/radio_button_group_input.spec.rb
 - specs/brut/front_end/forms/select_input.spec.rb
@@ -1575,7 +1591,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Web Framework Built around Ruby, Web Standards, Simplicity, and Object-Orientation
 test_files: []