feat(bundle-manager): blacklisted bundle directory names

[haganbmj]

Allows irrelevant folders (like .git) and invalid bundles to exist in the bundles directory without crashing.
It's likely that the bundle-parser should be logging these errors and returning an undefined bundle instead to avoid using this blind try/catch. That'd mean passing in and constructing a new logger instance each time with the current implementation, though.

[haganbmj]

Not sure there's a way to get this to rerun the security checks.

[haganbmj]

Yeah, maybe I'm just trying to solve a problem I created for myself when I decided that my bundles directory should be one big git repo of submodules.

Without this commit nodecg exits because .git is an invalid bundle.

[haganbmj]

There might be a better way though, I don't doubt that at all. Maybe just a couple blacklisted directory names and the ability to add a few exclusions in your cfg/node.json

[haganbmj]

Went with blacklisting node_modules, bower_components, and anything that starts with a dot. Figured that'd take care of .git, .idea, .vscode, etc.
Any custom exclusions can be added in the bundles.disabled config to supplement that, which I'm realizing is just what I could've done from the start.

[haganbmj]

Whoops, was able to get some new issues related to chokidar because the watchers don't adhere to the ignored directories.

Unsure what the symlink limitations are, wasn't even sure nodecg resolved symlinks, but it's probably alright to just move this up into the bundle discovery loop. Whether that's before or after the semver compatibility check or not.

nodecg/lib/bundle-manager.js

Lines 190 to 194 in c39d45c

	watcher.add([
	path.join(bundlePath, '.git'), // Watch .git folders
	path.join(bundlePath, 'dashboard'), // Watch dashboard folders
	path.join(bundlePath, 'package.json') // Watch bundle package.json files
	]);

2018-05-02 10:38 NodeCG[43514] (FSEvents.framework) process_dir_events: creation: watch_path() failed for '~/git/nodecg/bundles/.git/dashboard'
2018-05-02 10:38 NodeCG[43514] (FSEvents.framework) process_dir_events: creation: watch_path() failed for '~/git/nodecg/bundles/.git/.git'
2018-05-02 10:38 NodeCG[43514] (FSEvents.framework) process_dir_events: creation: watch_path() failed for '~/git/nodecg/bundles/.git/.git'
2018-05-02 10:38 NodeCG[43514] (FSEvents.framework) process_dir_events: creation: watch_path() failed for '~/git/nodecg/bundles/.git/dashboard'
2018-05-02 10:39 NodeCG[43514] (FSEvents.framework) process_dir_events: creation: watch_path() failed for '~/git/nodecg/bundles/.git/dashboard'
2018-05-02 10:39 NodeCG[43514] (FSEvents.framework) process_dir_events: creation: watch_path() failed for '~/git/nodecg/bundles/.git/.git'

[haganbmj]

Change:

Add the concept of blacklisted bundle directories, directories that can safely exist in your bundles directory without nodecg attempting to load them.

My use case for this was having my bundles directory managed as a git repository with submodules. Due to this the .git directory was being parsed as a bundle and nodecg would exception out.

The currently ignored directories are the common things like node_modules and bower_components, but also any dot-prefixed directories (like .vscode, .idea).

As for a status, the ignoring works fine. There's some changes that need to be made to the chokidar logic though because it bypasses the concept of enabled/disabled bundles entirely and watches every folder in the bundles directory.