Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Engine server hook #347

Closed
wants to merge 6 commits into from
+167 −0
Closed

Engine server hook #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f77a0ce
Engine server hook
bruno- Apr 18, 2024
534a840
The tailwindcss watch process must not steal keystrokes
flavorjones Apr 27, 2024
355ed62
Use ServerProcess class
bruno- Apr 29, 2024
eed5343
Add config.tailwindcss.server_process option
bruno- Apr 29, 2024
7265220
Enable server process only for new installs
bruno- Apr 29, 2024
b4879aa
Ensure ServerProcess is started only once
bruno- Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions lib/install/tailwindcss.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
APPLICATION_LAYOUT_PATH = Rails.root.join("app/views/layouts/application.html.erb")
CENTERING_CONTAINER_INSERTION_POINT = /^\s*<%= yield %>/.freeze
DEVELOPMENT_ENVIRONMENT_CONFIG_PATH = Rails.root.join("config/environments/development.rb")

if APPLICATION_LAYOUT_PATH.exist?
say "Add Tailwindcss include tags and container element in application layout"
Expand All @@ -16,6 +17,15 @@
say %( Add <%= stylesheet_link_tag "tailwind", "inter-font", "data-turbo-track": "reload" %> within the <head> tag in your custom layout.)
end

if DEVELOPMENT_ENVIRONMENT_CONFIG_PATH.exist?
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will enable the "server process" only for new installs.

I opted for this solution over creating an initializer file because:

  • It's one file less to manage
  • Config options belong to config/environments/*, not initializers

say "Enable Tailwindcss server process in development"
insert_into_file DEVELOPMENT_ENVIRONMENT_CONFIG_PATH.to_s, <<~ERB.indent(2), before: /^end$/

# Automatically watch and build Tailwindcss when 'rails server' is started.
config.tailwindcss.server_process = true
ERB
end

say "Build into app/assets/builds"
empty_directory "app/assets/builds"
keep_file "app/assets/builds"
Expand Down
1 change: 1 addition & 0 deletions lib/tailwindcss-rails.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ module Tailwindcss
require_relative "tailwindcss/version"
require_relative "tailwindcss/engine"
require_relative "tailwindcss/commands"
require_relative "tailwindcss/server_process"
7 changes: 7 additions & 0 deletions lib/tailwindcss/engine.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

module Tailwindcss
class Engine < ::Rails::Engine
config.tailwindcss = ActiveSupport::OrderedOptions.new
config.tailwindcss.server_process = false # Rails.env.development?
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If (or when) you decide to make "server process" the default for all:

  • Just set the tailwindcss.server_process option value to Rails.env.development? (propshaft does it like that)
  • Optionally remove the if DEVELOPMENT_ENVIRONMENT_CONFIG_PATH.exist? section from lib/install/tailwindcss.rb


initializer "tailwindcss.assets" do
Rails.application.config.assets.precompile += %w( inter-font.css )
end
Expand All @@ -13,5 +16,9 @@ class Engine < ::Rails::Engine
config.app_generators do |g|
g.template_engine :tailwindcss
end

server do
flavorjones marked this conversation as resolved.
Show resolved Hide resolved
ServerProcess.start if config.tailwindcss.server_process
end
end
end
149 changes: 149 additions & 0 deletions lib/tailwindcss/server_process.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
module Tailwindcss
class ServerProcess
attr_reader :server, :pid

def self.start
new.start
end

def initialize
@server = Server.new(self)
end

def start
@pid = existing_process || start_process
server.monitor_process
server.exit_hook
end

def stop
return if dead?

Process.kill(:INT, pid)
Process.wait(pid)
rescue Errno::ECHILD, Errno::ESRCH
end

def dead?
Process.wait(pid, Process::WNOHANG)
false
rescue Errno::ECHILD, Errno::ESRCH
true
end

private

def existing_process
if (pid = Pidfile.pid)
begin
Process.kill 0, pid
pid
rescue Errno::ESRCH
# Process does not exist
rescue Errno::EPERM
# Ignore process owned by another user
end
end
end

def start_process
pid = fork do
Pidfile.write
monitor_server
exit_hook
# Using IO.popen(command, 'r+') will avoid watch_command read from $stdin.
# If we use system(*command) instead, IRB and Debug can't read from $stdin
# correctly bacause some keystrokes will be taken by watch_command.
IO.popen(Commands.watch_command, 'r+') do |io|
IO.copy_stream(io, $stdout)
end
ensure
Pidfile.delete
end
Process.detach pid
pid
end

def monitor_server
Thread.new do
loop do
if server.dead?
puts "Tailwind detected server has gone away"
exit
end
sleep 2
end
end
end

def exit_hook
at_exit do
puts "Stopping tailwind..."
server.stop
end
end

module Pidfile
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pidfile is a solution to a problem described here: #347 (comment)

def self.path
Rails.root.join("tmp", "pids", "tailwindcss.txt")
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New rails app already have tmp/pids/ dir https://github.com/rails/rails/blob/92591ebd54e044ff3f3b9d802fe65f69cb7e34f2/railties/lib/rails/generators/rails/app/app_generator.rb#L257-L260

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why txt?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is similar to turning the cache on or off, touch restart.txt, etc.

end

def self.read
File.read(path, mode: "rb:UTF-8")
rescue Errno::ENOENT
# File does not exist
end

def self.write
File.write(path, Process.pid, mode: "wb:UTF-8")
end

def self.delete
File.exist?(path) && File.delete(path)
end

def self.pid
Integer(read)
rescue ArgumentError, TypeError
# Invalid content
delete
end
end

class Server
attr_reader :process, :pid

def initialize(process)
@process = process
@pid = Process.pid
end

def monitor_process
Thread.new do
loop do
if process.dead?
puts "Detected tailwind has gone away, stopping server..."
exit
end
sleep 2
end
end
end

def exit_hook
at_exit do
process.stop
end
end

def dead?
Process.ppid != pid
end

def stop
Process.kill(:INT, pid)
rescue Errno::ECHILD, Errno::ESRCH
end
end
end
end
Loading