Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Improve the updater widget (#14316)

Damian Legawiec8332de382423
diff --git a/spree/admin/app/models/spree/admin/updater.rb b/spree/admin/app/models/spree/admin/updater.rb
index 214302c1ac..d899ad65e9 100644
--- a/spree/admin/app/models/spree/admin/updater.rb
+++ b/spree/admin/app/models/spree/admin/updater.rb
@@ -7,25 +7,42 @@ module Spree
class Updater
SPREE_CLOUD_UPDATES_URL = 'https://spreecloud.io/updates.json'.freeze
- @updates = nil
+ class << self
+ def update_available?
+ fetch_updates.any?
+ end
- def self.update_available?
- fetch_updates.any?
- end
+ def latest_release
+ fetch_updates.first
+ end
- def self.latest_release
- @latest_release ||= fetch_updates.first
- end
+ def current_release
+ Spree.version
+ end
- def self.current_release
- @current_release ||= Spree.version
- end
+ # Returns the releases newer than the running version, fetched from
+ # spreecloud.io and cached for a day. The request carries only the
+ # running version, +Rails.env+, the storefront URL and the anonymous
+ # {Spree.install_id}. Failures are cached as an empty list too, so an
+ # unreachable endpoint costs at most one timed-out request per day.
+ #
+ # @return [Array<Hash>] newer releases, newest first
+ def fetch_updates
+ Rails.cache.fetch("spree/admin/updater/fetch_updates/#{current_release}", expires_in: 1.day) do
+ fetch_updates_from_spree_cloud
+ end
+ end
- def self.fetch_updates
- @updates ||= Rails.cache.fetch("spree/admin/updater/fetch_updates/#{current_release}", expires_in: 1.day) do
+ private
+
+ def fetch_updates_from_spree_cloud
uri = URI(SPREE_CLOUD_UPDATES_URL)
- params = { version: current_release, environment: Rails.env, url: Spree::Store.current.url_or_custom_domain }
- uri.query = URI.encode_www_form(params)
+ uri.query = URI.encode_www_form(
+ version: current_release,
+ environment: Rails.env,
+ url: Spree::Current.store&.storefront_url,
+ install_id: Spree.install_id
+ )
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
@@ -33,13 +50,11 @@ module Spree
http.read_timeout = 1 # 1s timeout for reading the response
response = http.get(uri)
- return {} unless response.is_a?(Net::HTTPSuccess)
-
- JSON.parse(response.body)
+ response.is_a?(Net::HTTPSuccess) ? JSON.parse(response.body) : []
+ rescue StandardError => e
+ Rails.error.report(e)
+ []
end
- rescue StandardError => e
- Rails.error.report(e)
- {}
end
end
end
diff --git a/spree/admin/spec/models/spree/admin/updater_spec.rb b/spree/admin/spec/models/spree/admin/updater_spec.rb
new file mode 100644
index 0000000000..fe5360d43c
--- /dev/null
+++ b/spree/admin/spec/models/spree/admin/updater_spec.rb
@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::Updater do
+ let(:memory_store) { ActiveSupport::Cache::MemoryStore.new }
+ let(:releases) do
+ [{ 'name' => '9.9.9', 'tag_name' => 'v9.9.9', 'url' => 'https://github.com/spree/spree/releases/tag/v9.9.9' }]
+ end
+
+ before do
+ allow(Rails).to receive(:cache).and_return(memory_store)
+ end
+
+ def stub_spree_cloud(success: true, body: releases.to_json)
+ http = instance_double(Net::HTTP, 'use_ssl=': nil, 'open_timeout=': nil, 'read_timeout=': nil)
+ allow(Net::HTTP).to receive(:new).and_return(http)
+
+ response = double('response', body: body)
+ allow(response).to receive(:is_a?) { |klass| success && klass == Net::HTTPSuccess }
+ allow(http).to receive(:get) do |uri|
+ @requested_uri = uri
+ response
+ end
+
+ http
+ end
+
+ describe '.fetch_updates' do
+ it 'reports version, environment, storefront url and the anonymous install id' do
+ stub_spree_cloud
+
+ described_class.fetch_updates
+
+ params = Rack::Utils.parse_query(@requested_uri.query)
+ expect(params['version']).to eq(Spree.version)
+ expect(params['environment']).to eq('test')
+ expect(params['url']).to eq(Spree::Current.store.storefront_url)
+ expect(params['install_id']).to eq(Spree.install_id)
+ end
+
+ it 'returns the parsed release list' do
+ stub_spree_cloud
+
+ expect(described_class.fetch_updates).to eq(releases)
+ expect(described_class.update_available?).to be true
+ expect(described_class.latest_release['name']).to eq('9.9.9')
+ end
+
+ it 'returns an empty list on a non-success response and caches it' do
+ http = stub_spree_cloud(success: false, body: 'oops')
+
+ expect(described_class.fetch_updates).to eq([])
+ expect(described_class.update_available?).to be false
+ expect(http).to have_received(:get).once
+ end
+
+ it 'returns an empty list and reports the error when the request raises' do
+ http = stub_spree_cloud
+ allow(http).to receive(:get).and_raise(Net::OpenTimeout)
+ allow(Rails.error).to receive(:report)
+
+ expect(described_class.fetch_updates).to eq([])
+ expect(Rails.error).to have_received(:report).with(instance_of(Net::OpenTimeout))
+ end
+ end
+end
diff --git a/spree/core/lib/spree/core.rb b/spree/core/lib/spree/core.rb
index f4fafaf4c6..e7fe77c959 100644
--- a/spree/core/lib/spree/core.rb
+++ b/spree/core/lib/spree/core.rb
@@ -180,6 +180,22 @@ module Spree
->(locale) { locale.name == Spree::Current.content_locale }
end
+ # Stable anonymous identifier for this Spree installation. Generated once,
+ # persisted in the preferences store and reused afterwards. It identifies the
+ # installation only
+ #
+ # Deliberately not memoized: the persisted preference is the single source
+ # of truth, so processes that race to generate the first value converge on
+ # the winning row at the next read instead of each holding a different id
+ # for their lifetime.
+ #
+ # @return [String] UUID
+ def self.install_id
+ store = Spree::Preferences::Store.instance
+ store.get('spree/install_id') { nil }.presence ||
+ SecureRandom.uuid.tap { |id| store.set('spree/install_id', id) }
+ end
+
# Used to configure Spree.
#
# Example:
diff --git a/spree/core/spec/lib/spree/core_spec.rb b/spree/core/spec/lib/spree/core_spec.rb
index 36ca886982..dbee6094fb 100644
--- a/spree/core/spec/lib/spree/core_spec.rb
+++ b/spree/core/spec/lib/spree/core_spec.rb
@@ -107,4 +107,28 @@ describe Spree do
end
end
+ describe '.install_id' do
+ let(:store) { Spree::Preferences::Store.instance }
+
+ around do |example|
+ store.delete('spree/install_id')
+ example.run
+ store.delete('spree/install_id')
+ end
+
+ it 'generates a UUID, persists it and returns the same value on subsequent calls' do
+ id = described_class.install_id
+
+ expect(id).to match(/\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
+ expect(store.get('spree/install_id') { nil }).to eq(id)
+ expect(described_class.install_id).to eq(id)
+ end
+
+ it 'reuses an identifier already persisted in the preferences store' do
+ store.set('spree/install_id', 'already-persisted-id')
+
+ expect(described_class.install_id).to eq('already-persisted-id')
+ end
+ end
+
end