Cache babel-transpiled code #352

vadimdemedes · 2015-12-22T16:38:43Z

Originated from #351, inspired from #189.

This PR was created to avoid retranspiling test files on every run and even require('babel-core'). MD5 hash of test file gets calculated and if stored hash equals current hash, AVA loads transpiled code from cache.

vadimdemedes · 2015-12-22T16:44:02Z

Compared to master branch (see results in #351), now test runs take ~0.7s, given the same test files.

jamestalmage · 2015-12-22T16:57:57Z

I don't think we should put cached files in the home dir. Users will not be able to find and clear them. For nyc we settled on node_modules/.cache/nyc, the equivalent for use would be node_modules/.cache/ava. This means users will clear the cache themselves if they trash node_modules and reinstall (even if they don't know the cache is there). If we convince enough modules to adapt that pattern, it also makes trash node_modules/.cache a standard way to clear caches.

If you are storing in the home dir, then you need to take extra care salting the hash with the versions of Babel and every plugin used. That would still be a good idea in a local cache, but less critical since it's easier to clear the cache.

sindresorhus · 2015-12-22T17:01:25Z

I like the node_modules/.cache convention.

sindresorhus · 2015-12-22T17:01:37Z

// @floatdrop

vadimdemedes · 2015-12-22T17:01:51Z

Good suggestion! Update is coming.

jamestalmage · 2015-12-22T17:08:08Z

also, I wrote caching-transform for nyc. My intent was to use it here as well. Similar to cacha, but intended specifically for transforms.

vadimdemedes · 2015-12-22T17:41:36Z

@sindresorhus @jamestalmage PR updated to store cache in node_modules/.cache/ava. Do you have other things in mind or we can merge it in?

jamestalmage · 2015-12-22T17:55:15Z

lib/babel.js

-	appendPaths: module.paths
-});
+var cachePath = hasha(testPath);
+var hashPath = hasha(testPath) + '_hash';


cachePath + '_hash'
instead of invoking hasha twice

sindresorhus · 2015-12-22T19:55:26Z

LGTM. @jamestalmage ?

Tried it on got (6.0.0 branch). First uncached run 17 sec, and second cached run 7 sec.

jamestalmage · 2015-12-23T03:36:59Z

The cache is currently saved in ./node_modules/ava/node_modules/.cache/ava, whereas I think it should be in ./node_modules/.cache/ava. That is how I did it in nyc, and my hope was we would all store our cache content in a single directory that was easy to delete.

I think the solution to this is to do:

pkgDir.sync(path.dirname(filename))

However, there is a chance they are using a global install, and do not have a package.json anywhere. I think we just disable caching in that situation, I do not like the idea of users having to hunt down were we are hiding the global cache.

nyc is starting with caching disabled by default for the time being. It is enabled with a --cache argument. I think we should do the opposite. Enable by default and provide a --no-cache argument. That could help eliminate the cache as the source of some difficult problem down the road.

We should probably salt the hash with babel.version as well (maybe even with the version of every preset/plugin, but that may be overkill).

vadimdemedes · 2015-12-23T06:54:26Z

Why don't we just fallback to xdg-basedir (with os-tmpdir as a backup)? It is a stable approach.

Regarding cache, when do you think users would want to clear it?

jamestalmage · 2015-12-23T07:48:46Z

Regarding cache, when do you think users would want to clear it?

Because caches cause problems. The one CSE joke I know is about cache invalidation. I can't think of a single piece of software I use that is so absolutely confident in its caching strategy that it does not provide a means for me to clear it. My browser, my IDE, npm, all of these give me an option to clear the cache.

As a practical example, the first thing I can think of is babel-plugin-xxx publishes a regression and the result of that regression makes its way into the cache. I am sure that is just the tip of the iceberg.

Perhaps, when we can't resolve their node modules folder, we do put it with the global AVA install and just provide a --clear-cache flag.

sindresorhus · 2015-12-23T10:48:02Z

The cache is currently saved in ./node_modules/ava/node_modules/.cache/ava, whereas I think it should be in ./node_modules/.cache/ava.

Not sure about this. It would mean when the user upgrades to a new AVA version, that might change how the cache works, the existing cache is still kept around. Should at least then be ./node_modules/.cache/ava-0.8.0.

However, there is a chance they are using a global install, and do not have a package.json anywhere. I think we just disable caching in that situation

👍

We should probably salt the hash with babel.version

👍 Actually, we should make the salt based on the versions of the various Babel related packages. Upgrades to any of them should invalidate the cache.

Why don't we just fallback to xdg-basedir (with os-tmpdir as a backup)? It is a stable approach.

We now have multiple ways the cache can go wrong and when in xdg-basedir it's never emptied so cache errors will live forever unless the user does something manually to solve it, which I really don't want.

Perhaps, when we can't resolve their node modules folder, we do put it with the global AVA install and just provide a --clear-cache flag.

I don't see the point of a flag if we only put the cache in ./node_modules/.cache. A flag comes with a lot of hidden overhead.

jamestalmage · 2015-12-23T11:10:55Z

Should at least then be ./node_modules/.cache/ava-0.8.0.

That makes it (only a little) harder to script removing the directory. I was going to suggest we include the AVA version in the salt. I'm fine with this approach though. I just really want it in their root node_modules folder so it is visible.

Actually, we should make the salt based on the versions of the various Babel related packages

