Note: You can read the wkhtmltopdf edition of “How to Decrease Heroku Slug Size” series here.
Heroku is a platform as a service tool where you can host your websites easily. It is helping the teams who don’t want to maintain their own servers.
Even though Heroku is a very helpful platform for the development teams, sometimes it can introduce limitations related to how you can serve your applications. In this post, we will mention the slug size limitation of Heroku.
Heroku wants our projects to have small sizes in order to have a faster CI/CD and boot times. Compiling and deploying a project with small size is way faster than having a big one. Once you hit 300MB limit on your slug, Heroku starts warning you about the problems related to having a big slug size. The current hard limitation on Heroku is 500MB.
Our project was very close to the hard limitation of Heroku at the beginning as you can see from the image. When I connected to our application dyno with
heroku run bash command, I wanted to see what are the biggest files are. I accomplished this with
du -h | sort -rh command.
matching_inbox directory, we have our Ember application. As you can see from the image, the uncompressed version of
node_modules folder was taking 400MB of space.
What ember-cli-rails does?
Ember-cli-rails gem has multiple features, but it this post we will focus on having a single way to deploy our application with
git push command. You can see the other features here.
When you have
ember-cli-rails in your project, you can use the same way of deploying applications to Heroku. There are multiple ways to deploy an application to Heroku but the most common way is through git pushes. While heroku is compiling the application, it is also running
ember build command to build the ember application and stores the builded application in temporary folders. After the ember application is built and stored, you don’t actually need to have
node_modules folder anymore.
While investigating this issue further, I encountered with an existing github issue on
ember-cli-rails repo as Heroku Slug Size: can node_modules be deleted after build. In this issue developers shared some helpful messages which I used in this blog post as well.
Setting up heroku-buildpack-post-build-clean
You can add buildpack with
heroku buildpacks:add --index 1 https://github.com/Lostmyname/heroku-buildpack-post-build-clean command. You may need to adjust
--index parameter depending on the existing buildpacks on your application. After that, we need to define a new file called
.slug-post-clean. This file should have the ember application path and node modules and tmp folders as:
When we deploy the changes to our application, we could see a decrease on slug size but it was not enough for us to stop here.
We decreased Heroku slug size further with the changes to
wkhtmltopdf set-up and you can read that post here: How to Decrease Heroku Slug Size: WKHTMLTOPDF Edition.
Thank you for your time, I hope it can help you as well.