Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Improve admin updater notification (#12932)
Damian Legawiec8164cb4c42cb
diff --git a/admin/app/assets/stylesheets/spree/admin/components/_buttons.scss b/admin/app/assets/stylesheets/spree/admin/components/_buttons.scssindex f733654d53..d7fe1ca9a7 100644--- a/admin/app/assets/stylesheets/spree/admin/components/_buttons.scss+++ b/admin/app/assets/stylesheets/spree/admin/components/_buttons.scss@@ -131,7 +131,7 @@ button[disabled] .show-when-enabled { display: none; }&:hover {opacity: 0.8 !important;- background-color: $gray-100 !important;+ background-color: $gray-50 !important;}}diff --git a/admin/app/assets/stylesheets/spree/admin/components/_main.scss b/admin/app/assets/stylesheets/spree/admin/components/_main.scssindex 7d196ae6bf..21938b9fca 100644--- a/admin/app/assets/stylesheets/spree/admin/components/_main.scss+++ b/admin/app/assets/stylesheets/spree/admin/components/_main.scss@@ -276,6 +276,21 @@}}+#updater-notice {+ background-color: $white;+ width: 100%;+ display: flex;+ flex-direction: row;+ gap: 1rem;+ justify-content: flex-start;+ align-items: center;+ padding: 0.5rem 0.5rem;+ border: 1px solid $border-color;+ border-radius: $border-radius-lg;+ box-shadow: $box-shadow-xs;+}++.documentation-link-container {font-size: $font-size-sm;text-align: center;diff --git a/admin/app/controllers/spree/admin/dashboard_controller.rb b/admin/app/controllers/spree/admin/dashboard_controller.rbindex 6bfc19bf29..4621225697 100644--- a/admin/app/controllers/spree/admin/dashboard_controller.rb+++ b/admin/app/controllers/spree/admin/dashboard_controller.rb@@ -64,6 +64,12 @@ module Spreeredirect_back(fallback_location: spree.admin_dashboard_path)end+ # PATCH /admin/dashboard/dismiss_updater_notice+ def dismiss_updater_notice+ session[:spree_updater_notice_dismissed] = { value: true, expires_at: 7.days.from_now }+ redirect_back(fallback_location: spree.admin_dashboard_path)+ end+privatedef load_vendordiff --git a/admin/app/helpers/spree/admin/base_helper.rb b/admin/app/helpers/spree/admin/base_helper.rbindex 5925c3ec22..b4bcfd93dc 100644--- a/admin/app/helpers/spree/admin/base_helper.rb+++ b/admin/app/helpers/spree/admin/base_helper.rb@@ -13,6 +13,7 @@ module Spreedefined?(SpreeEnterprise)end+ # @return [Spree::Admin::Updater] the spree updaterdef spree_updater@spree_updater ||= Spree::Admin::Updaterend@@ -21,6 +22,15 @@ module Spree@spree_update_available ||= !Rails.env.test? && spree_updater.update_available?end+ def updater_notice_dismissed?+ dismissal_data = session[:spree_updater_notice_dismissed]+ dismissal_data.is_a?(Hash) && dismissal_data['expires_at'].to_time > Time.current+ end++ def show_spree_updater_notice?+ Spree::Admin::RuntimeConfig.admin_updater_enabled && can?(:manage, current_store) && spree_update_available? && !updater_notice_dismissed?+ end+# check if the current controller is a settings controller# this is used to display different sidebar navigation for settings pages# @return [Boolean]diff --git a/admin/app/models/spree/admin/updater.rb b/admin/app/models/spree/admin/updater.rbindex 8247a87d25..f5fc9fcf27 100644--- a/admin/app/models/spree/admin/updater.rb+++ b/admin/app/models/spree/admin/updater.rb@@ -5,7 +5,7 @@ require 'uri'module Spreemodule Adminclass Updater- SPREE_CLOUD_UPDATES_URL = 'https://spreecloud.io/updates.json'+ SPREE_CLOUD_UPDATES_URL = 'https://spreecloud.io/updates.json'.freeze@updates = nil@@ -13,14 +13,18 @@ module Spreefetch_updates.any?end- def self.latest_version- @latest_version ||= fetch_updates.first&.dig('version')+ def self.latest_release+ @latest_release ||= fetch_updates.first+ end++ def self.current_release+ @current_release ||= Spree.versionenddef self.fetch_updates- @updates ||= Rails.cache.fetch("spree/admin/updater/fetch_updates/#{Spree.version}", expires_in: 1.day) do+ @updates ||= Rails.cache.fetch("spree/admin/updater/fetch_updates/#{current_release}", expires_in: 1.day) douri = URI(SPREE_CLOUD_UPDATES_URL)- params = { version: Spree.version, environment: Rails.env, url: Spree::Store.current.url_or_custom_domain }+ params = { version: current_release, environment: Rails.env, url: Spree::Store.current.url_or_custom_domain }uri.query = URI.encode_www_form(params)http = Net::HTTP.new(uri.host, uri.port)diff --git a/admin/app/views/spree/admin/dashboard/_updater.html.erb b/admin/app/views/spree/admin/dashboard/_updater.html.erbindex 3e018ca7ff..1f9bc123d2 100644--- a/admin/app/views/spree/admin/dashboard/_updater.html.erb+++ b/admin/app/views/spree/admin/dashboard/_updater.html.erb@@ -1,9 +1,19 @@-<% if Spree::Admin::RuntimeConfig.admin_updater_enabled && can?(:manage, current_store) && spree_update_available? %>- <div class="alert alert-info">- <div>- <p class="mb-1">There's a newer version of Spree available.</p>+<% if show_spree_updater_notice? %>+ <div id="updater-notice" class="mb-3">+ <%= image_tag 'favicon_256x256.png', alt: 'Spree', width: 32, height: 32 %>+ <div class="d-flex flex-column">+ <p class="mb-1">+ <strong>Spree <%= spree_updater.latest_release['name'] %></strong> is available.+ <br />Your current version is <strong>Spree <%= spree_updater.current_release %></strong>.+ </p>- <%= link_to_with_icon 'settings-up', 'Update now', 'https://spreecommerce.org/docs/developer/upgrades', target: '_blank', class: 'btn btn-light btn-sm' %>+ <% if spree_updater.latest_release['url'] %>+ <div>+ <%= external_link_to "View release notes", spree_updater.latest_release['url'], target: '_blank', class: 'btn btn-sm btn-link' %>+ </div>+ <% end %></div>++ <%= link_to '', spree.admin_dismiss_updater_notice_path, data: { turbo_method: :patch }, class: 'btn-close ml-auto' %></div><% end %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/shared/sidebar/_enterprise_edition_notice.html.erb b/admin/app/views/spree/admin/shared/sidebar/_enterprise_edition_notice.html.erbindex f3d0f92cfa..901eb36e1f 100644--- a/admin/app/views/spree/admin/shared/sidebar/_enterprise_edition_notice.html.erb+++ b/admin/app/views/spree/admin/shared/sidebar/_enterprise_edition_notice.html.erb@@ -2,7 +2,7 @@<% unless session[:spree_enterprise_edition_notice_dismissed] %><section class="d-none d-lg-block"><div id="enterprise-edition-notice">- <%= link_to '', spree.admin_dismiss_enterprise_edition_notice_path, method: :patch, class: 'btn-close' %>+ <%= link_to '', spree.admin_dismiss_enterprise_edition_notice_path, data: { turbo_method: :patch }, class: 'btn-close' %><p>You're using Spree Community Edition. To get access to all features, please upgrade to Enterprise Edition.</p><%= external_link_to 'Upgrade', 'https://spreecommerce.org/pricing', target: '_blank', class: 'btn btn-link btn-sm shadow-xs' %>diff --git a/admin/config/routes.rb b/admin/config/routes.rbindex 528021f8dc..81dc5e91ff 100644--- a/admin/config/routes.rb+++ b/admin/config/routes.rb@@ -249,7 +249,8 @@ Spree::Core::Engine.add_routes doresource :dashboard, controller: 'dashboard'get '/dashboard/analytics', to: 'dashboard#analytics', as: :dashboard_analyticsget '/getting-started', to: 'dashboard#getting_started', as: :getting_started- get '/dismiss_enterprise_edition_notice', to: 'dashboard#dismiss_enterprise_edition_notice', as: :dismiss_enterprise_edition_notice+ patch '/dismiss_enterprise_edition_notice', to: 'dashboard#dismiss_enterprise_edition_notice', as: :dismiss_enterprise_edition_notice+ patch '/dismiss_updater_notice', to: 'dashboard#dismiss_updater_notice', as: :dismiss_updater_noticeroot to: 'dashboard#show'enddiff --git a/admin/spec/controllers/spree/admin/dashboard_controller_spec.rb b/admin/spec/controllers/spree/admin/dashboard_controller_spec.rbindex de5f750d77..1dda9fc288 100644--- a/admin/spec/controllers/spree/admin/dashboard_controller_spec.rb+++ b/admin/spec/controllers/spree/admin/dashboard_controller_spec.rb@@ -54,4 +54,15 @@ describe Spree::Admin::DashboardController, type: :controller doexpect(session[:spree_enterprise_edition_notice_dismissed]).to be_truthyendend++ describe '#dismiss_updater_notice' do+ it 'dismisses the updater notice' do+ patch :dismiss_updater_notice+ expect(response).to redirect_to(spree.admin_dashboard_path)+ expect(session[:spree_updater_notice_dismissed]).to include(+ value: true,+ expires_at: be_within(1.second).of(7.days.from_now)+ )+ end+ endend