[#1][Backend] Setup project

[captainnimble]

[Backend] Setup project

What happened 👀

To ensure that everything works properly after setting up the project and using the codebase from rails-template on different Ruby versions, Rails versions, and Node versions

• Changed gem psych version from < 4.0 to 3.3.4

Insight 📝

From this StackOverflow answer, mention is made of a major change in Ruby 3.1 with Psych 4.0 that is incompatible with Ruby 3.0.

For Psych version 4.0.0 or above working with rails-template, there will be an error about saf_load (see picture below).

Proof Of Work 📹

Set gem psych to version below 4.0.0

Running the server locally works properly.

[byhbt]

hi @captainnimble !
Could you please share which Ruby version you use for this project? 🤔 In the ticket description I see you mention about Ruby 3.1. However, when checking out the source code locally, I see a different version. Ruby 3.2.1 in the .tool-version. I am not sure which version we will use.

At Nimble, for the development dependencies (Ruby, Node, Yarn, Elixir,...) we use asdf for manage the version. So if you intent to use the Ruby v3.1 please update the file .tool-version in this codebase as well.

[captainnimble]

In this project I use

• Ruby 3.2.1
• Rails 7.0.4.3
• Node 19.8.1

I mention Ruby 3.1 because there is a major change in the gem psych version since Ruby 3.1 that also affects the above version.

[longnd]

this comment does not reflect the actual situation. What does it mean by "conflicts with rails-template"?

[captainnimble]

I tried to create a rails app without a template using Ruby 3.2.1 without downgrading Psych to version 3, and everything worked fine. So, I think there will be some issue that does not work properly in the template.

I might be misunderstanding the root issue in this case.

[longnd]

You mean you created the project without using the Rails template, and it worked, right?
It's because Rails template uses the Figaro gem, and it will break if you use Ruby 3.1 and above (which requires psych v4).
So, even if you initialized the project without the Rails template, later, if you add the Figaro gem (or any other gem that depends on psynch but has not been updated to work with psynch v4), it will break again.
Check this issue for more details
nimblehq/rails-templates#316.

So instead of forcing psych < 4.0, I would suggest, either

• Removing the Figaro gem, replacing by https://github.com/bkeepers/dotenv. The end purpose is to allow the loading of different configuration per environment (we're making these changes in Rails template [gh394] Remove the Figaro gem dependency nimblehq/rails-templates#400)
• Downgrading Ruby to a lower version ( Ruby 3.0.x)

[longnd]

also to clarify: in the end, did you use the Rails-template to initialize this project?

[longnd]

the root cause is that Ruby 3.1 comes with psych v4 which is a breaking change. But the gem file here is limiting the version to < 4 already. So why we need to set a specific version 3.3.4?

[captainnimble]

The line gem 'psych', '< 4.0, is that I accidentally committed it with initial commit. I think it can make some confused, so I set it to a specific version to have a clear understanding, and 3.3.4 is the latest version before 4.0.