I think we are going to find that difficult and costly. Babel doesn't do that in it's own cache implementation. To actually do that right, you would need to resolve the package.json of all 20 (twenty!) dependencies of babel-preset-es2015, fetch and parse those to extract pkg.version, and hash them all together. Same for babel-preset-stage-2 (another 5 dependencies when you walk the full graph), and again for power-assert, and transform-runtime

--clear-cache ... A flag comes with a lot of hidden overhead.

Agreed. That was offered as a workaround for my concerns with global installs. If we disable caching for global installs, then this is moot. I still think --no-cache has value, the cache introduces so many moving parts, it would be nice to be able to disable it and eliminate it as the source when troubleshooting a problem with users.

sindresorhus · 2015-12-23T11:15:38Z

I was going to suggest we include the AVA version in the salt.

👍 AVA version in the salt would be even better.

I think we are going to find that difficult and costly. Babel doesn't do that in it's own cache implementation.

Ok, lets not do it then.

vadimdemedes · 2015-12-24T11:34:08Z

lib/babel.js


 var opts = JSON.parse(process.argv[2]);
+var testPath = opts.file;
+
+var cache = cacha(path.join(pkgDir(path.dirname(testPath)), 'node_modules', '.cache', 'ava'));


So, the cache is being stored in node_modules/.cache/ava, but later down this file versions from ava & babel-* packages are being included in the cache key.

That way, when users rm -rf node_modules/.cache/ava, they can be sure they removed all the cache. And they won't need to get the AVA version to remove ava-0.8.0 (for example).

vadimdemedes · 2015-12-25T11:14:08Z

So, are we good on this? Would really like to get it in before the release, so that users don't experience bad performance.

Cache babel-transpiled code

sindresorhus · 2015-12-25T15:33:29Z

👍

vadimdemedes force-pushed the cache-babel branch from dd21358 to bd36318 Compare December 22, 2015 16:42

vadimdemedes force-pushed the cache-babel branch 2 times, most recently from d4d4377 to 844fad9 Compare December 22, 2015 16:48

vadimdemedes force-pushed the cache-babel branch from 844fad9 to 8add554 Compare December 22, 2015 17:13

jamestalmage reviewed Dec 22, 2015
View reviewed changes

vadimdemedes force-pushed the cache-babel branch 2 times, most recently from 74fc5a9 to 6e4c5b2 Compare December 22, 2015 18:43

jamestalmage mentioned this pull request Dec 23, 2015

Make --require relative to where the command is run. #346

Closed

vadimdemedes force-pushed the cache-babel branch from 6e4c5b2 to 4dc5c7d Compare December 24, 2015 11:26

cache babel-transpiled code

0daec3e

vadimdemedes force-pushed the cache-babel branch from 4dc5c7d to 0daec3e Compare December 24, 2015 11:27

vadimdemedes reviewed Dec 24, 2015
View reviewed changes

sindresorhus added a commit that referenced this pull request Dec 25, 2015

Merge pull request #352 from sindresorhus/cache-babel

865cc05

Cache babel-transpiled code

sindresorhus merged commit 865cc05 into master Dec 25, 2015

sindresorhus deleted the cache-babel branch December 25, 2015 15:33

vadimdemedes mentioned this pull request Dec 25, 2015

Performance issues after Babel 6 upgrade #351

Closed

sindresorhus mentioned this pull request Dec 25, 2015

Cache transformed files #189

Closed

jamestalmage mentioned this pull request Dec 27, 2015

Babel caching #118

Closed

jamestalmage mentioned this pull request Jan 12, 2016

please don't use node_modules for this sindresorhus/find-cache-dir#1

Closed

asfktz mentioned this pull request Jul 20, 2017

add watch option for cache validation asfktz/autodll-webpack-plugin#13

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cache babel-transpiled code #352

Cache babel-transpiled code #352

vadimdemedes commented Dec 22, 2015

vadimdemedes commented Dec 22, 2015

jamestalmage commented Dec 22, 2015

sindresorhus commented Dec 22, 2015

sindresorhus commented Dec 22, 2015

vadimdemedes commented Dec 22, 2015

jamestalmage commented Dec 22, 2015

vadimdemedes commented Dec 22, 2015

jamestalmage Dec 22, 2015

sindresorhus commented Dec 22, 2015

jamestalmage commented Dec 23, 2015

vadimdemedes commented Dec 23, 2015

jamestalmage commented Dec 23, 2015

sindresorhus commented Dec 23, 2015

jamestalmage commented Dec 23, 2015

sindresorhus commented Dec 23, 2015

vadimdemedes Dec 24, 2015

vadimdemedes commented Dec 25, 2015

sindresorhus commented Dec 25, 2015

Cache babel-transpiled code #352

Cache babel-transpiled code #352

Conversation

vadimdemedes commented Dec 22, 2015

vadimdemedes commented Dec 22, 2015

jamestalmage commented Dec 22, 2015

sindresorhus commented Dec 22, 2015

sindresorhus commented Dec 22, 2015

vadimdemedes commented Dec 22, 2015

jamestalmage commented Dec 22, 2015

vadimdemedes commented Dec 22, 2015

jamestalmage Dec 22, 2015

Choose a reason for hiding this comment

sindresorhus commented Dec 22, 2015

jamestalmage commented Dec 23, 2015

vadimdemedes commented Dec 23, 2015

jamestalmage commented Dec 23, 2015

sindresorhus commented Dec 23, 2015

jamestalmage commented Dec 23, 2015

sindresorhus commented Dec 23, 2015

vadimdemedes Dec 24, 2015

Choose a reason for hiding this comment

vadimdemedes commented Dec 25, 2015

sindresorhus commented Dec 25, 2015