Fork `solidus_frontend` into a separate repo #1

gsmendoza · 2022-04-04T07:27:10Z

Dependencies

Dependent on #2.

Status

Wasn't able to update yet:

Gem scripts
GitHub config

TODOs

Test on CircleCI - realized only now that I can probably test the repo on my gsmendoza CircleCI account.
Rebuild SolidusLegacyFrontend as a Solidus extension.
Instead of pointing SolidusLegacyFrontend to Solidus, point the gem to Solidus' subprojects instead (excluding SolidusFrontend, of course).
No longer applicable - Test if renaming the manifest.js will break production apps depending on SolidusFrontend.
Update Gemfile - Remove :frontend group.
Update README
- Add notice to let new users know that this is not the recommended frontend anymore.
- Rename "Testing" to "Contributing".
Update Gem summary - We could also link to the new recommended starter frontend.
Test if solidus frontend can be added to an app AFTER Solidus has been installed on it (without any frontend).
Ensure that SolidusFrontend will allow backward compatibility for Solidus starting with 3.2.0.alpha.

Files

gsmendoza · 2022-04-05T09:44:34Z

Gemfile

+gem 'solidus', github: 'gsmendoza/solidus',
+  branch: 'gsmendoza/eng-311-remove-solidus_frontend-from-solidus-gem'


This GitHub branch is temporary.

gsmendoza · 2022-04-05T09:45:23Z

bin/sandbox

@@ -53,7 +53,8 @@ fi
 cd ./sandbox
 cat <<RUBY >> Gemfile

-gem 'solidus', path: '..'
+gem 'solidus', github: 'gsmendoza/solidus', branch: 'gsmendoza/eng-311-remove-solidus_frontend-from-solidus-gem'


This GitHub branch is temporary.

waiting-for-dev · 2022-04-06T04:29:32Z

Gemfile

@@ -48,7 +51,7 @@ group :backend, :frontend, :core, :api do
  gem 'factory_bot_rails', '>= 4.8', require: false
 end

-group :backend, :frontend do
+group :frontend do


Probably we can remove wrapping with group :frontend altogether. I mean, now, that's THE group 🙂

I removed the groups in the new update.

waiting-for-dev · 2022-04-06T04:39:55Z

Rakefile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true

+require 'bundler'


Probably, for the Rakefile and CI, we should take now what extensions do. Take solidus_subscriptions as an example. Do you think that's something doable here?

I like the idea of rebuilding SolidusLegacyFrontend as a Solidus extension. It would make the support code consistent with the extensions we already have. I'll give it a try 👍

I rebuilt SolidusFrontend as an extension in the new PR update.

waiting-for-dev · 2022-04-06T04:41:55Z

bin/build

@@ -7,28 +7,7 @@ export DB=${DB:-postgresql}

 bin/setup

-echo "***********************"


Similarly, could we use the extensions format for the bin folder?

waiting-for-dev · 2022-04-06T04:44:15Z

config/initializers/assets.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true

-Rails.application.config.assets.precompile << 'solidus_frontend_manifest.js'
+Rails.application.config.assets.precompile << 'solidus_legacy_frontend_manifest.js'


Isn't it going to break applications using solidus_frontend now? If so, we could just keep the old name.

I'm not sure if it will break apps in productions. I'll test it first.

I retained the SolidusFrontend name in the new PR update.

waiting-for-dev · 2022-04-06T04:46:01Z

solidus_legacy_frontend.gemspec

-  s.name        = 'solidus_frontend'
-  s.version     = Spree.solidus_version
+  s.name        = 'solidus_legacy_frontend'
+  s.version     = Spree::Frontend.version
  s.summary     = 'Cart and storefront for the Solidus e-commerce project.'


We could also link to the new recommended starter frontend.

waiting-for-dev

Thanks, @gsmendoza for this master-watchmaker job 🙂

Other comments:

I would add a notice in the README to let new users know that this is not the recommended frontend anymore.
We're not adding tests to the host application if I'm not wrong. So I think the "Testig" section in the README should instead be called "Contributing".
Did you try running tests on docker?

gsmendoza · 2022-04-06T07:14:15Z

Thank you @waiting-for-dev for the review and the kind compliment :) I'm listing my TODOs for this below. Let me know I missed anything:

Test on CircleCI - realized only now that I can probably test the repo on my gsmendoza CircleCI account.
Rebuild SolidusLegacyFrontend as a Solidus extension.
Instead of pointing SolidusLegacyFrontend to Solidus, point the gem to Solidus' subprojects instead (excluding SolidusFrontend, of course).
Test if renaming the manifest.js will break production apps depending on SolidusFrontend.
Update Gemfile - Remove :frontend group.
Update README
- Add notice to let new users know that this is not the recommended frontend anymore.
- Rename "Testing" to "Contributing".
Update Gem summary - We could also link to the new recommended starter frontend.

