Merge branch 'relative-url-assets' into 'master'

Remove hard-coded absolute URLs from all frontend assets

See merge request !8831

.gitlab-ci.yml

@@ -107,7 +107,7 @@ setup-test-env:
   <<: *dedicated-runner
   stage: prepare
   script:
-    - bundle exec rake assets:precompile 2>/dev/null
+    - bundle exec rake gitlab:assets:compile 2>/dev/null
     - bundle exec ruby -Ispec -e 'require "spec_helper" ; TestEnv.init'
   artifacts:
     expire_in: 7d

app/assets/javascripts/lib/ace.js

-/*= require ace-rails-ap */
+/*= require ace/ace */
 /*= require ace/ext-searchbox */
+/*= require ./ace/ace_config_paths */

app/assets/javascripts/lib/ace/ace_config_paths.js.erb

+<%
+ace_gem_path = Bundler.rubygems.find_name('ace-rails-ap').first.full_gem_path
+ace_workers = Dir[ace_gem_path + '/vendor/assets/javascripts/ace/worker-*.js'].sort.map do |file|
+  File.basename(file, '.js').sub(/^worker-/, '')
+end
+ace_modes = Dir[ace_gem_path + '/vendor/assets/javascripts/ace/mode-*.js'].sort.map do |file|
+  File.basename(file, '.js').sub(/^mode-/, '')
+end
+%>
+
+(function() {
+  window.gon = window.gon || {};
+  var basePath = (window.gon.relative_url_root || '').replace(/\/$/, '') + '/assets/ace';
+  ace.config.set('basePath', basePath);
+
+  // configure paths for all worker modules
+<% ace_workers.each do |worker| %>
+  ace.config.setModuleUrl('ace/mode/<%= worker %>_worker', basePath + '/worker-<%= worker %>.js');
+<% end %>
+
+  // configure paths for all mode modules
+<% ace_modes.each do |mode| %>
+  ace.config.setModuleUrl('ace/mode/<%= mode %>', basePath + '/mode-<%= mode %>.js');
+<% end %>
+})();

app/models/application_setting.rb

@@ -158,7 +158,7 @@ class ApplicationSetting < ActiveRecord::Base
     Rails.cache.delete(CACHE_KEY)
   rescue
     # Gracefully handle when Redis is not available. For example,
-    # omnibus may fail here during assets:precompile.
+    # omnibus may fail here during gitlab:assets:compile.
   end
   def self.cached

changelogs/unreleased/relative-url-assets.yml

+---
+title: allow relative url change without recompiling frontend assets
+merge_request: 8831
+author:

doc/administration/raketasks/maintenance.md

@@ -172,14 +172,14 @@ Omnibus packages.
 ```
 cd /home/git/gitlab
-sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production
+sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production
 ```
 For omnibus versions, the unoptimized assets (JavaScript, CSS) are frozen at
 the release of upstream GitLab. The omnibus version includes optimized versions
 of those assets. Unless you are modifying the JavaScript / CSS code on your
 production machine after installing the package, there should be no reason to redo
-rake assets:precompile on the production machine. If you suspect that assets
+rake gitlab:assets:compile on the production machine. If you suspect that assets
 have been corrupted, you should reinstall the omnibus package.
 ## Tracking Deployments

doc/api/commits.md

@@ -245,7 +245,7 @@ Example response:
 ```json
 [
   {
-    "diff": "--- a/doc/update/5.4-to-6.0.md\n+++ b/doc/update/5.4-to-6.0.md\n@@ -71,6 +71,8 @@\n sudo -u git -H bundle exec rake migrate_keys RAILS_ENV=production\n sudo -u git -H bundle exec rake migrate_inline_notes RAILS_ENV=production\n \n+sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production\n+\n ```\n \n ### 6. Update config files",
+    "diff": "--- a/doc/update/5.4-to-6.0.md\n+++ b/doc/update/5.4-to-6.0.md\n@@ -71,6 +71,8 @@\n sudo -u git -H bundle exec rake migrate_keys RAILS_ENV=production\n sudo -u git -H bundle exec rake migrate_inline_notes RAILS_ENV=production\n \n+sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production\n+\n ```\n \n ### 6. Update config files",
     "new_path": "doc/update/5.4-to-6.0.md",
     "old_path": "doc/update/5.4-to-6.0.md",
     "a_mode": null,

doc/install/installation.md

@@ -448,7 +448,7 @@ Check if GitLab and its environment are configured correctly:
 ### Compile Assets
-    sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production
+    sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production
 ### Start Your GitLab Instance

doc/install/relative_url.md

@@ -113,14 +113,6 @@ Make sure to follow all steps below:
     If you are using a custom init script, make sure to edit the above
     gitlab-workhorse setting as needed.
-1.  After all the above changes recompile the assets. This is an important task
-    and will take some time to complete depending on the server resources:
-
-    ```
-    cd /home/git/gitlab
-    sudo -u git -H bundle exec rake assets:clean assets:precompile RAILS_ENV=production
-    ```
-
 1. [Restart GitLab][] for the changes to take effect.
 ### Disable relative URL in GitLab

doc/update/patch_versions.md

@@ -57,7 +57,7 @@ sudo -u git -H bundle clean
 sudo -u git -H bundle exec rake db:migrate RAILS_ENV=production
 # Clean up assets and cache
-sudo -u git -H bundle exec rake assets:clean assets:precompile cache:clear RAILS_ENV=production
+sudo -u git -H bundle exec rake gitlab:assets:clean gitlab:assets:compile cache:clear RAILS_ENV=production
 ```
 ### 4. Update gitlab-workhorse to the corresponding version

lib/gitlab/upgrader.rb

@@ -61,7 +61,7 @@ module Gitlab
         "Switch to new version" => %W(#{Gitlab.config.git.bin_path} checkout v#{latest_version}),
         "Install gems" => %W(bundle),
         "Migrate DB" => %W(bundle exec rake db:migrate),
-        "Recompile assets" => %W(bundle exec rake assets:clean assets:precompile),
+        "Recompile assets" => %W(bundle exec rake gitlab:assets:clean gitlab:assets:compile),
         "Clear cache" => %W(bundle exec rake cache:clear)
       }
     end

lib/support/deploy/deploy.sh

@@ -31,8 +31,8 @@ echo 'Deploy: Bundle and migrate'
 sudo -u git -H bundle --without aws development test mysql --deployment
 sudo -u git -H bundle exec rake db:migrate RAILS_ENV=production
-sudo -u git -H bundle exec rake assets:clean RAILS_ENV=production
-sudo -u git -H bundle exec rake assets:precompile RAILS_ENV=production
+sudo -u git -H bundle exec rake gitlab:assets:clean RAILS_ENV=production
+sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production
 sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production
 # return stashed changes (if necessary)

lib/tasks/gitlab/assets.rake

+namespace :gitlab do
+  namespace :assets do
+    desc 'GitLab | Assets | Compile all frontend assets'
+    task :compile do
+      Rake::Task['assets:precompile'].invoke
+      Rake::Task['gitlab:assets:fix_urls'].invoke
+    end
+
+    desc 'GitLab | Assets | Clean up old compiled frontend assets'
+    task :clean do
+      Rake::Task['assets:clean'].invoke
+    end
+
+    desc 'GitLab | Assets | Remove all compiled frontend assets'
+    task :purge do
+      Rake::Task['assets:clobber'].invoke
+    end
+
+    desc 'GitLab | Assets | Fix all absolute url references in CSS'
+    task :fix_urls do
+      css_files = Dir['public/assets/*.css']
+      css_files.each do | file |
+        # replace url(/assets/*) with url(./*)
+        puts "Fixing #{file}"
+        system "sed", "-i", "-e", 's/url(\([\"\']\?\)\/assets\//url(\1.\//g', file
+
+        # rewrite the corresponding gzip file (if it exists)
+        gzip = "#{file}.gz"
+        if File.exist?(gzip)
+          puts "Fixing #{gzip}"
+
+          FileUtils.rm(gzip)
+          mtime = File.stat(file).mtime
+
+          File.open(gzip, 'wb+') do |f|
+            gz = Zlib::GzipWriter.new(f, Zlib::BEST_COMPRESSION)
+            gz.mtime = mtime
+            gz.write IO.binread(file)
+            gz.close
+
+            File.utime(mtime, mtime, f.path)
+          end
+        end
+      end
+    end
+  end
+end