waiting-for-dev · 2022-04-06T12:56:55Z

Instead of pointing SolidusLegacyFrontend to Solidus, point the gem to Solidus' subprojects instead (excluding SolidusFrontend, of course).

I think you'll only need solidus_core & solidus_api.

Looks good @gsmendoza, thanks!!

Ensured that `bundle exec rake changelog` is working.

Fixes following error when running `rake extension:specs`: ``` Don't know how to build task 'db:reset' ```

Ensure that sandbox loads only the SolidusFrontend from the root dir.

Updates .gitignore.

Also add a warning that since the frontend engine is still part of the Solidus meta-gem, we need to make sure to enable these configurations only if they haven't already been enabled in the `spree.rb` initializer.

Code doesn't pass RuboCop.

When SolidusFrontend was part of Solidus, its version was lockstep with the other components of Solidus. As such, during this fork, there's no need to make SolidusFrontend 3.2.0.alpha compatible with older versions of Solidus. However, future versions of SolidusFrontend would be expected to provide backward compatibility to supported versions of Solidus.

As suggested in rubygems/bundler#7346 (comment).

Fixes `Webdrivers::BrowserNotFound` errors in CI.

The default changed on Rails 7. See: - https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#active-storage-default-variant-processor-changed-to-vips - rails/rails#42744

* Add notice to let new users know that this is not the recommended frontend anymore. * Rename "Testing" to "Contributing".

Remove bundler workaround. No longer needed.

Will be updated in the next commit.

* Update GitHub and CircleCI links. * Change `bin/rspec` to `bundle exec rspec`. * Remove section on running Solidus test suites.

gsmendoza · 2022-07-04T09:48:44Z

Hi @kennyadsl . I made the following updates. Appreciate if you can review!

Fix: Remove some non-frontend code from Solidus that I missed in Inline Solidus Frontend #2 .
Fix: Decouple the Solidus API and Core versions from the frontend version
Fix: Ensure that SolidusFrontend can be installed on an app that already had Solidus installed on it (without a frontend).

Walkthrough

2022-07-04.17-10-47-solidus-frontend-pr-1-update.mp4

Demo

2022-07-04.17-41-00.solidus-frontend.pr.1.demo.mp4

kennyadsl

👍 Thanks George!

gsmendoza self-assigned this Apr 4, 2022

gsmendoza force-pushed the gsmendoza/eng-310-fork-solidus_frontend-into-a-separate branch 3 times, most recently from 92a556f to 0da4946 Compare April 5, 2022 09:12

gsmendoza changed the base branch from master to gsmendoza/eng-310-fork-solidus_frontend-into-a-separate--inline-frontend April 5, 2022 09:41

gsmendoza commented Apr 5, 2022

View reviewed changes

gsmendoza force-pushed the gsmendoza/eng-310-fork-solidus_frontend-into-a-separate branch from 0da4946 to 6201cc5 Compare April 5, 2022 09:48

gsmendoza force-pushed the gsmendoza/eng-310-fork-solidus_frontend-into-a-separate--inline-frontend branch from c1007e6 to fce3ee9 Compare April 5, 2022 10:15

gsmendoza force-pushed the gsmendoza/eng-310-fork-solidus_frontend-into-a-separate branch from 6201cc5 to f73eb42 Compare April 5, 2022 10:15

waiting-for-dev mentioned this pull request Apr 6, 2022

Inline Solidus Frontend #2

Merged

waiting-for-dev reviewed Apr 6, 2022

View reviewed changes

gsmendoza changed the base branch from gsmendoza/eng-310-fork-solidus_frontend-into-a-separate--inline-frontend to master April 11, 2022 07:08

gsmendoza force-pushed the gsmendoza/eng-310-fork-solidus_frontend-into-a-separate branch 5 times, most recently from 344a2d6 to 7eba458 Compare April 12, 2022 10:33

gsmendoza force-pushed the gsmendoza/eng-310-fork-solidus_frontend-into-a-separate branch 5 times, most recently from eef7a8e to 5a32917 Compare April 26, 2022 10:07

gsmendoza added 25 commits July 4, 2022 17:29

Move changelog files to root directory

66c209f

Ensured that `bundle exec rake changelog` is working.

Re-add DummyApp rake tasks

be40838

Fixes following error when running `rake extension:specs`: ``` Don't know how to build task 'db:reset' ```

Move bin development files to root dir

1f6e056

Ensure that sandbox Solidus dependencies match those from Gemfile

48e3705

Ensure that sandbox loads only the SolidusFrontend from the root dir.

Move default extension config files to root dir

53259aa

Updates .gitignore.

Update gem release version file path

a8c6b3d

Test gem in CircleCI

8c13f19

Temporarily restore Solidus install generator

e48f58d

Retain only frontend installation from solidus:install generator

87b52c6

Move SolidusFrontend extension generator to lib

1ddbbc2

Remove non-frontend installation code from generator

71e2e78

Merge frontend generator from Solidus into SolidusFrontend generator

6367c14

Comment out SolidusFrontend initializer configurations

9227211

Also add a warning that since the frontend engine is still part of the Solidus meta-gem, we need to make sure to enable these configurations only if they haven't already been enabled in the `spree.rb` initializer.

Delete temporary SolidusFrontend extension directory

d14fb84

Skip linting code for the moment

ddac53a

Code doesn't pass RuboCop.

Decouple the Solidus API and Core versions from the frontend version

a717a9b

Wrap Solidus gems in git block instead of using glob option

b445212

As suggested in rubygems/bundler#7346 (comment).

Install Chrome driver before running tests

fae11d4

Fixes `Webdrivers::BrowserNotFound` errors in CI.

Update default image processing library to vips

3892680

The default changed on Rails 7. See: - https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#active-storage-default-variant-processor-changed-to-vips - rails/rails#42744

Update README

70d636d

* Add notice to let new users know that this is not the recommended frontend anymore. * Rename "Testing" to "Contributing".

Point to SolidusStarterFrontend in gem summary

b9b11fb

Allow RAILS_VERSION to be overridden

0ca8bbf

Remove bundler workaround. No longer needed.

Copy "Developing Solidus" section without changes from Solidus

3038f38

Will be updated in the next commit.

Update "Developing Solidus Frontend" section

b4ea5c6

* Update GitHub and CircleCI links. * Change `bin/rspec` to `bundle exec rspec`. * Remove section on running Solidus test suites.

gsmendoza force-pushed the gsmendoza/eng-310-fork-solidus_frontend-into-a-separate branch from 2feeea4 to b4ea5c6 Compare July 4, 2022 09:29

kennyadsl approved these changes Jul 4, 2022

View reviewed changes

kennyadsl merged commit c91cdee into master Jul 4, 2022

kennyadsl deleted the gsmendoza/eng-310-fork-solidus_frontend-into-a-separate branch July 4, 2022 15:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fork `solidus_frontend` into a separate repo #1

Fork `solidus_frontend` into a separate repo #1

gsmendoza commented Apr 4, 2022 •

edited

gsmendoza Apr 5, 2022

gsmendoza Apr 5, 2022

waiting-for-dev Apr 6, 2022

gsmendoza Apr 27, 2022

waiting-for-dev Apr 6, 2022

gsmendoza Apr 6, 2022

gsmendoza Apr 27, 2022

waiting-for-dev Apr 6, 2022

waiting-for-dev Apr 6, 2022

gsmendoza Apr 6, 2022

gsmendoza Apr 27, 2022

waiting-for-dev Apr 6, 2022

waiting-for-dev left a comment •

edited

gsmendoza commented Apr 6, 2022

waiting-for-dev commented Apr 6, 2022

gsmendoza commented Jul 4, 2022

kennyadsl left a comment

		gem 'solidus', github: 'gsmendoza/solidus',
		branch: 'gsmendoza/eng-311-remove-solidus_frontend-from-solidus-gem'

		@@ -1,5 +1,6 @@
		# frozen_string_literal: true

		require 'bundler'

		@@ -7,28 +7,7 @@ export DB=${DB:-postgresql}

		bin/setup

		echo "***********************"

Fork solidus_frontend into a separate repo #1

Fork solidus_frontend into a separate repo #1

Conversation

gsmendoza commented Apr 4, 2022 • edited

Dependencies

Status

TODOs

Files

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

waiting-for-dev left a comment • edited

Choose a reason for hiding this comment

gsmendoza commented Apr 6, 2022

waiting-for-dev commented Apr 6, 2022

gsmendoza commented Jul 4, 2022

Walkthrough

Demo

kennyadsl left a comment

Choose a reason for hiding this comment

Fork `solidus_frontend` into a separate repo #1

Fork `solidus_frontend` into a separate repo #1

gsmendoza commented Apr 4, 2022 •

edited

waiting-for-dev left a comment •

edited